scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-10-08 20:07:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add brief explanations for query parameters on the query endpoint

Browse source
This commit is contained in:
Alan Bernstein 2017-06-28 15:44:39 -05:00
parent b180bc77bc
commit 124fd6a351
2 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api-reference.md
View file

@ -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/<index-name>/time-quantum) endpoint.
Request:
```
curl localhost:10101/index/user/query?columnAttrs=true \

2
docs/data-model.md
View file

@ -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.