From 124fd6a351fd9d34a10713da6aa77403606ced3b Mon Sep 17 00:00:00 2001 From: Alan Bernstein Date: Wed, 28 Jun 2017 15:44:39 -0500 Subject: [PATCH] Add brief explanations for query parameters on the query endpoint --- docs/api-reference.md | 4 ++++ docs/data-model.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api-reference.md b/docs/api-reference.md index 39f66683f..afc4d9f1a 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -93,6 +93,10 @@ In order to send protobuf binaries in the request and response, set `Content-Typ The response doesn't include column attributes by default. To return them, set `columnAttrs` query argument to `true`. +The query is executed for all [slices](data-model#slice) by default. To use specified slices only, set `slices` query argument to a comma-separated list of slice indices. + +The time quantum can be specified with the `time_granularity`. Valid values match those for the [time-quantum](#/index//time-quantum) endpoint. + Request: ``` curl localhost:10101/index/user/query?columnAttrs=true \ diff --git a/docs/data-model.md b/docs/data-model.md index b4b98de9a..2779f17ad 100644 --- a/docs/data-model.md +++ b/docs/data-model.md @@ -54,7 +54,7 @@ Attributes are arbitrary key/value pairs that can be associated to both rows or ### Slice -Indexes are sharded into groups of columns called Slices - each Slice contains a fixed number of columns which is the SliceWidth. +Indexes are sharded into groups of columns called Slices - each Slice contains a fixed number of columns which is the SliceWidth. SliceWidth is a non-configurable constant set to 2^20. Columns are sharded on a preset width, and each shard is referred to as a Slice. Slices are operated on in parallel, and they are evenly distributed across a cluster via a consistent hash algorithm.