BSI Range doc updates

This commit is contained in:
Alan Bernstein 2017-11-14 10:28:25 -06:00
parent cf85a08596
commit 52c0676d34

View file

@ -441,7 +441,7 @@ Returns bits that are true for the comparison operator.
**Examples:**
In our source data, commitactivity was counted over the last year.
The following greater-than (GT) Range query returns all repositories having more than 100 commits.
The following greater-than Range query returns all repositories having more than 100 commits.
```
Range(frame="stats", commitactivity > 100)
@ -451,13 +451,25 @@ Returns `{{"attrs":{},"bits":[10]}`
* bits are repositories which had at least 100 commits in the last year.
Similar syntax is supported for less-than (LT or `<`), less-than-or-equal (LTE or `<=`), and greater-than-or-equal (GTE or `>=`). An interval with both bounds can be specified with the "BETWEEN" operator `><`, and a two-element list containing the lower and upper bounds of the interval:
BSI range queries support the following operators:
Operator | Name | Value
----------|-------------------------------|--------------------
`>` | greater-than, GT | integer
`<` | less-than, LT | integer
`<=` | less-than-or-equal-to, LTE | integer
`>=` | greater-than-or-equal-to, GTE | integer
`==` | equal-to, EQ | integer
`!=` | not-equal-to, NEQ | integer or `null`
`><` | between, BETWEEN | [integer, integer]
The `BETWEEN` query specifies an interval with both bounds, using `><` operator, and a two-element list containing the lower and upper bounds of the interval:
```
Range(frame="stats", commitactivity >< [100, 200])
```
This is conceptually equivalent to the interval 100 < commitactivity < 200, but this chained comparison syntax is not currently supported. BETWEEN queries syntax is restricted to greater-than and less-than, but any valid interval on the integers can be represented this way.
This is conceptually equivalent to the interval 100 <= commitactivity <= 200, but this chained comparison syntax is not currently supported. `BETWEEN` query syntax is restricted to greater-than-or-equal-to and less-than-or-equal-to, but any valid interval on the integers can be represented this way.
#### Sum