Chelabase
ManagementSql editor

The schema for the SQL editor's completion

GET
/v1/databases/{id}/branches/{branch_id}/sql/schema

Everything the database's owner (or, with role, that role) can use in one Postgres database of the branch, read on the same kind of fresh connection a run with that role uses, with postgres-language-server's own introspection (the version PGLS_VERSION pins), as the JSON its WASM build's setSchema takes. Not cached on the server.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Database id

Formatuuid
branch_id*string

Branch id

Formatuuid

Query Parameters

database?string

The Postgres database; the branch's main database when absent.

role?string

The role to read as (what it may use), as a run with this role would; the owner when absent.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/databases/497f6eca-6276-4993-bfeb-53cbbbba6f08/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/sql/schema"
{}

Cancel a SQL run POST

Cancels a run in flight that you started (an Admin may cancel any): Postgres's cancel request is sent and the run's stream ends with `done` (`outcome: cancelled`). Closing the stream cancels too.

List your saved SQL queries GET

The caller's saved queries for the database, by name (ignoring case), without their SQL text. Saved queries are private to their author.