druid/docs/content/TimeBoundaryQuery.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

---
2013-09-26 19:22:28 -04:00
layout: doc_page
---
2014-01-16 18:37:07 -05:00
# Time Boundary Queries
2013-09-13 18:20:39 -04:00
Time boundary queries return the earliest and latest data points of a data set. The grammar is:
```json
{
"queryType" : "timeBoundary",
2014-08-01 13:43:18 -04:00
"dataSource": "sample_datasource",
"bound" : < "maxTime" | "minTime" > # optional, defaults to returning both timestamps if not set
}
```
2013-09-13 18:20:39 -04:00
There are 3 main parts to a time boundary query:
|property|description|required?|
|--------|-----------|---------|
|queryType|This String should always be "timeBoundary"; this is the first thing Druid looks at to figure out how to interpret the query|yes|
2013-09-13 18:20:39 -04:00
|dataSource|A String defining the data source to query, very similar to a table in a relational database|yes|
2014-08-01 13:43:18 -04:00
|bound | Optional, set to `maxTime` or `minTime` to return only the latest or earliest timestamp. Default to returning both if not set| no |
2013-09-13 18:20:39 -04:00
|context|An additional JSON Object which can be used to specify certain flags.|no|
The format of the result is:
```json
[ {
"timestamp" : "2013-05-09T18:24:00.000Z",
"result" : {
"minTime" : "2013-05-09T18:24:00.000Z",
"maxTime" : "2013-05-09T18:37:00.000Z"
}
} ]
```