soundex

Returns the SoundEx encoding for a string.

For the corresponding Databricks SQL function, see soundex function.

Syntax

from pyspark.sql import functions as dbf

dbf.soundex(col=<col>)

Parameters

Parameter	Type	Description
col	pyspark.sql.Column or str	target column to work on.

Returns

pyspark.sql.Column: SoundEx encoded string.

Examples

from pyspark.sql import functions as dbf
df = spark.createDataFrame([("Peters",),("Uhrbach",)], ["s"])
df.select("*", dbf.soundex("s")).show()