メインコンテンツまでスキップ
に最終更新

ARRAY_JOIN

array_join​

SinceVersion 2.0.0

説明​

配列の要素を連結して文字列を作ります。この関数は配列内のすべての要素を文字列に変換し、指定した区切り文字で連結します。

構文​

array_join(ARRAY<T> arr, STRING separator [, STRING null_replacement])

パラメータ​

  • arr:ARRAY 型。連結する配列
  • separator:STRING 型。必須パラメータ。配列の要素間に挿入する区切り文字
  • null_replacement:STRING 型。省略可能なパラメータ。配列内の NULL 値を置き換える文字列。指定しない場合、NULL 値はスキップされます

T でサポートされる型:

  • 数値型:TINYINT、SMALLINT、INT、BIGINT、LARGEINT、FLOAT、DOUBLE、DECIMAL
  • 文字列型:CHAR、VARCHAR、STRING
  • 日付・時刻型:DATE、DATETIME、DATEV2、DATETIMEV2
  • 真偽値型:BOOLEAN
  • IP 型:IPV4、IPV6

戻り値​

戻り値の型:STRING

戻り値の意味:

  • 配列のすべての要素を区切り文字で連結した文字列を返します
  • 入力配列が NULL の場合は NULL を返します

使用上の注意:

  • この関数は配列の各要素を文字列に変換し、指定した区切り文字で連結します
  • 配列内の NULL 要素について:
    • null_replacement パラメータを指定した場合、NULL 要素をその文字列に置き換えます
    • null_replacement パラメータを指定しない場合、NULL 要素をスキップします
  • 空の配列に対しては空文字列を返します

クエリの例:

区切り文字を使って配列を連結する:

SELECT array_join([1, 2, 3, 4, 5], ',');
+--------------------------------------+
| array_join([1, 2, 3, 4, 5], ',') |
+--------------------------------------+
| 1,2,3,4,5 |
+--------------------------------------+

空白を区切り文字として文字列配列を連結する:

SELECT array_join(['hello', 'world', 'doris'], ' ');
+--------------------------------------------------+
| array_join(['hello', 'world', 'doris'], ' ') |
+--------------------------------------------------+
| hello world doris |
+--------------------------------------------------+

NULL 値を含む配列を連結する(NULL 値はスキップされます):

SELECT array_join([1, null, 3, null, 5], '-');
+--------------------------------------------+
| array_join([1, null, 3, null, 5], '-') |
+--------------------------------------------+
| 1-3-5 |
+--------------------------------------------+

null_replacement パラメータを使って NULL 値を置き換える:

SELECT array_join([1, null, 3, null, 5], '-', 'NULL');
+--------------------------------------------------+
| array_join([1, null, 3, null, 5], '-', 'NULL') |
+--------------------------------------------------+
| 1-NULL-3-NULL-5 |
+--------------------------------------------------+

浮動小数点数の配列を連結する:

SELECT array_join([1.1, 2.2, 3.3], ' | ');
+------------------------------------------+
| array_join([1.1, 2.2, 3.3], ' | ') |
+------------------------------------------+
| 1.1 | 2.2 | 3.3 |
+------------------------------------------+

日付の配列を連結する:

SELECT array_join(CAST(['2023-01-01', '2023-06-15', '2023-12-31'] AS ARRAY<DATETIME>), ' to ');
+-----------------------------------------------------------------------------------------+
| array_join(CAST(['2023-01-01', '2023-06-15', '2023-12-31'] AS ARRAY<DATETIME>), ' to ') |
+-----------------------------------------------------------------------------------------+
| 2023-01-01 00:00:00 to 2023-06-15 00:00:00 to 2023-12-31 00:00:00 |
+-----------------------------------------------------------------------------------------+

IP アドレスの配列を連結する:

SELECT array_join(CAST(['192.168.1.1', '192.168.1.2', '192.168.1.3'] AS ARRAY<IPV4>), ' -> ');
+----------------------------------------------------------------------------------+
| array_join(CAST(['192.168.1.1', '192.168.1.2', '192.168.1.3'] AS ARRAY<IPV4>), ' -> ') |
+----------------------------------------------------------------------------------+
| 192.168.1.1 -> 192.168.1.2 -> 192.168.1.3 |
+----------------------------------------------------------------------------------+

空の配列に対しては空文字列を返す:

SELECT array_join([], ',');
+----------------------+
| array_join([], ',') |
+----------------------+
| |
+----------------------+

NULL の配列に対しては NULL を返す:

SELECT array_join(NULL, ',');
+----------------------+
| array_join(NULL, ',') |
+----------------------+
| NULL |
+----------------------+

複合型を渡した場合のエラー:

SELECT array_join([{'name':'Alice','age':20}, {'name':'Bob','age':30}], '; ');
ERROR 1105 (HY000): errCode = 2, detailMessage = can not cast from origin type ARRAY<MAP<TEXT,TEXT>> to target type=ARRAY<VARCHAR(65533)>

パラメータの数が正しくない場合のエラー:

SELECT array_join([1,2,3], ',', 'extra', 'too_many');
ERROR 1105 (HY000): errCode = 2, detailMessage = Can not found function 'array_join' which has 4 arity. Candidate functions are: [array_join(Expression, Expression, Expression), array_join(Expression, Expression)]

配列以外の型を渡した場合のエラー:

SELECT array_join('not_an_array', ',');
ERROR 1105 (HY000): errCode = 2, detailMessage = Can not find the compatibility function signature: array_join(VARCHAR(12), VARCHAR(1))

キーワード​

ARRAY, JOIN, ARRAY_JOIN