daft.functions.soundex#

def soundex(expr: Expression) -> Expression:
    """Returns the Soundex code of the string.

    Soundex is a phonetic algorithm that produces a 4-character code representing
    the sound of the string. This is compatible with Spark's soundex function.

    Args:
        expr: The string expression

    Returns:
        Expression: a String expression with the Soundex code

    Examples:
        >>> import daft
        >>> from daft.functions import soundex
        >>> df = daft.from_pydict({"x": ["Robert", "Rupert", "Smith"]})
        >>> df = df.select(soundex(df["x"]))
        >>> df.show()
        ╭────────╮
        │ x      │
        │ ---    │
        │ String │
        ╞════════╡
        │ R163   │
        ├╌╌╌╌╌╌╌╌┤
        │ R163   │
        ├╌╌╌╌╌╌╌╌┤
        │ S530   │
        ╰────────╯
        <BLANKLINE>
        (Showing first 3 of 3 rows)

    """
    return Expression._call_builtin_scalar_fn("soundex", expr)