入力列がtrueの場合はnullを返します。それ以外の場合は、指定されたエラー メッセージを含む例外をスローします。
構文
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: 入力列がtrueされている場合にnull、指定されたメッセージを含むエラーがスローされます。
例示
例 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|
+---+---+---------------------------+