assert_true

Возвращает значение null , если входной столбец имеет значение true; вызывает исключение с предоставленным сообщением об ошибке в противном случае.

Синтаксис

from pyspark.sql import functions as sf

sf.assert_true(col, errMsg=None)

Параметры

Параметр	Тип	Description
col	pyspark.sql.Column или str	Имя столбца или столбец, представляющий входной столбец для тестирования.
errMsg	pyspark.sql.Column или str, необязательный	Строковый литерал Python или столбец, содержащий сообщение об ошибке.

Возвраты

pyspark.sql.Column: null если входной столбец true в противном случае вызывает ошибку с указанным сообщением.

Примеры

Пример 1. Утверждение истинного условия

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

Пример 2. Утверждение с сообщением об ошибке столбца

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

Пример 3. Утверждение с пользовательским сообщением об ошибке

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