リストタグ

集計関数: 区切り文字で区切られた null 以外の入力値の連結を返します。

対応する Databricks SQL 関数については、 listagg集計関数を参照してください。

構文

Python

import pyspark.sql.functions as sf

sf.listagg(col=<col>)

# With delimiter
sf.listagg(col=<col>, delimiter=<delimiter>)

パラメーター

パラメーター	Type	説明
col	pyspark.sql.Column または str	ターゲットカラムをコンピュートに。
delimiter	pyspark.sql.Column、 str 、または bytes	オプション。値を区切る区切り文字。デフォルト値は「なし」です。

戻り値

pyspark.sql.Column: コンピュート結果の列。

例

例 1 : listagg 関数の使用。

Python

import pyspark.sql.functions as sf
df = spark.createDataFrame([('a',), ('b',), (None,), ('c',)], ['strings'])
df.select(sf.listagg('strings')).show()

Output

+----------------------+
|listagg(strings, NULL)|
+----------------------+
|                   abc|
+----------------------+

例 2 : 区切り文字付きの listagg 関数を使用する。

Python

import pyspark.sql.functions as sf
df = spark.createDataFrame([('a',), ('b',), (None,), ('c',)], ['strings'])
df.select(sf.listagg('strings', ', ')).show()

Output

+--------------------+
|listagg(strings, , )|
+--------------------+
|             a, b, c|
+--------------------+

例 3 : バイナリ列と区切り文字を使用した listagg 関数の使用。

Python

import pyspark.sql.functions as sf
df = spark.createDataFrame([(b'\x01',), (b'\x02',), (None,), (b'\x03',)], ['bytes'])
df.select(sf.listagg('bytes', b'\x42')).show()

Output

+---------------------+
|listagg(bytes, X'42')|
+---------------------+
|     [01 42 02 42 03]|
+---------------------+

例 4 : すべての None 値を持つ列で listagg 関数を使用する。

Python

import pyspark.sql.functions as sf
from pyspark.sql.types import StructType, StructField, StringType
schema = StructType([StructField("strings", StringType(), True)])
df = spark.createDataFrame([(None,), (None,), (None,), (None,)], schema=schema)
df.select(sf.listagg('strings')).show()

Output

+----------------------+
|listagg(strings, NULL)|
+----------------------+
|                  NULL|
+----------------------+