assert_true

Retorna null se a coluna de entrada for true; gera uma exceção com a mensagem de erro fornecida caso contrário.

Sintaxe

from pyspark.sql import functions as sf

sf.assert_true(col, errMsg=None)

Parâmetros

Parâmetro	Tipo	Description
col	pyspark.sql.Column ou str	Nome da coluna ou coluna que representa a coluna de entrada a ser testada.
errMsg	pyspark.sql.Column ou str, opcional	Uma coluna ou literal de cadeia de caracteres python que contém a mensagem de erro.

Devoluções

pyspark.sql.Column: null se a coluna de entrada for true , caso contrário, gerará um erro com a mensagem especificada.

Exemplos

Exemplo 1: Afirmar uma condição verdadeira

from pyspark.sql import functions as sf
df = spark.createDataFrame([(0, 1)], ['a', 'b'])
df.select('*', sf.assert_true(df.a < df.b)).show()

+---+---+--------------------------------------------+
|  a|  b|assert_true((a < b), '(a < b)' is not true!)|
+---+---+--------------------------------------------+
|  0|  1|                                        NULL|
+---+---+--------------------------------------------+

Exemplo 2: Afirmar com mensagem de erro de coluna

from pyspark.sql import functions as sf
df = spark.createDataFrame([(0, 1)], ['a', 'b'])
df.select('*', sf.assert_true(df.a < df.b, df.a)).show()

+---+---+-----------------------+
|  a|  b|assert_true((a < b), a)|
+---+---+-----------------------+
|  0|  1|                   NULL|
+---+---+-----------------------+

Exemplo 3: Afirmar com mensagem de erro personalizada

from pyspark.sql import functions as sf
df = spark.createDataFrame([(0, 1)], ['a', 'b'])
df.select('*', sf.assert_true(df.a < df.b, 'error')).show()

+---+---+---------------------------+
|  a|  b|assert_true((a < b), error)|
+---+---+---------------------------+
|  0|  1|                       NULL|
+---+---+---------------------------+