Compile merge query

Compile several queries into a single merged warehouse statement.

Returns the statement and the fields it produces, without running it. Use it to validate a merge while it is being built: a merge that would produce wrong numbers comes back with errors and a null sql — most importantly the fan-out case, where a query still carries a dimension that is neither joined on nor pivoted. Run a valid merge with POST /mergeQuery/run.

POST /api/v1/projects/{projectUuid}/mergeQuery/compile

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "errors": [
      {
        "message": "<string>",
        "fieldIds": [
          "<string>"
        ],
        "sourceId": "<string>",
        "kind": "too_few_sources"
      }
    ],
    "requiresCompose": true,
    "fieldIdByColumn": {},
    "usedParametersValues": {},
    "parameterReferences": [
      "<string>"
    ],
    "fieldOrigins": {},
    "itemsMap": {},
    "fields": [
      {
        "sourceFieldId": "<string>",
        "sourceId": "<string>",
        "type": "<string>",
        "kind": "dimension",
        "label": "<string>",
        "column": "<string>"
      }
    ],
    "columns": {
      "valueColumnBySourceColumn": {},
      "joinKeyColumns": [
        "<string>"
      ]
    },
    "terminalWrapper": {
      "sourceLimitExceededSql": "<string>",
      "limit": 123,
      "orderBy": [
        "<string>"
      ]
    },
    "typedColumns": [
      {
        "origin": {
          "sourceFieldId": "<string>",
          "sourceId": "<string>",
          "kind": "source"
        },
        "type": "string",
        "reference": "<string>"
      }
    ],
    "coreSql": "<string>",
    "legs": [
      {
        "sql": "<string>",
        "sourceId": "<string>"
      }
    ],
    "sql": "<string>"
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

Body

application/json

Body of the compile endpoint: the spec plus the parameter values.

mergeQuery · object · required

Show child attributes

parameters · object

Construct a type with a set of properties K of type T

Show child attributes

Response

200

application/json

Success

results · object · required

What the compile endpoint returns. sql is null exactly when errors is non-empty: a merge that would produce wrong numbers is reported, not run.

A merge runs as a composition: each metric source runs on its own as a leg, and the join runs on the compose engine over the legs' results, which it reads as merge_source_N tables in source order. legs and sql together are the SQL that runs.

Show child attributes

status · enum<string> · required

Available options: ok