assert_true

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

Sintaxe

Python

from pyspark.sql import functions as sf

sf.assert_true(col, errMsg=None)

Parâmetros

Parâmetro	Tipo	Descrição
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 string literal Python ou uma coluna contendo a mensagem de erro.

Devoluções

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

Exemplos

Exemplo 1 : Afirme uma condição verdadeira

Python

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

Output

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

Exemplo 2 : Asserção com mensagem de erro na coluna

Python

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

Output

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

Exemplo 3 : Asserção com mensagem de erro personalizada

Python

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

Output

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