ClickHouse/docs/zh/sql-reference/dictionaries/external-dictionaries/external-dicts-dict-structure.md

slug	machine_translated	machine_translated_rev	sidebar_position	sidebar_label
/zh/sql-reference/dictionaries/external-dictionaries/external-dicts-dict-structure	true	72537a2d52	44	字典键和字段

字典键和字段

该 <structure> 子句描述可用于查询的字典键和字段。

XML描述:

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

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

        ...

    </structure>
</dictionary>

属性在元素中描述:

• <id> — 键列.
• <attribute> — 数据列. 可以有多个属性。

DDL查询:

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

查询正文中描述了属性:

• PRIMARY KEY — 键列
• AttrName AttrType — 数据列. 可以有多个属性。

键

ClickHouse支持以下类型的键:

• 数字键。 UInt64. 在定义 <id> 标记或使用 PRIMARY KEY 关键字。
• 复合密钥。 组不同类型的值。 在标签中定义 <key> 或 PRIMARY KEY 关键字。

Xml结构可以包含 <id> 或 <key>. DDL-查询必须包含单个 PRIMARY KEY.

!!! warning "警告" 不能将键描述为属性。

数字键

类型: UInt64.

配置示例:

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

配置字段:

• name – The name of the column with keys.

对于DDL-查询:

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

• PRIMARY KEY – The name of the column with keys.

复合密钥

关键可以是一个 tuple 从任何类型的字段。 该 布局 在这种情况下，必须是 complex_key_hashed 或 complex_key_cache.

!!! tip "提示" 复合键可以由单个元素组成。 例如，这使得可以使用字符串作为键。

键结构在元素中设置 <key>. 键字段的格式与字典的格式相同 属性. 示例:

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

或

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

对于查询 dictGet* 函数中，一个元组作为键传递。 示例: dictGetString('dict_name', 'attr_name', tuple('string for field1', num_for_field2)).

属性

配置示例:

<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>

或

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

配置字段:

标签	产品描述	必填项
name	列名称。	是
type	ClickHouse数据类型。 ClickHouse尝试将字典中的值转换为指定的数据类型。 例如，对于MySQL，该字段可能是 TEXT, VARCHAR，或 BLOB 在MySQL源表中，但它可以上传为 String 在克里克豪斯 可为空 不支持。	是
null_value	非现有元素的默认值。 在示例中，它是一个空字符串。 你不能使用 NULL 在这个领域。	是
expression	表达式 ClickHouse对该值执行。 表达式可以是远程SQL数据库中的列名。 因此，您可以使用它为远程列创建别名。 默认值：无表达式。	非也。
hierarchical	如果 true，该属性包含当前键的父键值。 看 分层字典. 默认值: false.	非也。
injective	标志，显示是否 id -> attribute 图像是 注射. 如果 true，ClickHouse可以自动放置后 GROUP BY 子句注入字典的请求。 通常它显着减少了这种请求的数量。 默认值: false.	非也。
is_object_id	显示是否通过以下方式对MongoDB文档执行查询的标志 ObjectID. 默认值: false.	非也。

另请参阅

• 使用外部字典的函数.