gjq

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2020 License: GPL-3.0 Imports: 12 Imported by: 0

README

gjq

gjq is a simple jq-like program with performance rather than completeness as the goal.

It only implements what I've needed, which at the moment is extracting fields from a series of messages. For example:

$ echo '[ {"x":1}, {"x":2}, {"x":3} ]' | gjq '.[].x'
1
2
3

At the moment gjq is about 5x faster than jq for the sort of input data and filter I'm interested in using it on:

$ time gjq '.X[].Y' <100k_json_records.json >/dev/null
real    0m12.647s
user    0m12.072s
sys     0m0.544s
$ time jq '.X[].Y' <100k_json_records.json >/dev/null
real    1m3.752s
user    1m2.780s
sys     0m0.780s
$ ls -l 100k_json_records.json
-rw-rw-r-- 1 ndade ndade 2719975876 Jun  2 07:52 100k_json_records.json

The test input is 100,000 lines, each line is a single compacted JSON object. The average size of an object in this file is 27kB, and I'm extracting a small (20 byte) field from a handful of list elements in each object. The output contains 171k elements.

Another performance comparison, 8x in this case, which consists of outputting everything in compacted form (compacted is the default for gjq since it's better for performance; use gjq -pretty for formatted output):

$ time gjq '.' <100k_json_records.json >/dev/null
real    0m14.569s
user    0m13.936s
sys     0m0.592s
$ time jq -c '.' <100k_json_records.json >/dev/null
real    2m4.632s
user    2m3.708s
sys     0m0.848s

Note passing jq the -c flag helps it. Without -c the jq time is 2m29s.

Multiple fields can be extracted in one pass. Separate them with ,

gjq .X,.Y

gjq supports comments in JSON. Comments start with a # symbol and extend to the end of the line. Comments aren't part of the JSON standard, of course, but they are darn useful never-the-less.

gjq allows the numeric values 'NaN', 'Inf', '+Inf" and '-Inf'. These are not part of the JSON standard, but some JSON contains them anyway due to how the encoder was written.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL