From 2dcdd9614cc1c2a6fad03a2917d2bd9deb153b32 Mon Sep 17 00:00:00 2001
From: Yuce Tekol <yucetekol@gmail.com>
Date: Wed, 12 Sep 2018 00:01:22 +0300
Subject: [PATCH] Added docs for the Options call

---
 docs/query-language.md | 66 +++++++++++++++++++++++++++++++++---------
 1 file changed, 53 insertions(+), 13 deletions(-)

diff --git a/docs/query-language.md b/docs/query-language.md
index a61a9bf09..21722fd80 100644
--- a/docs/query-language.md
+++ b/docs/query-language.md
@@ -46,8 +46,10 @@ curl localhost:10101/index/repository/query \
 * `field` The field specifies on which Pilosa [field](../glossary/#field) the query will operate. Valid field names are lower case strings; they start with an alphanumeric character, and contain only alphanumeric characters and `_-`. They must be 64 characters or less in length.
 * `TIMESTAMP` This is a timestamp in the following format `YYYY-MM-DDTHH:MM` (e.g. 2006-01-02T15:04)
 * `UINT` An unsigned integer (e.g. 42839)
+* `BOOL` A boolean value, `true` or `false`
 * `ATTR_NAME` Must be a valid identifier `[A-Za-z][A-Za-z0-9._-]*`
 * `ATTR_VALUE` Can be a string, float, integer, or bool.
+* `CALL` Any query
 * `ROW_CALL` Any query which returns a row, such as `Row`, `Union`, `Difference`, `Xor`, `Intersect`, `Range`
 * `[]ATTR_VALUE` Denotes an array of `ATTR_VALUE`s. (e.g. `["a", "b", "c"]`)
 
@@ -112,8 +114,8 @@ Set(10, pullrequests=2)
 **Spec:**
 
 ```
-SetRowAttrs(<FIELD>, <ROW>, 
-            <ATTR_NAME=ATTR_VALUE>, 
+SetRowAttrs(<FIELD>, <ROW>,
+            <ATTR_NAME=ATTR_VALUE>,
             [ATTR_NAME=ATTR_VALUE ...])
 ```
 
@@ -150,8 +152,8 @@ SetRowAttrs(stargazer, 10, username=null)
 **Spec:**
 
 ```
-SetColumnAttrs(<COLUMN>, 
-               <ATTR_NAME=ATTR_VALUE>, 
+SetColumnAttrs(<COLUMN>,
+               <ATTR_NAME=ATTR_VALUE>,
                [ATTR_NAME=ATTR_VALUE ...])
 ```
 
@@ -262,7 +264,7 @@ Row(stargazer=1)
 {"attrs":{"username":"mrpi","active":true},"columns":[10, 20]}
 ```
 
-* attrs are the attributes for user 1 
+* attrs are the attributes for user 1
 * columns are the repositories which user 1 has starred.
 
 #### Union
@@ -497,7 +499,7 @@ Range(<FIELD>=<ROW>, <TIMESTAMP>, <TIMESTAMP>)
 **Description:**
 
 Similar to `Row`, but only returns bits which were set with timestamps
-between the given `start` (first) and `end` (second) timestamps. 
+between the given `start` (first) and `end` (second) timestamps.
 
 **Result Type:** object with attrs and bits
 
@@ -548,14 +550,14 @@ Range(commitactivity > 100)
 
 BSI range queries support the following operators:
 
- Operator | Name                          | Value              
+ 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`  
+ `>`      | 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`
 
 `<`, and `<=` can be chained together to represent a bounded interval. For example:
 
@@ -645,3 +647,41 @@ Sum(field="diskusage")
 ```
 
 * Result is the sum of all values (total size of all repositories in kilobytes, here), plus the count of columns.
+
+### Other Operations
+
+#### Options
+
+**Spec:**
+
+```
+Options(<CALL>, columnAttrs=<BOOL>, excludeColumns=<BOOL>, excludeRowAttrs=<BOOL>, shards=[UINT ...])
+```
+
+**Description:**
+
+Modifies the given query as follows:
+* `columnAttrs`: The result includes column attributes (Default: `false`).
+* `excludeColumns`: Column IDs are not included in the result (Default: `false`).
+* `excludeRowAttrs`: Row attributes are not included in the result (Default: `false`).
+* `shards`: Runs the query only for the given shards. By default, the query is executed for all shards.
+
+**Result Type:** Result type of the given query.
+
+**Examples:**
+
+Return column attributes:
+```request
+Query(Row(f1=10), columnAttrs=true)
+```
+```response
+{"attrs":{},"columns":[100]}],"columnAttrs":[{"id":100,"attrs":{"foo":"bar"}}
+```
+
+Run the query against shards 0 and 2 only:
+```request
+Query(Row(f1=10), shards=[0, 2])
+```
+```response
+{"attrs":{},"columns":[100, 2097152]}
+```