Статья создана

Validate dataset

Validates the specified dataset.

Request

POST

https://api.datalens.tech/rpc/validateDataset

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

Body

application/json

{
  "datasetId": "example",
  "workbookId": "example",
  "bindedDatasetId": "example",
  "data": {
    "dataset": {
      "avatar_relations": [
        {
          "conditions": [
            null
          ],
          "id": "example",
          "join_type": "inner",
          "left_avatar_id": "example",
          "managed_by": "user",
          "required": false,
          "right_avatar_id": "example"
        }
      ],
      "cache_invalidation_source": {
        "cache_invalidation_error": null,
        "field": null,
        "filters": [
          {}
        ],
        "mode": "off",
        "sql": "null"
      },
      "component_errors": {
        "items": [
          {}
        ]
      },
      "data_export_forbidden": false,
      "description": "",
      "load_preview_by_default": true,
      "obligatory_filters": [
        null
      ],
      "preview_enabled": false,
      "result_schema": [
        {}
      ],
      "result_schema_aux": {
        "inter_dependencies": {
          "deps": [
            null
          ]
        }
      },
      "revision_id": "null",
      "rls": {},
      "rls2": {},
      "source_avatars": [
        {
          "id": "example",
          "is_root": true,
          "managed_by": "user",
          "source_id": "example",
          "title": "example"
        }
      ],
      "sources": [
        {}
      ],
      "template_enabled": false
    },
    "updates": [
      {
        "action": "add_field",
        "field": {},
        "order_index": 0
      }
    ]
  }
}

Name	Description
datasetId	Type: string Example: `example`
bindedDatasetId	Type: string Example: `example`
data	Type: DatasetValidate Example { "dataset": { "avatar_relations": [ { "conditions": [ {} ], "id": "example", "join_type": "inner", "left_avatar_id": "example", "managed_by": "user", "required": false, "right_avatar_id": "example" } ], "cache_invalidation_source": { "cache_invalidation_error": null, "field": null, "filters": [ { "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true } ], "mode": "off", "sql": "null" }, "component_errors": { "items": [ { "errors": [ null ], "id": "example", "type": "data_source" } ] }, "data_export_forbidden": false, "description": "", "load_preview_by_default": true, "obligatory_filters": [ null ], "preview_enabled": false, "result_schema": [ { "aggregation": "none", "avatar_id": "example", "cast": "string", "data_type": "string", "description": "example", "guid": "example", "has_auto_aggregation": true, "hidden": false, "initial_data_type": "string", "lock_aggregation": true, "managed_by": "user", "source": "example", "title": "example", "type": "DIMENSION", "ui_settings": "", "valid": true } ], "result_schema_aux": { "inter_dependencies": { "deps": [ {} ] } }, "revision_id": "null", "rls": {}, "rls2": {}, "source_avatars": [ { "id": "example", "is_root": true, "managed_by": "user", "source_id": "example", "title": "example" } ], "sources": [ { "connection_id": "example", "id": "example", "index_info_set": null, "managed_by": "user", "parameters": {}, "raw_schema": [ null ], "source_type": "APPMETRICA_API", "title": "example", "valid": true } ], "template_enabled": false }, "updates": [ { "action": "add_field", "field": { "aggregation": "none", "avatar_id": "example", "calc_mode": "direct", "cast": "string", "default_value": null, "description": "example", "formula": "example", "guid": "example", "guid_formula": "example", "hidden": true, "new_id": "example", "source": "example", "strict": false, "template_enabled": true, "title": "example", "ui_settings": "example", "value_constraint": null }, "order_index": 0 } ] }
workbookId	Type: string \| null Example: `example`

direct

Name

Description

calc_mode

Type: string

Enum: direct, formula, result_field

source

Type: string

Example: example

Example

{
  "calc_mode": "direct",
  "source": "example"
}

formula

Name

Description

calc_mode

Type: string

Enum: direct, formula, result_field

formula

Type: string

Example: example

Example

{
  "calc_mode": "direct",
  "formula": "example"
}

result_field

Name

Description

calc_mode

Type: string

Enum: direct, formula, result_field

field_id

Type: string

Example: example

Example

{
  "calc_mode": "direct",
  "field_id": "example"
}

ConditionPartGeneric

Name

Description

One of 3 types

Type: direct

Example

{
  "calc_mode": "direct",
  "source": "example"
}

Type: formula

Example

{
  "calc_mode": "direct",
  "formula": "example"
}

Type: result_field

Example

{
  "calc_mode": "direct",
  "field_id": "example"
}

Example

{
  "calc_mode": "direct",
  "source": "example"
}

JoinCondition

Name	Description
left	Type: ConditionPartGeneric Example `{ "calc_mode": "direct", "source": "example" }`
operator	Type: string Enum: `gt`, `lt`, `gte`, `lte`, `eq`, `ne`
right	Type: ConditionPartGeneric Example `{ "calc_mode": "direct", "source": "example" }`
type	Type: string Const: `binary` Example: `example`

Example

{
  "left": {
    "calc_mode": "direct",
    "source": "example"
  },
  "operator": "gt",
  "right": null,
  "type": "binary"
}

AvatarRelation

Name	Description
id	Type: string Example: `example`
conditions	Type: JoinCondition[] Example `[ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ]`
join_type	Type: string Enum: `inner`, `left`, `right`, `full`
left_avatar_id	Type: string Example: `example`
managed_by	Type: string \| null Default: `user` Enum: `user`, `feature`, `compiler_runtime`, `null`
required	Type: boolean Default: `false`
right_avatar_id	Type: string Example: `example`

Example

{
  "conditions": [
    {
      "left": {
        "calc_mode": "direct",
        "source": "example"
      },
      "operator": "gt",
      "right": null,
      "type": "binary"
    }
  ],
  "id": "example",
  "join_type": "inner",
  "left_avatar_id": "example",
  "managed_by": "user",
  "required": false,
  "right_avatar_id": "example"
}

CacheInvalidationError

Name	Description
level	Type: string Enum: `info`, `warning`, `critical`
locator	Type: string Example: `example`
message	Type: string Example: `example`
title	Type: string Example: `example`

Example

{
  "level": "info",
  "locator": "example",
  "message": "example",
  "title": "example"
}

formula1

Name

Description

formula

Type: string

Default: ``

guid_formula

Type: string

Default: ``

Example

{
  "formula": "",
  "guid_formula": ""
}

CacheInvalidationField

Name	Description
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
calc_spec	Type: formula1 Example `{ "formula": "", "guid_formula": "" }`
cast	Type: string Default: `string` Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string Default: `string` Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
title	Type: string Default: `INVALIDATION CACHE SERVICE FIELD`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null

Example

{
  "aggregation": "none",
  "calc_spec": {
    "formula": "",
    "guid_formula": ""
  },
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "INVALIDATION CACHE SERVICE FIELD",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

Where

Name	Description
column	Type: string Example: `example`
operation	Type: string Enum: `ISNULL`, `ISNOTNULL`, `GT`, `LT`, `GTE`, `LTE`, `EQ`, `NE`, `STARTSWITH`, `ISTARTSWITH`, `ENDSWITH`, `IENDSWITH`, `CONTAINS`, `ICONTAINS`, `NOTCONTAINS`, `NOTICONTAINS`, `LENEQ`, `LENNE`, `LENGT`, `LENGTE`, `LENLT`, `LENLTE`, `IN`, `NIN`, `BETWEEN`
values	Type: array \| null Example `[ null ]`

Example

{
  "column": "example",
  "operation": "ISNULL",
  "values": [
    null
  ]
}

ObligatoryFilter

Name	Description
id	Type: string Example: `example`
default_filters	Type: Where[] Default: `[]` Example `[ { "column": "example", "operation": "ISNULL", "values": [ null ] } ]`
field_guid	Type: string Example: `example`
managed_by	Type: string \| null Default: `user` Enum: `user`, `feature`, `compiler_runtime`, `null`
valid	Type: boolean Default: `true`

Example

{
  "default_filters": [],
  "field_guid": "example",
  "id": "example",
  "managed_by": "user",
  "valid": true
}

CacheInvalidationSource

Name	Description
cache_invalidation_error	Any of 2 types Type: CacheInvalidationError Example `{ "level": "info", "locator": "example", "message": "example", "title": "example" }` Type: null Example: `null` Default: `null`
field	Any of 2 types Type: CacheInvalidationField Example `{ "aggregation": "none", "calc_spec": { "formula": "", "guid_formula": "" }, "cast": "string", "data_type": "string", "description": "example", "guid": "example", "has_auto_aggregation": true, "hidden": false, "initial_data_type": "string", "lock_aggregation": true, "managed_by": "user", "title": "INVALIDATION CACHE SERVICE FIELD", "type": "DIMENSION", "ui_settings": "", "valid": true }` Type: null Example: `null` Default: `null`
filters	Type: ObligatoryFilter[] Example `[ { "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true } ]`
mode	Type: string Default: `off` Enum: `sql`, `formula`, `off`
sql	Type: string \| null Default: `null`

Example

{
  "cache_invalidation_error": null,
  "field": null,
  "filters": [
    {
      "default_filters": [],
      "field_guid": "example",
      "id": "example",
      "managed_by": "user",
      "valid": true
    }
  ],
  "mode": "off",
  "sql": "null"
}

ComponentError

Name

Description

code

Type: unknown

Example: null

details

Type: object

[additional]

Type: unknown

Example: null

Example

{}

level

Type: string

Enum: error, warning

message

Type: string

Example: example

Example

{
  "code": null,
  "details": {},
  "level": "error",
  "message": "example"
}

ComponentErrorPack

Name	Description
errors	Type: ComponentError[] Example `[ { "code": null, "details": {}, "level": "error", "message": "example" } ]`
id	Type: string Example: `example`
type	Type: string Enum: `data_source`, `source_avatar`, `avatar_relation`, `field`, `obligatory_filter`, `result_schema`

Example

{
  "errors": [
    {
      "code": null,
      "details": {},
      "level": "error",
      "message": "example"
    }
  ],
  "id": "example",
  "type": "data_source"
}

ComponentErrorList

Name	Description
items	Type: ComponentErrorPack[] Example `[ { "errors": [ { "code": null, "details": {}, "level": "error", "message": "example" } ], "id": "example", "type": "data_source" } ]`

Example

{
  "items": [
    {
      "errors": [
        {
          "code": null,
          "details": {},
          "level": "error",
          "message": "example"
        }
      ],
      "id": "example",
      "type": "data_source"
    }
  ]
}

direct1

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
avatar_id	Type: string \| null Example: `example`
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
source	Type: string Example: `example`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

formula2

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
description	Type: string Example: `example`
formula	Type: string Default: ``
guid	Type: string Example: `example`
guid_formula	Type: string Default: ``
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null

Example

{
  "aggregation": "none",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "formula": "",
  "guid": "example",
  "guid_formula": "",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

regex

Name

Description

pattern

Type: string

Example: example

type

Type: string

Const: regex

Example: example

Example

{
  "pattern": "example",
  "type": "regex"
}

default

Name

Description

type

Type: string

Const: default

Example: example

Example

{
  "type": "default"
}

ParameterValueConstraint

Name

Description

One of 2 types

regex

Type: regex

Example

{
  "pattern": "example",
  "type": "regex"
}

default

Type: default
Example
```
{
  "type": "default"
}
```

Example

{
  "pattern": "example",
  "type": "regex"
}

parameter1

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Type: string \| null Example: `example`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
template_enabled	Type: boolean Default: `false`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`

Example

{
  "aggregation": "none",
  "cast": "string",
  "data_type": "string",
  "default_value": "example",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "template_enabled": false,
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

ResultSchemaSchemaGeneric

Name

Description

One of 3 types

Type: direct1

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

Type: formula2

Example

{
  "aggregation": "none",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "formula": "",
  "guid": "example",
  "guid_formula": "",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

Type: parameter1

Example

{
  "aggregation": "none",
  "cast": "string",
  "data_type": "string",
  "default_value": "example",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "template_enabled": false,
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true
}

FieldInterDependencyItem

Name

Description

dep_field_id

Type: string

Example: example

ref_field_ids

Type: string[]

Example

[
  "example"
]

Example

{
  "dep_field_id": "example",
  "ref_field_ids": [
    "example"
  ]
}

FieldInterDependencyInfo

Name	Description
deps	Type: FieldInterDependencyItem[] Example `[ { "dep_field_id": "example", "ref_field_ids": [ "example" ] } ]`

Example

{
  "deps": [
    {
      "dep_field_id": "example",
      "ref_field_ids": [
        "example"
      ]
    }
  ]
}

ResultSchemaAux

Name	Description
inter_dependencies	Type: FieldInterDependencyInfo Example `{ "deps": [ { "dep_field_id": "example", "ref_field_ids": [ "example" ] } ] }`

Example

{
  "inter_dependencies": {
    "deps": [
      {
        "dep_field_id": "example",
        "ref_field_ids": [
          "example"
        ]
      }
    ]
  }
}

RLSSubject

Name	Description
subject_id	Type: string Example: `example`
subject_name	Type: string \| null Default: `null`
subject_type	Type: string Enum: `user`, `group`, `all`, `userid`, `unknown`, `notfound`

Example

{
  "subject_id": "example",
  "subject_name": "null",
  "subject_type": "user"
}

RLS2ConfigEntry

Name	Description
subject	Type: RLSSubject Example `{ "subject_id": "example", "subject_name": "null", "subject_type": "user" }`
allowed_value	Type: string \| null Default: `null`
field_guid	Type: string \| null Default: `null`
pattern_type	Type: string Default: `value` Enum: `value`, `all`, `userid`

Example

{
  "allowed_value": "null",
  "field_guid": "null",
  "pattern_type": "value",
  "subject": {
    "subject_id": "example",
    "subject_name": "null",
    "subject_type": "user"
  }
}

SourceAvatarStrict

Name	Description
id	Type: string Example: `example`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
is_root	Type: boolean
source_id	Type: string Example: `example`
title	Type: string Example: `example`

Example

{
  "id": "example",
  "is_root": true,
  "managed_by": "user",
  "source_id": "example",
  "title": "example"
}

IndexInfo

Name

Description

columns

Type: string[]

Example

[
  "example"
]

kind

Type: string | null

Enum: table_sorting, null

Example: table_sorting

Example

{
  "columns": [
    "example"
  ],
  "kind": "table_sorting"
}

SQLParameters

Name	Description
db_name	Type: string \| null Example: `example`
db_version	Type: string \| null Example: `example`
table_name	Type: string \| null Example: `example`

Example

{
  "db_name": "example",
  "db_version": "example",
  "table_name": "example"
}

generic_native_type

Name

Description

name

Type: string

Example: example

Example

{
  "name": "example"
}

common_native_type

Name

Description

name

Type: string

Example: example

nullable

Type: boolean

Default: true

Example

{
  "name": "example",
  "nullable": true
}

lengthed_native_type

Name	Description
length	Type: integer \| null Default: `null`
name	Type: string Example: `example`
nullable	Type: boolean Default: `true`

Example

{
  "length": null,
  "name": "example",
  "nullable": true
}

clickhouse_native_type

Name	Description
lowcardinality	Type: boolean Default: `false`
name	Type: string Example: `example`
nullable	Type: boolean Default: `true`

Example

{
  "lowcardinality": false,
  "name": "example",
  "nullable": true
}

clickhouse_datetimewithtz_native_type

Name	Description
explicit_timezone	Type: boolean Default: `true`
lowcardinality	Type: boolean Default: `false`
name	Type: string Example: `example`
nullable	Type: boolean Default: `true`
timezone_name	Type: string Default: `UTC`

Example

{
  "explicit_timezone": true,
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "timezone_name": "UTC"
}

clickhouse_datetime64_native_type

Name	Description
precision	Type: integer
lowcardinality	Type: boolean Default: `false`
name	Type: string Example: `example`
nullable	Type: boolean Default: `true`

Example

{
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "precision": 0
}

clickhouse_datetime64withtz_native_type

Name	Description
precision	Type: integer
explicit_timezone	Type: boolean Default: `true`
lowcardinality	Type: boolean Default: `false`
name	Type: string Example: `example`
nullable	Type: boolean Default: `true`
timezone_name	Type: string Default: `UTC`

Example

{
  "explicit_timezone": true,
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "precision": 0,
  "timezone_name": "UTC"
}

OneOfNativeType

Name

Description

One of 7 types

Type: generic_native_type
Example
```
{
  "name": "example"
}
```

Type: common_native_type

Example

{
  "name": "example",
  "nullable": true
}

Type: lengthed_native_type

Example

{
  "length": null,
  "name": "example",
  "nullable": true
}

Type: clickhouse_native_type

Example

{
  "lowcardinality": false,
  "name": "example",
  "nullable": true
}

Type: clickhouse_datetimewithtz_native_type

Example

{
  "explicit_timezone": true,
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "timezone_name": "UTC"
}

Type: clickhouse_datetime64_native_type

Example

{
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "precision": 0
}

Type: clickhouse_datetime64withtz_native_type

Example

{
  "explicit_timezone": true,
  "lowcardinality": false,
  "name": "example",
  "nullable": true,
  "precision": 0,
  "timezone_name": "UTC"
}

Example

{
  "name": "example"
}

RawSchemaColumn

Name	Description
description	Type: string \| null Example: `example`
has_auto_aggregation	Type: boolean \| null
lock_aggregation	Type: boolean \| null
name	Type: string Example: `example`
native_type	Any of 2 types Type: OneOfNativeType Example `{ "name": "example" }` Type: null Example: `null` Example `{ "name": "example" }`
nullable	Type: boolean \| null
title	Type: string Example: `example`
user_type	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`

Example

{
  "description": "example",
  "has_auto_aggregation": true,
  "lock_aggregation": true,
  "name": "example",
  "native_type": {
    "name": "example"
  },
  "nullable": true,
  "title": "example",
  "user_type": "string"
}

APPMETRICA_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `APPMETRICA_API` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true
}

BigQueryTableParameters

Name	Description
dataset_name	Type: string \| null Example: `example`
db_version	Type: string \| null Example: `example`
table_name	Type: string \| null Example: `example`

Example

{
  "dataset_name": "example",
  "db_version": "example",
  "table_name": "example"
}

BIGQUERY_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: BigQueryTableParameters Example `{ "dataset_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BIGQUERY_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true
}

SubselectParameters

Name

Description

subsql

Type: string

Example: example

Example

{
  "subsql": "example"
}

BIGQUERY_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BIGQUERY_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true
}

BITRIX_GDS

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BITRIX_GDS` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true
}

CH_BILLING_ANALYTICS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_BILLING_ANALYTICS_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_YA_MUSIC_PODCAST_STATS_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true
}

CHYTTableListParameters

Name

Description

table_names

Type: string

Example: example

Example

{
  "table_names": "example"
}

CHYT_YTSAURUS_TABLE_LIST

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: CHYTTableListParameters Example `{ "table_names": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE_LIST` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true
}

CHYTTableRangeParameters

Name	Description
directory_path	Type: string Example: `example`
range_from	Type: string Example: `example`
range_to	Type: string Example: `example`

Example

{
  "directory_path": "example",
  "range_from": "example",
  "range_to": "example"
}

CHYT_YTSAURUS_TABLE_RANGE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: CHYTTableRangeParameters Example `{ "directory_path": "example", "range_from": "example", "range_to": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE_RANGE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true
}

CH_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true
}

EQUEO_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `EQUEO_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true
}

EXTRACTOR_1C_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `EXTRACTOR_1C_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true
}

SchematizedParameters

Name	Description
db_name	Type: string \| null Example: `example`
db_version	Type: string \| null Example: `example`
schema_name	Type: string \| null Example: `example`
table_name	Type: string \| null Example: `example`

Example

{
  "db_name": "example",
  "db_version": "example",
  "schema_name": "example",
  "table_name": "example"
}

GP_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GP_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true
}

GP_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GP_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true
}

SimpleParameters

Name

Description

Example

{}

GSHEETS

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GSHEETS` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true
}

JSON_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `JSON_API` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true
}

KONTUR_MARKET_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `KONTUR_MARKET_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true
}

METRIKA_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `METRIKA_API` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true
}

MONITORING

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MONITORING` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true
}

MOYSKLAD_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MOYSKLAD_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MSSQL_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MSSQL_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

MYSQL_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MYSQL_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true
}

MYSQL_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MYSQL_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

ORACLE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `ORACLE_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true
}

ORACLE_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `ORACLE_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true
}

PG_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PG_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true
}

PG_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PG_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true
}

PROMQL

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PROMQL` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true
}

CH_SMB_HEATMAPS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_SMB_HEATMAPS_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true
}

SnowFlakeTableParameters

Name	Description
db_name	Type: string \| null Example: `example`
schema	Type: string \| null Example: `example`
table_name	Type: string \| null Example: `example`

Example

{
  "db_name": "example",
  "schema": "example",
  "table_name": "example"
}

SNOWFLAKE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SnowFlakeTableParameters Example `{ "db_name": "example", "schema": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `SNOWFLAKE_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true
}

SPEECHSENSE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `SPEECHSENSE_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true
}

TRINO_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `TRINO_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true
}

TRINO_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `TRINO_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_USAGE_TRACKING_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_AGG_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_USAGE_TRACKING_AGG_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true
}

YDB_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YDB_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true
}

YDB_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YDB_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true
}

YQ_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YQ_TABLE` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true
}

YQ_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YQ_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true
}

DataSourceStrict

Name

Description

One of 42 types

APPMETRICA_API

Type: APPMETRICA_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true
}

BIGQUERY_TABLE

Type: BIGQUERY_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true
}

BIGQUERY_SUBSELECT

Type: BIGQUERY_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true
}

BITRIX_GDS

Type: BITRIX_GDS

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true
}

CH_BILLING_ANALYTICS_TABLE

Type: CH_BILLING_ANALYTICS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Type: CH_YA_MUSIC_PODCAST_STATS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE

Type: CHYT_YTSAURUS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE_LIST

Type: CHYT_YTSAURUS_TABLE_LIST

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE_RANGE

Type: CHYT_YTSAURUS_TABLE_RANGE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_SUBSELECT

Type: CHYT_YTSAURUS_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_TABLE

Type: CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true
}

CH_SUBSELECT

Type: CH_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true
}

EQUEO_CH_TABLE

Type: EQUEO_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true
}

EXTRACTOR_1C_CH_TABLE

Type: EXTRACTOR_1C_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true
}

GP_TABLE

Type: GP_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true
}

GP_SUBSELECT

Type: GP_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true
}

GSHEETS

Type: GSHEETS

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true
}

JSON_API

Type: JSON_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true
}

KONTUR_MARKET_CH_TABLE

Type: KONTUR_MARKET_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true
}

METRIKA_API

Type: METRIKA_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true
}

MONITORING

Type: MONITORING

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true
}

MOYSKLAD_CH_TABLE

Type: MOYSKLAD_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_TABLE

Type: MSSQL_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_SUBSELECT

Type: MSSQL_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

MYSQL_TABLE

Type: MYSQL_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true
}

MYSQL_SUBSELECT

Type: MYSQL_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

ORACLE_TABLE

Type: ORACLE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true
}

ORACLE_SUBSELECT

Type: ORACLE_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true
}

PG_TABLE

Type: PG_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true
}

PG_SUBSELECT

Type: PG_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true
}

PROMQL

Type: PROMQL

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true
}

CH_SMB_HEATMAPS_TABLE

Type: CH_SMB_HEATMAPS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true
}

SNOWFLAKE_TABLE

Type: SNOWFLAKE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true
}

SPEECHSENSE_TABLE

Type: SPEECHSENSE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true
}

TRINO_TABLE

Type: TRINO_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true
}

TRINO_SUBSELECT

Type: TRINO_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_TABLE

Type: CH_USAGE_TRACKING_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_AGG_TABLE

Type: CH_USAGE_TRACKING_AGG_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true
}

YDB_TABLE

Type: YDB_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true
}

YDB_SUBSELECT

Type: YDB_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true
}

YQ_TABLE

Type: YQ_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true
}

YQ_SUBSELECT

Type: YQ_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true
}

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true
}

DatasetContentInternal

Name

Description

avatar_relations

Type: AvatarRelation[]

Example

[
  {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example"
  }
]

cache_invalidation_source

Type: CacheInvalidationSource

Example

{
  "cache_invalidation_error": null,
  "field": null,
  "filters": [
    {
      "default_filters": [],
      "field_guid": "example",
      "id": "example",
      "managed_by": "user",
      "valid": true
    }
  ],
  "mode": "off",
  "sql": "null"
}

component_errors

Type: ComponentErrorList

Example

{
  "items": [
    {
      "errors": [
        {
          "code": null,
          "details": {},
          "level": "error",
          "message": "example"
        }
      ],
      "id": "example",
      "type": "data_source"
    }
  ]
}

data_export_forbidden

Type: boolean

Default: false

description

Type: string | null

Default: ``

load_preview_by_default

Type: boolean

Default: true

obligatory_filters

Type: ObligatoryFilter[]

Example

[
  {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  }
]

preview_enabled

Type: boolean

Default: false

result_schema

Type: ResultSchemaSchemaGeneric[]

Example

[
  {
    "aggregation": "none",
    "avatar_id": "example",
    "cast": "string",
    "data_type": "string",
    "description": "example",
    "guid": "example",
    "has_auto_aggregation": true,
    "hidden": false,
    "initial_data_type": "string",
    "lock_aggregation": true,
    "managed_by": "user",
    "source": "example",
    "title": "example",
    "type": "DIMENSION",
    "ui_settings": "",
    "valid": true
  }
]

result_schema_aux

Type: ResultSchemaAux

Example

{
  "inter_dependencies": {
    "deps": [
      {
        "dep_field_id": "example",
        "ref_field_ids": [
          "example"
        ]
      }
    ]
  }
}

revision_id

Type: string | null

Default: null

rls

Type: object

[additional]

Type: unknown

Example: null

Example

{}

rls2

Type: object

[additional]

Type: RLS2ConfigEntry[]

Example

[
  {
    "allowed_value": "null",
    "field_guid": "null",
    "pattern_type": "value",
    "subject": {
      "subject_id": "example",
      "subject_name": "null",
      "subject_type": "user"
    }
  }
]

Example

{}

source_avatars

Type: SourceAvatarStrict[]

Example

[
  {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example"
  }
]

sources

Type: DataSourceStrict[]

Example

[
  {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true
  }
]

template_enabled

Type: boolean

Default: false

Example

{
  "avatar_relations": [
    {
      "conditions": [
        {
          "left": {},
          "operator": "gt",
          "right": null,
          "type": "binary"
        }
      ],
      "id": "example",
      "join_type": "inner",
      "left_avatar_id": "example",
      "managed_by": "user",
      "required": false,
      "right_avatar_id": "example"
    }
  ],
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "component_errors": {
    "items": [
      {
        "errors": [
          {}
        ],
        "id": "example",
        "type": "data_source"
      }
    ]
  },
  "data_export_forbidden": false,
  "description": "",
  "load_preview_by_default": true,
  "obligatory_filters": [
    null
  ],
  "preview_enabled": false,
  "result_schema": [
    {
      "aggregation": "none",
      "avatar_id": "example",
      "cast": "string",
      "data_type": "string",
      "description": "example",
      "guid": "example",
      "has_auto_aggregation": true,
      "hidden": false,
      "initial_data_type": "string",
      "lock_aggregation": true,
      "managed_by": "user",
      "source": "example",
      "title": "example",
      "type": "DIMENSION",
      "ui_settings": "",
      "valid": true
    }
  ],
  "result_schema_aux": {
    "inter_dependencies": {
      "deps": [
        {
          "dep_field_id": "example",
          "ref_field_ids": [
            null
          ]
        }
      ]
    }
  },
  "revision_id": "null",
  "rls": {},
  "rls2": {},
  "source_avatars": [
    {
      "id": "example",
      "is_root": true,
      "managed_by": "user",
      "source_id": "example",
      "title": "example"
    }
  ],
  "sources": [
    {
      "connection_id": "example",
      "id": "example",
      "index_info_set": null,
      "managed_by": "user",
      "parameters": {
        "db_name": "example",
        "db_version": "example",
        "table_name": "example"
      },
      "raw_schema": [
        {}
      ],
      "source_type": "APPMETRICA_API",
      "title": "example",
      "valid": true
    }
  ],
  "template_enabled": false
}

string

Name

Description

type

Type: string

Enum: string, integer, float, date, datetime, boolean, geopoint, geopolygon, uuid, markup, datetimetz, unsupported, array_str, array_int, array_float, tree_str, genericdatetime

value

Type: string

Example: example

Example

{
  "type": "string",
  "value": "example"
}

integer

Name

Description

type

Type: string

value

Type: integer

Example

{
  "type": "string",
  "value": 0
}

float

Name

Description

type

Type: string

value

Type: number

Example

{
  "type": "string",
  "value": 0.5
}

date

Name

Description

type

Type: string

value

Type: string<date>

Example: 2025-01-01

Example

{
  "type": "string",
  "value": "2025-01-01"
}

datetime

Name

Description

type

Type: string

value

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

boolean

Name

Description

type

Type: string

value

Type: boolean

Example

{
  "type": "string",
  "value": true
}

geopoint

Name

Description

type

Type: string

value

Type: number[]

Example

[
  0.5
]

Example

{
  "type": "string",
  "value": [
    0.5
  ]
}

geopolygon

Name

Description

type

Type: string

value

Type: number[][][]

Example

[
  [
    [
      0.5
    ]
  ]
]

Example

{
  "type": "string",
  "value": [
    [
      [
        0.5
      ]
    ]
  ]
}

array_str

Name

Description

type

Type: string

value

Type: string[]

Example

[
  "example"
]

Example

{
  "type": "string",
  "value": [
    "example"
  ]
}

array_int

Name

Description

type

Type: string

value

Type: integer[]

Example

[
  0
]

Example

{
  "type": "string",
  "value": [
    0
  ]
}

Value

Name

Description

One of 16 types

Type: string

Example

{
  "type": "string",
  "value": "example"
}

Type: integer
Example
```
{
  "type": "string",
  "value": 0
}
```
Type: float
Example
```
{
  "type": "string",
  "value": 0.5
}
```

Type: date

Example

{
  "type": "string",
  "value": "2025-01-01"
}

Type: datetime

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: datetimetz

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: genericdatetime

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: boolean

Example

{
  "type": "string",
  "value": true
}

Type: geopoint

Example

{
  "type": "string",
  "value": [
    0.5
  ]
}

Type: geopolygon

Example

{
  "type": "string",
  "value": [
    [
      [
        0.5
      ]
    ]
  ]
}

Type: uuid

Example

{
  "type": "string",
  "value": "example"
}

Type: markup

Example

{
  "type": "string",
  "value": "example"
}

Type: array_str

Example

{
  "type": "string",
  "value": [
    "example"
  ]
}

Type: array_int

Example

{
  "type": "string",
  "value": [
    0
  ]
}

Type: array_float

Example

{
  "type": "string",
  "value": [
    0.5
  ]
}

Type: tree_str

Example

{
  "type": "string",
  "value": [
    "example"
  ]
}

Example

{
  "type": "string",
  "value": "example"
}

AddField

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
avatar_id	Type: string \| null Example: `example`
calc_mode	Type: string Enum: `direct`, `formula`, `parameter`
cast	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Any of 2 types Type: Value Example `{ "type": "string", "value": "example" }` Type: null Example: `null` Example `{ "type": "string", "value": "example" }`
description	Type: string Example: `example`
formula	Type: string Example: `example`
guid	Type: string Example: `example`
guid_formula	Type: string Example: `example`
hidden	Type: boolean
new_id	Type: string \| null Example: `example`
source	Type: string Example: `example`
strict	Type: boolean Default: `false`
template_enabled	Type: boolean \| null
ui_settings	Type: string Example: `example`
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "calc_mode": "direct",
  "cast": "string",
  "default_value": {
    "type": "string",
    "value": "example"
  },
  "description": "example",
  "formula": "example",
  "guid": "example",
  "guid_formula": "example",
  "hidden": true,
  "new_id": "example",
  "source": "example",
  "strict": false,
  "template_enabled": true,
  "title": "example",
  "ui_settings": "example",
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

add_field

Name	Description
action	Type: string Const: `add_field` Example: `example`
field	Type: AddField Example `{ "aggregation": "none", "avatar_id": "example", "calc_mode": "direct", "cast": "string", "default_value": { "type": "string", "value": "example" }, "description": "example", "formula": "example", "guid": "example", "guid_formula": "example", "hidden": true, "new_id": "example", "source": "example", "strict": false, "template_enabled": true, "title": "example", "ui_settings": "example", "value_constraint": { "pattern": "example", "type": "regex" } }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

UpdateField

Name	Description
aggregation	Type: string Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
avatar_id	Type: string \| null Example: `example`
calc_mode	Type: string Enum: `direct`, `formula`, `parameter`
cast	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Any of 2 types Type: Value Example `{ "type": "string", "value": "example" }` Type: null Example: `null` Example `{ "type": "string", "value": "example" }`
description	Type: string Example: `example`
formula	Type: string Example: `example`
guid	Type: string Example: `example`
guid_formula	Type: string Example: `example`
hidden	Type: boolean
new_id	Type: string \| null Example: `example`
source	Type: string Example: `example`
strict	Type: boolean Default: `false`
template_enabled	Type: boolean \| null
title	Type: string Example: `example`
ui_settings	Type: string Example: `example`
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "calc_mode": "direct",
  "cast": "string",
  "default_value": {
    "type": "string",
    "value": "example"
  },
  "description": "example",
  "formula": "example",
  "guid": "example",
  "guid_formula": "example",
  "hidden": true,
  "new_id": "example",
  "source": "example",
  "strict": false,
  "template_enabled": true,
  "title": "example",
  "ui_settings": "example",
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

update_field

Name	Description
action	Type: string Const: `update_field` Example: `example`
field	Type: UpdateField Example `{ "aggregation": "none", "avatar_id": "example", "calc_mode": "direct", "cast": "string", "default_value": { "type": "string", "value": "example" }, "description": "example", "formula": "example", "guid": "example", "guid_formula": "example", "hidden": true, "new_id": "example", "source": "example", "strict": false, "template_enabled": true, "title": "example", "ui_settings": "example", "value_constraint": { "pattern": "example", "type": "regex" } }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

DeleteField

Name

Description

guid

Type: string

Example: example

strict

Type: boolean

Default: false

Example

{
  "guid": "example",
  "strict": false
}

delete_field

Name	Description
action	Type: string Const: `delete_field` Example: `example`
field	Type: DeleteField Example `{ "guid": "example", "strict": false }`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_field",
  "field": {
    "guid": "example",
    "strict": false
  },
  "order_index": 0
}

CloneField

Name	Description
aggregation	Type: string \| null Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`, `null` Example: `none`
cast	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
from_guid	Type: string Example: `example`
guid	Type: string Example: `example`
strict	Type: boolean Default: `false`
title	Type: string Example: `example`

Example

{
  "aggregation": "none",
  "cast": "string",
  "from_guid": "example",
  "guid": "example",
  "strict": false,
  "title": "example"
}

clone_field

Name	Description
action	Type: string Const: `clone_field` Example: `example`
field	Type: CloneField Example `{ "aggregation": "none", "cast": "string", "from_guid": "example", "guid": "example", "strict": false, "title": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "clone_field",
  "field": {
    "aggregation": "none",
    "cast": "string",
    "from_guid": "example",
    "guid": "example",
    "strict": false,
    "title": "example"
  },
  "order_index": 0
}

DataSource

Name

Description

One of 42 types

APPMETRICA_API

Type: APPMETRICA_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true
}

BIGQUERY_TABLE

Type: BIGQUERY_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true
}

BIGQUERY_SUBSELECT

Type: BIGQUERY_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true
}

BITRIX_GDS

Type: BITRIX_GDS1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true
}

CH_BILLING_ANALYTICS_TABLE

Type: CH_BILLING_ANALYTICS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Type: CH_YA_MUSIC_PODCAST_STATS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE

Type: CHYT_YTSAURUS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE_LIST

Type: CHYT_YTSAURUS_TABLE_LIST1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_TABLE_RANGE

Type: CHYT_YTSAURUS_TABLE_RANGE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true
}

CHYT_YTSAURUS_SUBSELECT

Type: CHYT_YTSAURUS_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_TABLE

Type: CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true
}

CH_SUBSELECT

Type: CH_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true
}

EQUEO_CH_TABLE

Type: EQUEO_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true
}

EXTRACTOR_1C_CH_TABLE

Type: EXTRACTOR_1C_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true
}

GP_TABLE

Type: GP_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true
}

GP_SUBSELECT

Type: GP_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true
}

GSHEETS

Type: GSHEETS1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true
}

JSON_API

Type: JSON_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true
}

KONTUR_MARKET_CH_TABLE

Type: KONTUR_MARKET_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true
}

METRIKA_API

Type: METRIKA_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true
}

MONITORING

Type: MONITORING1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true
}

MOYSKLAD_CH_TABLE

Type: MOYSKLAD_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_TABLE

Type: MSSQL_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true
}

MSSQL_SUBSELECT

Type: MSSQL_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

MYSQL_TABLE

Type: MYSQL_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true
}

MYSQL_SUBSELECT

Type: MYSQL_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true
}

ORACLE_TABLE

Type: ORACLE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true
}

ORACLE_SUBSELECT

Type: ORACLE_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true
}

PG_TABLE

Type: PG_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true
}

PG_SUBSELECT

Type: PG_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true
}

PROMQL

Type: PROMQL1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true
}

CH_SMB_HEATMAPS_TABLE

Type: CH_SMB_HEATMAPS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true
}

SNOWFLAKE_TABLE

Type: SNOWFLAKE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true
}

SPEECHSENSE_TABLE

Type: SPEECHSENSE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true
}

TRINO_TABLE

Type: TRINO_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true
}

TRINO_SUBSELECT

Type: TRINO_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_TABLE

Type: CH_USAGE_TRACKING_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true
}

CH_USAGE_TRACKING_AGG_TABLE

Type: CH_USAGE_TRACKING_AGG_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true
}

YDB_TABLE

Type: YDB_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true
}

YDB_SUBSELECT

Type: YDB_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true
}

YQ_TABLE

Type: YQ_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true
}

YQ_SUBSELECT

Type: YQ_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true
}

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true
}

add_source

Name	Description
action	Type: string Const: `add_source` Example: `example`
source	Type: DataSource Example `{ "connection_id": "example", "id": "example", "index_info_set": null, "managed_by": "user", "parameters": { "db_name": "example", "db_version": "example", "table_name": "example" }, "raw_schema": [ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": {}, "nullable": true, "title": "example", "user_type": "string" } ], "source_type": "APPMETRICA_API", "title": "example", "valid": true }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true
  }
}

update_source

Name	Description
action	Type: string Const: `update_source` Example: `example`
source	Type: DataSource Example `{ "connection_id": "example", "id": "example", "index_info_set": null, "managed_by": "user", "parameters": { "db_name": "example", "db_version": "example", "table_name": "example" }, "raw_schema": [ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": {}, "nullable": true, "title": "example", "user_type": "string" } ], "source_type": "APPMETRICA_API", "title": "example", "valid": true }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true
  }
}

SourceBase

Name

Description

Type: string

Example: example

Example

{
  "id": "example"
}

delete_source

Name	Description
action	Type: string Const: `delete_source` Example: `example`
source	Type: SourceBase Example `{ "id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_source",
  "order_index": 0,
  "source": {
    "id": "example"
  }
}

RefreshSource

Name

Description

force_update_fields

Type: boolean

Default: false

Type: string

Example: example

Example

{
  "force_update_fields": false,
  "id": "example"
}

refresh_source

Name	Description
action	Type: string Const: `refresh_source` Example: `example`
source	Type: RefreshSource Example `{ "force_update_fields": false, "id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "refresh_source",
  "order_index": 0,
  "source": {
    "force_update_fields": false,
    "id": "example"
  }
}

SourceAvatar

Name	Description
id	Type: string Example: `example`
is_root	Type: boolean
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
source_id	Type: string Example: `example`
title	Type: string Example: `example`

Example

{
  "id": "example",
  "is_root": true,
  "managed_by": "user",
  "source_id": "example",
  "title": "example"
}

add_source_avatar

Name	Description
action	Type: string Const: `add_source_avatar` Example: `example`
source_avatar	Type: SourceAvatar Example `{ "id": "example", "is_root": true, "managed_by": "user", "source_id": "example", "title": "example" }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example"
  }
}

update_source_avatar

Name	Description
action	Type: string Const: `update_source_avatar` Example: `example`
source_avatar	Type: SourceAvatar Example `{ "id": "example", "is_root": true, "managed_by": "user", "source_id": "example", "title": "example" }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example"
  }
}

delete_source_avatar

Name	Description
action	Type: string Const: `delete_source_avatar` Example: `example`
source_avatar	Type: AvatarBase Example `{ "id": "example" }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example"
  }
}

add_avatar_relation

Name	Description
action	Type: string Const: `add_avatar_relation` Example: `example`
avatar_relation	Type: AvatarRelation Example `{ "conditions": [ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ], "id": "example", "join_type": "inner", "left_avatar_id": "example", "managed_by": "user", "required": false, "right_avatar_id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example"
  },
  "order_index": 0
}

update_avatar_relation

Name	Description
action	Type: string Const: `update_avatar_relation` Example: `example`
avatar_relation	Type: AvatarRelation Example `{ "conditions": [ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ], "id": "example", "join_type": "inner", "left_avatar_id": "example", "managed_by": "user", "required": false, "right_avatar_id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example"
  },
  "order_index": 0
}

delete_avatar_relation

Name	Description
action	Type: string Const: `delete_avatar_relation` Example: `example`
avatar_relation	Type: RelationBase Example `{ "id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_avatar_relation",
  "avatar_relation": {
    "id": "example"
  },
  "order_index": 0
}

ReplaceConnection

Name

Description

Type: string

Example: example

new_id

Type: string

Example: example

Example

{
  "id": "example",
  "new_id": "example"
}

replace_connection

Name	Description
action	Type: string Const: `replace_connection` Example: `example`
connection	Type: ReplaceConnection Example `{ "id": "example", "new_id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "replace_connection",
  "connection": {
    "id": "example",
    "new_id": "example"
  },
  "order_index": 0
}

add_obligatory_filter

Name	Description
action	Type: string Const: `add_obligatory_filter` Example: `example`
obligatory_filter	Type: ObligatoryFilter Example `{ "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

update_obligatory_filter

Name	Description
action	Type: string Const: `update_obligatory_filter` Example: `example`
obligatory_filter	Type: ObligatoryFilter Example `{ "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

DeleteObligatoryFilter

Name

Description

Type: string

Example: example

Example

{
  "id": "example"
}

delete_obligatory_filter

Name	Description
action	Type: string Const: `delete_obligatory_filter` Example: `example`
obligatory_filter	Type: DeleteObligatoryFilter Example `{ "id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_obligatory_filter",
  "obligatory_filter": {
    "id": "example"
  },
  "order_index": 0
}

Setting

Name

Description

name

Type: string

Enum: load_preview_by_default, template_enabled, data_export_forbidden

value

Type: boolean

Example

{
  "name": "load_preview_by_default",
  "value": true
}

update_setting

Name	Description
action	Type: string Const: `update_setting` Example: `example`
setting	Type: Setting Example `{ "name": "load_preview_by_default", "value": true }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_setting",
  "order_index": 0,
  "setting": {
    "name": "load_preview_by_default",
    "value": true
  }
}

update_description

Name	Description
action	Type: string Const: `update_description` Example: `example`
description	Type: string Example: `example`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_description",
  "description": "example",
  "order_index": 0
}

update_cache_invalidation_source

Name	Description
action	Type: string Const: `update_cache_invalidation_source` Example: `example`
cache_invalidation_source	Type: CacheInvalidationSource Example `{ "cache_invalidation_error": null, "field": null, "filters": [ { "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true } ], "mode": "off", "sql": "null" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_cache_invalidation_source",
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "order_index": 0
}

Action

Name

Description

One of 21 types

add_field

Type: add_field

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

update_field

Type: update_field

Example

{
  "action": "update_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

delete_field

Type: delete_field

Example

{
  "action": "delete_field",
  "field": {
    "guid": "example",
    "strict": false
  },
  "order_index": 0
}

clone_field

Type: clone_field

Example

{
  "action": "clone_field",
  "field": {
    "aggregation": "none",
    "cast": "string",
    "from_guid": "example",
    "guid": "example",
    "strict": false,
    "title": "example"
  },
  "order_index": 0
}

add_source

Type: add_source

Example

{
  "action": "add_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true
  }
}

update_source

Type: update_source

Example

{
  "action": "update_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true
  }
}

delete_source

Type: delete_source

Example

{
  "action": "delete_source",
  "order_index": 0,
  "source": {
    "id": "example"
  }
}

refresh_source

Type: refresh_source

Example

{
  "action": "refresh_source",
  "order_index": 0,
  "source": {
    "force_update_fields": false,
    "id": "example"
  }
}

add_source_avatar

Type: add_source_avatar

Example

{
  "action": "add_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example"
  }
}

update_source_avatar

Type: update_source_avatar

Example

{
  "action": "update_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example"
  }
}

delete_source_avatar

Type: delete_source_avatar

Example

{
  "action": "delete_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example"
  }
}

add_avatar_relation

Type: add_avatar_relation

Example

{
  "action": "add_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example"
  },
  "order_index": 0
}

update_avatar_relation

Type: update_avatar_relation

Example

{
  "action": "update_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example"
  },
  "order_index": 0
}

delete_avatar_relation

Type: delete_avatar_relation

Example

{
  "action": "delete_avatar_relation",
  "avatar_relation": {
    "id": "example"
  },
  "order_index": 0
}

replace_connection

Type: replace_connection

Example

{
  "action": "replace_connection",
  "connection": {
    "id": "example",
    "new_id": "example"
  },
  "order_index": 0
}

add_obligatory_filter

Type: add_obligatory_filter

Example

{
  "action": "add_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

update_obligatory_filter

Type: update_obligatory_filter

Example

{
  "action": "update_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

delete_obligatory_filter

Type: delete_obligatory_filter

Example

{
  "action": "delete_obligatory_filter",
  "obligatory_filter": {
    "id": "example"
  },
  "order_index": 0
}

update_setting

Type: update_setting

Example

{
  "action": "update_setting",
  "order_index": 0,
  "setting": {
    "name": "load_preview_by_default",
    "value": true
  }
}

update_description

Type: update_description

Example

{
  "action": "update_description",
  "description": "example",
  "order_index": 0
}

update_cache_invalidation_source

Type: update_cache_invalidation_source

Example

{
  "action": "update_cache_invalidation_source",
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "order_index": 0
}

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {},
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {}
  },
  "order_index": 0
}

DatasetValidate

Name

Description

dataset

Type: DatasetContentInternal

Example

{
  "avatar_relations": [
    {
      "conditions": [
        {
          "left": {},
          "operator": "gt",
          "right": null,
          "type": "binary"
        }
      ],
      "id": "example",
      "join_type": "inner",
      "left_avatar_id": "example",
      "managed_by": "user",
      "required": false,
      "right_avatar_id": "example"
    }
  ],
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "component_errors": {
    "items": [
      {
        "errors": [
          {}
        ],
        "id": "example",
        "type": "data_source"
      }
    ]
  },
  "data_export_forbidden": false,
  "description": "",
  "load_preview_by_default": true,
  "obligatory_filters": [
    null
  ],
  "preview_enabled": false,
  "result_schema": [
    {
      "aggregation": "none",
      "avatar_id": "example",
      "cast": "string",
      "data_type": "string",
      "description": "example",
      "guid": "example",
      "has_auto_aggregation": true,
      "hidden": false,
      "initial_data_type": "string",
      "lock_aggregation": true,
      "managed_by": "user",
      "source": "example",
      "title": "example",
      "type": "DIMENSION",
      "ui_settings": "",
      "valid": true
    }
  ],
  "result_schema_aux": {
    "inter_dependencies": {
      "deps": [
        {
          "dep_field_id": "example",
          "ref_field_ids": [
            null
          ]
        }
      ]
    }
  },
  "revision_id": "null",
  "rls": {},
  "rls2": {},
  "source_avatars": [
    {
      "id": "example",
      "is_root": true,
      "managed_by": "user",
      "source_id": "example",
      "title": "example"
    }
  ],
  "sources": [
    {
      "connection_id": "example",
      "id": "example",
      "index_info_set": null,
      "managed_by": "user",
      "parameters": {
        "db_name": "example",
        "db_version": "example",
        "table_name": "example"
      },
      "raw_schema": [
        {}
      ],
      "source_type": "APPMETRICA_API",
      "title": "example",
      "valid": true
    }
  ],
  "template_enabled": false
}

updates

Type: Action[]

Example

[
  {
    "action": "add_field",
    "field": {
      "aggregation": "none",
      "avatar_id": "example",
      "calc_mode": "direct",
      "cast": "string",
      "default_value": {},
      "description": "example",
      "formula": "example",
      "guid": "example",
      "guid_formula": "example",
      "hidden": true,
      "new_id": "example",
      "source": "example",
      "strict": false,
      "template_enabled": true,
      "title": "example",
      "ui_settings": "example",
      "value_constraint": {}
    },
    "order_index": 0
  }
]

Example

{
  "dataset": {
    "avatar_relations": [
      {
        "conditions": [
          {}
        ],
        "id": "example",
        "join_type": "inner",
        "left_avatar_id": "example",
        "managed_by": "user",
        "required": false,
        "right_avatar_id": "example"
      }
    ],
    "cache_invalidation_source": {
      "cache_invalidation_error": null,
      "field": null,
      "filters": [
        {
          "default_filters": [],
          "field_guid": "example",
          "id": "example",
          "managed_by": "user",
          "valid": true
        }
      ],
      "mode": "off",
      "sql": "null"
    },
    "component_errors": {
      "items": [
        {
          "errors": [
            null
          ],
          "id": "example",
          "type": "data_source"
        }
      ]
    },
    "data_export_forbidden": false,
    "description": "",
    "load_preview_by_default": true,
    "obligatory_filters": [
      null
    ],
    "preview_enabled": false,
    "result_schema": [
      {
        "aggregation": "none",
        "avatar_id": "example",
        "cast": "string",
        "data_type": "string",
        "description": "example",
        "guid": "example",
        "has_auto_aggregation": true,
        "hidden": false,
        "initial_data_type": "string",
        "lock_aggregation": true,
        "managed_by": "user",
        "source": "example",
        "title": "example",
        "type": "DIMENSION",
        "ui_settings": "",
        "valid": true
      }
    ],
    "result_schema_aux": {
      "inter_dependencies": {
        "deps": [
          {}
        ]
      }
    },
    "revision_id": "null",
    "rls": {},
    "rls2": {},
    "source_avatars": [
      {
        "id": "example",
        "is_root": true,
        "managed_by": "user",
        "source_id": "example",
        "title": "example"
      }
    ],
    "sources": [
      {
        "connection_id": "example",
        "id": "example",
        "index_info_set": null,
        "managed_by": "user",
        "parameters": {},
        "raw_schema": [
          null
        ],
        "source_type": "APPMETRICA_API",
        "title": "example",
        "valid": true
      }
    ],
    "template_enabled": false
  },
  "updates": [
    {
      "action": "add_field",
      "field": {
        "aggregation": "none",
        "avatar_id": "example",
        "calc_mode": "direct",
        "cast": "string",
        "default_value": null,
        "description": "example",
        "formula": "example",
        "guid": "example",
        "guid_formula": "example",
        "hidden": true,
        "new_id": "example",
        "source": "example",
        "strict": false,
        "template_enabled": true,
        "title": "example",
        "ui_settings": "example",
        "value_constraint": null
      },
      "order_index": 0
    }
  ]
}

Responses

200 OK

Response

Body

application/json

{
  "collection_id": "example",
  "ctime": "example",
  "dataset": {
    "avatar_relations": [
      {
        "conditions": [
          {}
        ],
        "id": "example",
        "join_type": "inner",
        "left_avatar_id": "example",
        "managed_by": "user",
        "required": false,
        "right_avatar_id": "example",
        "virtual": null
      }
    ],
    "cache_invalidation_source": {
      "cache_invalidation_error": null,
      "field": null,
      "filters": [
        {
          "default_filters": [],
          "field_guid": "example",
          "id": "example",
          "managed_by": "user",
          "valid": true
        }
      ],
      "mode": "off",
      "sql": "null"
    },
    "component_errors": {
      "items": [
        {
          "errors": [
            null
          ],
          "id": "example",
          "type": "data_source"
        }
      ]
    },
    "data_export_forbidden": false,
    "description": "",
    "load_preview_by_default": true,
    "obligatory_filters": [
      null
    ],
    "preview_enabled": false,
    "result_schema": [
      {
        "aggregation": "none",
        "aggregation_locked": false,
        "autoaggregated": true,
        "avatar_id": "example",
        "cast": "string",
        "data_type": "string",
        "description": "example",
        "guid": "example",
        "has_auto_aggregation": true,
        "hidden": false,
        "initial_data_type": "string",
        "lock_aggregation": true,
        "managed_by": "user",
        "source": "example",
        "title": "example",
        "type": "DIMENSION",
        "ui_settings": "",
        "valid": true,
        "virtual": null
      }
    ],
    "result_schema_aux": {
      "inter_dependencies": {
        "deps": [
          {}
        ]
      }
    },
    "revision_id": "null",
    "rls": {},
    "rls2": {},
    "source_avatars": [
      {
        "id": "example",
        "is_root": true,
        "managed_by": "user",
        "source_id": "example",
        "title": "example",
        "valid": true,
        "virtual": null
      }
    ],
    "sources": [
      {
        "connection_id": "example",
        "id": "example",
        "index_info_set": null,
        "managed_by": "user",
        "parameter_hash": "example",
        "parameters": {},
        "raw_schema": [
          null
        ],
        "source_type": "APPMETRICA_API",
        "title": "example",
        "valid": true,
        "virtual": null
      }
    ],
    "template_enabled": false
  },
  "full_permissions": {},
  "id": "example",
  "is_favorite": true,
  "key": "example",
  "mtime": "example",
  "name": "example",
  "options": {
    "connections": {
      "compatible_types": [
        {
          "conn_type": null
        }
      ],
      "items": [
        {
          "id": "example",
          "replacement_types": [
            null
          ]
        }
      ],
      "max": 0
    },
    "data_types": {
      "items": [
        {
          "aggregations": [
            null
          ],
          "casts": [
            null
          ],
          "filter_operations": [
            null
          ],
          "type": "string"
        }
      ]
    },
    "fields": {
      "items": [
        {
          "aggregations": [
            null
          ],
          "casts": [
            null
          ],
          "guid": "example"
        }
      ]
    },
    "is_cache_invalidation_enabled_in_conn": true,
    "join": {
      "operators": [
        "gt"
      ],
      "types": [
        "inner"
      ]
    },
    "preview": {
      "enabled": true
    },
    "schema_update_enabled": true,
    "source_avatars": {
      "items": [
        {
          "id": "example",
          "schema_update_enabled": true
        }
      ],
      "max": 0
    },
    "source_listing": {
      "db_name_label": "example",
      "db_name_required_for_search": true,
      "supports_db_name_listing": true,
      "supports_source_pagination": true,
      "supports_source_search": true
    },
    "sources": {
      "compatible_types": [
        {
          "source_type": null
        }
      ],
      "items": [
        {
          "id": "example",
          "schema_update_enabled": true
        }
      ],
      "max": 0
    },
    "supported_functions": [
      "example"
    ],
    "supports_offset": true
  },
  "permissions": {},
  "pub_operation_id": "example",
  "row_count": 0,
  "workbook_id": "example"
}

Name

Description

dataset

Type: DatasetContentInternal

Example

{
  "avatar_relations": [
    {
      "conditions": [
        {
          "left": {},
          "operator": "gt",
          "right": null,
          "type": "binary"
        }
      ],
      "id": "example",
      "join_type": "inner",
      "left_avatar_id": "example",
      "managed_by": "user",
      "required": false,
      "right_avatar_id": "example",
      "virtual": null
    }
  ],
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "component_errors": {
    "items": [
      {
        "errors": [
          {}
        ],
        "id": "example",
        "type": "data_source"
      }
    ]
  },
  "data_export_forbidden": false,
  "description": "",
  "load_preview_by_default": true,
  "obligatory_filters": [
    null
  ],
  "preview_enabled": false,
  "result_schema": [
    {
      "aggregation": "none",
      "aggregation_locked": false,
      "autoaggregated": true,
      "avatar_id": "example",
      "cast": "string",
      "data_type": "string",
      "description": "example",
      "guid": "example",
      "has_auto_aggregation": true,
      "hidden": false,
      "initial_data_type": "string",
      "lock_aggregation": true,
      "managed_by": "user",
      "source": "example",
      "title": "example",
      "type": "DIMENSION",
      "ui_settings": "",
      "valid": true,
      "virtual": null
    }
  ],
  "result_schema_aux": {
    "inter_dependencies": {
      "deps": [
        {
          "dep_field_id": "example",
          "ref_field_ids": [
            null
          ]
        }
      ]
    }
  },
  "revision_id": "null",
  "rls": {},
  "rls2": {},
  "source_avatars": [
    {
      "id": "example",
      "is_root": true,
      "managed_by": "user",
      "source_id": "example",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "sources": [
    {
      "connection_id": "example",
      "id": "example",
      "index_info_set": null,
      "managed_by": "user",
      "parameter_hash": "example",
      "parameters": {
        "db_name": "example",
        "db_version": "example",
        "table_name": "example"
      },
      "raw_schema": [
        {}
      ],
      "source_type": "APPMETRICA_API",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "template_enabled": false
}

collection_id

Type: string

Example: example

ctime

Type: string

Pattern: null

Example: example

full_permissions

Type: object

[additional]

Type: boolean

Example

{}

Type: string

Example: example

is_favorite

Type: boolean

key

Type: string

Example: example

mtime

Type: string

Pattern: null

Example: example

name

Type: string

Example: example

options

Type: Options

Example

{
  "connections": {
    "compatible_types": [
      {
        "conn_type": null
      }
    ],
    "items": [
      {
        "id": "example",
        "replacement_types": [
          null
        ]
      }
    ],
    "max": 0
  },
  "data_types": {
    "items": [
      {
        "aggregations": [
          "none"
        ],
        "casts": [
          "string"
        ],
        "filter_operations": [
          "ISNULL"
        ],
        "type": "string"
      }
    ]
  },
  "fields": {
    "items": [
      {
        "aggregations": [
          "none"
        ],
        "casts": [
          "string"
        ],
        "guid": "example"
      }
    ]
  },
  "is_cache_invalidation_enabled_in_conn": true,
  "join": {
    "operators": [
      "gt"
    ],
    "types": [
      "inner"
    ]
  },
  "preview": {
    "enabled": true
  },
  "schema_update_enabled": true,
  "source_avatars": {
    "items": [
      {
        "id": "example",
        "schema_update_enabled": true
      }
    ],
    "max": 0
  },
  "source_listing": {
    "db_name_label": "example",
    "db_name_required_for_search": true,
    "supports_db_name_listing": true,
    "supports_source_pagination": true,
    "supports_source_search": true
  },
  "sources": {
    "compatible_types": [
      {
        "source_type": null
      }
    ],
    "items": [
      {
        "id": "example",
        "schema_update_enabled": true
      }
    ],
    "max": 0
  },
  "supported_functions": [
    "example"
  ],
  "supports_offset": true
}

permissions

Type: object

[additional]

Type: boolean

Example

{}

pub_operation_id

Type: string

Example: example

row_count

Type: integer

workbook_id

Type: string

Example: example

AvatarRelation

Name	Description
id	Type: string Example: `example`
conditions	Type: JoinCondition[] Example `[ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ]`
join_type	Type: string Enum: `inner`, `left`, `right`, `full`
left_avatar_id	Type: string Example: `example`
managed_by	Type: string \| null Default: `user` Enum: `user`, `feature`, `compiler_runtime`, `null`
required	Type: boolean Default: `false`
right_avatar_id	Type: string Example: `example`
virtual	Type: unknown Example: `null`

Example

{
  "conditions": [
    {
      "left": {
        "calc_mode": "direct",
        "source": "example"
      },
      "operator": "gt",
      "right": null,
      "type": "binary"
    }
  ],
  "id": "example",
  "join_type": "inner",
  "left_avatar_id": "example",
  "managed_by": "user",
  "required": false,
  "right_avatar_id": "example",
  "virtual": null
}

CacheInvalidationField

Name	Description
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
aggregation_locked	Type: boolean \| null Default: `false`
autoaggregated	Type: boolean \| null
calc_spec	Type: formula1 Example `{ "formula": "", "guid_formula": "" }`
cast	Type: string Default: `string` Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string Default: `string` Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
title	Type: string Default: `INVALIDATION CACHE SERVICE FIELD`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null
virtual	Type: unknown Example: `null`

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "calc_spec": {
    "formula": "",
    "guid_formula": ""
  },
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "INVALIDATION CACHE SERVICE FIELD",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

CacheInvalidationSource

Name	Description
cache_invalidation_error	Any of 2 types Type: CacheInvalidationError Example `{ "level": "info", "locator": "example", "message": "example", "title": "example" }` Type: null Example: `null` Default: `null`
field	Any of 2 types Type: CacheInvalidationField Example `{ "aggregation": "none", "aggregation_locked": false, "autoaggregated": true, "calc_spec": { "formula": "", "guid_formula": "" }, "cast": "string", "data_type": "string", "description": "example", "guid": "example", "has_auto_aggregation": true, "hidden": false, "initial_data_type": "string", "lock_aggregation": true, "managed_by": "user", "title": "INVALIDATION CACHE SERVICE FIELD", "type": "DIMENSION", "ui_settings": "", "valid": true, "virtual": null }` Type: null Example: `null` Default: `null`
filters	Type: ObligatoryFilter[] Example `[ { "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true } ]`
mode	Type: string Default: `off` Enum: `sql`, `formula`, `off`
sql	Type: string \| null Default: `null`

Example

{
  "cache_invalidation_error": null,
  "field": null,
  "filters": [
    {
      "default_filters": [],
      "field_guid": "example",
      "id": "example",
      "managed_by": "user",
      "valid": true
    }
  ],
  "mode": "off",
  "sql": "null"
}

direct1

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
aggregation_locked	Type: boolean \| null Default: `false`
autoaggregated	Type: boolean \| null
avatar_id	Type: string \| null Example: `example`
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
source	Type: string Example: `example`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null
virtual	Type: unknown Example: `null`

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

formula2

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
aggregation_locked	Type: boolean \| null Default: `false`
autoaggregated	Type: boolean \| null
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
description	Type: string Example: `example`
formula	Type: string Default: ``
guid	Type: string Example: `example`
guid_formula	Type: string Default: ``
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null
virtual	Type: unknown Example: `null`

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "formula": "",
  "guid": "example",
  "guid_formula": "",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

parameter1

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Default: `none` Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
aggregation_locked	Type: boolean \| null Default: `false`
autoaggregated	Type: boolean \| null
cast	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`
data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Type: string \| null Example: `example`
description	Type: string Example: `example`
guid	Type: string Example: `example`
has_auto_aggregation	Type: boolean \| null
hidden	Type: boolean Default: `false`
initial_data_type	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
lock_aggregation	Type: boolean \| null
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
template_enabled	Type: boolean Default: `false`
type	Type: string Enum: `DIMENSION`, `MEASURE`
ui_settings	Type: string Default: ``
valid	Type: boolean \| null
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`
virtual	Type: unknown Example: `null`

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "cast": "string",
  "data_type": "string",
  "default_value": "example",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "template_enabled": false,
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  },
  "virtual": null
}

ResultSchemaSchemaGeneric

Name

Description

One of 3 types

Type: direct1

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

Type: formula2

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "formula": "",
  "guid": "example",
  "guid_formula": "",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

Type: parameter1

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "cast": "string",
  "data_type": "string",
  "default_value": "example",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "template_enabled": false,
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  },
  "virtual": null
}

Example

{
  "aggregation": "none",
  "aggregation_locked": false,
  "autoaggregated": true,
  "avatar_id": "example",
  "cast": "string",
  "data_type": "string",
  "description": "example",
  "guid": "example",
  "has_auto_aggregation": true,
  "hidden": false,
  "initial_data_type": "string",
  "lock_aggregation": true,
  "managed_by": "user",
  "source": "example",
  "title": "example",
  "type": "DIMENSION",
  "ui_settings": "",
  "valid": true,
  "virtual": null
}

SourceAvatarStrict

Name	Description
id	Type: string Example: `example`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
is_root	Type: boolean
source_id	Type: string Example: `example`
title	Type: string Example: `example`
valid	Type: boolean
virtual	Type: unknown Example: `null`

Example

{
  "id": "example",
  "is_root": true,
  "managed_by": "user",
  "source_id": "example",
  "title": "example",
  "valid": true,
  "virtual": null
}

APPMETRICA_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `APPMETRICA_API` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: BigQueryTableParameters Example `{ "dataset_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BIGQUERY_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BIGQUERY_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

BITRIX_GDS

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `BITRIX_GDS` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_BILLING_ANALYTICS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_BILLING_ANALYTICS_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_YA_MUSIC_PODCAST_STATS_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_LIST

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: CHYTTableListParameters Example `{ "table_names": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE_LIST` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_RANGE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: CHYTTableRangeParameters Example `{ "directory_path": "example", "range_from": "example", "range_to": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_TABLE_RANGE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CHYT_YTSAURUS_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

EQUEO_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `EQUEO_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

EXTRACTOR_1C_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `EXTRACTOR_1C_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GP_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GP_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

GSHEETS

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `GSHEETS` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true,
  "virtual": null
}

JSON_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `JSON_API` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

KONTUR_MARKET_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `KONTUR_MARKET_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

METRIKA_API

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `METRIKA_API` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

MONITORING

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MONITORING` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true,
  "virtual": null
}

MOYSKLAD_CH_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MOYSKLAD_CH_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MSSQL_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MSSQL_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MYSQL_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `MYSQL_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `ORACLE_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `ORACLE_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PG_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PG_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PROMQL

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SimpleParameters Example `{}`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `PROMQL` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SMB_HEATMAPS_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_SMB_HEATMAPS_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SNOWFLAKE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SnowFlakeTableParameters Example `{ "db_name": "example", "schema": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `SNOWFLAKE_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SPEECHSENSE_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `SPEECHSENSE_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SchematizedParameters Example `{ "db_name": "example", "db_version": "example", "schema_name": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `TRINO_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `TRINO_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_USAGE_TRACKING_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_AGG_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `CH_USAGE_TRACKING_AGG_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YDB_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YDB_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_TABLE

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SQLParameters Example `{ "db_name": "example", "db_version": "example", "table_name": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YQ_TABLE` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_SUBSELECT

Name	Description
id	Type: string Example: `example`
title	Type: string Example: `example`
connection_id	Type: string \| null Example: `example`
index_info_set	Type: array \| null Default: `null` Example `[ { "columns": [ "example" ], "kind": "table_sorting" } ]`
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
parameter_hash	Type: string Example: `example`
parameters	Type: SubselectParameters Example `{ "subsql": "example" }`
raw_schema	Type: array \| null Example `[ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": { "name": "example" }, "nullable": true, "title": "example", "user_type": "string" } ]`
source_type	Type: string Const: `YQ_SUBSELECT` Example: `example`
valid	Type: boolean Default: `true`
virtual	Type: unknown Example: `null`

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

DataSourceStrict

Name

Description

One of 42 types

APPMETRICA_API

Type: APPMETRICA_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_TABLE

Type: BIGQUERY_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_SUBSELECT

Type: BIGQUERY_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

BITRIX_GDS

Type: BITRIX_GDS

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_BILLING_ANALYTICS_TABLE

Type: CH_BILLING_ANALYTICS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Type: CH_YA_MUSIC_PODCAST_STATS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE

Type: CHYT_YTSAURUS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_LIST

Type: CHYT_YTSAURUS_TABLE_LIST

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_RANGE

Type: CHYT_YTSAURUS_TABLE_RANGE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_SUBSELECT

Type: CHYT_YTSAURUS_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_TABLE

Type: CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SUBSELECT

Type: CH_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

EQUEO_CH_TABLE

Type: EQUEO_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

EXTRACTOR_1C_CH_TABLE

Type: EXTRACTOR_1C_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_TABLE

Type: GP_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_SUBSELECT

Type: GP_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

GSHEETS

Type: GSHEETS

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true,
  "virtual": null
}

JSON_API

Type: JSON_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

KONTUR_MARKET_CH_TABLE

Type: KONTUR_MARKET_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

METRIKA_API

Type: METRIKA_API

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

MONITORING

Type: MONITORING

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true,
  "virtual": null
}

MOYSKLAD_CH_TABLE

Type: MOYSKLAD_CH_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_TABLE

Type: MSSQL_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_SUBSELECT

Type: MSSQL_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_TABLE

Type: MYSQL_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_SUBSELECT

Type: MYSQL_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_TABLE

Type: ORACLE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_SUBSELECT

Type: ORACLE_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_TABLE

Type: PG_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_SUBSELECT

Type: PG_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PROMQL

Type: PROMQL

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SMB_HEATMAPS_TABLE

Type: CH_SMB_HEATMAPS_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SNOWFLAKE_TABLE

Type: SNOWFLAKE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SPEECHSENSE_TABLE

Type: SPEECHSENSE_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_TABLE

Type: TRINO_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_SUBSELECT

Type: TRINO_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_TABLE

Type: CH_USAGE_TRACKING_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_AGG_TABLE

Type: CH_USAGE_TRACKING_AGG_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_TABLE

Type: YDB_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_SUBSELECT

Type: YDB_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_TABLE

Type: YQ_TABLE

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_SUBSELECT

Type: YQ_SUBSELECT

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

DatasetContentInternal

Name

Description

avatar_relations

Type: AvatarRelation[]

Example

[
  {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example",
    "virtual": null
  }
]

cache_invalidation_source

Type: CacheInvalidationSource

Example

{
  "cache_invalidation_error": null,
  "field": null,
  "filters": [
    {
      "default_filters": [],
      "field_guid": "example",
      "id": "example",
      "managed_by": "user",
      "valid": true
    }
  ],
  "mode": "off",
  "sql": "null"
}

component_errors

Type: ComponentErrorList

Example

{
  "items": [
    {
      "errors": [
        {
          "code": null,
          "details": {},
          "level": "error",
          "message": "example"
        }
      ],
      "id": "example",
      "type": "data_source"
    }
  ]
}

data_export_forbidden

Type: boolean

Default: false

description

Type: string | null

Default: ``

load_preview_by_default

Type: boolean

Default: true

obligatory_filters

Type: ObligatoryFilter[]

Example

[
  {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  }
]

preview_enabled

Type: boolean

Default: false

result_schema

Type: ResultSchemaSchemaGeneric[]

Example

[
  {
    "aggregation": "none",
    "aggregation_locked": false,
    "autoaggregated": true,
    "avatar_id": "example",
    "cast": "string",
    "data_type": "string",
    "description": "example",
    "guid": "example",
    "has_auto_aggregation": true,
    "hidden": false,
    "initial_data_type": "string",
    "lock_aggregation": true,
    "managed_by": "user",
    "source": "example",
    "title": "example",
    "type": "DIMENSION",
    "ui_settings": "",
    "valid": true,
    "virtual": null
  }
]

result_schema_aux

Type: ResultSchemaAux

Example

{
  "inter_dependencies": {
    "deps": [
      {
        "dep_field_id": "example",
        "ref_field_ids": [
          "example"
        ]
      }
    ]
  }
}

revision_id

Type: string | null

Default: null

rls

Type: object

[additional]

Type: unknown

Example: null

Example

{}

rls2

Type: object

[additional]

Type: RLS2ConfigEntry[]

Example

[
  {
    "allowed_value": "null",
    "field_guid": "null",
    "pattern_type": "value",
    "subject": {
      "subject_id": "example",
      "subject_name": "null",
      "subject_type": "user"
    }
  }
]

Example

{}

source_avatars

Type: SourceAvatarStrict[]

Example

[
  {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example",
    "valid": true,
    "virtual": null
  }
]

sources

Type: DataSourceStrict[]

Example

[
  {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameter_hash": "example",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true,
    "virtual": null
  }
]

template_enabled

Type: boolean

Default: false

Example

{
  "avatar_relations": [
    {
      "conditions": [
        {
          "left": {},
          "operator": "gt",
          "right": null,
          "type": "binary"
        }
      ],
      "id": "example",
      "join_type": "inner",
      "left_avatar_id": "example",
      "managed_by": "user",
      "required": false,
      "right_avatar_id": "example",
      "virtual": null
    }
  ],
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "component_errors": {
    "items": [
      {
        "errors": [
          {}
        ],
        "id": "example",
        "type": "data_source"
      }
    ]
  },
  "data_export_forbidden": false,
  "description": "",
  "load_preview_by_default": true,
  "obligatory_filters": [
    null
  ],
  "preview_enabled": false,
  "result_schema": [
    {
      "aggregation": "none",
      "aggregation_locked": false,
      "autoaggregated": true,
      "avatar_id": "example",
      "cast": "string",
      "data_type": "string",
      "description": "example",
      "guid": "example",
      "has_auto_aggregation": true,
      "hidden": false,
      "initial_data_type": "string",
      "lock_aggregation": true,
      "managed_by": "user",
      "source": "example",
      "title": "example",
      "type": "DIMENSION",
      "ui_settings": "",
      "valid": true,
      "virtual": null
    }
  ],
  "result_schema_aux": {
    "inter_dependencies": {
      "deps": [
        {
          "dep_field_id": "example",
          "ref_field_ids": [
            null
          ]
        }
      ]
    }
  },
  "revision_id": "null",
  "rls": {},
  "rls2": {},
  "source_avatars": [
    {
      "id": "example",
      "is_root": true,
      "managed_by": "user",
      "source_id": "example",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "sources": [
    {
      "connection_id": "example",
      "id": "example",
      "index_info_set": null,
      "managed_by": "user",
      "parameter_hash": "example",
      "parameters": {
        "db_name": "example",
        "db_version": "example",
        "table_name": "example"
      },
      "raw_schema": [
        {}
      ],
      "source_type": "APPMETRICA_API",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "template_enabled": false
}

Value

Name

Description

One of 16 types

Type: string

Example

{
  "type": "string",
  "value": "example"
}

Type: integer
Example
```
{
  "type": "string",
  "value": 0
}
```
Type: float
Example
```
{
  "type": "string",
  "value": 0.5
}
```

Type: date

Example

{
  "type": "string",
  "value": "2025-01-01"
}

Type: datetime

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: datetimetz

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: genericdatetime

Example

{
  "type": "string",
  "value": "2025-01-01T00:00:00Z"
}

Type: boolean

Example

{
  "type": "string",
  "value": true
}

Type: geopoint

Example

{
  "type": "string",
  "value": [
    0.5
  ]
}

Type: geopolygon

Example

{
  "type": "string",
  "value": [
    [
      [
        0.5
      ]
    ]
  ]
}

Type: uuid

Example

{
  "type": "string",
  "value": "example"
}

Type: markup

Example

{
  "type": "string",
  "value": "example"
}

Type: array_str

Example

{
  "type": "string",
  "value": [
    "example"
  ]
}

Type: array_int

Example

{
  "type": "string",
  "value": [
    0
  ]
}

Type: array_float

Example

{
  "type": "string",
  "value": [
    0.5
  ]
}

Type: tree_str

Example

{
  "type": "string",
  "value": [
    "example"
  ]
}

Example

{
  "type": "string",
  "value": "example"
}

AddField

Name	Description
title	Type: string Example: `example`
aggregation	Type: string Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
avatar_id	Type: string \| null Example: `example`
calc_mode	Type: string Enum: `direct`, `formula`, `parameter`
cast	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Any of 2 types Type: Value Example `{ "type": "string", "value": "example" }` Type: null Example: `null` Example `{ "type": "string", "value": "example" }`
description	Type: string Example: `example`
formula	Type: string Example: `example`
guid	Type: string Example: `example`
guid_formula	Type: string Example: `example`
hidden	Type: boolean
new_id	Type: string \| null Example: `example`
source	Type: string Example: `example`
strict	Type: boolean Default: `false`
template_enabled	Type: boolean \| null
ui_settings	Type: string Example: `example`
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "calc_mode": "direct",
  "cast": "string",
  "default_value": {
    "type": "string",
    "value": "example"
  },
  "description": "example",
  "formula": "example",
  "guid": "example",
  "guid_formula": "example",
  "hidden": true,
  "new_id": "example",
  "source": "example",
  "strict": false,
  "template_enabled": true,
  "title": "example",
  "ui_settings": "example",
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

add_field

Name	Description
action	Type: string Const: `add_field` Example: `example`
field	Type: AddField Example `{ "aggregation": "none", "avatar_id": "example", "calc_mode": "direct", "cast": "string", "default_value": { "type": "string", "value": "example" }, "description": "example", "formula": "example", "guid": "example", "guid_formula": "example", "hidden": true, "new_id": "example", "source": "example", "strict": false, "template_enabled": true, "title": "example", "ui_settings": "example", "value_constraint": { "pattern": "example", "type": "regex" } }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

UpdateField

Name	Description
aggregation	Type: string Enum: `none`, `sum`, `avg`, `min`, `max`, `count`, `countunique`
avatar_id	Type: string \| null Example: `example`
calc_mode	Type: string Enum: `direct`, `formula`, `parameter`
cast	Type: string \| null Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`, `null` Example: `string`
default_value	Any of 2 types Type: Value Example `{ "type": "string", "value": "example" }` Type: null Example: `null` Example `{ "type": "string", "value": "example" }`
description	Type: string Example: `example`
formula	Type: string Example: `example`
guid	Type: string Example: `example`
guid_formula	Type: string Example: `example`
hidden	Type: boolean
new_id	Type: string \| null Example: `example`
source	Type: string Example: `example`
strict	Type: boolean Default: `false`
template_enabled	Type: boolean \| null
title	Type: string Example: `example`
ui_settings	Type: string Example: `example`
value_constraint	Any of 2 types Type: ParameterValueConstraint Example `{ "pattern": "example", "type": "regex" }` Type: null Example: `null` Example `{ "pattern": "example", "type": "regex" }`

Example

{
  "aggregation": "none",
  "avatar_id": "example",
  "calc_mode": "direct",
  "cast": "string",
  "default_value": {
    "type": "string",
    "value": "example"
  },
  "description": "example",
  "formula": "example",
  "guid": "example",
  "guid_formula": "example",
  "hidden": true,
  "new_id": "example",
  "source": "example",
  "strict": false,
  "template_enabled": true,
  "title": "example",
  "ui_settings": "example",
  "value_constraint": {
    "pattern": "example",
    "type": "regex"
  }
}

update_field

Name	Description
action	Type: string Const: `update_field` Example: `example`
field	Type: UpdateField Example `{ "aggregation": "none", "avatar_id": "example", "calc_mode": "direct", "cast": "string", "default_value": { "type": "string", "value": "example" }, "description": "example", "formula": "example", "guid": "example", "guid_formula": "example", "hidden": true, "new_id": "example", "source": "example", "strict": false, "template_enabled": true, "title": "example", "ui_settings": "example", "value_constraint": { "pattern": "example", "type": "regex" } }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

DataSource

Name

Description

One of 42 types

APPMETRICA_API

Type: APPMETRICA_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_TABLE

Type: BIGQUERY_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "dataset_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

BIGQUERY_SUBSELECT

Type: BIGQUERY_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BIGQUERY_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

BITRIX_GDS

Type: BITRIX_GDS1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "BITRIX_GDS",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_BILLING_ANALYTICS_TABLE

Type: CH_BILLING_ANALYTICS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_BILLING_ANALYTICS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_YA_MUSIC_PODCAST_STATS_TABLE

Type: CH_YA_MUSIC_PODCAST_STATS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_YA_MUSIC_PODCAST_STATS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE

Type: CHYT_YTSAURUS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_LIST

Type: CHYT_YTSAURUS_TABLE_LIST1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "table_names": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_LIST",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_TABLE_RANGE

Type: CHYT_YTSAURUS_TABLE_RANGE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "directory_path": "example",
    "range_from": "example",
    "range_to": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_TABLE_RANGE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CHYT_YTSAURUS_SUBSELECT

Type: CHYT_YTSAURUS_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CHYT_YTSAURUS_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_TABLE

Type: CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SUBSELECT

Type: CH_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

EQUEO_CH_TABLE

Type: EQUEO_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EQUEO_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

EXTRACTOR_1C_CH_TABLE

Type: EXTRACTOR_1C_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "EXTRACTOR_1C_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_TABLE

Type: GP_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

GP_SUBSELECT

Type: GP_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GP_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

GSHEETS

Type: GSHEETS1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "GSHEETS",
  "title": "example",
  "valid": true,
  "virtual": null
}

JSON_API

Type: JSON_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "JSON_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

KONTUR_MARKET_CH_TABLE

Type: KONTUR_MARKET_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "KONTUR_MARKET_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

METRIKA_API

Type: METRIKA_API1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "METRIKA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

MONITORING

Type: MONITORING1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MONITORING",
  "title": "example",
  "valid": true,
  "virtual": null
}

MOYSKLAD_CH_TABLE

Type: MOYSKLAD_CH_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MOYSKLAD_CH_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_TABLE

Type: MSSQL_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MSSQL_SUBSELECT

Type: MSSQL_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MSSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_TABLE

Type: MYSQL_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

MYSQL_SUBSELECT

Type: MYSQL_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "MYSQL_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_TABLE

Type: ORACLE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

ORACLE_SUBSELECT

Type: ORACLE_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "ORACLE_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_TABLE

Type: PG_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

PG_SUBSELECT

Type: PG_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PG_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

PROMQL

Type: PROMQL1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {},
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "PROMQL",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_SMB_HEATMAPS_TABLE

Type: CH_SMB_HEATMAPS_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_SMB_HEATMAPS_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SNOWFLAKE_TABLE

Type: SNOWFLAKE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "schema": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SNOWFLAKE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

SPEECHSENSE_TABLE

Type: SPEECHSENSE_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "SPEECHSENSE_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_TABLE

Type: TRINO_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "schema_name": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

TRINO_SUBSELECT

Type: TRINO_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "TRINO_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_TABLE

Type: CH_USAGE_TRACKING_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

CH_USAGE_TRACKING_AGG_TABLE

Type: CH_USAGE_TRACKING_AGG_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "CH_USAGE_TRACKING_AGG_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_TABLE

Type: YDB_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YDB_SUBSELECT

Type: YDB_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YDB_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_TABLE

Type: YQ_TABLE1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_TABLE",
  "title": "example",
  "valid": true,
  "virtual": null
}

YQ_SUBSELECT

Type: YQ_SUBSELECT1

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "subsql": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "YQ_SUBSELECT",
  "title": "example",
  "valid": true,
  "virtual": null
}

Example

{
  "connection_id": "example",
  "id": "example",
  "index_info_set": null,
  "managed_by": "user",
  "parameter_hash": "example",
  "parameters": {
    "db_name": "example",
    "db_version": "example",
    "table_name": "example"
  },
  "raw_schema": [
    {
      "description": "example",
      "has_auto_aggregation": true,
      "lock_aggregation": true,
      "name": "example",
      "native_type": {},
      "nullable": true,
      "title": "example",
      "user_type": "string"
    }
  ],
  "source_type": "APPMETRICA_API",
  "title": "example",
  "valid": true,
  "virtual": null
}

add_source

Name	Description
action	Type: string Const: `add_source` Example: `example`
source	Type: DataSource Example `{ "connection_id": "example", "id": "example", "index_info_set": null, "managed_by": "user", "parameter_hash": "example", "parameters": { "db_name": "example", "db_version": "example", "table_name": "example" }, "raw_schema": [ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": {}, "nullable": true, "title": "example", "user_type": "string" } ], "source_type": "APPMETRICA_API", "title": "example", "valid": true, "virtual": null }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameter_hash": "example",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

update_source

Name	Description
action	Type: string Const: `update_source` Example: `example`
source	Type: DataSource Example `{ "connection_id": "example", "id": "example", "index_info_set": null, "managed_by": "user", "parameter_hash": "example", "parameters": { "db_name": "example", "db_version": "example", "table_name": "example" }, "raw_schema": [ { "description": "example", "has_auto_aggregation": true, "lock_aggregation": true, "name": "example", "native_type": {}, "nullable": true, "title": "example", "user_type": "string" } ], "source_type": "APPMETRICA_API", "title": "example", "valid": true, "virtual": null }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameter_hash": "example",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

SourceAvatar

Name	Description
id	Type: string Example: `example`
is_root	Type: boolean
managed_by	Type: string \| null Enum: `user`, `feature`, `compiler_runtime`, `null` Example: `user`
source_id	Type: string Example: `example`
title	Type: string Example: `example`
valid	Type: boolean
virtual	Type: unknown Example: `null`

Example

{
  "id": "example",
  "is_root": true,
  "managed_by": "user",
  "source_id": "example",
  "title": "example",
  "valid": true,
  "virtual": null
}

add_source_avatar

Name	Description
action	Type: string Const: `add_source_avatar` Example: `example`
source_avatar	Type: SourceAvatar Example `{ "id": "example", "is_root": true, "managed_by": "user", "source_id": "example", "title": "example", "valid": true, "virtual": null }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

update_source_avatar

Name	Description
action	Type: string Const: `update_source_avatar` Example: `example`
source_avatar	Type: SourceAvatar Example `{ "id": "example", "is_root": true, "managed_by": "user", "source_id": "example", "title": "example", "valid": true, "virtual": null }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

delete_source_avatar

Name	Description
action	Type: string Const: `delete_source_avatar` Example: `example`
source_avatar	Type: AvatarBase Example `{ "id": "example" }`
disable_fields_update	Type: boolean Default: `false`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example"
  }
}

add_avatar_relation

Name	Description
action	Type: string Const: `add_avatar_relation` Example: `example`
avatar_relation	Type: AvatarRelation Example `{ "conditions": [ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ], "id": "example", "join_type": "inner", "left_avatar_id": "example", "managed_by": "user", "required": false, "right_avatar_id": "example", "virtual": null }`
order_index	Type: integer Default: `0`

Example

{
  "action": "add_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example",
    "virtual": null
  },
  "order_index": 0
}

update_avatar_relation

Name	Description
action	Type: string Const: `update_avatar_relation` Example: `example`
avatar_relation	Type: AvatarRelation Example `{ "conditions": [ { "left": { "calc_mode": "direct", "source": "example" }, "operator": "gt", "right": null, "type": "binary" } ], "id": "example", "join_type": "inner", "left_avatar_id": "example", "managed_by": "user", "required": false, "right_avatar_id": "example", "virtual": null }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example",
    "virtual": null
  },
  "order_index": 0
}

delete_avatar_relation

Name	Description
action	Type: string Const: `delete_avatar_relation` Example: `example`
avatar_relation	Type: RelationBase Example `{ "id": "example" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "delete_avatar_relation",
  "avatar_relation": {
    "id": "example"
  },
  "order_index": 0
}

update_cache_invalidation_source

Name	Description
action	Type: string Const: `update_cache_invalidation_source` Example: `example`
cache_invalidation_source	Type: CacheInvalidationSource Example `{ "cache_invalidation_error": null, "field": null, "filters": [ { "default_filters": [], "field_guid": "example", "id": "example", "managed_by": "user", "valid": true } ], "mode": "off", "sql": "null" }`
order_index	Type: integer Default: `0`

Example

{
  "action": "update_cache_invalidation_source",
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "order_index": 0
}

Action

Name

Description

One of 21 types

add_field

Type: add_field

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

update_field

Type: update_field

Example

{
  "action": "update_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {
      "type": "string",
      "value": "example"
    },
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {
      "pattern": "example",
      "type": "regex"
    }
  },
  "order_index": 0
}

delete_field

Type: delete_field

Example

{
  "action": "delete_field",
  "field": {
    "guid": "example",
    "strict": false
  },
  "order_index": 0
}

clone_field

Type: clone_field

Example

{
  "action": "clone_field",
  "field": {
    "aggregation": "none",
    "cast": "string",
    "from_guid": "example",
    "guid": "example",
    "strict": false,
    "title": "example"
  },
  "order_index": 0
}

add_source

Type: add_source

Example

{
  "action": "add_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameter_hash": "example",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

update_source

Type: update_source

Example

{
  "action": "update_source",
  "order_index": 0,
  "source": {
    "connection_id": "example",
    "id": "example",
    "index_info_set": null,
    "managed_by": "user",
    "parameter_hash": "example",
    "parameters": {
      "db_name": "example",
      "db_version": "example",
      "table_name": "example"
    },
    "raw_schema": [
      {
        "description": "example",
        "has_auto_aggregation": true,
        "lock_aggregation": true,
        "name": "example",
        "native_type": null,
        "nullable": true,
        "title": "example",
        "user_type": "string"
      }
    ],
    "source_type": "APPMETRICA_API",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

delete_source

Type: delete_source

Example

{
  "action": "delete_source",
  "order_index": 0,
  "source": {
    "id": "example"
  }
}

refresh_source

Type: refresh_source

Example

{
  "action": "refresh_source",
  "order_index": 0,
  "source": {
    "force_update_fields": false,
    "id": "example"
  }
}

add_source_avatar

Type: add_source_avatar

Example

{
  "action": "add_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

update_source_avatar

Type: update_source_avatar

Example

{
  "action": "update_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example",
    "is_root": true,
    "managed_by": "user",
    "source_id": "example",
    "title": "example",
    "valid": true,
    "virtual": null
  }
}

delete_source_avatar

Type: delete_source_avatar

Example

{
  "action": "delete_source_avatar",
  "disable_fields_update": false,
  "order_index": 0,
  "source_avatar": {
    "id": "example"
  }
}

add_avatar_relation

Type: add_avatar_relation

Example

{
  "action": "add_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example",
    "virtual": null
  },
  "order_index": 0
}

update_avatar_relation

Type: update_avatar_relation

Example

{
  "action": "update_avatar_relation",
  "avatar_relation": {
    "conditions": [
      {
        "left": {},
        "operator": "gt",
        "right": null,
        "type": "binary"
      }
    ],
    "id": "example",
    "join_type": "inner",
    "left_avatar_id": "example",
    "managed_by": "user",
    "required": false,
    "right_avatar_id": "example",
    "virtual": null
  },
  "order_index": 0
}

delete_avatar_relation

Type: delete_avatar_relation

Example

{
  "action": "delete_avatar_relation",
  "avatar_relation": {
    "id": "example"
  },
  "order_index": 0
}

replace_connection

Type: replace_connection

Example

{
  "action": "replace_connection",
  "connection": {
    "id": "example",
    "new_id": "example"
  },
  "order_index": 0
}

add_obligatory_filter

Type: add_obligatory_filter

Example

{
  "action": "add_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

update_obligatory_filter

Type: update_obligatory_filter

Example

{
  "action": "update_obligatory_filter",
  "obligatory_filter": {
    "default_filters": [],
    "field_guid": "example",
    "id": "example",
    "managed_by": "user",
    "valid": true
  },
  "order_index": 0
}

delete_obligatory_filter

Type: delete_obligatory_filter

Example

{
  "action": "delete_obligatory_filter",
  "obligatory_filter": {
    "id": "example"
  },
  "order_index": 0
}

update_setting

Type: update_setting

Example

{
  "action": "update_setting",
  "order_index": 0,
  "setting": {
    "name": "load_preview_by_default",
    "value": true
  }
}

update_description

Type: update_description

Example

{
  "action": "update_description",
  "description": "example",
  "order_index": 0
}

update_cache_invalidation_source

Type: update_cache_invalidation_source

Example

{
  "action": "update_cache_invalidation_source",
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "order_index": 0
}

Example

{
  "action": "add_field",
  "field": {
    "aggregation": "none",
    "avatar_id": "example",
    "calc_mode": "direct",
    "cast": "string",
    "default_value": {},
    "description": "example",
    "formula": "example",
    "guid": "example",
    "guid_formula": "example",
    "hidden": true,
    "new_id": "example",
    "source": "example",
    "strict": false,
    "template_enabled": true,
    "title": "example",
    "ui_settings": "example",
    "value_constraint": {}
  },
  "order_index": 0
}

DatasetValidate

Name

Description

dataset

Type: DatasetContentInternal

Example

{
  "avatar_relations": [
    {
      "conditions": [
        {
          "left": {},
          "operator": "gt",
          "right": null,
          "type": "binary"
        }
      ],
      "id": "example",
      "join_type": "inner",
      "left_avatar_id": "example",
      "managed_by": "user",
      "required": false,
      "right_avatar_id": "example",
      "virtual": null
    }
  ],
  "cache_invalidation_source": {
    "cache_invalidation_error": null,
    "field": null,
    "filters": [
      {
        "default_filters": [],
        "field_guid": "example",
        "id": "example",
        "managed_by": "user",
        "valid": true
      }
    ],
    "mode": "off",
    "sql": "null"
  },
  "component_errors": {
    "items": [
      {
        "errors": [
          {}
        ],
        "id": "example",
        "type": "data_source"
      }
    ]
  },
  "data_export_forbidden": false,
  "description": "",
  "load_preview_by_default": true,
  "obligatory_filters": [
    null
  ],
  "preview_enabled": false,
  "result_schema": [
    {
      "aggregation": "none",
      "aggregation_locked": false,
      "autoaggregated": true,
      "avatar_id": "example",
      "cast": "string",
      "data_type": "string",
      "description": "example",
      "guid": "example",
      "has_auto_aggregation": true,
      "hidden": false,
      "initial_data_type": "string",
      "lock_aggregation": true,
      "managed_by": "user",
      "source": "example",
      "title": "example",
      "type": "DIMENSION",
      "ui_settings": "",
      "valid": true,
      "virtual": null
    }
  ],
  "result_schema_aux": {
    "inter_dependencies": {
      "deps": [
        {
          "dep_field_id": "example",
          "ref_field_ids": [
            null
          ]
        }
      ]
    }
  },
  "revision_id": "null",
  "rls": {},
  "rls2": {},
  "source_avatars": [
    {
      "id": "example",
      "is_root": true,
      "managed_by": "user",
      "source_id": "example",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "sources": [
    {
      "connection_id": "example",
      "id": "example",
      "index_info_set": null,
      "managed_by": "user",
      "parameter_hash": "example",
      "parameters": {
        "db_name": "example",
        "db_version": "example",
        "table_name": "example"
      },
      "raw_schema": [
        {}
      ],
      "source_type": "APPMETRICA_API",
      "title": "example",
      "valid": true,
      "virtual": null
    }
  ],
  "template_enabled": false
}

updates

Type: Action[]

Example

[
  {
    "action": "add_field",
    "field": {
      "aggregation": "none",
      "avatar_id": "example",
      "calc_mode": "direct",
      "cast": "string",
      "default_value": {},
      "description": "example",
      "formula": "example",
      "guid": "example",
      "guid_formula": "example",
      "hidden": true,
      "new_id": "example",
      "source": "example",
      "strict": false,
      "template_enabled": true,
      "title": "example",
      "ui_settings": "example",
      "value_constraint": {}
    },
    "order_index": 0
  }
]

Example

{
  "dataset": {
    "avatar_relations": [
      {
        "conditions": [
          {}
        ],
        "id": "example",
        "join_type": "inner",
        "left_avatar_id": "example",
        "managed_by": "user",
        "required": false,
        "right_avatar_id": "example",
        "virtual": null
      }
    ],
    "cache_invalidation_source": {
      "cache_invalidation_error": null,
      "field": null,
      "filters": [
        {
          "default_filters": [],
          "field_guid": "example",
          "id": "example",
          "managed_by": "user",
          "valid": true
        }
      ],
      "mode": "off",
      "sql": "null"
    },
    "component_errors": {
      "items": [
        {
          "errors": [
            null
          ],
          "id": "example",
          "type": "data_source"
        }
      ]
    },
    "data_export_forbidden": false,
    "description": "",
    "load_preview_by_default": true,
    "obligatory_filters": [
      null
    ],
    "preview_enabled": false,
    "result_schema": [
      {
        "aggregation": "none",
        "aggregation_locked": false,
        "autoaggregated": true,
        "avatar_id": "example",
        "cast": "string",
        "data_type": "string",
        "description": "example",
        "guid": "example",
        "has_auto_aggregation": true,
        "hidden": false,
        "initial_data_type": "string",
        "lock_aggregation": true,
        "managed_by": "user",
        "source": "example",
        "title": "example",
        "type": "DIMENSION",
        "ui_settings": "",
        "valid": true,
        "virtual": null
      }
    ],
    "result_schema_aux": {
      "inter_dependencies": {
        "deps": [
          {}
        ]
      }
    },
    "revision_id": "null",
    "rls": {},
    "rls2": {},
    "source_avatars": [
      {
        "id": "example",
        "is_root": true,
        "managed_by": "user",
        "source_id": "example",
        "title": "example",
        "valid": true,
        "virtual": null
      }
    ],
    "sources": [
      {
        "connection_id": "example",
        "id": "example",
        "index_info_set": null,
        "managed_by": "user",
        "parameter_hash": "example",
        "parameters": {},
        "raw_schema": [
          null
        ],
        "source_type": "APPMETRICA_API",
        "title": "example",
        "valid": true,
        "virtual": null
      }
    ],
    "template_enabled": false
  },
  "updates": [
    {
      "action": "add_field",
      "field": {
        "aggregation": "none",
        "avatar_id": "example",
        "calc_mode": "direct",
        "cast": "string",
        "default_value": null,
        "description": "example",
        "formula": "example",
        "guid": "example",
        "guid_formula": "example",
        "hidden": true,
        "new_id": "example",
        "source": "example",
        "strict": false,
        "template_enabled": true,
        "title": "example",
        "ui_settings": "example",
        "value_constraint": null
      },
      "order_index": 0
    }
  ]
}

CompatConnectionTypeListItem

Name

Description

conn_type

Type: unknown

Example: null

Example

{
  "conn_type": null
}

ConnectionListItem

Name

Description

Type: string

Example: example

replacement_types

Type: CompatConnectionTypeListItem[]

Example

[
  {
    "conn_type": null
  }
]

Example

{
  "id": "example",
  "replacement_types": [
    {
      "conn_type": null
    }
  ]
}

Connections

Name	Description
compatible_types	Type: CompatConnectionTypeListItem[] Example `[ { "conn_type": null } ]`
items	Type: ConnectionListItem[] Example `[ { "id": "example", "replacement_types": [ { "conn_type": null } ] } ]`
max	Type: integer

Example

{
  "compatible_types": [
    {
      "conn_type": null
    }
  ],
  "items": [
    {
      "id": "example",
      "replacement_types": [
        null
      ]
    }
  ],
  "max": 0
}

DataTypeListItem

Name	Description
aggregations	Type: string[] Example `[ "none" ]`
casts	Type: string[] Example `[ "string" ]`
filter_operations	Type: string[] Example `[ "ISNULL" ]`
type	Type: string Enum: `string`, `integer`, `float`, `date`, `datetime`, `boolean`, `geopoint`, `geopolygon`, `uuid`, `markup`, `datetimetz`, `unsupported`, `array_str`, `array_int`, `array_float`, `tree_str`, `genericdatetime`

Example

{
  "aggregations": [
    "none"
  ],
  "casts": [
    "string"
  ],
  "filter_operations": [
    "ISNULL"
  ],
  "type": "string"
}

DataTypes

Name	Description
items	Type: DataTypeListItem[] Example `[ { "aggregations": [ "none" ], "casts": [ "string" ], "filter_operations": [ "ISNULL" ], "type": "string" } ]`

Example

{
  "items": [
    {
      "aggregations": [
        "none"
      ],
      "casts": [
        "string"
      ],
      "filter_operations": [
        "ISNULL"
      ],
      "type": "string"
    }
  ]
}

FieldListItem

Name	Description
aggregations	Type: string[] Example `[ "none" ]`
casts	Type: string[] Example `[ "string" ]`
guid	Type: string Example: `example`

Example

{
  "aggregations": [
    "none"
  ],
  "casts": [
    "string"
  ],
  "guid": "example"
}

Fields

Name	Description
items	Type: FieldListItem[] Example `[ { "aggregations": [ "none" ], "casts": [ "string" ], "guid": "example" } ]`

Example

{
  "items": [
    {
      "aggregations": [
        "none"
      ],
      "casts": [
        "string"
      ],
      "guid": "example"
    }
  ]
}

Join

Name	Description
operators	Type: string[] Example `[ "gt" ]`
types	Type: string[] Example `[ "inner" ]`

Example

{
  "operators": [
    "gt"
  ],
  "types": [
    "inner"
  ]
}

Preview

Name	Description
enabled	Type: boolean

Example

{
  "enabled": true
}

SourceListItem

Name

Description

Type: string

Example: example

schema_update_enabled

Type: boolean

Example

{
  "id": "example",
  "schema_update_enabled": true
}

Avatars

Name	Description
items	Type: SourceListItem[] Example `[ { "id": "example", "schema_update_enabled": true } ]`
max	Type: integer

Example

{
  "items": [
    {
      "id": "example",
      "schema_update_enabled": true
    }
  ],
  "max": 0
}

SourceListing

Name	Description
db_name_label	Type: string Example: `example`
db_name_required_for_search	Type: boolean
supports_db_name_listing	Type: boolean
supports_source_pagination	Type: boolean
supports_source_search	Type: boolean

Example

{
  "db_name_label": "example",
  "db_name_required_for_search": true,
  "supports_db_name_listing": true,
  "supports_source_pagination": true,
  "supports_source_search": true
}

CompatSourceTypeListItem

Name

Description

source_type

Type: unknown

Example: null

Example

{
  "source_type": null
}

Sources

Name	Description
compatible_types	Type: CompatSourceTypeListItem[] Example `[ { "source_type": null } ]`
items	Type: SourceListItem1[] Example `[ { "id": "example", "schema_update_enabled": true } ]`
max	Type: integer

Example

{
  "compatible_types": [
    {
      "source_type": null
    }
  ],
  "items": [
    {
      "id": "example",
      "schema_update_enabled": true
    }
  ],
  "max": 0
}

Options

Name	Description
connections	Type: Connections Example `{ "compatible_types": [ { "conn_type": null } ], "items": [ { "id": "example", "replacement_types": [ null ] } ], "max": 0 }`
data_types	Type: DataTypes Example `{ "items": [ { "aggregations": [ "none" ], "casts": [ "string" ], "filter_operations": [ "ISNULL" ], "type": "string" } ] }`
fields	Type: Fields Example `{ "items": [ { "aggregations": [ "none" ], "casts": [ "string" ], "guid": "example" } ] }`
is_cache_invalidation_enabled_in_conn	Type: boolean
join	Type: Join Example `{ "operators": [ "gt" ], "types": [ "inner" ] }`
preview	Type: Preview Example `{ "enabled": true }`
schema_update_enabled	Type: boolean
source_avatars	Type: Avatars Example `{ "items": [ { "id": "example", "schema_update_enabled": true } ], "max": 0 }`
source_listing	Type: SourceListing Example `{ "db_name_label": "example", "db_name_required_for_search": true, "supports_db_name_listing": true, "supports_source_pagination": true, "supports_source_search": true }`
sources	Type: Sources Example `{ "compatible_types": [ { "source_type": null } ], "items": [ { "id": "example", "schema_update_enabled": true } ], "max": 0 }`
supported_functions	Type: string[] Example `[ "example" ]`
supports_offset	Type: boolean

Example

{
  "connections": {
    "compatible_types": [
      {
        "conn_type": null
      }
    ],
    "items": [
      {
        "id": "example",
        "replacement_types": [
          null
        ]
      }
    ],
    "max": 0
  },
  "data_types": {
    "items": [
      {
        "aggregations": [
          "none"
        ],
        "casts": [
          "string"
        ],
        "filter_operations": [
          "ISNULL"
        ],
        "type": "string"
      }
    ]
  },
  "fields": {
    "items": [
      {
        "aggregations": [
          "none"
        ],
        "casts": [
          "string"
        ],
        "guid": "example"
      }
    ]
  },
  "is_cache_invalidation_enabled_in_conn": true,
  "join": {
    "operators": [
      "gt"
    ],
    "types": [
      "inner"
    ]
  },
  "preview": {
    "enabled": true
  },
  "schema_update_enabled": true,
  "source_avatars": {
    "items": [
      {
        "id": "example",
        "schema_update_enabled": true
      }
    ],
    "max": 0
  },
  "source_listing": {
    "db_name_label": "example",
    "db_name_required_for_search": true,
    "supports_db_name_listing": true,
    "supports_source_pagination": true,
    "supports_source_search": true
  },
  "sources": {
    "compatible_types": [
      {
        "source_type": null
      }
    ],
    "items": [
      {
        "id": "example",
        "schema_update_enabled": true
      }
    ],
    "max": 0
  },
  "supported_functions": [
    "example"
  ],
  "supports_offset": true
}

Validate dataset

RequestRequest

HeadersHeaders

BodyBody

directdirect

formulaformula

result_fieldresult_field

ConditionPartGenericConditionPartGeneric

JoinConditionJoinCondition

AvatarRelationAvatarRelation

CacheInvalidationErrorCacheInvalidationError

formula1formula1

CacheInvalidationFieldCacheInvalidationField

WhereWhere

ObligatoryFilterObligatoryFilter

CacheInvalidationSourceCacheInvalidationSource

ComponentErrorComponentError

ComponentErrorPackComponentErrorPack

ComponentErrorListComponentErrorList

direct1direct1

formula2formula2

regexregex

defaultdefault

ParameterValueConstraintParameterValueConstraint

parameter1parameter1

ResultSchemaSchemaGenericResultSchemaSchemaGeneric

FieldInterDependencyItemFieldInterDependencyItem

FieldInterDependencyInfoFieldInterDependencyInfo

ResultSchemaAuxResultSchemaAux

RLSSubjectRLSSubject

RLS2ConfigEntryRLS2ConfigEntry

SourceAvatarStrictSourceAvatarStrict

IndexInfoIndexInfo

SQLParametersSQLParameters

generic_native_typegeneric_native_type

common_native_typecommon_native_type

lengthed_native_typelengthed_native_type

clickhouse_native_typeclickhouse_native_type

clickhouse_datetimewithtz_native_typeclickhouse_datetimewithtz_native_type

clickhouse_datetime64_native_typeclickhouse_datetime64_native_type

clickhouse_datetime64withtz_native_typeclickhouse_datetime64withtz_native_type

OneOfNativeTypeOneOfNativeType

RawSchemaColumnRawSchemaColumn

APPMETRICA_APIAPPMETRICA_API

BigQueryTableParametersBigQueryTableParameters

BIGQUERY_TABLEBIGQUERY_TABLE

SubselectParametersSubselectParameters

BIGQUERY_SUBSELECTBIGQUERY_SUBSELECT

BITRIX_GDSBITRIX_GDS

CH_BILLING_ANALYTICS_TABLECH_BILLING_ANALYTICS_TABLE

CH_YA_MUSIC_PODCAST_STATS_TABLECH_YA_MUSIC_PODCAST_STATS_TABLE

CHYT_YTSAURUS_TABLECHYT_YTSAURUS_TABLE

CHYTTableListParametersCHYTTableListParameters

CHYT_YTSAURUS_TABLE_LISTCHYT_YTSAURUS_TABLE_LIST

CHYTTableRangeParametersCHYTTableRangeParameters

CHYT_YTSAURUS_TABLE_RANGECHYT_YTSAURUS_TABLE_RANGE

CHYT_YTSAURUS_SUBSELECTCHYT_YTSAURUS_SUBSELECT

CH_TABLECH_TABLE

CH_SUBSELECTCH_SUBSELECT

EQUEO_CH_TABLEEQUEO_CH_TABLE

EXTRACTOR_1C_CH_TABLEEXTRACTOR_1C_CH_TABLE

SchematizedParametersSchematizedParameters

GP_TABLEGP_TABLE

GP_SUBSELECTGP_SUBSELECT

SimpleParametersSimpleParameters

GSHEETSGSHEETS

JSON_APIJSON_API

KONTUR_MARKET_CH_TABLEKONTUR_MARKET_CH_TABLE

METRIKA_APIMETRIKA_API

MONITORINGMONITORING

MOYSKLAD_CH_TABLEMOYSKLAD_CH_TABLE

MSSQL_TABLEMSSQL_TABLE

MSSQL_SUBSELECTMSSQL_SUBSELECT

MYSQL_TABLEMYSQL_TABLE

MYSQL_SUBSELECTMYSQL_SUBSELECT

ORACLE_TABLEORACLE_TABLE

ORACLE_SUBSELECTORACLE_SUBSELECT

PG_TABLEPG_TABLE

PG_SUBSELECTPG_SUBSELECT

PROMQLPROMQL

Request

Headers

Body

direct

formula

result_field

ConditionPartGeneric

JoinCondition

AvatarRelation

CacheInvalidationError

formula1

CacheInvalidationField

Where

ObligatoryFilter

CacheInvalidationSource

ComponentError

ComponentErrorPack

ComponentErrorList

direct1

formula2

regex

default

ParameterValueConstraint

parameter1

ResultSchemaSchemaGeneric

FieldInterDependencyItem

FieldInterDependencyInfo

ResultSchemaAux

RLSSubject

RLS2ConfigEntry

SourceAvatarStrict

IndexInfo

SQLParameters

generic_native_type

common_native_type

lengthed_native_type

clickhouse_native_type

clickhouse_datetimewithtz_native_type

clickhouse_datetime64_native_type

clickhouse_datetime64withtz_native_type

OneOfNativeType

RawSchemaColumn

APPMETRICA_API

BigQueryTableParameters

BIGQUERY_TABLE

SubselectParameters

BIGQUERY_SUBSELECT

BITRIX_GDS

CH_BILLING_ANALYTICS_TABLE

CH_YA_MUSIC_PODCAST_STATS_TABLE

CHYT_YTSAURUS_TABLE

CHYTTableListParameters

CHYT_YTSAURUS_TABLE_LIST

CHYTTableRangeParameters

CHYT_YTSAURUS_TABLE_RANGE

CHYT_YTSAURUS_SUBSELECT

CH_TABLE

CH_SUBSELECT

EQUEO_CH_TABLE

EXTRACTOR_1C_CH_TABLE

SchematizedParameters

GP_TABLE

GP_SUBSELECT

SimpleParameters

GSHEETS

JSON_API

KONTUR_MARKET_CH_TABLE

METRIKA_API

MONITORING

MOYSKLAD_CH_TABLE

MSSQL_TABLE

MSSQL_SUBSELECT

MYSQL_TABLE

MYSQL_SUBSELECT

ORACLE_TABLE

ORACLE_SUBSELECT

PG_TABLE

PG_SUBSELECT

PROMQL

CH_SMB_HEATMAPS_TABLE