pyspark.sql.functions.to_binary

pyspark.sql.functions.to_binary(col: ColumnOrName, format: Optional[ColumnOrName] = None) → pyspark.sql.column.Column

Converts the input col to a binary value based on the supplied format. The format can be a case-insensitive string literal of “hex”, “utf-8”, “utf8”, or “base64”. By default, the binary format for conversion is “hex” if format is omitted. The function returns NULL if at least one of the input parameters is NULL.

New in version 3.5.0.

Parameters

colColumn or str

Input column or strings.

formatColumn or str, optional

format to use to convert binary values.

Examples

>>> df = spark.createDataFrame([("abc",)], ["e"])
>>> df.select(to_binary(df.e, lit("utf-8")).alias('r')).collect()
[Row(r=bytearray(b'abc'))]

>>> df = spark.createDataFrame([("414243",)], ["e"])
>>> df.select(to_binary(df.e).alias('r')).collect()
[Row(r=bytearray(b'ABC'))]

previous

pyspark.sql.functions.sentences

next

pyspark.sql.functions.to_char