pyspark.sql.functions.try_variant_get#
- pyspark.sql.functions.try_variant_get(v, path, targetType)[source]#
Extracts a sub-variant from v according to path, and then cast the sub-variant to targetType. Returns null if the path does not exist or the cast fails.
New in version 4.0.0.
- Parameters
- v
Columnor str a variant column or column name
- pathstr
the extraction path. A valid path should start with $ and is followed by zero or more segments like [123], .name, [‘name’], or [“name”].
- targetTypestr
the target data type to cast into, in a DDL-formatted string
- v
- Returns
Columna column of targetType representing the extracted result
Examples
>>> df = spark.createDataFrame([ {'json': '''{ "a" : 1 }'''} ]) >>> df.select(try_variant_get(parse_json(df.json), "$.a", "int").alias("r")).collect() [Row(r=1)] >>> df.select(try_variant_get(parse_json(df.json), "$.b", "int").alias("r")).collect() [Row(r=None)] >>> df.select(try_variant_get(parse_json(df.json), "$.a", "binary").alias("r")).collect() [Row(r=None)]