Skip to content

Projection REST API

Projections have a dedicated query endpoint plus metadata endpoints under /api/dereg.

MethodRoute
GET/api/projections/{name}/query

Query parameters:

  • limit optional, default 1000
  • offset optional, default 0

Behavior:

  • Validates projection name as an identifier
  • Confirms the projection exists in DeReg
  • Reads query_sql from DESCRIBE PROJECTION {name}
  • Executes that SQL with appended pagination
  • Returns Arrow IPC
MethodRoute
GET/api/dereg/projections
GET/api/dereg/projections/{name}

Use the optional schema API:

MethodRoute
POST/api/deql/create

with a CREATE PROJECTION ... statement.

StatusMeaning
400Invalid identifier
404Projection not found
500Missing query_sql or execution failure