Skip to main content

ViewCreate

Request to create a logical or materialized view from one or more backing resources. Materialized views require order_by and options.refresh.

nameName (string)required

lower_snake_case identifier from 1 to 63 characters. It must start with a lowercase letter or underscore and may contain lowercase letters, digits, and underscores.

Possible values: Value must match regular expression ^[a-z_][a-z0-9_]{0,62}$

alias object
anyOf
string
typeType (string)required

View kind: 'view' or 'materialized'

Possible values: [view, materialized]

collection_idCollection Id (string)required

Parent collection ID (required)

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    tables object[]required

    Backing resources. tables[0] = primary (FROM). length ≥ 1

  • Array [
    • aliasAlias (string)required

    SQL alias used in column references

    typeType (string)required

    Backing resource category

    Possible values: [dataset, source]

    resourceResource (string)required

    Identifier of the dataset or source used by this view table.

  • ]
    • joins object
    anyOf
  • Array [
    • targetTarget (string)required

    alias of the ViewTable this join introduces

    kindJoinKind (string)

    Allowed Join Kind values. Values: inner, left, right, full.

    Possible values: [inner, left, right, full]

    Default value: inner
    on object[]required

    AND'd binary conditions

  • Array [
    • left objectrequired

    Join condition operand. Exactly one of column / expression set.

    column object

    Backing column reference in 'alias.col' form

    anyOf
    string
    expression object

    SQL fragment when the operand is a computed expression

    anyOf
    string
    right objectrequired

    Join condition operand. Exactly one of column / expression set.

    column object

    Backing column reference in 'alias.col' form

    anyOf
    string
    expression object

    SQL fragment when the operand is a computed expression

    anyOf
    string
    operatorJoinOperator (string)

    Allowed Join Operator values. Values: eq, ne, gt, gte, lt, lte.

    Possible values: [eq, ne, gt, gte, lt, lte]

    Default value: eq
  • ]
  • ]
    • schema objectrequired

    Output Arrow schema (REQUIRED)

    property name*any

    Output Arrow schema (REQUIRED)

    column_masks object
    anyOf
    object
    row_filters object
    anyOf
    kindKind (string)

    Possible values: [and, or]

    Default value: and
    conditions object[]

    Nested conditions (leaf RowFilterCondition or group RowFilter)

  • Array [
    • anyOf
    kindKind (string)
    Constant value: condition
    Default value: condition
    columnColumn (string)required

    Column name to filter on

    operatorRowFilterOperator (string)required

    Allowed Row Filter Operator values. Values: eq, ne, gt, gte, lt, lte, in, not_in, and 4 more.

    Possible values: [eq, ne, gt, gte, lt, lte, in, not_in, between, like, is_null, is_not_null]

    value object

    Filter value. Single value for scalar operators, list for 'in'/'not_in', 2-element list for 'between'. Omit for 'is_null'/'is_not_null'.

    anyOf
  • ]
    • group_by object
    anyOf
  • Array [
    • string
  • ]
    • having object
    anyOf
    kindKind (string)

    Possible values: [and, or]

    Default value: and
    conditions object[]

    Nested conditions (leaf RowFilterCondition or group RowFilter)

  • Array [
    • anyOf
    kindKind (string)
    Constant value: condition
    Default value: condition
    columnColumn (string)required

    Column name to filter on

    operatorRowFilterOperator (string)required

    Allowed Row Filter Operator values. Values: eq, ne, gt, gte, lt, lte, in, not_in, and 4 more.

    Possible values: [eq, ne, gt, gte, lt, lte, in, not_in, between, like, is_null, is_not_null]

    value object

    Filter value. Single value for scalar operators, list for 'in'/'not_in', 2-element list for 'between'. Omit for 'is_null'/'is_not_null'.

    anyOf
  • ]
    • order_by object

    MergeTree ORDER BY ⊆ schema_ fields (required when type='materialized')

    anyOf
  • Array [
    • string
  • ]
    • partition_by object

    MergeTree PARTITION BY ⊆ schema_ fields (optional)

    anyOf
  • Array [
    • string
  • ]
    • options object

    View options. For type=materialized, options.refresh is required as a non-empty refresh-interval expression; type=view must not set it.

    anyOf
    object
    ViewCreate
    {
      "name": "string",
      "alias": "string",
      "type": "view",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "tables": [
        {
          "alias": "string",
          "type": "dataset",
          "resource": "string"
        }
      ],
      "joins": [
        {
          "target": "string",
          "kind": "inner",
          "on": [
            {
              "left": {
                "column": "string",
                "expression": "string"
              },
              "right": {
                "column": "string",
                "expression": "string"
              },
              "operator": "eq"
            }
          ]
        }
      ],
      "schema": {},
      "column_masks": {},
      "row_filters": {
        "kind": "and",
        "conditions": [
          {
            "kind": "condition",
            "column": "string",
            "operator": "eq"
          },
          null
        ]
      },
      "group_by": [
        "string"
      ],
      "having": {
        "kind": "and",
        "conditions": [
          {
            "kind": "condition",
            "column": "string",
            "operator": "eq"
          },
          null
        ]
      },
      "order_by": [
        "string"
      ],
      "partition_by": [
        "string"
      ],
      "options": {}
    }