array_prepend

Retorna um array contendo o elemento fornecido como primeiro elemento e os demais elementos do array original.

Sintaxe

Python

from pyspark.sql import functions as sf

sf.array_prepend(col, value)

Parâmetros

Parâmetro	Tipo	Descrição
col	pyspark.sql.Column ou str	Nome da coluna que contém a matriz
value	Qualquer um	Um valor literal ou uma expressão de coluna.

Devoluções

pyspark.sql.Column: uma matriz com o valor fornecido adicionado ao início.

Exemplos

Exemplo 1 : Adicionando um valor de coluna ao início de uma coluna de matriz

Python

from pyspark.sql import Row, functions as sf
df = spark.createDataFrame([Row(c1=["b", "a", "c"], c2="c")])
df.select(sf.array_prepend(df.c1, df.c2)).show()

Output

+---------------------+
|array_prepend(c1, c2)|
+---------------------+
|         [c, b, a, c]|
+---------------------+

Exemplo 2 : Adicionando um valor numérico ao início de uma coluna de matriz

Python

from pyspark.sql import functions as sf
df = spark.createDataFrame([([1, 2, 3],)], ['data'])
df.select(sf.array_prepend(df.data, 4)).show()

Output

+----------------------+
|array_prepend(data, 4)|
+----------------------+
|          [4, 1, 2, 3]|
+----------------------+

Exemplo 3 : Adicionando um valor nulo ao início de uma coluna de matriz

Python

from pyspark.sql import functions as sf
df = spark.createDataFrame([([1, 2, 3],)], ['data'])
df.select(sf.array_prepend(df.data, None)).show()

Output

+-------------------------+
|array_prepend(data, NULL)|
+-------------------------+
|          [NULL, 1, 2, 3]|
+-------------------------+

Exemplo 4 : Adicionando um valor ao início de uma coluna de matriz NULL

Python

from pyspark.sql import functions as sf
from pyspark.sql.types import ArrayType, IntegerType, StructType, StructField
schema = StructType([
  StructField("data", ArrayType(IntegerType()), True)
])
df = spark.createDataFrame([(None,)], schema=schema)
df.select(sf.array_prepend(df.data, 4)).show()

Output

+----------------------+
|array_prepend(data, 4)|
+----------------------+
|                  NULL|
+----------------------+

Exemplo 5 : Adicionando um valor ao início de um array vazio

Python

from pyspark.sql import functions as sf
from pyspark.sql.types import ArrayType, IntegerType, StructType, StructField
schema = StructType([
  StructField("data", ArrayType(IntegerType()), True)
])
df = spark.createDataFrame([([],)], schema=schema)
df.select(sf.array_prepend(df.data, 1)).show()

Output

+----------------------+
|array_prepend(data, 1)|
+----------------------+
|                   [1]|
+----------------------+