Jq - Revision history

Andre Castro: /* References */

2019-11-18T20:10:36Z

References

← Older revision		Revision as of 22:10, 18 November 2019
Line 179:		Line 179:
	* https://blog.appoptics.com/jq-json/		* https://blog.appoptics.com/jq-json/
	* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/		* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/
			* https://blog.appoptics.com/jq-json/

	[[Category:Cookbook]]		[[Category:Cookbook]]

Andre Castro: /* Filter function: select */

2019-10-07T08:13:29Z

Filter function: select

← Older revision		Revision as of 10:13, 7 October 2019
Line 161:		Line 161:
	"captures": []		"captures": []
	}		}
	</~~code~~>		</source>

	If we want to get only the strings we can simply add <code>.string</code> to the match pattern: <code>("^0.*").string</code>		If we want to get only the strings we can simply add <code>.string</code> to the match pattern: <code>("^0.*").string</code>

	<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" \| jq '.query.allusers[].name \| match ("^0.*").string'</source>		<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" \| jq '.query.allusers[].name \| match ("^0.*").string'</source>

			<source lang="bash">
			"0885629"
			"0998247"
			</source>

	==References==		==References==

Andre Castro: /* Filter function: select */

2019-10-07T08:12:40Z

Filter function: select

← Older revision		Revision as of 10:12, 7 October 2019
Line 131:		Line 131:

	From the list os alluser (<code>.query.allusers[0]</code>) I want only the one that has the value "Albert Jongstra" to key "name".		From the list os alluser (<code>.query.allusers[0]</code>) I want only the one that has the value "Albert Jongstra" to key "name".
	In other words <code> select (.name=="Albert Jongstra")		In other words <code> select (.name=="Albert Jongstra")</code>

	<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" \| jq '.query.allusers[0] \| (.name=="Albert Jongstra")'</source>		<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" \| jq '.query.allusers[0] \| (.name=="Albert Jongstra")'</source>

Andre Castro at 08:12, 7 October 2019

2019-10-07T08:12:09Z

@@ Line 109: / Line 109: @@
 "Albert Jongstra"
 </source>
 ==References==

Andre Castro: /* References */

2019-10-07T07:43:26Z

References

← Older revision		Revision as of 09:43, 7 October 2019
Line 112:		Line 112:
	==References==		==References==
	* [https://stedolan.github.io/jq/manual/#Invokingjq man jq]		* [https://stedolan.github.io/jq/manual/#Invokingjq man jq]
	* https://shapeshed.com/jq-json/~~#how~~-to-~~find~~-~~items~~-in-an-~~array~~		* https://shapeshed.com/jq-json/
			* https://blog.appoptics.com/jq-json/
			* https://thoughtbot.com/blog/jq-is-sed-for-json
			* https://blog.appoptics.com/jq-json/
	* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/		* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/

	[[Category:Cookbook]]		[[Category:Cookbook]]

Andre Castro at 06:48, 7 October 2019

2019-10-07T06:48:38Z

← Older revision		Revision as of 08:48, 7 October 2019
Line 98:		Line 98:
	* <code>jq '.query.allusers[].name'</code> '''the value of key "name"''' for all items of list "allusers"		* <code>jq '.query.allusers[].name'</code> '''the value of key "name"''' for all items of list "allusers"

			request:
			<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" \| jq '.query.allusers[].name'</source>

			response:
			<source lang="bash">
			")biyibiyibiyi("
			"0885629"
			"0998247"
			"10000BL"
			"Albert Jongstra"
			</source>

	==References==		==References==

Andre Castro at 06:46, 7 October 2019

2019-10-07T06:46:49Z

← Older revision		Revision as of 08:46, 7 October 2019
Line 103:		Line 103:
	* https://shapeshed.com/jq-json/#how-to-find-items-in-an-array		* https://shapeshed.com/jq-json/#how-to-find-items-in-an-array
	* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/		* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/

			[[Category:Cookbook]]

Andre Castro: *

2019-10-07T06:46:17Z

New page

jq is a Command line [[JSON]] processor

==install==
* GNU/Linux: <code>apt install jq</code>
* Mac: <code>brew install jq</code>

==Usage==
===Basic:prettyfier===
'''jq''' is often used to pretty (make readable) JSON files or request in the shell terminal

For instances, the reply following GET Request to the PZI Wiki api: asking for the first 5 user, will look quite difficult to read

request:
<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" </source>
response:
<source lang="bash">{"query-continue":{"allusers":{"aufrom":"Alef8"}},"query":{"allusers":[{"userid":"234","name":")biyibiyibiyi("},{"userid":"283","name":"0885629"},{"userid":"275","name":"0998247"},{"userid":"160","name":"10000BL"},{"userid":"15","name":"Albert Jongstra"}]}}</source>

But with '''jq''' with get the JSON indented according to the hierarchy of the response
request:
<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" | jq</source>

response:
<source lang="bash">{
"query-continue": {
"allusers": {
"aufrom": "Alef8"
}
},
"query": {
"allusers": [
{
"userid": "234",
"name": ")biyibiyibiyi("
},
{
"userid": "283",
"name": "0885629"
},
{
"userid": "275",
"name": "0998247"
},
{
"userid": "160",
"name": "10000BL"
},
{
"userid": "15",
"name": "Albert Jongstra"
}
]
}
}
</source>

===Filters===
jq can be used as a command line filter , who's output can be sent to another application by using the <code>'.'</code> instruction

request: Here grep is matching only the lines with "userid"
<source lang="bash">curl -s "http://pzwiki.wdka.nl/mw-mediadesign/api.php?format=json&action=query&list=allusers&aulimit=5" | jq '.' | grep userid</source>

response:
<source lang="bash">
"userid": "234",
"userid": "283",
"userid": "275",
"userid": "160",
"userid": "15",
</source>

===Filters for querying===
'''jq''' Filters can be used for querying:

Using the following request if would like to '''receive only the value of the users names'''.

If we look at the structure of the response we see that each user <code>name</code> is wrapped withing the following structure

<source lang="python">
"query": {
"allusers": [
{
"userid": "234",
"name": ")biyibiyibiyi("
}
]
}
</source>

Which we could handle in jq by doing the following steps:
* <code>jq '.query'</code> '''the value of key "query"'''
* <code>jq '.query.allusers'</code> '''the value of key "allusers"''', within the value of key "query", which is a list
* <code>jq '.query.allusers[]'</code> '''all the items of list "allusers"
** <code>jq '.query.allusers[0]'</code> only the 1st item of list
** <code>jq '.query.allusers[0,2]'</code> items 0, 2 of list
** <code>jq '.query.allusers[1:]'</code> all items but first
** <code>jq '.query.allusers[:-1]'</code> all items but last
* <code>jq '.query.allusers[].name'</code> '''the value of key "name"''' for all items of list "allusers"

==References==
* [https://stedolan.github.io/jq/manual/#Invokingjq man jq]
* https://shapeshed.com/jq-json/#how-to-find-items-in-an-array
* https://zerokspot.com/weblog/2013/07/18/processing-json-with-jq/