Queries

Execute a HelixDB query

Executes one read or write batch. request_type must match the closed read or write variant under query. Local servers accept request bodies up to 16 MiB. Helix Cloud gateways accept request bodies up to 2 MiB.

post/v2/query

Request

  • Base URL: http://localhost:6969
  • URL: http://localhost:6969/v2/query
  • Auth: one of:
    • none
    • HTTP bearer

Headers

X-Helix-Database-Idstring

Database identifier shown in Helix Cloud connection details. Required by the GA shared gateway, not needed by a standalone local server, and not allowed by a database-specific cluster-mode gateway. The legacy X-Helix-Tenant-Id alias is also accepted in GA mode.

X-Helix-Warmboolean

Warm read execution state. Valid only for read requests.

X-Helix-Require-Writerboolean

Reject the request unless it reaches a writer-capable server.

X-Helix-Await-Durableboolean

Flush the writer before acknowledging success. Valid only for write requests.

Request body

OR

Response

Query executed successfully.

QueryResponse required

Returned variables keyed by the names listed in the batch returns array.

Example response

{
  "node_count": [
    42
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.