Skip to main content

encode

Computes the first argument into a binary from a string using the provided character set (one of 'US-ASCII', 'ISO-8859-1', 'UTF-8', 'UTF-16BE', 'UTF-16LE', 'UTF-16', 'UTF-32').

For the corresponding Databricks SQL function, see encode function.

Syntax​

Python
from pyspark.sql import functions as dbf

dbf.encode(col=<col>, charset=<charset>)

Parameters​

Parameter

Type

Description

col

pyspark.sql.Column or str

target column to work on.

charset

literal string

charset to use to encode.

Parameter

Type

Description

col

pyspark.sql.Column or str

target column to work on.

charset

literal string

charset to use to encode.

Returns​

pyspark.sql.Column: the column for computed results.

Examples​

Python
from pyspark.sql import functions as dbf
df = spark.createDataFrame([("abcd",)], ["c"])
df.select("*", dbf.encode("c", "UTF-8")).show()