v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-051387180.3 KB

compiler

Compile resolved query to SQL

Compile a resolved query to SQL.

Takes a previously resolved query and generates the final SQL statement for the target dialect.

RLS: Filtered to current client (ClientRLSDB).

post/api/v1/compiler/compile

Query parameters

sourcestring nullable

Headers

X-Kater-CLI-IDstring nullable

Request body

connection_idstring uuid required

Connection to compile against

tenant_keystring required

Tenant key for multi-tenant compilation. Use 'kater_global_tenant' for no-tenancy clients or to bypass tenant isolation. For database tenancy, maps to the tenant's database. For row tenancy, used as the row-level filter value.

Example request

{
  "resolved_query": {
    "chart_hints": [
      {
        "config": {
          "color_by": "ref(created_date)",
          "size": "ref(created_date)",
          "stack_by": "ref(created_date)",
          "x_axis": "ref(created_date)",
          "y_axis": "ref(created_date)"
        }
      }
    ],
    "filters": [
      {
        "exists": {
          "from": "ref(dim_customer.sale_price)"
        },
        "not_exists": {
          "from": "ref(dim_customer.sale_price)"
        }
      }
    ],
    "resolved_chart": {
      "config": {
        "color_by": "ref(created_date)",
        "size": "ref(created_date)",
        "stack_by": "ref(created_date)",
        "x_axis": "ref(created_date)",
        "y_axis": "ref(created_date)"
      }
    },
    "resolved_variables": [
      {
        "allowed_values": {
          "from_column": "ref(dim_customer.sale_price)"
        }
      }
    ],
    "select_from": [
      {
        "ref": "ref(dim_customer.sale_price)"
      }
    ],
    "source_query": "ref(dim_customer.sale_price)",
    "topic": "ref(dim_customer.sale_price)"
  }
}

Response

Successful Response

dialectstring required

SQL dialect used (e.g. 'snowflake')

request_idstring nullable

Write-back request ID. Non-null when files were dispatched to CLI via WebSocket.

sqlstring nullable

Generated SQL statement

successboolean required

Whether compilation succeeded