Aller au contenu principal

assert_true

Renvoie null si la colonne d'entrée est true; sinon, lève une exception avec le message d'erreur fourni.

Syntaxe

Python
from pyspark.sql import functions as sf

sf.assert_true(col, errMsg=None)

parameter

parameter

Type

Description

col

pyspark.sql.Column ou str

Nom de colonne ou colonne qui représente la colonne d'entrée à tester.

errMsg

pyspark.sql.Column ou str, facultatif

Un littéral de chaîne Python ou une colonne contenant le message d'erreur.

parameter

Type

Description

col

pyspark.sql.Column ou str

Nom de colonne ou colonne qui représente la colonne d'entrée à tester.

errMsg

pyspark.sql.Column ou str, facultatif

Un littéral de chaîne Python ou une colonne contenant le message d'erreur.

Renvoie

pyspark.sql.Column: null si la colonne d'entrée est true, sinon une erreur avec le message spécifié est générée.

Exemples

Exemple 1 : Affirmer une condition vraie.

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|
+---+---+--------------------------------------------+

Exemple 2 : assertion avec message d'erreur de colonne

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|
+---+---+-----------------------+

Exemple 3 : Assert avec message d'erreur personnalisé

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|
+---+---+---------------------------+