pyspark.sql.functions.collation#

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

Returns the collation name of a given column.

Added in version 4.0.0.

Parameters:

colColumn or str: Target string column to work on. A column that evaluates to a string.

Returns:

Column: collation name of a given expression. Returns a column that evaluates to a string.

Examples

>>> df = spark.createDataFrame([('name',)], ['dt'])
>>> df.select(collation('dt').alias('collation')).show(truncate=False)
+--------------------------+
|collation                 |
+--------------------------+
|SYSTEM.BUILTIN.UTF8_BINARY|
+--------------------------+