system.disk_types

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

Описание

Содержит список типов дисков, поддерживаемых сервером, а также встроенную документацию для каждого типа. Тип диска задаётся в поле type конфигурации диска и определяет, где и как диск хранит свои данные (локальная файловая система, Объектное хранилище, кэш поверх другого диска и т. д.).

Обратите внимание: в этой таблице перечислены доступные типы дисков, тогда как в system.disks перечислены экземпляры дисков, настроенные на сервере.

Столбцы

• name (String) — Название типа диска, указанное в type конфигурации диска.
• description (String) — Общее описание назначения типа диска.
• syntax (String) — Как указывается тип диска в конфигурации диска.
• examples (String) — Примеры использования.
• introduced_in (String) — Версия ClickHouse, в которой этот тип диска был впервые представлен, в формате major.minor.
• related (Array(String)) — Названия связанных типов дисков.

Примеры конфигурации

Диск можно настроить двумя способами: статически, в файлах конфигурации сервера (XML или YAML), или динамически, в настройках запроса CREATE/ATTACH с помощью функции disk. В обоих случаях поддерживаются один и тот же тип диска и один и тот же набор параметров.

Статическая конфигурация

Диски задаются в разделе storage_configuration конфигурации сервера. В следующем примере определены диск s3 и использующая его политика хранения.

config.xml

<clickhouse>
    <storage_configuration>
        <disks>
            <s3_disk>
                <type>s3</type>
                <endpoint>https://s3.eu-west-1.amazonaws.com/clickhouse-eu-west-1.clickhouse.com/data/</endpoint>
                <use_environment_credentials>1</use_environment_credentials>
            </s3_disk>
        </disks>
        <policies>
            <s3_policy>
                <volumes>
                    <main>
                        <disk>s3_disk</disk>
                    </main>
                </volumes>
            </s3_policy>
        </policies>
    </storage_configuration>
</clickhouse>

Та же конфигурация в YAML:

config.yaml

storage_configuration:
  disks:
    s3_disk:
      type: s3
      endpoint: https://s3.eu-west-1.amazonaws.com/clickhouse-eu-west-1.clickhouse.com/data/
      use_environment_credentials: 1
  policies:
    s3_policy:
      volumes:
        main:
          disk: s3_disk

Затем таблица может использовать диск через свою политику хранения:

Query

CREATE TABLE test (a Int32, b String)
ENGINE = MergeTree() ORDER BY a
SETTINGS storage_policy = 's3_policy';

Динамическая конфигурация

Диск также можно определить прямо в параметрах запроса CREATE/ATTACH, без предварительного объявления диска в конфигурационных файлах, с помощью функции disk:

Query

CREATE TABLE test (a Int32, b String)
ENGINE = MergeTree() ORDER BY a
SETTINGS disk = disk(
    type = s3,
    endpoint = 'https://s3.eu-west-1.amazonaws.com/clickhouse-eu-west-1.clickhouse.com/data/',
    use_environment_credentials = 1
);

См. Настройка внешнего хранилища, где приведён полный список параметров для каждого типа диска.

Пример

Query

SELECT name, description
FROM system.disk_types
WHERE name IN ('local', 'object_storage')
ORDER BY name

См. также

• system.disks — Диски, настроенные на сервере.
• system.storage_policies — Политики хранения и тома.