string_agg_distinct

Агрегатная функция: возвращает объединение отдельных входных значений, отличных от NULL, разделенных разделителем. Псевдоним listagg_distinct.

Синтаксис

import pyspark.sql.functions as sf

sf.string_agg_distinct(col=<col>)

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

Параметры

Параметр	Тип	Description
col	pyspark.sql.Column или str	Целевой столбец для вычисления.
delimiter	pyspark.sql.Column, str или bytes	Необязательно. Разделитель для разделения значений. Значение по умолчанию — None.

Возвраты

pyspark.sql.Column: столбец для вычисляемых результатов.

Примеры

Пример 1. Использование функции string_agg_distinct.

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

+----------------------------------+
|string_agg(DISTINCT strings, NULL)|
+----------------------------------+
|                               abc|
+----------------------------------+

Пример 2. Использование функции string_agg_distinct с разделителем.

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

+--------------------------------+
|string_agg(DISTINCT strings, , )|
+--------------------------------+
|                         a, b, c|
+--------------------------------+

Пример 3. Использование функции string_agg_distinct с двоичным столбцом и разделителем.

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

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

Пример 4. Использование функции string_agg_distinct в столбце со всеми значениями None.

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.string_agg_distinct('strings')).show()

+----------------------------------+
|string_agg(DISTINCT strings, NULL)|
+----------------------------------+
|                              NULL|
+----------------------------------+