string_agg

Função agregada: retorna a concatenação de valores de entrada não nulos, separados pelo delimitador. Um alias de listagg.

Sintaxe

Python

from pyspark.sql import functions as sf

sf.string_agg(col, delimiter=None)

Parâmetros

Parâmetro	Tipo	Descrição
col	pyspark.sql.Column ou str	coluna de destino para compute .
delimiter	pyspark.sql.Column, str ou bytes, opcional	O delimitador para separar os valores. O valor default é Nenhum.

Devoluções

pyspark.sql.Column: a coluna para resultados de cálculo.

Exemplos

Exemplo 1 : Usando a função string_agg

Python

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

Output

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

Exemplo 2 : Usando a função string_agg com um delimitador

Python

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

Output

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

Exemplo 3 : Usando a função string_agg com uma coluna binária e um delimitador

Python

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

Output

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