pyspark.sql.functions.is_valid_variant#

pyspark.sql.functions.is_valid_variant(v)[source]#

Check if a variant value is valid. Returns true if the variant is valid, false if it is malformed, and NULL if the input is NULL.

Added in version 4.2.0.

Parameters:

vColumn or str: a variant column or column name A column that evaluates to a variant.

Returns:

Column: a boolean column indicating whether the variant value is valid Returns a column that evaluates to a boolean.

Examples

>>> df = spark.createDataFrame([ {'json': '''{ "a" : 1 }'''} ])
>>> df.select(is_valid_variant(parse_json(df.json)).alias("r")).collect()
[Row(r=True)]