Execute SQL query
Changed onExecute a single SQL query or a batch of queries against a PostgreSQL branch.
Authentication: send the branch's PostgreSQL connection string in the Connection-String header. The control-plane API key (Bearer token) is not accepted on the gateway host.
Routing: the target branch, region, and endpoint type are taken from the hostname embedded in the connection string, which must match the request host. See the Connection-String security scheme for the host format.
Single query: provide query (and optional params) at the top level.
Batch: provide queries as an array of query objects, or send the request body as a JSON array. Batch queries execute within a single transaction.
Errors: PostgreSQL errors return 400 with their SQLSTATE in code and their diagnostic fields. A 503 means the gateway could not reach the database: 08001 when a connection cannot be established and 08006 when an established connection fails. A 503 does not guarantee that replaying a write is safe: a connection failure can leave its outcome unknown.
Request
- Base URLhttps://my-branch.us-east-1.xata.tech
- AuthAPI key in header Connection-String
Headers
When true, return rows as arrays instead of objects.
When true, return all values as strings without type conversion.
Transaction isolation level for batch queries.
When true, execute the batch transaction in read-only mode.
When true, execute the batch transaction in deferrable mode.
Request body
Response
Query executed successfully
Changes
- info
added the non-success response with the status
- info
- breaking
the
////////response's property format changed fromint32toint64for status - breaking
the
////////response's property format changed fromint32toint64for status - breaking
the
//////response's property format changed fromint32toint64for status - breaking
the
//////response's property format changed fromint32toint64for status
- breaking