array_prepend

Devolve um array contendo o elemento dado como primeiro elemento e os restantes elementos do array original.

Sintaxe

from pyspark.sql import functions as sf

sf.array_prepend(col, value)

Parâmetros

Parâmetro	Tipo	Description
col	pyspark.sql.Column ou str	Nome da coluna que contém o array
value	Qualquer	Um valor literal, ou uma expressão Coluna.

Devoluções

pyspark.sql.Column: um array com o valor indicado antecipado.

Examples

Exemplo 1: Colocar um valor de coluna numa coluna de array

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()

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

Exemplo 2: Anteceder um valor numérico a uma coluna de array

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

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

Exemplo 3: Colocar um valor nulo numa coluna de array

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

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

Exemplo 4: Colocar um valor na coluna de um array NULL

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()

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

Exemplo 5: Antepender um valor a um array vazio

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()

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