Cypher

Execute a Cypher statement

Executes the supported Cypher read/CRUD profile. The server derives read/write effects from the statement; Helix Cloud routes reads to readers and writes to the elected writer. Modifying statements execute atomically in one write transaction. X-Helix-Warm is valid only for reads; X-Helix-Await-Durable:true is valid only for writes. Local servers accept request bodies up to 16 MiB. Helix Cloud gateways accept request bodies up to 2 MiB. Local servers apply a 30-second default deadline and Helix Cloud applies the database's query time limit. The response limit is 16 MiB, and resource exhaustion returns an error instead of truncation.

post/v2/cypher

Request

  • Base URL: http://localhost:6969
  • URL: http://localhost:6969/v2/cypher
  • 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

querystring required

One statement in the supported Cypher profile; empty or unsupported statements return a classified query error.

parametersobject
query_namestring nullable

Optional caller-supplied query name.

Response

Statement executed successfully, including writes without RETURN.

columnsstring[] required

Changes

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