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

Readme

Browse Source
This commit is contained in:
Fabian Märki
2016-04-15 15:46:29 +02:00
parent ef9cad3b9f
commit 2dc33d8161
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Readme.md
View File

@ -142,7 +142,7 @@ The simplest way to define channels is to use an array of channel name Strings.
]
```
The query interface will automatically select the backend which contains the channel (e.g., *databuffer* for *Channel_02* and *archiverappliance* for *Channel_04*). In case name clashes exist, the query interface will use following order of priority: *databuffer* and *archiverappliance*.
The query interface will automatically select the backend which contains the channel (e.g., *databuffer* for *Channel_02* and *archiverappliance* for *Channel_04*). In case name clashes exist, the query interface will use following order of priority: *databuffer* and then *archiverappliance*.
It is also possible to explicitly define the backend to overcome name clashes.
@ -204,18 +204,16 @@ Queries are applied to a range. The following types of ranges are supported.
- **endSeconds**: The end time of the range in seconds.
### Define `responseFormat`
### Response Format
Responses can be formatted as CSV or JSON using the `responseFormat` field. The returned data is JSON-formatted by default.
CSV export does not support `index` and `extrema` aggregations.
The format of the response can be defined through the field `responseFormat` (values: **JSON**|CSV). Please note that CSV does not support `index` and `extrema` aggregations.
### Define `compression`
### Response Compression
By default, data is not compressed when transferred from the server to the client. However, compression can be enabled by setting the `compression` attribute to a value other than `none`, i.e. to `gzip` or `deflate`.
Responses can be compressed when transferred from the server by setting the field `compression` (values: **none**|gzip|deflate).
If compression is enabled, you have to tell `curl` that the data is compressed so that it is being decompressed automatically. `curl` decompresses the response when the `--compressed` parameter is set.
If compression is enabled, you have to tell `curl` that the data is compressed by defining the attribute `--compressed` so that it decompresses the data automatically.
### Example Queries