vastorbit.sql.functions.soundex¶

vastorbit.sql.functions.soundex(expr: Annotated[str | list[str] | StringSQL | list[StringSQL], '']) → StringSQL¶

Returns Soundex encoding of a varchar strings as a four character string.

Parameters:: expr (SQLExpression) – Expression.
Returns:: SQL string.
Return type:: StringSQL

Examples

First, let’s import the VastFrame in order to create a dummy dataset.

from vastorbit import VastFrame

Now, let’s import the vastorbit SQL functions.

import vastorbit.sql.functions as vof

We can now build a dummy dataset.

df = VastFrame({"x": ["hello", "apple", "heroes", "allo"]})

Now, let’s go ahead and apply the function.

df["soundex_x"] = vof.soundex(df["x"])
display(df)

	Abc x Varchar(6) 100%	Abc soundex_x Varchar(4) 100%
1	hello	H400
2	heroes	H620
3	apple	A140
4	allo	A400

Note

It’s crucial to utilize vastorbit SQL functions in coding, as they can be updated over time with new syntax. While SQL functions typically remain stable, they may vary across platforms or versions. vastorbit effectively manages these changes, a task not achievable with pure SQL.