> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-3a82795f.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> 辞書キーと属性の設定
# Dictionary 属性
ClickHouse Cloud で Dictionary を使用している場合は、DDLクエリオプションを使用して Dictionary を作成し、`default` ユーザーとして作成してください。
また、サポートされている Dictionary ソースの一覧は、[Cloud Compatibility ガイド](/ja/products/cloud/guides/cloud-compatibility)で確認してください。
`structure` 句では、クエリで使用できる辞書キーとフィールドを定義します。
XML の説明:
```xml theme={null}
Id
...
```
属性は次の要素で表されます:
* `` — キーカラム
* `` — データカラム: 属性は複数指定できます。
DDLクエリ:
```sql theme={null}
CREATE DICTIONARY dict_name (
Id UInt64,
-- 属性
)
PRIMARY KEY Id
...
```
属性はクエリのボディ内で記述します：
* `PRIMARY KEY` — キーカラム
* `AttrName AttrType` — データカラム。属性は複数指定できます。
## キー
ClickHouse は、次の種類のキーをサポートしています。
* 数値キー。`UInt64`。`` タグ、または `PRIMARY KEY` キーワードで定義します。
* 複合キー。異なる型の値の集合。`` タグ、または `PRIMARY KEY` キーワードで定義します。
XML 構造には `` と `` のどちらか一方のみを含めることができます。DDLクエリには `PRIMARY KEY` を1つだけ含める必要があります。
キーを 属性 として記述してはいけません。
### 数値キー
型: `UInt64`。
設定例:
```xml theme={null}
Id
```
設定項目:
* `name` – キーを含むカラム名。
DDLクエリの場合:
```sql theme={null}
CREATE DICTIONARY (
Id UInt64,
...
)
PRIMARY KEY Id
...
```
* `PRIMARY KEY` – キーとなるカラムの名前。
### 複合キー
キーには、任意の型のフィールドからなる`tuple`を指定できます。この場合、[layout](/ja/reference/statements/create/dictionary/layouts/overview)は`complex_key_hashed`または`complex_key_cache`である必要があります。
複合キーは、単一の要素から構成することもできます。これにより、たとえば文字列をキーとして使用できます。
キーの構造は``要素で設定します。キーのフィールドは、Dictionaryの[属性](#attributes)と同じ形式で指定します。例:
```xml theme={null}
field1
String
field2
UInt32
...
...
```
または
```sql theme={null}
CREATE DICTIONARY (
field1 String,
field2 UInt32
...
)
PRIMARY KEY field1, field2
...
```
`dictGet*` 関数へのクエリでは、キーとしてタプルを渡します。例: `dictGetString('dict_name', 'attr_name', tuple('string for field1', num_for_field2))`.
## 属性
設定例:
```xml theme={null}
...
Name
ClickHouseDataType
rand64()
true
true
true
```
または
```sql theme={null}
CREATE DICTIONARY somename (
Name ClickHouseDataType DEFAULT '' EXPRESSION rand64() HIERARCHICAL INJECTIVE IS_OBJECT_ID
)
```
設定フィールド:
| タグ | 説明 | 必須 |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| `name` | カラム名。 | はい |
| `type` | ClickHouseのデータ型: [UInt8](/ja/reference/data-types/int-uint), [UInt16](/ja/reference/data-types/int-uint), [UInt32](/ja/reference/data-types/int-uint), [UInt64](/ja/reference/data-types/int-uint), [Int8](/ja/reference/data-types/int-uint), [Int16](/ja/reference/data-types/int-uint), [Int32](/ja/reference/data-types/int-uint), [Int64](/ja/reference/data-types/int-uint), [Float32](/ja/reference/data-types/float), [Float64](/ja/reference/data-types/float), [UUID](/ja/reference/data-types/uuid), [Decimal32](/ja/reference/data-types/decimal), [Decimal64](/ja/reference/data-types/decimal), [Decimal128](/ja/reference/data-types/decimal), [Decimal256](/ja/reference/data-types/decimal),[Date](/ja/reference/data-types/date), [Date32](/ja/reference/data-types/date32), [DateTime](/ja/reference/data-types/datetime), [DateTime64](/ja/reference/data-types/datetime64), [String](/ja/reference/data-types/string), [Array](/ja/reference/data-types/array).
ClickHouseは、Dictionaryの値を指定されたデータ型にCASTしようとします。たとえばMySQLでは、MySQLのソーステーブル内のフィールドが `TEXT`、`VARCHAR`、または `BLOB` であっても、ClickHouseでは `String` として取り込めます。
[Nullable](/ja/reference/data-types/nullable) は現在、[Flat](/ja/reference/statements/create/dictionary/layouts/flat), [Hashed](/ja/reference/statements/create/dictionary/layouts/hashed), [ComplexKeyHashed](/ja/reference/statements/create/dictionary/layouts/hashed#complex_key_hashed), [Direct](/ja/reference/statements/create/dictionary/layouts/direct), [ComplexKeyDirect](/ja/reference/statements/create/dictionary/layouts/direct#complex_key_direct), [RangeHashed](/ja/reference/statements/create/dictionary/layouts/range-hashed), Polygon, [Cache](/ja/reference/statements/create/dictionary/layouts/cache), [ComplexKeyCache](/ja/reference/statements/create/dictionary/layouts/cache), [SSDCache](/ja/reference/statements/create/dictionary/layouts/ssd-cache), [SSDComplexKeyCache](/ja/reference/statements/create/dictionary/layouts/ssd-cache#complex_key_ssd_cache) Dictionaryでサポートされています。[IPTrie](/ja/reference/statements/create/dictionary/layouts/ip-trie) Dictionaryでは、`Nullable` 型はサポートされていません。 | はい |
| `null_value` | 存在しない要素に対するデフォルト値。
この例では空文字列です。[NULL](/ja/reference/syntax#null) 値を使用できるのは `Nullable` 型のみです (型の説明がある前の行を参照してください) 。 | はい |
| `expression` | ClickHouseが値に対して実行する[Expression](/ja/reference/syntax#expressions)。
この式には、リモートSQLデータベース内のカラム名を指定できます。そのため、リモートカラムの alias を作成するために使用できます。
デフォルト値: 式なし。 | いいえ |
| `hierarchical` | `true` の場合、この属性には現在のキーに対応する親キーの値が含まれます。[Hierarchical Dictionaries](/ja/reference/statements/create/dictionary/layouts/hierarchical) を参照してください。
デフォルト値: `false`。 | いいえ |
| `injective` | `id -> attribute` の写像が[injective](https://en.wikipedia.org/wiki/Injective_function)であるかどうかを示すフラグ。
`true` の場合、ClickHouseは injective な Dictionary に対するリクエストを `GROUP BY` clause の後に自動的に配置できます。通常、これによりそのようなリクエスト数を大幅に減らせます。
デフォルト値: `false`。 | いいえ |
| `is_object_id` | MongoDBドキュメントに対するクエリが `ObjectID` によって実行されるかどうかを示すフラグ。
デフォルト値: `false`。 | |