Метод listShards

Получает список шардов, принадлежащих указанному кластеру.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/shards

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера ClickHouse, для которого нужно вывести список шардов. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
pageToken Номер страницы. Чтобы получить следующую страницу результатов, установите значение pageToken равным значению поля nextPageToken прошлого запроса. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "shards": [
    {
      "name": "string",
      "clusterId": "string",
      "config": {
        "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"
                  },

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

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

                  // `shards[].config.clickhouse.config.defaultConfig.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // конец списка возможных полей`shards[].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",
              "geobaseUri": "string"
            }
          },
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          },
          "weight": "integer"
        }
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
shards[] object

Список шардов ClickHouse.

shards[].
name
string

Имя шарда.

shards[].
clusterId
string

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

shards[].
config
object

Конфигурация шарда.

shards[].
config.
clickhouse
object

Конфигурация ClickHouse для шарда.

shards[].
config.
clickhouse.
config
object

Настройки ClickHouse для шарда.

shards[].
config.
clickhouse.
config.
effectiveConfig
object

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

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
logLevel
string

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree
object

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
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.
shards[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Режим SSL TCP/IP соединения с хостом PostgreSQL. Дополнительные сведения см. в документации PostgreSQL.

  • DISABLE: SSL-соединение не используется.
  • ALLOW: Сначала предпринимается попытка установить незашифрованное соединение. Если это не удается, устанавливается SSL-соединение.
  • PREFER: Сначала предпринимается попытка установить SSL-соединение. Если это не удается, устанавливается незашифрованное соединение.
  • VERIFY_CA: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации (CA).
  • VERIFY_FULL: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации и что имя хоста сервера совпадает с указанным в сертификате.
shards[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[]
object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxConnections
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxConcurrentQueries
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
keepAliveTimeout
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
uncompressedCacheSize
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
markCacheSize
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxTableSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxPartitionSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
builtinDictionariesReloadInterval
integer (int64)

Параметр устарел и не имеет никакого эффекта.

shards[].
config.
clickhouse.
config.
effectiveConfig.
timezone
string

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
geobaseUri
string
shards[].
config.
clickhouse.
config.
userConfig
object

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

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

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

shards[].
config.
clickhouse.
config.
userConfig.
logLevel
string

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

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree
object

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

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

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
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.
shards[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Режим SSL TCP/IP соединения с хостом PostgreSQL. Дополнительные сведения см. в документации PostgreSQL.

  • DISABLE: SSL-соединение не используется.
  • ALLOW: Сначала предпринимается попытка установить незашифрованное соединение. Если это не удается, устанавливается SSL-соединение.
  • PREFER: Сначала предпринимается попытка установить SSL-соединение. Если это не удается, устанавливается незашифрованное соединение.
  • VERIFY_CA: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации (CA).
  • VERIFY_FULL: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации и что имя хоста сервера совпадает с указанным в сертификате.
shards[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[]
object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
config.
clickhouse.
config.
userConfig.
maxConnections
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
userConfig.
maxConcurrentQueries
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
userConfig.
keepAliveTimeout
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
uncompressedCacheSize
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
markCacheSize
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
userConfig.
maxTableSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
maxPartitionSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
builtinDictionariesReloadInterval
integer (int64)

Параметр устарел и не имеет никакого эффекта.

shards[].
config.
clickhouse.
config.
userConfig.
timezone
string

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

shards[].
config.
clickhouse.
config.
userConfig.
geobaseUri
string
shards[].
config.
clickhouse.
config.
defaultConfig
object

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

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
logLevel
string

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

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree
object

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
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.
shards[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Режим SSL TCP/IP соединения с хостом PostgreSQL. Дополнительные сведения см. в документации PostgreSQL.

  • DISABLE: SSL-соединение не используется.
  • ALLOW: Сначала предпринимается попытка установить незашифрованное соединение. Если это не удается, устанавливается SSL-соединение.
  • PREFER: Сначала предпринимается попытка установить SSL-соединение. Если это не удается, устанавливается незашифрованное соединение.
  • VERIFY_CA: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации (CA).
  • VERIFY_FULL: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации и что имя хоста сервера совпадает с указанным в сертификате.
shards[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[]
object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
maxConnections
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
maxConcurrentQueries
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
keepAliveTimeout
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
uncompressedCacheSize
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
markCacheSize
integer (int64)

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
maxTableSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
maxPartitionSizeToDrop
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
builtinDictionariesReloadInterval
integer (int64)

Параметр устарел и не имеет никакого эффекта.

shards[].
config.
clickhouse.
config.
defaultConfig.
timezone
string

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

shards[].
config.
clickhouse.
config.
defaultConfig.
geobaseUri
string
shards[].
config.
clickhouse.
resources
object

Вычислительные ресурсы для шарда.

shards[].
config.
clickhouse.
resources.
resourcePresetId
string

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

shards[].
config.
clickhouse.
resources.
diskSize
string (int64)

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

shards[].
config.
clickhouse.
resources.
diskTypeId
string

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

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
shards[].
config.
clickhouse.
weight
integer (int64)

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

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.