Attributs du dictionnaire

La clause structure décrit la clé du dictionnaire et les champs disponibles pour les requêtes.

Description XML :

<dictionary>
    <structure>
        <id>
            <name>Id</name>
        </id>

        <attribute>
            <!-- Attribute parameters -->
        </attribute>

        ...

    </structure>
</dictionary>

Les attributs sont décrits dans les éléments :

• <id> — colonne clé
• <attribute> — colonne de données : il peut y avoir plusieurs attributs.

Requête DDL :

CREATE DICTIONARY dict_name (
    Id UInt64,
    -- attributes
)
PRIMARY KEY Id
...

Les attributs sont décrits dans le corps de la requête :

• PRIMARY KEY — Colonne clé
• AttrName AttrType — Colonne de données. Il peut y avoir plusieurs attributs.

ClickHouse prend en charge les types de clés suivants :

• Clé numérique. UInt64. Définie dans la balise <id> ou à l’aide du mot-clé PRIMARY KEY.
• Clé composite. Ensemble de valeurs de types différents. Définie dans la balise <key> ou à l’aide du mot-clé PRIMARY KEY.

Une structure XML peut contenir soit <id>, soit <key>. La requête DDL ne doit contenir qu’une seule PRIMARY KEY.

Type : UInt64.

Exemple de configuration :

<id>
    <name>Id</name>
</id>

Champs de configuration :

• name – Le nom de la colonne contenant les clés.

Pour la requête DDL :

CREATE DICTIONARY (
    Id UInt64,
    ...
)
PRIMARY KEY Id
...

• PRIMARY KEY – Le nom de la colonne contenant les clés.

La clé peut être un tuple composé de champs de n’importe quel type. Le layout doit alors être complex_key_hashed ou complex_key_cache.

La structure de la clé est définie dans l’élément <key>. Les champs de la clé sont spécifiés dans le même format que les attributs du dictionnaire. Exemple :

<structure>
    <key>
        <attribute>
            <name>field1</name>
            <type>String</type>
        </attribute>
        <attribute>
            <name>field2</name>
            <type>UInt32</type>
        </attribute>
        ...
    </key>
...

ou

CREATE DICTIONARY (
    field1 String,
    field2 UInt32
    ...
)
PRIMARY KEY field1, field2
...

Pour une requête adressée à la fonction dictGet*, un tuple est utilisé comme clé. Exemple : dictGetString('dict_name', 'attr_name', tuple('string for field1', num_for_field2)).

Lorsque la clé composite est constituée d’un seul attribut, la valeur de la clé peut être transmise directement, sans être encapsulée dans tuple. Par exemple, dictGetString('dict_name', 'attr_name', 'key') et dictGetString('dict_name', 'attr_name', tuple('key')) sont tous deux valides.

Exemple de configuration :

<structure>
    ...
    <attribute>
        <name>Name</name>
        <type>ClickHouseDataType</type>
        <null_value></null_value>
        <expression>rand64()</expression>
        <hierarchical>true</hierarchical>
        <injective>true</injective>
        <is_object_id>true</is_object_id>
    </attribute>
</structure>

ou

CREATE DICTIONARY somename (
    Name ClickHouseDataType DEFAULT '' EXPRESSION rand64() HIERARCHICAL INJECTIVE IS_OBJECT_ID
)

Champs de configuration :