> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Dictionary を操作する関数のドキュメント

# Dictionary を操作する関数

<Note>
  [DDLクエリ](/ja/reference/statements/create/dictionary) で作成された辞書では、`dict_name` parameter は `<database>.<dict_name>` のように完全修飾で指定する必要があります。そうしないと、現在の database が使用されます。
</Note>

辞書の接続方法と設定については、[Dictionaries](/ja/reference/statements/create/dictionary) を参照してください。

<div id="example-dictionary">
  ## 辞書の例
</div>

このセクションの例では、以下の Dictionary を使用します。以下で説明する関数の例を実行するには、
これらを ClickHouse に作成してください。

<Accordion title="dictGet\<T\> 関数および dictGet\<T\>OrDefault 関数用の Dictionary の例">
  ```sql theme={null}
  -- 必要なすべてのデータ型を持つテーブルを作成
  CREATE TABLE all_types_test (
      `id` UInt32,
      
      -- String 型
      `String_value` String,
      
      -- 符号なし整数型
      `UInt8_value` UInt8,
      `UInt16_value` UInt16,
      `UInt32_value` UInt32,
      `UInt64_value` UInt64,
      
      -- 符号付き整数型
      `Int8_value` Int8,
      `Int16_value` Int16,
      `Int32_value` Int32,
      `Int64_value` Int64,
      
      -- 浮動小数点型
      `Float32_value` Float32,
      `Float64_value` Float64,
      
      -- 日付/時刻型
      `Date_value` Date,
      `DateTime_value` DateTime,
      
      -- ネットワーク型
      `IPv4_value` IPv4,
      `IPv6_value` IPv6,
      
      -- UUID 型
      `UUID_value` UUID
  ) ENGINE = MergeTree() 
  ORDER BY id;
  ```

  ```sql theme={null}
  -- テストデータを挿入
  INSERT INTO all_types_test VALUES
  (
      1,                              -- id
      'ClickHouse',                   -- String
      100,                            -- UInt8
      5000,                           -- UInt16
      1000000,                        -- UInt32
      9223372036854775807,            -- UInt64
      -100,                           -- Int8
      -5000,                          -- Int16
      -1000000,                       -- Int32
      -9223372036854775808,           -- Int64
      123.45,                         -- Float32
      987654.123456,                  -- Float64
      '2024-01-15',                   -- Date
      '2024-01-15 10:30:00',          -- DateTime
      '192.168.1.1',                  -- IPv4
      '2001:db8::1',                  -- IPv6
      '550e8400-e29b-41d4-a716-446655440000' -- UUID
  )
  ```

  ```sql theme={null}
  -- Dictionary を作成
  CREATE DICTIONARY all_types_dict
  (
      id UInt32,
      String_value String,
      UInt8_value UInt8,
      UInt16_value UInt16,
      UInt32_value UInt32,
      UInt64_value UInt64,
      Int8_value Int8,
      Int16_value Int16,
      Int32_value Int32,
      Int64_value Int64,
      Float32_value Float32,
      Float64_value Float64,
      Date_value Date,
      DateTime_value DateTime,
      IPv4_value IPv4,
      IPv6_value IPv6,
      UUID_value UUID
  )
  PRIMARY KEY id
  SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'all_types_test' DB 'default'))
  LAYOUT(HASHED())
  LIFETIME(MIN 300 MAX 600);
  ```
</Accordion>

<Accordion title="dictGetAll 用の Dictionary の例">
  regexp tree Dictionary 用のデータを格納するテーブルを作成します。

  ```sql theme={null}
  CREATE TABLE regexp_os(
      id UInt64,
      parent_id UInt64,
      regexp String,
      keys Array(String),
      values Array(String)
  )
  ENGINE = Memory;
  ```

  テーブルにデータを挿入します。

  ```sql theme={null}
  INSERT INTO regexp_os 
  SELECT *
  FROM s3(
      'https://datasets-documentation.s3.eu-west-3.amazonaws.com/' ||
      'user_agent_regex/regexp_os.csv'
  );
  ```

  regexp tree Dictionary を作成します。

  ```sql theme={null}
  CREATE DICTIONARY regexp_tree
  (
      regexp String,
      os_replacement String DEFAULT 'Other',
      os_v1_replacement String DEFAULT '0',
      os_v2_replacement String DEFAULT '0',
      os_v3_replacement String DEFAULT '0',
      os_v4_replacement String DEFAULT '0'
  )
  PRIMARY KEY regexp
  SOURCE(CLICKHOUSE(TABLE 'regexp_os'))
  LIFETIME(MIN 0 MAX 0)
  LAYOUT(REGEXP_TREE);
  ```
</Accordion>

<Accordion title="範囲キー辞書の例">
  入力テーブルを作成します:

  ```sql theme={null}
  CREATE TABLE range_key_dictionary_source_table
  (
      key UInt64,
      start_date Date,
      end_date Date,
      value String,
      value_nullable Nullable(String)
  )
  ENGINE = TinyLog();
  ```

  入力テーブルにデータを挿入します:

  ```sql theme={null}
  INSERT INTO range_key_dictionary_source_table VALUES(1, toDate('2019-05-20'), toDate('2019-05-20'), 'First', 'First');
  INSERT INTO range_key_dictionary_source_table VALUES(2, toDate('2019-05-20'), toDate('2019-05-20'), 'Second', NULL);
  INSERT INTO range_key_dictionary_source_table VALUES(3, toDate('2019-05-20'), toDate('2019-05-20'), 'Third', 'Third');
  ```

  辞書を作成します:

  ```sql theme={null}
  CREATE DICTIONARY range_key_dictionary
  (
      key UInt64,
      start_date Date,
      end_date Date,
      value String,
      value_nullable Nullable(String)
  )
  PRIMARY KEY key
  SOURCE(CLICKHOUSE(HOST 'localhost' PORT tcpPort() TABLE 'range_key_dictionary_source_table'))
  LIFETIME(MIN 1 MAX 1000)
  LAYOUT(RANGE_HASHED())
  RANGE(MIN start_date MAX end_date);
  ```
</Accordion>

<Accordion title="複合キー辞書の例">
  ソーステーブルを作成します:

  ```sql theme={null}
  CREATE TABLE dict_mult_source
  (
  id UInt32,
  c1 UInt32,
  c2 String
  ) ENGINE = Memory;
  ```

  ソーステーブルにデータを挿入します:

  ```sql theme={null}
  INSERT INTO dict_mult_source VALUES
  (1, 1, '1'),
  (2, 2, '2'),
  (3, 3, '3');
  ```

  辞書を作成します:

  ```sql theme={null}
  CREATE DICTIONARY ext_dict_mult
  (
      id UInt32,
      c1 UInt32,
      c2 String
  )
  PRIMARY KEY id
  SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'dict_mult_source' DB 'default'))
  LAYOUT(FLAT())
  LIFETIME(MIN 0 MAX 0);
  ```
</Accordion>

<Accordion title="階層型辞書の例">
  ソーステーブルを作成します:

  ```sql theme={null}
  CREATE TABLE hierarchy_source
  (
    id UInt64,
    parent_id UInt64,
    name String
  ) ENGINE = Memory;
  ```

  ソーステーブルにデータを挿入します:

  ```sql theme={null}
  INSERT INTO hierarchy_source VALUES
  (0, 0, 'Root'),
  (1, 0, 'Level 1 - Node 1'),
  (2, 1, 'Level 2 - Node 2'),
  (3, 1, 'Level 2 - Node 3'),
  (4, 2, 'Level 3 - Node 4'),
  (5, 2, 'Level 3 - Node 5'),
  (6, 3, 'Level 3 - Node 6');

  -- 0 (ルート)
  -- └── 1 (レベル 1 - ノード 1)
  --     ├── 2 (レベル 2 - ノード 2)
  --     │   ├── 4 (レベル 3 - ノード 4)
  --     │   └── 5 (レベル 3 - ノード 5)
  --     └── 3 (レベル 2 - ノード 3)
  --         └── 6 (レベル 3 - ノード 6)
  ```

  辞書を作成します:

  ```sql theme={null}
  CREATE DICTIONARY hierarchical_dictionary
  (
      id UInt64,
      parent_id UInt64 HIERARCHICAL,
      name String
  )
  PRIMARY KEY id
  SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'hierarchy_source' DB 'default'))
  LAYOUT(HASHED())
  LIFETIME(MIN 300 MAX 600);
  ```
</Accordion>

{/*AUTOGENERATED_START*/}

<div id="dictGet">
  ## dictGet
</div>

導入バージョン: v18.16.0

Dictionary から値を取得します。

**構文**

```sql theme={null}
dictGet('dict_name', attr_names, id_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_names` — Dictionary のカラム名、またはカラム名のタプル。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キーの値。UInt64/Tuple(T) を返す式。[`UInt64`](/ja/reference/data-types/int-uint) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

キーが見つかった場合は、id\_expr に対応する Dictionary 属性の値を返します。
キーが見つからない場合は、Dictionary 設定でその属性に指定された `<null_value>` 要素の内容を返します。

**例**

**単一の属性を取得する**

```sql title=Query theme={null}
SELECT dictGet('ext_dict_test', 'c1', toUInt64(1)) AS val
```

```response title=Response theme={null}
1
```

**複数属性**

```sql title=Query theme={null}
SELECT
    dictGet('ext_dict_mult', ('c1','c2'), number + 1) AS val,
    toTypeName(val) AS type
FROM system.numbers
LIMIT 3;
```

```response title=Response theme={null}
┌─val─────┬─type───────────┐
│ (1,'1') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
│ (2,'2') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
│ (3,'3') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
└─────────┴────────────────┘
```

<div id="dictGetAll">
  ## dictGetAll
</div>

導入バージョン: v23.5.0

Dictionary の属性値を、Dictionary の設定にかかわらず `All` データ型に変換します。

**構文**

```sql theme={null}
dictGetAll(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — Dictionary の名前。 [`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (Dictionary の設定に依存) 。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
対応する値がない場合は、Dictionary の設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、または値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT
    'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36' AS user_agent,

    -- 該当するすべてのパターンに一致します
    dictGetAll('regexp_tree', 'os_replacement', 'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36') AS all_matches,

    -- 最初の一致のみを返します
    dictGet('regexp_tree', 'os_replacement', 'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36') AS first_match;
```

```response title=Response theme={null}
┌─user_agent─────────────────────────────────────────────────────┬─all_matches─────────────────────────────┬─first_match─┐
│ Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36 │ ['Android','Android','Android','Linux'] │ Android     │
└────────────────────────────────────────────────────────────────┴─────────────────────────────────────────┴─────────────┘
```

<div id="dictGetChildren">
  ## dictGetChildren
</div>

導入バージョン: v21.4.0

第1階層の子を索引の配列として返します。これは [dictGetHierarchy](#dictGetHierarchy) の逆変換にあたります。

**構文**

```sql theme={null}
dictGetChildren(dict_name, key)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `key` — 確認対象のキー。[`const String`](/ja/reference/data-types/string)

**戻り値**

キーの第1レベルの子要素を返します。[`Array(UInt64)`](/ja/reference/data-types/array)

**例**

**辞書の第1レベルの子要素を取得する**

```sql title=Query theme={null}
SELECT dictGetChildren('hierarchical_dictionary', 2);
```

```response title=Response theme={null}
┌─dictGetChild⋯ionary', 2)─┐
│ [4,5]                    │
└──────────────────────────┘
```

<div id="dictGetDate">
  ## dictGetDate
</div>

導入バージョン: v1.1.0

Dictionaryの属性値を、Dictionaryの設定にかかわらず`Date`データ型に変換します。

**構文**

```sql theme={null}
dictGetDate(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetDate('all_types_dict', 'Date_value', 1)
```

```response title=Response theme={null}
┌─dictGetDate(⋯_value', 1)─┐
│               2020-01-01 │
└──────────────────────────┘
```

<div id="dictGetDateOrDefault">
  ## dictGetDateOrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、辞書 attribute の値を `Date` データ型に変換し、秘密鍵 が見つからない場合は指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetDateOrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (Dictionary の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — Dictionary に `id_expr` キーを持つ行が含まれていない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
それ以外の場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetDate('all_types_dict', 'Date_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetDateOrDefault('all_types_dict', 'Date_value', 999, toDate('1970-01-01'));
```

```response title=Response theme={null}
┌─dictGetDate(⋯_value', 1)─┐
│               2024-01-15 │
└──────────────────────────┘
┌─dictGetDateO⋯70-01-01'))─┐
│               1970-01-01 │
└──────────────────────────┘
```

<div id="dictGetDateTime">
  ## dictGetDateTime
</div>

導入バージョン: v1.1.0

辞書設定に関係なく、辞書属性の値を`DateTime`データ型に変換します。

**構文**

```sql theme={null}
dictGetDateTime(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
それ以外の場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  属性の値をパースできない場合、または値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetDateTime('all_types_dict', 'DateTime_value', 1)
```

```response title=Response theme={null}
┌─dictGetDateT⋯_value', 1)─┐
│      2024-01-15 10:30:00 │
└──────────────────────────┘
```

<div id="dictGetDateTimeOrDefault">
  ## dictGetDateTimeOrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、Dictionary の属性値を `DateTime` データ型に変換します。キーが見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetDateTimeOrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キーの値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行がない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetDateTime('all_types_dict', 'DateTime_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetDateTimeOrDefault('all_types_dict', 'DateTime_value', 999, toDateTime('1970-01-01 00:00:00'));
```

```response title=Response theme={null}
┌─dictGetDateT⋯_value', 1)─┐
│      2024-01-15 10:30:00 │
└──────────────────────────┘
┌─dictGetDateT⋯0:00:00'))──┐
│      1970-01-01 00:00:00 │
└──────────────────────────┘
```

<div id="dictGetDescendants">
  ## dictGetDescendants
</div>

導入バージョン: v21.4.0

[`dictGetChildren`](#dictGetChildren) 関数を `level` 回再帰的に適用した場合と同様に、すべての子孫ノードを返します。

**構文**

```sql theme={null}
dictGetDescendants(dict_name, key, level)
```

**引数**

* `dict_name` — Dictionary 名。[`String`](/ja/reference/data-types/string)
* `key` — 確認するキー。[`const String`](/ja/reference/data-types/string)
* `level` — 確認するキーの階層レベル。`level = 0` の場合は、末端まですべての子孫を返します。[`UInt8`](/ja/reference/data-types/int-uint)

**戻り値**

キーの子孫を返します。[`Array(UInt64)`](/ja/reference/data-types/array)

**例**

**Dictionary の第1レベルの子を取得する**

```sql title=Query theme={null}
-- 以下の階層型Dictionaryを考える:
-- 0 (ルート)
-- └── 1 (レベル1 - ノード1)
--     ├── 2 (レベル2 - ノード2)
--     │   ├── 4 (レベル3 - ノード4)
--     │   └── 5 (レベル3 - ノード5)
--     └── 3 (レベル2 - ノード3)
--         └── 6 (レベル3 - ノード6)

SELECT dictGetDescendants('hierarchical_dictionary', 0, 2)
```

```response title=Response theme={null}
┌─dictGetDesce⋯ary', 0, 2)─┐
│ [3,2]                    │
└──────────────────────────┘
```

<div id="dictGetFloat32">
  ## dictGetFloat32
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、Dictionary の設定にかかわらず `Float32` データ型に変換します。

**構文**

```sql theme={null}
dictGetFloat32(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、または値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetFloat32('all_types_dict', 'Float32_value', 1)
```

```response title=Response theme={null}
┌─dictGetFloat⋯_value', 1)─┐
│               -123.123   │
└──────────────────────────┘
```

<div id="dictGetFloat32OrDefault">
  ## dictGetFloat32OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、Dictionary の属性値を `Float32` 型に変換します。秘密鍵が見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetFloat32OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当しない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetFloat32('all_types_dict', 'Float32_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（-1.0）を返す
SELECT dictGetFloat32OrDefault('all_types_dict', 'Float32_value', 999, -1.0);
```

```response title=Response theme={null}
┌─dictGetFloat⋯_value', 1)─┐
│                   123.45 │
└──────────────────────────┘
┌─dictGetFloat⋯e', 999, -1)─┐
│                       -1  │
└───────────────────────────┘
```

<div id="dictGetFloat64">
  ## dictGetFloat64
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、Dictionary の設定に関係なく `Float64` データ型に変換します。

**構文**

```sql theme={null}
dictGetFloat64(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書の属性値を返します。
該当しない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetFloat64('all_types_dict', 'Float64_value', 1)
```

```response title=Response theme={null}
┌─dictGetFloat⋯_value', 1)─┐
│                 -123.123 │
└──────────────────────────┘
```

<div id="dictGetFloat64OrDefault">
  ## dictGetFloat64OrDefault
</div>

導入バージョン: v1.1.0

辞書の設定にかかわらず、辞書属性の値を `Float64` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetFloat64OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。 [`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetFloat64('all_types_dict', 'Float64_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（nan）を返す
SELECT dictGetFloat64OrDefault('all_types_dict', 'Float64_value', 999, nan);
```

```response title=Response theme={null}
┌─dictGetFloat⋯_value', 1)─┐
│            987654.123456 │
└──────────────────────────┘
┌─dictGetFloat⋯, 999, nan)─┐
│                      nan │
└──────────────────────────┘
```

<div id="dictGetHierarchy">
  ## dictGetHierarchy
</div>

導入バージョン: v1.1.0

[階層型Dictionary](/ja/reference/statements/create/dictionary/layouts/hierarchical#hierarchical-dictionaries) 内で、キーのすべての親を含む配列を作成します。

**構文**

```sql theme={null}
dictGetHierarchy(dict_name, key)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `key` — キー値。[`const String`](/ja/reference/data-types/string)

**戻り値**

キーに対応する親を返します。[`Array(UInt64)`](/ja/reference/data-types/array)

**例**

**キーの階層を取得**

```sql title=Query theme={null}
SELECT dictGetHierarchy('hierarchical_dictionary', 5)
```

```response title=Response theme={null}
┌─dictGetHiera⋯ionary', 5)─┐
│ [5,2,1]                  │
└──────────────────────────┘
```

<div id="dictGetIPv4">
  ## dictGetIPv4
</div>

導入バージョン: v1.1.0

Dictionary の設定に関係なく、Dictionary 属性の値を `IPv4` データ型に変換します。

**構文**

```sql theme={null}
dictGetIPv4(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。 [`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に対して指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合、例外を送出します。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetIPv4('all_types_dict', 'IPv4_value', 1)
```

```response title=Response theme={null}
┌─dictGetIPv4('all_⋯ 'IPv4_value', 1)─┐
│ 192.168.0.1                         │
└─────────────────────────────────────┘
```

<div id="dictGetIPv4OrDefault">
  ## dictGetIPv4OrDefault
</div>

導入バージョン: v23.1.0

Dictionary の設定にかかわらず、辞書の属性値を `IPv4` データ型に変換します。キーが見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetIPv4OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetIPv4('all_types_dict', 'IPv4_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetIPv4OrDefault('all_types_dict', 'IPv4_value', 999, toIPv4('0.0.0.0'));
```

```response title=Response theme={null}
┌─dictGetIPv4('all_⋯ 'IPv4_value', 1)─┐
│ 192.168.0.1                         │
└─────────────────────────────────────┘
┌─dictGetIPv4OrDefa⋯0.0.0.0'))─┐
│ 0.0.0.0                      │
└──────────────────────────────┘
```

<div id="dictGetIPv6">
  ## dictGetIPv6
</div>

導入バージョン: v23.1.0

Dictionary の設定にかかわらず、辞書属性の値を `IPv6` データ型に変換します。

**構文**

```sql theme={null}
dictGetIPv6(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。 [`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キーの値。辞書キー型の値またはタプル値を返す式 (辞書の設定に依存) 。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書の設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetIPv6('all_types_dict', 'IPv6_value', 1)
```

```response title=Response theme={null}
┌─dictGetIPv6('all_⋯ 'IPv6_value', 1)─┐
│ 2001:db8:85a3::8a2e:370:7334        │
└─────────────────────────────────────┘
```

<div id="dictGetIPv6OrDefault">
  ## dictGetIPv6OrDefault
</div>

導入バージョン: v23.1.0

辞書設定にかかわらず、辞書属性の値を `IPv6` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetIPv6OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetIPv6('all_types_dict', 'IPv6_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetIPv6OrDefault('all_types_dict', 'IPv6_value', 999, '::1'::IPv6);
```

```response title=Response theme={null}
┌─dictGetIPv6('all_⋯ 'IPv6_value', 1)─┐
│ 2001:db8:85a3::8a2e:370:7334        │
└─────────────────────────────────────┘
┌─dictGetIPv6OrDefa⋯:1'::IPv6)─┐
│ ::1                          │
└──────────────────────────────┘
```

<div id="dictGetInt16">
  ## dictGetInt16
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、Dictionary の設定にかかわらず `Int16` データ型に変換します。

**構文**

```sql theme={null}
dictGetInt16(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書の設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書の設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外を発生させます。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetInt16('all_types_dict', 'Int16_value', 1)
```

```response title=Response theme={null}
┌─dictGetInt16⋯_value', 1)─┐
│                    -5000 │
└──────────────────────────┘
```

<div id="dictGetInt16OrDefault">
  ## dictGetInt16OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、Dictionary の設定にかかわらず `Int16` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetInt16OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetInt16('all_types_dict', 'Int16_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（-1）を返す
SELECT dictGetInt16OrDefault('all_types_dict', 'Int16_value', 999, -1);
```

```response title=Response theme={null}
┌─dictGetInt16⋯_value', 1)─┐
│                    -5000 │
└──────────────────────────┘
┌─dictGetInt16⋯', 999, -1)─┐
│                       -1 │
└──────────────────────────┘
```

<div id="dictGetInt32">
  ## dictGetInt32
</div>

導入バージョン: v1.1.0

辞書設定に関係なく、辞書の属性値を `Int32` データ型に変換します。

**構文**

```sql theme={null}
dictGetInt32(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、または Tuple 値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。対応する値がない場合は、辞書の設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、または値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetInt32('all_types_dict', 'Int32_value', 1)
```

```response title=Response theme={null}
┌─dictGetInt32⋯_value', 1)─┐
│                -1000000  │
└──────────────────────────┘
```

<div id="dictGetInt32OrDefault">
  ## dictGetInt32OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、辞書属性の値を `Int32` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetInt32OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (Dictionary の設定に依存します) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — Dictionary に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
存在しない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetInt32('all_types_dict', 'Int32_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（-1）を返す
SELECT dictGetInt32OrDefault('all_types_dict', 'Int32_value', 999, -1);
```

```response title=Response theme={null}
┌─dictGetInt32⋯_value', 1)─┐
│                -1000000  │
└──────────────────────────┘
┌─dictGetInt32⋯', 999, -1)─┐
│                       -1 │
└──────────────────────────┘
```

<div id="dictGetInt64">
  ## dictGetInt64
</div>

導入バージョン: v1.1.0

Dictionary の設定に関係なく、辞書属性の値を `Int64` データ型に変換します。

**構文**

```sql theme={null}
dictGetInt64(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetInt64('all_types_dict', 'Int64_value', 1)
```

```response title=Response theme={null}
┌─dictGetInt64⋯_value', 1)───┐
│       -9223372036854775807 │
└────────────────────────────┘
```

<div id="dictGetInt64OrDefault">
  ## dictGetInt64OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、辞書属性の値を `Int64` データ型に変換します。キーが見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetInt64OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が含まれていない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、`default_value_expr` パラメーターとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetInt64('all_types_dict', 'Int64_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（-1）を返す
SELECT dictGetInt64OrDefault('all_types_dict', 'Int64_value', 999, -1);
```

```response title=Response theme={null}
┌─dictGetInt64⋯_value', 1)─┐
│     -9223372036854775808 │
└──────────────────────────┘
┌─dictGetInt64⋯', 999, -1)─┐
│                       -1 │
└──────────────────────────┘
```

<div id="dictGetInt8">
  ## dictGetInt8
</div>

導入バージョン: v1.1.0

辞書の設定に関係なく、辞書属性の値を `Int8` データ型に変換します。

**構文**

```sql theme={null}
dictGetInt8(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書の属性値を返します。
対応する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  属性の値をパースできない場合、または値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetInt8('all_types_dict', 'Int8_value', 1)
```

```response title=Response theme={null}
┌─dictGetInt8(⋯_value', 1)─┐
│                     -100 │
└──────────────────────────┘
```

<div id="dictGetInt8OrDefault">
  ## dictGetInt8OrDefault
</div>

導入バージョン: v1.1.0

ディクショナリの設定にかかわらず、ディクショナリ属性の値を `Int8` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetInt8OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。 [`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書設定に依存) 。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当しない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetInt8('all_types_dict', 'Int8_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（-1）を返す
SELECT dictGetInt8OrDefault('all_types_dict', 'Int8_value', 999, -1);
```

```response title=Response theme={null}
┌─dictGetInt8(⋯_value', 1)─┐
│                     -100 │
└──────────────────────────┘
┌─dictGetInt8O⋯', 999, -1)─┐
│                       -1 │
└──────────────────────────┘
```

<div id="dictGetKeys">
  ## dictGetKeys
</div>

導入バージョン: v25.12.0

属性が指定した値に等しい辞書キーを返します。これは、単一の属性に対する関数 `dictGet` の逆です。

`dictGetKeys` で使用されるクエリごとの逆ルックアップキャッシュのサイズを制限するには、設定 `max_reverse_dictionary_lookup_cache_size_bytes` を使用します。
このキャッシュは、同じクエリ内で辞書を再走査しないよう、各属性値に対応するシリアライズ済みのキーのタプルを格納します。
このキャッシュはクエリをまたいで保持されません。上限に達すると、エントリは LRU に従って追い出されます。
これは、大きな辞書で、入力のカーディナリティが低く、かつワーキングセットがキャッシュに収まる場合に最も効果的です。キャッシュを無効にするには `0` を設定します。

**構文**

```sql theme={null}
dictGetKeys('dict_name', 'attr_name', value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 照合する属性。[`String`](/ja/reference/data-types/string)
* `value_expr` — 属性と照合する値。[`Expression`](/ja/reference/data-types/special-data-types/expression)

**戻り値**

単一キーの Dictionary の場合、属性が `value_expr` と等しいキーの配列を返します。複合キーの Dictionary の場合、属性が `value_expr` と等しいキーのタプルの配列を返します。Dictionary 内に `value_expr` に対応する属性がない場合は、空の配列が返されます。ClickHouse は、属性の値を解析できない場合、またはその値を属性のデータ型に変換できない場合に例外をスローします。

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetKeys('task_id_to_priority_dictionary', 'priority_level', 'high') AS ids;
```

```response title=Response theme={null}
┌─ids───┐
│ [4,2] │
└───────┘
```

<div id="dictGetOrDefault">
  ## dictGetOrDefault
</div>

導入バージョン: v18.16.0

Dictionary から値を取得します。キーが見つからない場合は、デフォルト値を返します。

**構文**

```sql theme={null}
dictGetOrDefault('dict_name', attr_names, id_expr, default_value)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_names` — Dictionary のカラム名、またはカラム名のタプル。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。UInt64/Tuple(T) を返す式。[`UInt64`](/ja/reference/data-types/int-uint) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value` — キーが見つからない場合に返されるデフォルト値。型は属性のデータ型と一致している必要があります。

**戻り値**

キーが見つかった場合は、`id_expr` に対応する Dictionary の属性値を返します。
キーが見つからない場合は、指定した `default_value` を返します。

**例**

**デフォルト値付きで値を取得**

```sql title=Query theme={null}
SELECT dictGetOrDefault('ext_dict_mult', 'c1', toUInt64(999), 0) AS val
```

```response title=Response theme={null}
0
```

<div id="dictGetOrNull">
  ## dictGetOrNull
</div>

導入バージョン: v21.4.0

Dictionary から値を取得し、キーが見つからない場合は NULL を返します。

**構文**

```sql theme={null}
dictGetOrNull('dict_name', 'attr_name', id_expr)
```

**引数**

* `dict_name` — 辞書の名前。文字列リテラル。 - `attr_name` — 取得するカラム名。文字列リテラル。 - `id_expr` — キー値。辞書のキー型の値を返す式。

**戻り値**

キーが見つかった場合は、`id_expr` に対応する辞書属性の値を返します。
キーが見つからない場合は、`NULL` を返します。

**例**

**範囲キー辞書を使用する例**

```sql title=Query theme={null}
SELECT
    (number, toDate('2019-05-20')),
    dictGetOrNull('range_key_dictionary', 'value', number, toDate('2019-05-20')),
FROM system.numbers LIMIT 5 FORMAT TabSeparated;
```

```response title=Response theme={null}
(0,'2019-05-20')  \N
(1,'2019-05-20')  First
(2,'2019-05-20')  Second
(3,'2019-05-20')  Third
(4,'2019-05-20')  \N
```

<div id="dictGetString">
  ## dictGetString
</div>

導入バージョン: v1.1.0

辞書の設定に関係なく、辞書属性の値を `String` データ型に変換します。

**構文**

```sql theme={null}
dictGetString(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetString('all_types_dict', 'String_value', 1)
```

```response title=Response theme={null}
┌─dictGetString(⋯_value', 1)─┐
│ test string                │
└────────────────────────────┘
```

<div id="dictGetStringOrDefault">
  ## dictGetStringOrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、辞書 attribute の値を `String` データ型に変換するか、秘密鍵が見つからない場合は指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetStringOrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キーとして使用する値。辞書キー型の値またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetString('all_types_dict', 'String_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetStringOrDefault('all_types_dict', 'String_value', 999, 'default');
```

```response title=Response theme={null}
┌─dictGetString(⋯_value', 1)─┐
│ test string                │
└────────────────────────────┘
┌─dictGetStringO⋯ 999, 'default')─┐
│ default                         │
└─────────────────────────────────┘
```

<div id="dictGetUInt16">
  ## dictGetUInt16
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、辞書設定に関係なく `UInt16` データ型に変換します。

**構文**

```sql theme={null}
dictGetUInt16(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetUInt16('all_types_dict', 'UInt16_value', 1)
```

```response title=Response theme={null}
┌─dictGetUInt1⋯_value', 1)─┐
│                     5000 │
└──────────────────────────┘
```

<div id="dictGetUInt16OrDefault">
  ## dictGetUInt16OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定にかかわらず、Dictionary 属性の値を `UInt16` データ型に変換します。キーが見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetUInt16OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
それ以外の場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外を発生させます。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetUInt16('all_types_dict', 'UInt16_value', 1);

-- キーが存在しない場合、指定されたデフォルト値 (0) を返す
SELECT dictGetUInt16OrDefault('all_types_dict', 'UInt16_value', 999, 0);
```

```response title=Response theme={null}
┌─dictGetUInt1⋯_value', 1)─┐
│                     5000 │
└──────────────────────────┘
┌─dictGetUInt1⋯e', 999, 0)─┐
│                        0 │
└──────────────────────────┘
```

<div id="dictGetUInt32">
  ## dictGetUInt32
</div>

導入バージョン: v1.1.0

辞書の設定にかかわらず、辞書の属性値を`UInt32`データ型に変換します。

**構文**

```sql theme={null}
dictGetUInt32(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に応じる) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetUInt32('all_types_dict', 'UInt32_value', 1)
```

```response title=Response theme={null}
┌─dictGetUInt3⋯_value', 1)─┐
│                  1000000 │
└──────────────────────────┘
```

<div id="dictGetUInt32OrDefault">
  ## dictGetUInt32OrDefault
</div>

導入バージョン: v1.1.0

辞書設定にかかわらず、辞書属性の値を `UInt32` データ型に変換します。キーが見つからない場合は、指定したデフォルト値を返します。

**構文**

```sql theme={null}
dictGetUInt32OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — 辞書に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
対応する値がない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetUInt32('all_types_dict', 'UInt32_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（0）を返す
SELECT dictGetUInt32OrDefault('all_types_dict', 'UInt32_value', 999, 0);
```

```response title=Response theme={null}
┌─dictGetUInt3⋯_value', 1)─┐
│                  1000000 │
└──────────────────────────┘
┌─dictGetUInt3⋯e', 999, 0)─┐
│                        0 │
└──────────────────────────┘
```

<div id="dictGetUInt64">
  ## dictGetUInt64
</div>

導入バージョン: v1.1.0

辞書の設定にかかわらず、辞書属性の値を `UInt64` データ型に変換します。

**構文**

```sql theme={null}
dictGetUInt64(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — Dictionary の名前。 [`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値を返す式 (辞書設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
対応する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、または値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetUInt64('all_types_dict', 'UInt64_value', 1)
```

```response title=Response theme={null}
┌─dictGetUInt6⋯_value', 1)─┐
│      9223372036854775807 │
└──────────────────────────┘
```

<div id="dictGetUInt64OrDefault">
  ## dictGetUInt64OrDefault
</div>

導入バージョン: v1.1.0

Dictionary の属性値を、Dictionary の設定に関係なく `UInt64` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetUInt64OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — 辞書キーの値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — Dictionary に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
存在しない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetUInt64('all_types_dict', 'UInt64_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（0）を返す
SELECT dictGetUInt64OrDefault('all_types_dict', 'UInt64_value', 999, 0);
```

```response title=Response theme={null}
┌─dictGetUInt6⋯_value', 1)─┐
│      9223372036854775807 │
└──────────────────────────┘
┌─dictGetUInt6⋯e', 999, 0)─┐
│                        0 │
└──────────────────────────┘
```

<div id="dictGetUInt8">
  ## dictGetUInt8
</div>

導入バージョン: v1.1.0

Dictionary の設定に関係なく、Dictionary 属性の値を `UInt8` データ型に変換します。

**構文**

```sql theme={null}
dictGetUInt8(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値、またはタプル値 (辞書設定に依存) を返す式。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当する値がない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  属性の値をパースできない場合、または値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetUInt8('all_types_dict', 'UInt8_value', 1)
```

```response title=Response theme={null}
┌─dictGetUInt8⋯_value', 1)─┐
│                      100 │
└──────────────────────────┘
```

<div id="dictGetUInt8OrDefault">
  ## dictGetUInt8OrDefault
</div>

導入バージョン: v1.1.0

辞書設定に関係なく、辞書属性の値を`UInt8`データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetUInt8OrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。Dictionary のキー型の値、またはタプル値を返す式 (dictionary configuration に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — Dictionary に `id_expr` キーを持つ行が存在しない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary の属性値を返します。
該当しない場合は、`default_value_expr` パラメーターとして渡された値を返します。

<Note>
  ClickHouse は、属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetUInt8('all_types_dict', 'UInt8_value', 1);

-- キーが存在しない場合、指定されたデフォルト値（0）を返す
SELECT dictGetUInt8OrDefault('all_types_dict', 'UInt8_value', 999, 0);
```

```response title=Response theme={null}
┌─dictGetUInt8⋯_value', 1)─┐
│                      100 │
└──────────────────────────┘
┌─dictGetUInt8⋯e', 999, 0)─┐
│                        0 │
└──────────────────────────┘
```

<div id="dictGetUUID">
  ## dictGetUUID
</div>

導入バージョン: v1.1.0

辞書の設定にかかわらず、辞書属性の値を `UUID` データ型に変換します。

**構文**

```sql theme={null}
dictGetUUID(dict_name, attr_name, id_expr)
```

**引数**

* `dict_name` — 辞書の名前。 [`String`](/ja/reference/data-types/string)
* `attr_name` — 辞書のカラム名。 [`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キーの値。辞書キー型の値またはタプル値を返す式 (辞書設定に依存) 。 [`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する辞書属性の値を返します。
該当しない場合は、辞書設定でその属性に指定された `<null_value>` 要素の内容を返します。

<Note>
  ClickHouse は、属性の値を解析できない場合、またはその値が属性のデータ型と一致しない場合に例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
SELECT dictGetUUID('all_types_dict', 'UUID_value', 1)
```

```response title=Response theme={null}
┌─dictGetUUID(⋯_value', 1)─────────────┐
│ 123e4567-e89b-12d3-a456-426614174000 │
└──────────────────────────────────────┘
```

<div id="dictGetUUIDOrDefault">
  ## dictGetUUIDOrDefault
</div>

導入バージョン: v1.1.0

Dictionary の設定に関係なく、ディクショナリ属性の値を `UUID` データ型に変換します。キーが見つからない場合は、指定されたデフォルト値を返します。

**構文**

```sql theme={null}
dictGetUUIDOrDefault(dict_name, attr_name, id_expr, default_value_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `attr_name` — Dictionary のカラム名。[`String`](/ja/reference/data-types/string) または [`Tuple(String)`](/ja/reference/data-types/tuple)
* `id_expr` — キー値。辞書キー型の値またはタプル値を返す式 (辞書の設定に依存) 。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)
* `default_value_expr` — Dictionary に `id_expr` キーを持つ行が含まれていない場合に返される値。[`Expression`](/ja/reference/data-types/special-data-types/expression) または [`Tuple(T)`](/ja/reference/data-types/tuple)

**戻り値**

`id_expr` に対応する Dictionary 属性の値を返します。
存在しない場合は、`default_value_expr` パラメータとして渡された値を返します。

<Note>
  属性の値をパースできない場合、またはその値が属性のデータ型と一致しない場合、ClickHouse は例外をスローします。
</Note>

**例**

**使用例**

```sql title=Query theme={null}
-- キーが存在する場合
SELECT dictGetUUID('all_types_dict', 'UUID_value', 1);

-- キーが存在しない場合、指定されたデフォルト値を返す
SELECT dictGetUUIDOrDefault('all_types_dict', 'UUID_value', 999, '00000000-0000-0000-0000-000000000000'::UUID);
```

```response title=Response theme={null}
┌─dictGetUUID('all_t⋯ 'UUID_value', 1)─┐
│ 550e8400-e29b-41d4-a716-446655440000 │
└──────────────────────────────────────┘
┌─dictGetUUIDOrDefa⋯000000000000'::UUID)─┐
│ 00000000-0000-0000-0000-000000000000   │
└────────────────────────────────────────┘
```

<div id="dictHas">
  ## dictHas
</div>

導入バージョン: v1.1.0

キーがDictionaryに存在するかどうかを判定します。

**構文**

```sql theme={null}
dictHas('dict_name', id_expr)
```

**引数**

* `dict_name` — Dictionary の名前。[`String`](/ja/reference/data-types/string)
* `id_expr` — キー値 [`const String`](/ja/reference/data-types/string)

**戻り値**

キーが存在する場合は `1`、存在しない場合は `0` を返します。[`UInt8`](/ja/reference/data-types/int-uint)

**例**

**Dictionary にキーが存在するか確認する**

```sql title=Query theme={null}
-- 以下の階層型 Dictionary を考えます:
-- 0 (ルート)
-- └── 1 (レベル 1 - ノード 1)
--     ├── 2 (レベル 2 - ノード 2)
--     │   ├── 4 (レベル 3 - ノード 4)
--     │   └── 5 (レベル 3 - ノード 5)
--     └── 3 (レベル 2 - ノード 3)
--         └── 6 (レベル 3 - ノード 6)

SELECT dictHas('hierarchical_dictionary', 2);
SELECT dictHas('hierarchical_dictionary', 7);
```

```response title=Response theme={null}
┌─dictHas('hie⋯ionary', 2)─┐
│                        1 │
└──────────────────────────┘
┌─dictHas('hie⋯ionary', 7)─┐
│                        0 │
└──────────────────────────┘
```

<div id="dictIsIn">
  ## dictIsIn
</div>

導入バージョン: v1.1.0

Dictionary 内の階層チェーン全体をたどって、キーの祖先かどうかを確認します。

**構文**

```sql theme={null}
dictIsIn(dict_name, child_id_expr, ancestor_id_expr)
```

**引数**

* `dict_name` — 辞書名。[`String`](/ja/reference/data-types/string)
* `child_id_expr` — 確認するキー。[`String`](/ja/reference/data-types/string)
* `ancestor_id_expr` — `child_id_expr` キーの祖先と見なされるキー。[`const String`](/ja/reference/data-types/string)

**戻り値**

`child_id_expr` が `ancestor_id_expr` の子でない場合は `0`、`child_id_expr` が `ancestor_id_expr` の子である場合、または `child_id_expr` が `ancestor_id_expr` 自身である場合は `1` を返します。[`UInt8`](/ja/reference/data-types/int-uint)

**例**

**階層関係を確認する**

```sql title=Query theme={null}
-- 有効な階層
SELECT dictIsIn('hierarchical_dictionary', 6, 3)

-- 無効な階層
SELECT dictIsIn('hierarchical_dictionary', 3, 5)
```

```response title=Response theme={null}
┌─dictIsIn('hi⋯ary', 6, 3)─┐
│                        1 │
└──────────────────────────┘
┌─dictIsIn('hi⋯ary', 3, 5)─┐
│                        0 │
└──────────────────────────┘
```