バージョン: Latest-3.4

dict_mapping

指定されたキーにマップされた値を辞書テーブルから返します。

この関数は主にグローバル辞書テーブルの適用を簡素化するために使用されます。ターゲットテーブルへのデータロード中に、StarRocks はこの関数の入力パラメータを使用して辞書テーブルから指定されたキーにマップされた値を自動的に取得し、その値をターゲットテーブルにロードします。

v3.2.5以降、StarRocks はこの関数をサポートしています。また、現在 StarRocks の共有データモードではこの関数をサポートしていないことに注意してください。

Syntax

dict_mapping("[<db_name>.]<dict_table>", key_column_expr_list [, <value_column> ] [, <null_if_not_exist>] )

key_column_expr_list ::= key_column_expr [, key_column_expr ... ]

key_column_expr ::= <column_name> | <expr>

Parameters

必須パラメータ:
- [<db_name>.]<dict_table>: 辞書テーブルの名前で、主キーテーブルである必要があります。サポートされるデータ型は VARCHAR です。
- key_column_expr_list: 辞書テーブルのキー列のための式リストで、1つまたは複数の key_column_exprs を含みます。key_column_expr は辞書テーブルのキー列の名前、または特定のキーやキー式であることができます。
  
  この式リストには辞書テーブルのすべての主キー列を含める必要があります。つまり、式の総数は辞書テーブルの主キー列の総数と一致する必要があります。したがって、辞書テーブルが複合主キーを使用する場合、このリストの式はテーブルスキーマで定義された主キー列に順番に対応する必要があります。このリストの複数の式はカンマ（,）で区切られます。また、key_column_expr が特定のキーまたはキー式である場合、その型は辞書テーブルの対応する主キー列の型と一致する必要があります。
オプションパラメータ:
- <value_column>: 値列の名前で、マッピング列でもあります。値列が指定されていない場合、デフォルトの値列は辞書テーブルの AUTO_INCREMENT 列です。値列は、辞書テーブル内の自動インクリメント列および主キーを除く任意の列として定義することもできます。列のデータ型には制限がありません。
- <null_if_not_exist> (オプション): 辞書テーブルにキーが存在しない場合に返すかどうか。有効な値:
  - true: キーが存在しない場合、Null が返されます。
  - false (デフォルト): キーが存在しない場合、例外がスローされます。

Return Value

返される値のデータ型は、値列のデータ型と一致します。値列が辞書テーブルの自動インクリメント列である場合、返される値のデータ型は BIGINT です。

ただし、指定されたキーにマップされた値が見つからない場合、<null_if_not_exist> パラメータが true に設定されている場合は NULL が返されます。パラメータが false（デフォルト）に設定されている場合、エラー query failed if record not exist in dict table が返されます。

Example

Example 1: 辞書テーブルからキーにマップされた値を直接クエリします。

辞書テーブルを作成し、シミュレートされたデータをロードします。

MySQL [test]> CREATE TABLE dict (
    order_uuid STRING,
    order_id_int BIGINT AUTO_INCREMENT 
)
PRIMARY KEY (order_uuid)
DISTRIBUTED BY HASH (order_uuid);
Query OK, 0 rows affected (0.02 sec)

MySQL [test]> INSERT INTO dict (order_uuid) VALUES ('a1'), ('a2'), ('a3');
Query OK, 3 rows affected (0.12 sec)
{'label':'insert_9e60b0e4-89fa-11ee-a41f-b22a2c00f66b', 'status':'VISIBLE', 'txnId':'15029'}

MySQL [test]> SELECT * FROM dict;
+------------+--------------+
| order_uuid | order_id_int |
+------------+--------------+
| a1         |            1 |
| a3         |            3 |
| a2         |            2 |
+------------+--------------+
3 rows in set (0.01 sec)

NOTICE

現在、INSERT INTO ステートメントは部分更新をサポートしていません。したがって、dict のキー列に挿入される値が重複しないことを確認してください。そうしないと、辞書テーブルに同じキー列の値を複数回挿入すると、値列にマップされた値が変更されます。

辞書テーブル内のキー a1 にマップされた値をクエリします。

MySQL [test]> SELECT dict_mapping('dict', 'a1');
+----------------------------+
| dict_mapping('dict', 'a1') |
+----------------------------+
|                          1 |
+----------------------------+
1 row in set (0.01 sec)

Example 2: テーブル内のマッピング列が dict_mapping 関数を使用して生成列として構成されています。したがって、StarRocks はこのテーブルにデータをロードする際にキーにマップされた値を自動的に取得できます。

データテーブルを作成し、dict_mapping('dict', order_uuid) を使用してマッピング列を生成列として構成します。

CREATE TABLE dest_table1 (
    id BIGINT,
    -- この列は STRING 型の注文番号を記録し、Example 1 の dict テーブルの order_uuid 列に対応します。
    order_uuid STRING, 
    batch int comment 'used to distinguish different batch loading',
    -- この列は BIGINT 型の注文番号を記録し、order_uuid 列とマッピングされています。
    -- この列は dict_mapping で構成された生成列であるため、この列の値はデータロード中に Example 1 の dict テーブルから自動的に取得されます。
    -- その後、この列は重複排除や JOIN クエリに直接使用できます。
    order_id_int BIGINT AS dict_mapping('dict', order_uuid)
)
DUPLICATE KEY (id, order_uuid)
DISTRIBUTED BY HASH(id);

order_id_int 列が dict_mapping('dict', 'order_uuid') として構成されているこのテーブルにシミュレートされたデータをロードする際、StarRocks は dict テーブル内のキーと値のマッピング関係に基づいて order_id_int 列に値を自動的にロードします。
```
MySQL [test]> INSERT INTO dest_table1(id, order_uuid, batch) VALUES (1, 'a1', 1), (2, 'a1', 1), (3, 'a3', 1), (4, 'a3', 1);
Query OK, 4 rows affected (0.05 sec) 
{'label':'insert_e191b9e4-8a98-11ee-b29c-00163e03897d', 'status':'VISIBLE', 'txnId':'72'}

MySQL [test]> SELECT * FROM dest_table1;
+------+------------+-------+--------------+
| id   | order_uuid | batch | order_id_int |
+------+------------+-------+--------------+
|    1 | a1         |     1 |            1 |
|    4 | a3         |     1 |            3 |
|    2 | a1         |     1 |            1 |
|    3 | a3         |     1 |            3 |
+------+------------+-------+--------------+
4 rows in set (0.02 sec)
```
この例での dict_mapping の使用は、重複排除計算と JOIN クエリを加速できます。グローバル辞書を構築して正確な重複排除を加速する以前のソリューションと比較して、dict_mapping を使用したソリューションはより柔軟でユーザーフレンドリーです。なぜなら、マッピング値はキーと値のマッピング関係をテーブルにロードする段階で辞書テーブルから直接取得されるためです。辞書テーブルをジョインしてマッピング値を取得するためのステートメントを書く必要はありません。さらに、このソリューションはさまざまなデータロード方法をサポートしています。

Example 3: テーブル内のマッピング列が生成列として構成されていない場合、データをテーブルにロードする際にマッピング列のために dict_mapping 関数を明示的に構成し、キーにマップされた値を取得する必要があります。

NOTICE

Example 3 と Example 2 の違いは、データテーブルにインポートする際に、インポートコマンドを変更してマッピング列のために dict_mapping 式を明示的に構成する必要があることです。

テーブルを作成します。

CREATE TABLE dest_table2 (
    id BIGINT,
    order_uuid STRING,
    order_id_int BIGINT NULL,
    batch int comment 'used to distinguish different batch loading'
)
DUPLICATE KEY (id, order_uuid, order_id_int)
DISTRIBUTED BY HASH(id);

このテーブルにシミュレートされたデータをロードする際、dict_mapping を構成して辞書テーブルからマッピングされた値を取得します。

MySQL [test]> INSERT INTO dest_table2 VALUES (1, 'a1', dict_mapping('dict', 'a1'), 1);
Query OK, 1 row affected (0.35 sec)
{'label':'insert_19872ab6-8a96-11ee-b29c-00163e03897d', 'status':'VISIBLE', 'txnId':'42'}

MySQL [test]> SELECT * FROM dest_table2;
+------+------------+--------------+-------+
| id   | order_uuid | order_id_int | batch |
+------+------------+--------------+-------+
|    1 | a1         |            1 |     1 |
+------+------------+--------------+-------+
1 row in set (0.02 sec)

Example 4: null_if_not_exist モードを有効にする

<null_if_not_exist> モードが無効で、辞書テーブルに存在しないキーにマップされた値をクエリする場合、NULL ではなくエラーが返されます。これにより、データ行のキーが最初に辞書テーブルにロードされ、そのマッピング値（辞書 ID）が生成されてから、そのデータ行がターゲットテーブルにロードされることが保証されます。

MySQL [test]>  SELECT dict_mapping('dict', 'b1', true);
ERROR 1064 (HY000): Query failed if record not exist in dict table.

Example 5: 辞書テーブルが複合主キーを使用している場合、クエリ時にすべての主キーを指定する必要があります。

複合主キーを持つ辞書テーブルを作成し、シミュレートされたデータをロードします。

MySQL [test]> CREATE TABLE dict2 (
    order_uuid STRING,
    order_date DATE, 
    order_id_int BIGINT AUTO_INCREMENT
)
PRIMARY KEY (order_uuid,order_date)  -- 複合主キー
DISTRIBUTED BY HASH (order_uuid,order_date)
;
Query OK, 0 rows affected (0.02 sec)

MySQL [test]> INSERT INTO dict2 VALUES ('a1','2023-11-22',default), ('a2','2023-11-22',default), ('a3','2023-11-22',default);
Query OK, 3 rows affected (0.12 sec)
{'label':'insert_9e60b0e4-89fa-11ee-a41f-b22a2c00f66b', 'status':'VISIBLE', 'txnId':'15029'}


MySQL [test]> select * from dict2;
+------------+------------+--------------+
| order_uuid | order_date | order_id_int |
+------------+------------+--------------+
| a1         | 2023-11-22 |            1 |
| a3         | 2023-11-22 |            3 |
| a2         | 2023-11-22 |            2 |
+------------+------------+--------------+
3 rows in set (0.01 sec)

辞書テーブル内のキーにマップされた値をクエリします。辞書テーブルが複合主キーを持っているため、dict_mapping で全ての主キーを指定する必要があります。
```
SELECT dict_mapping('dict2', 'a1', cast('2023-11-22' as DATE));
```
主キーが1つだけ指定されている場合、エラーが発生します。
```
MySQL [test]> SELECT dict_mapping('dict2', 'a1');
ERROR 1064 (HY000): Getting analyzing error. Detail message: dict_mapping function param size should be 3 - 5.
```

Syntax​

Parameters​

Return Value​

Example​

このドキュメントについてどう思いましたか？

Syntax

Parameters

Return Value

Example