💻HTTP Interface
How to use the HTTP interface
Endpoints
The HTTP interface is composed of only two routes.
path | description | input | output |
---|---|---|---|
/catalog | get schemas, tables, columns metadata | A JSON-formatted representation of the database catalog | |
/query | process SQL queries | An SQL query in the HTTP request's body | A JSON-formatted result set |
Caching
Various parameters of the query influence the caching behavior of the query endpoint. We try to stay as close to standard HTTP caching as possible and implement custom extensions only when needed. Cache-related parameters must be passed through the standard Cache-Control
header (or cache-control
query param).
supported directive | semantic |
---|---|
| Bypass query cache |
| Do not store the result of this query in the query cache |
| The client can tolerate a result at most |
We support some custom request headers related to the caching behavior of the HTTP interface.
header | |
---|---|
| The value must be a float between 0 and 1.
On cache hit, we compute the ratio |
Some cache-related headers are set on the response.
header | meaning |
---|---|
| will be set to |
|
|
| this header is set on cache hit with the age (in seconds) of the served result |
Last updated