pyspark.sql.functions.octet_length#

pyspark.sql.functions.octet_length(col)[source]#

Calculates the byte length for the specified string column.

Added in version 3.3.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters:

colColumn or column name: Source column or strings. A column that evaluates to a string or binary.

Returns:

Column: Byte length of the col Returns a column that evaluates to an integer.

Examples

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([('cat',), ( '🐈',)], ['cat'])
>>> df.select('*', sf.octet_length('cat')).show()
+---+-----------------+
|cat|octet_length(cat)|
+---+-----------------+
|cat|                3|
| 🐈|                4|
+---+-----------------+