system.disk_types

Table système contenant la liste des types de disque pris en charge par le serveur, ainsi que leur documentation intégrée.

Description

Contient la liste des types de disque pris en charge par le serveur, ainsi que la documentation intégrée de chaque type. Un type de disque est spécifié dans le type d’une configuration de disque et détermine où et comment un disque stocke ses données (système de fichiers local, object storage, cache sur un autre disque, etc.).

Notez que cette table répertorie les types de disque disponibles, tandis que system.disks répertorie les instances de disque configurées sur le serveur.

Colonnes

• name (String) — Le nom du type de disque, tel qu’il est indiqué dans le champ type d’une configuration de disque.
• description (String) — Une description générale du rôle du type de disque.
• syntax (String) — La manière dont le type de disque est spécifié dans une configuration de disque.
• examples (String) — Exemples d’utilisation.
• introduced_in (String) — La version de ClickHouse dans laquelle le type de disque a été introduit pour la première fois, sous la forme major.minor.
• related (Array(String)) — Les noms des types de disque associés.

Exemples de configuration

Un disque peut être configuré de deux manières : statiquement, dans les fichiers de configuration du serveur (XML ou YAML), ou dynamiquement, dans les paramètres d’une requête CREATE/ATTACH à l’aide de la fonction disk. Le même type de disque et les mêmes paramètres sont pris en charge dans les deux cas.

Configuration statique

Les disques sont définis dans storage_configuration de la configuration du serveur. L’exemple suivant définit un disque s3 et une stratégie de stockage qui l’utilise.

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>

La même configuration au format 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

Une table peut ensuite utiliser le disque grâce à sa stratégie de stockage :

Query

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

Configuration dynamique

Un disque peut également être défini directement dans les paramètres d’une requête CREATE/ATTACH, sans disque prédéfini dans les fichiers de configuration, à l’aide de la fonction 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
);

Consultez Configurer le stockage externe pour obtenir la liste complète des paramètres de chaque type de disque.

Exemple

Query

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

Voir aussi

• system.disks — Les disques configurés sur le serveur.
• system.storage_policies — Les stratégies de stockage et les volumes.