Skip to content
You are viewing docs for v0.1.0. Switch to latest

Query Console REST API

The query console is an optional development endpoint.

This route may be deployment-dependent and can be omitted by conservative runtime configurations.

MethodRoute
POST/api/query

Request body:

{
"sql": "SELECT * FROM \"dereg\".\"Employee$Events\";"
}
  • SQL must start with SELECT or WITH
  • Mutation keywords are rejected even if they appear later in the text
  • On success, result batches are returned as Arrow IPC
StatusMeaning
403Non-read-only SQL was supplied
404Route not registered or not available in the current deployment
500Query execution or IPC serialization failure
  • This endpoint is intended for debugging, exploration, and lightweight integrations.
  • It is not the primary path for schema mutation or command execution.