diff --git a/docs/api-reference.md b/docs/api-reference.md index 115cf3383..eef3c4cbc 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -168,10 +168,10 @@ The request payload is in JSON, and may contain the `options` field. The `option Each individual `field` contains the following: * `name` (string): Field name. * `type` (string): Field type, currently only "int" is supported. -* `min` (int): Minimum of the value range stored in this field. -* `max` (int): Maximum of the value range stored in this field. +* `min` (int): Minimum value allowed for this field. +* `max` (int): Maximum value allowed for this field. -Integer fields are stored as n-bit range-encoded values. Pilosa can use up to a 64-bit integer with one bit reserved for the non-null bitmap leaving up to a 63-bit signed integer represented between `min` and `max`. +Integer fields are stored as n-bit range-encoded values. Pilosa supports 63-bit, signed integers with values between `min` and `max`. Request: ``` @@ -247,8 +247,8 @@ Creates a new field to store integer values in the given frame. The request payload is JSON, and it must contain the fields `type`, `min`, `max`. * `type` (string): Field type, currently only "int" is supported. -* `min` (int): Minimum of the value range stored in this field. -* `max` (int): Maximum of the value range stored in this field. +* `min` (int): Minimum value allowed for this field. +* `max` (int): Maximum value allowed for this field. Request: ``` diff --git a/docs/query-language.md b/docs/query-language.md index 178eff562..874a1e380 100644 --- a/docs/query-language.md +++ b/docs/query-language.md @@ -432,16 +432,16 @@ Range(, ) **Description:** -The to `Range` query is overloaded to also work on `field` values. -Returns bits that are true for the comparison operator +The `Range` query is overloaded to work on `field` values as well as `timestamp` values. +Returns bits that are true for the comparison operator. **Result Type:** object with attrs and bits **Examples:** -In our source data commitactivity was counted over the last year. -This Range query finds all repositories that had that many commits. +In our source data, commitactivity was counted over the last year. +The following Range query returns all repositories having more than 100 commits. ``` Range(frame="stats", commitactivity > 100) @@ -457,14 +457,14 @@ Returns `{{"attrs":{},"bits":[10]}` **Spec:** ``` -Sum(, ) +Sum(, , [BITMAP_CALL]) ``` **Description:** -Returns the computed sum of all `field` values across the bits in a `frame` plus the count of bitmaps with a field value. +Returns the count and computed sum of all bitmap encoded integer values across the `field` in this `frame`. The optional Bitmap call filters the bits used in this computation. -**Result Type:** object with sum and count. +**Result Type:** object with the computed sum and count of the bitmap field. **Examples:** @@ -488,11 +488,11 @@ SetFieldValue(, , ) **Description:** -`SetFieldValue` assigns an integer value with the specified field name to the `columnID` in the given `frame`. The `field` values is encoded across the bits in a `frame`. +`SetFieldValue` assigns an integer value with the specified field name to the `columnID` in the given `frame`. **Result Type:** null -SetFieldValue queries always return `null` upon success. +SetFieldValue returns `null` upon success. **Examples:**