summaryrefslogtreecommitdiffstats
path: root/jq.1.prebuilt
diff options
context:
space:
mode:
authorNicolas Williams <nico@cryptonector.com>2017-01-27 10:06:04 -0600
committerNicolas Williams <nico@cryptonector.com>2017-01-30 14:11:05 -0600
commit7bdf3a39ade47c0571bda45c639a8fc0f11d0ca6 (patch)
treedba867b62a0fbda30a9f7265d018c061ba014e29 /jq.1.prebuilt
parent396543191cec32f69712b4364d26a0ebaa61b801 (diff)
Add SQL-style operators (#1322)
Diffstat (limited to 'jq.1.prebuilt')
-rw-r--r--jq.1.prebuilt39
1 files changed, 39 insertions, 0 deletions
diff --git a/jq.1.prebuilt b/jq.1.prebuilt
index 995b40e9..615b033c 100644
--- a/jq.1.prebuilt
+++ b/jq.1.prebuilt
@@ -2005,6 +2005,45 @@ jq \'strptime("%Y\-%m\-%dT%H:%M:%SZ")|mktime\'
.
.IP "" 0
.
+.SS "SQL\-Style Operators"
+jq provides a few SQL\-style operators\.
+.
+.TP
+INDEX(stream; index_expression):
+.
+.IP
+This builtin produces an object whose keys are computed by the given index expression applied to each value from the given stream\.
+.
+.TP
+JOIN($idx; stream; idx_expr; join_expr):
+.
+.IP
+This builtin joins the values from the given stream to the given index\. The index\'s keys are computed by applying the given index expression to each value from the given stream\. An array of the value in the stream and the corresponding value from the index is fed to the given join expression to produce each result\.
+.
+.TP
+JOIN($idx; stream; idx_expr):
+.
+.IP
+Same as \fBJOIN($idx; stream; idx_expr; \.)\fR\.
+.
+.TP
+JOIN($idx; idx_expr):
+.
+.IP
+This builtin joins the input \fB\.\fR to the given index, applying the given index expression to \fB\.\fR to compute the index key\. The join operation is as described above\.
+.
+.TP
+IN(s):
+.
+.IP
+This builtin outputs \fBtrue\fR if \fB\.\fR appears in the given stream, otherwise it outputs \fBfalse\fR\.
+.
+.TP
+IN(source; s):
+.
+.IP
+This builtin outputs \fBtrue\fR if any value in the source stream appears in the second stream, otherwise it outputs \fBfalse\fR\.
+.
.SH "CONDITIONALS AND COMPARISONS"
.
.SS "==, !="