Cluster

Набор методов для управления кластерами ClickHouse.

JSON-представление

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "clickhouse": {
      "config": {
        "effectiveConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer",
            "partsToDelayInsert": "integer",
            "partsToThrowInsert": "integer",
            "maxReplicatedMergesInQueue": "integer",
            "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
            "maxBytesToMergeAtMinSpaceInPool": "integer"
          },
          "compression": [
            {
              "method": "string",
              "minPartSize": "string",
              "minPartSizeRatio": "number"
            }
          ],
          "dictionaries": [
            {
              "name": "string",
              "structure": {
                "id": {
                  "name": "string"
                },
                "key": {
                  "attributes": [
                    {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": true,
                      "injective": true
                    }
                  ]
                },
                "rangeMin": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "rangeMax": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.effectiveConfig.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // конец списка возможных полей`config.clickhouse.config.effectiveConfig.dictionaries[]`

              "httpSource": {
                "url": "string",
                "format": "string"
              },
              "mysqlSource": {
                "db": "string",
                "table": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "replicas": [
                  {
                    "host": "string",
                    "priority": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string"
                  }
                ],
                "where": "string",
                "invalidateQuery": "string"
              },
              "clickhouseSource": {
                "db": "string",
                "table": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "where": "string"
              },
              "mongodbSource": {
                "db": "string",
                "collection": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string"
              },
              "postgresqlSource": {
                "db": "string",
                "table": "string",
                "hosts": [
                  "string"
                ],
                "port": "string",
                "user": "string",
                "password": "string",
                "invalidateQuery": "string",
                "sslMode": "string"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        },
        "userConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer",
            "partsToDelayInsert": "integer",
            "partsToThrowInsert": "integer",
            "maxReplicatedMergesInQueue": "integer",
            "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
            "maxBytesToMergeAtMinSpaceInPool": "integer"
          },
          "compression": [
            {
              "method": "string",
              "minPartSize": "string",
              "minPartSizeRatio": "number"
            }
          ],
          "dictionaries": [
            {
              "name": "string",
              "structure": {
                "id": {
                  "name": "string"
                },
                "key": {
                  "attributes": [
                    {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": true,
                      "injective": true
                    }
                  ]
                },
                "rangeMin": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "rangeMax": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.userConfig.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // конец списка возможных полей`config.clickhouse.config.userConfig.dictionaries[]`

              "httpSource": {
                "url": "string",
                "format": "string"
              },
              "mysqlSource": {
                "db": "string",
                "table": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "replicas": [
                  {
                    "host": "string",
                    "priority": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string"
                  }
                ],
                "where": "string",
                "invalidateQuery": "string"
              },
              "clickhouseSource": {
                "db": "string",
                "table": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "where": "string"
              },
              "mongodbSource": {
                "db": "string",
                "collection": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string"
              },
              "postgresqlSource": {
                "db": "string",
                "table": "string",
                "hosts": [
                  "string"
                ],
                "port": "string",
                "user": "string",
                "password": "string",
                "invalidateQuery": "string",
                "sslMode": "string"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        },
        "defaultConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer",
            "partsToDelayInsert": "integer",
            "partsToThrowInsert": "integer",
            "maxReplicatedMergesInQueue": "integer",
            "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
            "maxBytesToMergeAtMinSpaceInPool": "integer"
          },
          "compression": [
            {
              "method": "string",
              "minPartSize": "string",
              "minPartSizeRatio": "number"
            }
          ],
          "dictionaries": [
            {
              "name": "string",
              "structure": {
                "id": {
                  "name": "string"
                },
                "key": {
                  "attributes": [
                    {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": true,
                      "injective": true
                    }
                  ]
                },
                "rangeMin": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "rangeMax": {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.defaultConfig.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // конец списка возможных полей`config.clickhouse.config.defaultConfig.dictionaries[]`

              "httpSource": {
                "url": "string",
                "format": "string"
              },
              "mysqlSource": {
                "db": "string",
                "table": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "replicas": [
                  {
                    "host": "string",
                    "priority": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string"
                  }
                ],
                "where": "string",
                "invalidateQuery": "string"
              },
              "clickhouseSource": {
                "db": "string",
                "table": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string",
                "where": "string"
              },
              "mongodbSource": {
                "db": "string",
                "collection": "string",
                "host": "string",
                "port": "string",
                "user": "string",
                "password": "string"
              },
              "postgresqlSource": {
                "db": "string",
                "table": "string",
                "hosts": [
                  "string"
                ],
                "port": "string",
                "user": "string",
                "password": "string",
                "invalidateQuery": "string",
                "sslMode": "string"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        }
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}
Поле Описание
id string

Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.

folderId string

Идентификатор каталога, которому принадлежит кластер ClickHouse.

createdAt string (date-time)

Время создания в формате RFC3339 .

Строка в формате RFC3339.

name string

Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.

description string

Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.

labels object

Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.

environment string

Среда развертывания кластера ClickHouse.

Среда развертывания.

  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
monitoring[] object

Метаданные системы мониторинга.

monitoring[].
name
string

Название системы мониторинга.

monitoring[].
description
string

Описание системы мониторинга.

monitoring[].
link
string

Ссылка на графики системы мониторинга для данного кластера ClickHouse.

config object

Конфигурация кластера ClickHouse.

config.
version
string

Версия серверного программного обеспечения ClickHouse.

config.
clickhouse
object

Конфигурация и распределение ресурсов для хостов ClickHouse.

config.
clickhouse.
config
object

Параметры конфигурации сервера ClickHouse.

config.
clickhouse.
config.
effectiveConfig
object

Обязательное поле. Действующие параметры для кластера ClickHouse (сочетание параметров, определенных в userConfig и [default_config]).

Настройки конфигурации ClickHouse. Подробное описание для каждого набора настроек доступно в документации ClickHouse.

Любые настройки, не перечисленные здесь, не поддерживаются.

config.
clickhouse.
config.
effectiveConfig.
logLevel
string

Уровень логирования для кластера ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
mergeTree
object

Параметры движка MergeTree. См. описание в документации Clickhouse.

Настройки движка таблицы MergeTree.

config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Количество блоков хэшей, которые должен хранить ZooKeeper. Смотрите подробное описание в ClickHouse sources.

config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Период времени, в течение которого следует хранить блоки хэшей. См. описание в ClickHouse sources.

config.
clickhouse.
config.
effectiveConfig.
mergeTree.
partsToDelayInsert
integer (int64)
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
partsToThrowInsert
integer (int64)
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)
config.
clickhouse.
config.
effectiveConfig.
compression[]
object

Параметры сжатия для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
effectiveConfig.
compression[].
method
string

Метод сжатия, используемый для указанной комбинации min_part_size и min_part_size_ratio.

config.
clickhouse.
config.
effectiveConfig.
compression[].
minPartSize
string (int64)

Минимальный размер части таблицы.

Минимальное значение — 1.

config.
clickhouse.
config.
effectiveConfig.
compression[].
minPartSizeRatio
number (double)

Минимальное отношение части к размеру всех данных в таблице.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[]
object

Конфигурация внешних словарей для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
name
string

Обязательное поле. Имя внешнего словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure
object
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
id
object

Один столбец с числовыми ключами для словаря.

Числовой ключ.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
id.
name
string

Обязательное поле. Имя числового ключа.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key
object

Составной ключ для словаря, содержащего один или несколько столбцов с ключами. Подробнее см. в документации ClickHouse.

Составной ключ.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[]
object

Обязательное поле. Поля составного ключа.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin
object

Поле, содержащее начало диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax
object

Поле, содержащее конец диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[]
object

Обязательное поле. Описание полей, доступных для запросов к базе данных. Подробнее см. в документации Clickhouse.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout
object

Макет, определяющий способ хранения словаря в памяти.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout.
type
string

Обязательное поле. Тип макета для внешнего словаря.

  • FLAT: Весь словарь хранится в памяти в виде плоских массивов. Доступно для любых источников словарей.
  • HASHED: Весь словарь хранится в памяти в виде хэш-таблицы. Доступно для любых источников словарей.
  • COMPLEX_KEY_HASHED: Аналогичен HASHED, для использования с составными ключами. Доступно для любых источников словарей.
  • RANGE_HASHED: Весь словарь хранится в памяти в виде хэш-таблицы, с упорядоченным массивом диапазонов и соответствующих им значений. Доступно для любых источников словарей.
  • CACHE: Словарь хранится в кэше с заданным количеством ячеек. Доступно для источников словарей MySQL, ClickHouse и HTTP.
  • COMPLEX_KEY_CACHE: Аналогичен CACHE, для использования с составными ключами. Доступно для источников словарей MySQL, ClickHouse и HTTP.
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Количество ячеек в кэше. Округляется до степени двойки. Применимо только для типов макета CACHE и COMPLEX_KEY_CACHE.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
fixedLifetime
string (int64)
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

Жесткий интервал между обновлениями словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Минимальное время жизни словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Максимальное время жизни словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource.
url
string

Обязательное поле. URL внешнего словаря, доступного по HTTP.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource.
format
string

Обязательное поле. Формат данных. Допустимые значения: все форматы, поддерживаемые диалектом ClickHouse SQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
db
string

Обязательное поле. Имя базы данных MySQL, к которой нужно подключаться.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
table
string

Обязательное поле. Имя таблицы базы данных, которую следует использовать в качестве словаря ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Порт по умолчанию, который нужно использовать при подключении к реплике источника словаря.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
user
string

Имя пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
password
string

Пароль пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Обязательное поле. Список реплик базы данных MySQL, используемой в качестве источника словаря.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Обязательное поле. Хост реплики MySQL.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Обязательное поле. Приоритет реплики, который ClickHouse должен учитывать при подключении. Реплике с наивысшим приоритетом должно соответствовать наименьшее значение в этом поле.

Значение должно быть больше 0.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Порт, который нужно использовать при подключении к реплике. Если для какой-либо реплики не указан порт, ClickHouse использует порт, указанный для источника.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Имя пользователя базы данных MySQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Пароль пользователя базы данных MySQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
where
string

Критерии выбора данных в указанной таблице MySQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
db
string

Обязательное поле. Имя базы данных ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
host
string

Обязательное поле. Хост ClickHouse для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
user
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
password
string

Пароль пользователя базы данных ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
where
string

Критерии выбора данных в указанной таблице ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
db
string

Обязательное поле. Имя базы данных MongoDB.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
collection
string

Обязательное поле. Имя коллекции в указанной базе данных, которую следует использовать в качестве источника словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
host
string

Обязательное поле. Хост MongoDB для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
user
string

Обязательное поле. Имя пользователя базы данных MongoDB.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
password
string

Пароль пользователя базы данных MongoDB.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource
object
config.clickhouse.config.effectiveConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
db
string

Обязательное поле. Имя базы данных PostrgreSQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Обязательное поле. Имя хоста PostrgreSQL.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
user
string

Обязательное поле. Имя пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
password
string

Пароль пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Режим SSL TCP/IP соединения с хостом PostgreSQL. Есть шесть режимов: disable, allow, prefer (используется по умолчанию), require, verify-ca, verify-full. Дополнительные сведения см. в документации PostgreSQL.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[]
object

Параметры свертки для движка таблицы GraphiteMergeTree.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
name
string

Обязательное поле. Имя указанной комбинации параметров для свертки Graphite.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[]
object

Обязательное поле. Шаблон, используемый для свертки.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
regexp
string

Шаблон для имен метрик.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
function
string

Обязательное поле. Имя агрегирующей функции, которую следует применить к данным старше возраста, указанного в retention.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[]
object

Обязательное поле. Возраст данных, которые следует использовать для прореживания.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Минимальный возраст данных в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Точность определения возраста данных, в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
effectiveConfig.
maxConnections
integer (int64)

Максимальное количество входящих подключений.

Минимальное значение — 10.

config.
clickhouse.
config.
effectiveConfig.
maxConcurrentQueries
integer (int64)

Максимальное количество одновременно обрабатываемых запросов.

Минимальное значение — 10.

config.
clickhouse.
config.
effectiveConfig.
keepAliveTimeout
integer (int64)

Количество миллисекунд, в течение которых ClickHouse ожидает входящие запросы прежде чем закрыть подключение.

config.
clickhouse.
config.
effectiveConfig.
uncompressedCacheSize
integer (int64)

Размер кэша (в байтах) для несжатых данных, используемых таблицами MergeTree. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
effectiveConfig.
markCacheSize
integer (int64)

Примерный размер (в байтах) кэша «меток», используемых таблицами MergeTree. Подробнее в документации ClickHouse.

Значение должно быть больше 5368709120.

config.
clickhouse.
config.
effectiveConfig.
maxTableSizeToDrop
integer (int64)

Максимальный размер таблицы, которую можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
effectiveConfig.
maxPartitionSizeToDrop
integer (int64)

Максимальный размер раздела, который можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
effectiveConfig.
builtinDictionariesReloadInterval
integer (int64)

Интервал времени для перезагрузки встроенных словарей. См. подробное описание в документации ClickHouse.

config.
clickhouse.
config.
effectiveConfig.
timezone
string

Часовой пояс сервера, используемый в преобразованиях полей DateTime. Указывается как идентификатор IANA. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig
object

Пользовательские настройки для кластера ClickHouse.

Настройки конфигурации ClickHouse. Подробное описание для каждого набора настроек доступно в документации ClickHouse.

Любые настройки, не перечисленные здесь, не поддерживаются.

config.
clickhouse.
config.
userConfig.
logLevel
string

Уровень логирования для кластера ClickHouse.

config.
clickhouse.
config.
userConfig.
mergeTree
object

Параметры движка MergeTree. См. описание в документации Clickhouse.

Настройки движка таблицы MergeTree.

config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Количество блоков хэшей, которые должен хранить ZooKeeper. Смотрите подробное описание в ClickHouse sources.

config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Период времени, в течение которого следует хранить блоки хэшей. См. описание в ClickHouse sources.

config.
clickhouse.
config.
userConfig.
mergeTree.
partsToDelayInsert
integer (int64)
config.
clickhouse.
config.
userConfig.
mergeTree.
partsToThrowInsert
integer (int64)
config.
clickhouse.
config.
userConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)
config.
clickhouse.
config.
userConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)
config.
clickhouse.
config.
userConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)
config.
clickhouse.
config.
userConfig.
compression[]
object

Параметры сжатия для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig.
compression[].
method
string

Метод сжатия, используемый для указанной комбинации min_part_size и min_part_size_ratio.

config.
clickhouse.
config.
userConfig.
compression[].
minPartSize
string (int64)

Минимальный размер части таблицы.

Минимальное значение — 1.

config.
clickhouse.
config.
userConfig.
compression[].
minPartSizeRatio
number (double)

Минимальное отношение части к размеру всех данных в таблице.

config.
clickhouse.
config.
userConfig.
dictionaries[]
object

Конфигурация внешних словарей для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
name
string

Обязательное поле. Имя внешнего словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure
object
Обязательное поле. Набор атрибутов внешнего словаря. Подробное описание см. в документации ClickHouse.
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
id
object

Один столбец с числовыми ключами для словаря.

Числовой ключ.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
id.
name
string

Обязательное поле. Имя числового ключа.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key
object

Составной ключ для словаря, содержащего один или несколько столбцов с ключами. Подробнее см. в документации ClickHouse.

Составной ключ.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[]
object

Обязательное поле. Поля составного ключа.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin
object

Поле, содержащее начало диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax
object

Поле, содержащее конец диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[]
object

Обязательное поле. Описание полей, доступных для запросов к базе данных. Подробнее см. в документации Clickhouse.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
userConfig.
dictionaries[].
layout
object
Обязательное поле. Макет для хранения словаря в памяти. Подробное описание см. в документации ClickHouse.

Макет, определяющий способ хранения словаря в памяти.

config.
clickhouse.
config.
userConfig.
dictionaries[].
layout.
type
string

Обязательное поле. Тип макета для внешнего словаря.

  • FLAT: Весь словарь хранится в памяти в виде плоских массивов. Доступно для любых источников словарей.
  • HASHED: Весь словарь хранится в памяти в виде хэш-таблицы. Доступно для любых источников словарей.
  • COMPLEX_KEY_HASHED: Аналогичен HASHED, для использования с составными ключами. Доступно для любых источников словарей.
  • RANGE_HASHED: Весь словарь хранится в памяти в виде хэш-таблицы, с упорядоченным массивом диапазонов и соответствующих им значений. Доступно для любых источников словарей.
  • CACHE: Словарь хранится в кэше с заданным количеством ячеек. Доступно для источников словарей MySQL, ClickHouse и HTTP.
  • COMPLEX_KEY_CACHE: Аналогичен CACHE, для использования с составными ключами. Доступно для источников словарей MySQL, ClickHouse и HTTP.
config.
clickhouse.
config.
userConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Количество ячеек в кэше. Округляется до степени двойки. Применимо только для типов макета CACHE и COMPLEX_KEY_CACHE.

config.
clickhouse.
config.
userConfig.
dictionaries[].
fixedLifetime
string (int64)
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

Жесткий интервал между обновлениями словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange
object
Диапазон интервалов между обновлениями словаря, из которых может выбирать ClickHouse.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Минимальное время жизни словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Максимальное время жизни словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource
object
HTTP-источник для словаря.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource.
url
string

Обязательное поле. URL внешнего словаря, доступного по HTTP.

config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource.
format
string

Обязательное поле. Формат данных. Допустимые значения: все форматы, поддерживаемые диалектом ClickHouse SQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource
object
MySQL-источник для словаря.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
db
string

Обязательное поле. Имя базы данных MySQL, к которой нужно подключаться.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
table
string

Обязательное поле. Имя таблицы базы данных, которую следует использовать в качестве словаря ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Порт по умолчанию, который нужно использовать при подключении к реплике источника словаря.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
user
string

Имя пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
password
string

Пароль пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Обязательное поле. Список реплик базы данных MySQL, используемой в качестве источника словаря.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Обязательное поле. Хост реплики MySQL.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Обязательное поле. Приоритет реплики, который ClickHouse должен учитывать при подключении. Реплике с наивысшим приоритетом должно соответствовать наименьшее значение в этом поле.

Значение должно быть больше 0.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Порт, который нужно использовать при подключении к реплике. Если для какой-либо реплики не указан порт, ClickHouse использует порт, указанный для источника.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Имя пользователя базы данных MySQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Пароль пользователя базы данных MySQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
where
string

Критерии выбора данных в указанной таблице MySQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource
object
ClickHouse-источник для словаря.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
db
string

Обязательное поле. Имя базы данных ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
host
string

Обязательное поле. Хост ClickHouse для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
user
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
password
string

Пароль пользователя базы данных ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
where
string

Критерии выбора данных в указанной таблице ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource
object
MongoDB-источник для словаря.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
db
string

Обязательное поле. Имя базы данных MongoDB.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
collection
string

Обязательное поле. Имя коллекции в указанной базе данных, которую следует использовать в качестве источника словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
host
string

Обязательное поле. Хост MongoDB для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
user
string

Обязательное поле. Имя пользователя базы данных MongoDB.

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
password
string

Пароль пользователя базы данных MongoDB.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource
object
PostgreSQL-источник для словаря.
config.clickhouse.config.userConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
db
string

Обязательное поле. Имя базы данных PostrgreSQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Обязательное поле. Имя хоста PostrgreSQL.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
user
string

Обязательное поле. Имя пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
password
string

Пароль пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Режим SSL TCP/IP соединения с хостом PostgreSQL. Есть шесть режимов: disable, allow, prefer (используется по умолчанию), require, verify-ca, verify-full. Дополнительные сведения см. в документации PostgreSQL.

config.
clickhouse.
config.
userConfig.
graphiteRollup[]
object

Параметры свертки для движка таблицы GraphiteMergeTree.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
name
string

Обязательное поле. Имя указанной комбинации параметров для свертки Graphite.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[]
object

Обязательное поле. Шаблон, используемый для свертки.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
regexp
string

Шаблон для имен метрик.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
function
string

Обязательное поле. Имя агрегирующей функции, которую следует применить к данным старше возраста, указанного в retention.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[]
object

Обязательное поле. Возраст данных, которые следует использовать для прореживания.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Минимальный возраст данных в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Точность определения возраста данных, в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
userConfig.
maxConnections
integer (int64)

Максимальное количество входящих подключений.

Минимальное значение — 10.

config.
clickhouse.
config.
userConfig.
maxConcurrentQueries
integer (int64)

Максимальное количество одновременно обрабатываемых запросов.

Минимальное значение — 10.

config.
clickhouse.
config.
userConfig.
keepAliveTimeout
integer (int64)

Количество миллисекунд, в течение которых ClickHouse ожидает входящие запросы прежде чем закрыть подключение.

config.
clickhouse.
config.
userConfig.
uncompressedCacheSize
integer (int64)

Размер кэша (в байтах) для несжатых данных, используемых таблицами MergeTree. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig.
markCacheSize
integer (int64)

Примерный размер (в байтах) кэша «меток», используемых таблицами MergeTree. Подробнее в документации ClickHouse.

Значение должно быть больше 5368709120.

config.
clickhouse.
config.
userConfig.
maxTableSizeToDrop
integer (int64)

Максимальный размер таблицы, которую можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig.
maxPartitionSizeToDrop
integer (int64)

Максимальный размер раздела, который можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
userConfig.
builtinDictionariesReloadInterval
integer (int64)

Интервал времени для перезагрузки встроенных словарей. См. подробное описание в документации ClickHouse.

config.
clickhouse.
config.
userConfig.
timezone
string

Часовой пояс сервера, используемый в преобразованиях полей DateTime. Указывается как идентификатор IANA. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig
object

Конфигурация по умолчанию для кластера ClickHouse.

Настройки конфигурации ClickHouse. Подробное описание для каждого набора настроек доступно в документации ClickHouse.

Любые настройки, не перечисленные здесь, не поддерживаются.

config.
clickhouse.
config.
defaultConfig.
logLevel
string

Уровень логирования для кластера ClickHouse.

config.
clickhouse.
config.
defaultConfig.
mergeTree
object

Параметры движка MergeTree. См. описание в документации Clickhouse.

Настройки движка таблицы MergeTree.

config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Количество блоков хэшей, которые должен хранить ZooKeeper. Смотрите подробное описание в ClickHouse sources.

config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Период времени, в течение которого следует хранить блоки хэшей. См. описание в ClickHouse sources.

config.
clickhouse.
config.
defaultConfig.
mergeTree.
partsToDelayInsert
integer (int64)
config.
clickhouse.
config.
defaultConfig.
mergeTree.
partsToThrowInsert
integer (int64)
config.
clickhouse.
config.
defaultConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)
config.
clickhouse.
config.
defaultConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)
config.
clickhouse.
config.
defaultConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)
config.
clickhouse.
config.
defaultConfig.
compression[]
object

Параметры сжатия для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig.
compression[].
method
string

Метод сжатия, используемый для указанной комбинации min_part_size и min_part_size_ratio.

config.
clickhouse.
config.
defaultConfig.
compression[].
minPartSize
string (int64)

Минимальный размер части таблицы.

Минимальное значение — 1.

config.
clickhouse.
config.
defaultConfig.
compression[].
minPartSizeRatio
number (double)

Минимальное отношение части к размеру всех данных в таблице.

config.
clickhouse.
config.
defaultConfig.
dictionaries[]
object

Конфигурация внешних словарей для кластера ClickHouse. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
name
string

Обязательное поле. Имя внешнего словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure
object
Обязательное поле. Набор атрибутов внешнего словаря. Подробное описание см. в документации ClickHouse.
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
id
object

Один столбец с числовыми ключами для словаря.

Числовой ключ.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
id.
name
string

Обязательное поле. Имя числового ключа.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key
object

Составной ключ для словаря, содержащего один или несколько столбцов с ключами. Подробнее см. в документации ClickHouse.

Составной ключ.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[]
object

Обязательное поле. Поля составного ключа.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin
object

Поле, содержащее начало диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax
object

Поле, содержащее конец диапазона для словарей, которые хранятся в памяти способомRANGE_HASHED. Подробнее см.документации Clickhouse

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[]
object

Обязательное поле. Описание полей, доступных для запросов к базе данных. Подробнее см. в документации Clickhouse.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
name
string

Обязательное поле. Имя столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
type
string

Обязательное поле. Тип столбца.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию false.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout
object
Обязательное поле. Макет для хранения словаря в памяти. Подробное описание см. в документации ClickHouse.

Макет, определяющий способ хранения словаря в памяти.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout.
type
string

Обязательное поле. Тип макета для внешнего словаря.

  • FLAT: Весь словарь хранится в памяти в виде плоских массивов. Доступно для любых источников словарей.
  • HASHED: Весь словарь хранится в памяти в виде хэш-таблицы. Доступно для любых источников словарей.
  • COMPLEX_KEY_HASHED: Аналогичен HASHED, для использования с составными ключами. Доступно для любых источников словарей.
  • RANGE_HASHED: Весь словарь хранится в памяти в виде хэш-таблицы, с упорядоченным массивом диапазонов и соответствующих им значений. Доступно для любых источников словарей.
  • CACHE: Словарь хранится в кэше с заданным количеством ячеек. Доступно для источников словарей MySQL, ClickHouse и HTTP.
  • COMPLEX_KEY_CACHE: Аналогичен CACHE, для использования с составными ключами. Доступно для источников словарей MySQL, ClickHouse и HTTP.
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Количество ячеек в кэше. Округляется до степени двойки. Применимо только для типов макета CACHE и COMPLEX_KEY_CACHE.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
fixedLifetime
string (int64)
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

Жесткий интервал между обновлениями словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange
object
Диапазон интервалов между обновлениями словаря, из которых может выбирать ClickHouse.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Минимальное время жизни словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Максимальное время жизни словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource
object
HTTP-источник для словаря.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource.
url
string

Обязательное поле. URL внешнего словаря, доступного по HTTP.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource.
format
string

Обязательное поле. Формат данных. Допустимые значения: все форматы, поддерживаемые диалектом ClickHouse SQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource
object
MySQL-источник для словаря.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
db
string

Обязательное поле. Имя базы данных MySQL, к которой нужно подключаться.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
table
string

Обязательное поле. Имя таблицы базы данных, которую следует использовать в качестве словаря ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Порт по умолчанию, который нужно использовать при подключении к реплике источника словаря.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
user
string

Имя пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
password
string

Пароль пользователя по умолчанию для реплик источника словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Обязательное поле. Список реплик базы данных MySQL, используемой в качестве источника словаря.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Обязательное поле. Хост реплики MySQL.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Обязательное поле. Приоритет реплики, который ClickHouse должен учитывать при подключении. Реплике с наивысшим приоритетом должно соответствовать наименьшее значение в этом поле.

Значение должно быть больше 0.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Порт, который нужно использовать при подключении к реплике. Если для какой-либо реплики не указан порт, ClickHouse использует порт, указанный для источника.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Имя пользователя базы данных MySQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Пароль пользователя базы данных MySQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
where
string

Критерии выбора данных в указанной таблице MySQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource
object
ClickHouse-источник для словаря.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
db
string

Обязательное поле. Имя базы данных ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
host
string

Обязательное поле. Хост ClickHouse для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
user
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
password
string

Пароль пользователя базы данных ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
where
string

Критерии выбора данных в указанной таблице ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource
object
MongoDB-источник для словаря.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
db
string

Обязательное поле. Имя базы данных MongoDB.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
collection
string

Обязательное поле. Имя коллекции в указанной базе данных, которую следует использовать в качестве источника словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
host
string

Обязательное поле. Хост MongoDB для указанной базы данных.

Максимальная длина строки в символах — 253.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
user
string

Обязательное поле. Имя пользователя базы данных MongoDB.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
password
string

Пароль пользователя базы данных MongoDB.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource
object
PostgreSQL-источник для словаря.
config.clickhouse.config.defaultConfig.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
db
string

Обязательное поле. Имя базы данных PostrgreSQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Обязательное поле. Имя хоста PostrgreSQL.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
user
string

Обязательное поле. Имя пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
password
string

Пароль пользователя базы данных PostrgreSQL.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Режим SSL TCP/IP соединения с хостом PostgreSQL. Есть шесть режимов: disable, allow, prefer (используется по умолчанию), require, verify-ca, verify-full. Дополнительные сведения см. в документации PostgreSQL.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[]
object

Параметры свертки для движка таблицы GraphiteMergeTree.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
name
string

Обязательное поле. Имя указанной комбинации параметров для свертки Graphite.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[]
object

Обязательное поле. Шаблон, используемый для свертки.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
regexp
string

Шаблон для имен метрик.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
function
string

Обязательное поле. Имя агрегирующей функции, которую следует применить к данным старше возраста, указанного в retention.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[]
object

Обязательное поле. Возраст данных, которые следует использовать для прореживания.

Должен содержать хотя бы один элемент.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Минимальный возраст данных в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Точность определения возраста данных, в секундах.

Значение должно быть больше 0.

config.
clickhouse.
config.
defaultConfig.
maxConnections
integer (int64)

Максимальное количество входящих подключений.

Минимальное значение — 10.

config.
clickhouse.
config.
defaultConfig.
maxConcurrentQueries
integer (int64)

Максимальное количество одновременно обрабатываемых запросов.

Минимальное значение — 10.

config.
clickhouse.
config.
defaultConfig.
keepAliveTimeout
integer (int64)

Количество миллисекунд, в течение которых ClickHouse ожидает входящие запросы прежде чем закрыть подключение.

config.
clickhouse.
config.
defaultConfig.
uncompressedCacheSize
integer (int64)

Размер кэша (в байтах) для несжатых данных, используемых таблицами MergeTree. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig.
markCacheSize
integer (int64)

Примерный размер (в байтах) кэша «меток», используемых таблицами MergeTree. Подробнее в документации ClickHouse.

Значение должно быть больше 5368709120.

config.
clickhouse.
config.
defaultConfig.
maxTableSizeToDrop
integer (int64)

Максимальный размер таблицы, которую можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig.
maxPartitionSizeToDrop
integer (int64)

Максимальный размер раздела, который можно удалить с помощью запроса DROP. См. подробное описание в документации Clickhouse.

config.
clickhouse.
config.
defaultConfig.
builtinDictionariesReloadInterval
integer (int64)

Интервал времени для перезагрузки встроенных словарей. См. подробное описание в документации ClickHouse.

config.
clickhouse.
config.
defaultConfig.
timezone
string

Часовой пояс сервера, используемый в преобразованиях полей DateTime. Указывается как идентификатор IANA. См. подробное описание в документации Clickhouse.

config.
clickhouse.
resources
object

Ресурсы, выделенные хостам ClickHouse.

config.
clickhouse.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.

config.
clickhouse.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

config.
clickhouse.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
config.
zookeeper
object

Конфигурация и распределение ресурсов для хостов ZooKeeper.

config.
zookeeper.
resources
object

Ресурсы, выделенные хостам ZooKeeper.

config.
zookeeper.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.

config.
zookeeper.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

config.
zookeeper.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
config.
backupWindowStart
object

Время запуска ежедневного резервного копирования, в часовом поясе UTC.

Описывает время суток. Дата и часовой пояс либо не имеют значения, либо указаны другим образом. API может разрешить високосные секунды. Связанные типы: [google.type.Date][google.type.Date] и google.protobuf.Timestamp.

config.
backupWindowStart.
hours
integer (int32)

Час в 24-часовом формате. Допустимые значения — от 0 до 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия заведения.

config.
backupWindowStart.
minutes
integer (int32)

Минута часа. Допустимые значения — от 0 до 59.

config.
backupWindowStart.
seconds
integer (int32)

Секунда минуты. Обычно допустимые значения — от 0 до 59. API может разрешить значение 60, если поддерживаются високосные секунды.

config.
backupWindowStart.
nanos
integer (int32)

Доли секунды, в наносекундах. Допустимые значения — от 0 до 999 999 999.

networkId string

Идентификатор сети, к которой принадлежит кластер.

health string

Агрегированная работоспособность кластера.

  • HEALTH_UNKNOWN: Состояние кластера неизвестно ([Host.health] для каждого хоста в кластере — UNKNOWN).
  • ALIVE: Кластер работает нормально ([Host.health] для каждого хоста в кластере — ALIVE).
  • DEAD: Кластер не работает ([Host.health] для каждого узла в кластере — DEAD).
  • DEGRADED: Кластер работает неоптимально ([Host.health] по крайней мере для одного узла в кластере не ALIVE).
status string

Текущее состояние кластера.

  • STATUS_UNKNOWN: Состояние кластера неизвестно.
  • CREATING: Кластер создается.
  • RUNNING: Кластер работает нормально.
  • ERROR: На кластере произошла ошибка, блокирующая работу.
  • UPDATING: Кластер изменяется.
  • STOPPING: Кластер останавливается.
  • STOPPED: Кластер остановлен.
  • STARTING: Кластер запускается.

Методы

Метод Описание
addHosts Создает новые хосты для кластера.
addShard Создает новый шард в указанном кластере.
addZookeeper Добавляет подкластер ZooKeeper в указанный кластер ClickHouse.
backup Создает резервную копию для указанного кластера ClickHouse.
create Создает кластер ClickHouse в указанном каталоге.
createExternalDictionary Создает внешний словарь для указанного кластера ClickHouse.
delete Удаляет указанный кластер ClickHouse.
deleteExternalDictionary Удаляет указанный внешний словарь.
deleteHosts Удаляет указанные хосты кластера.
deleteShard Удаляет указанный шард.
get Возвращает указанный ClickHouse-кластер.
getShard Возвращает указанный шард.
list Получает список ClickHouse-кластеров, принадлежащих указанному каталогу.
listBackups Получает список доступных резервных копий для указанного кластера ClickHouse.
listHosts Получает список хостов для указанного кластера.
listLogs Получает логи для указанного кластера ClickHouse. Дополнительные сведения о логах см. в разделе Logs документации.
listOperations Получает список ресурсов Operation для указанного кластера.
listShards Получает список шардов, принадлежащих указанному кластеру.
move Перемещает кластер ClickHouse в указанный каталог.
restore Создает новый кластер ClickHouse с использованием указанной резервной копии.
start Запускает указанный кластер ClickHouse.
stop Останавливает указанный кластер ClickHouse.
update Изменяет указанный кластер ClickHouse.
updateShard Изменяет указанный шард.