ITQC/gls_docs
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Description on query expansion.

Browse Source
This commit is contained in:
Fabian Märki
2018-09-12 14:24:00 +02:00
parent c6b966d468
commit f87fc644d1
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Readme.md
View File

@ -381,15 +381,19 @@ Queries are applied to a range. The following types of ranges are supported.
"range":{
"startPulseId":0,
"startInclusive":true,
"startExpansion":false,
"endPulseId":100,
"endInclusive":true
"endInclusive":true,
"endExpansion":false
}
```
- **startPulseId**: The start pulse-id of the range request.
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **startExpansion**: Expands the query start until the first entry before the defined start (values: true|**false**). Binning aggregations are expanded until the start of the bin of that entry.
- **endPulseId**: The end pulse-id of the range request.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
- **endExpansion**: Expands the query end until the first entry after the defined end (values: true|**false**). Binning aggregations are expanded until the end of the bin of that entry.
#### By Date
@ -398,15 +402,19 @@ Queries are applied to a range. The following types of ranges are supported.
"range":{
"startDate":"2015-08-06T18:00:00.000",
"startInclusive":true,
"startExpansion":false,
"endDate":"2015-08-06T18:59:59.999",
"endInclusive":true
"endInclusive":true,
"endExpansion":false
}
```
- **startDate**: The start date of the time range in the ISO8601 format (such as 1997-07-16T19:20:30.123+02:00 or 1997-07-16T19:20:30.123456789+02:00 (omitting +02:00 falls back to the server's time zone)).
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **startExpansion**: Expands the query start until the first entry before the defined start (values: true|**false**). Binning aggregations are expanded until the start of the bin of that entry.
- **endDate**: The end date of the time range.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
- **endExpansion**: Expands the query end until the first entry after the defined end (values: true|**false**). Binning aggregations are expanded until the end of the bin of that entry.
#### By Time
@ -415,15 +423,19 @@ Queries are applied to a range. The following types of ranges are supported.
"range":{
"startSeconds":"0.0",
"startInclusive":true,
"startExpansion":false,
"endSeconds":"1.000999999",
"endInclusive":true
"endInclusive":true,
"endExpansion":false
}
```
- **startSeconds**: The start time of the range in seconds since midnight, January 1, 1970 UTC (the UNIX epoch) as a decimal value including fractional seconds.
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **startExpansion**: Expands the query start until the first entry before the defined start (values: true|**false**). Binning aggregations are expanded until the start of the bin of that entry.
- **endSeconds**: The end time of the range in seconds.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
- **endExpansion**: Expands the query end until the first entry after the defined end (values: true|**false**). Binning aggregations are expanded until the end of the bin of that entry.
<a name="data_ordering"/>