Skip to content

daft.functions.list_join#

list_join #

list_join(list_expr: Expression, delimiter: str | Expression) -> Expression

Joins every element of a list using the specified string delimiter.

Parameters:

Name Type Description Default
list_expr List Expression

expression to join

required
delimiter str | String Expression

the delimiter to use to join lists with

required

Returns:

Name Type Description
Expression String Expression

an expression which is every element of the list joined on the delimiter

Source code in daft/functions/list.py
61
62
63
64
65
66
67
68
69
70
71
def list_join(list_expr: Expression, delimiter: str | Expression) -> Expression:
    """Joins every element of a list using the specified string delimiter.

    Args:
        list_expr (List Expression): expression to join
        delimiter (str | String Expression): the delimiter to use to join lists with

    Returns:
        Expression (String Expression): an expression which is every element of the list joined on the delimiter
    """
    return Expression._call_builtin_scalar_fn("list_join", list_expr, delimiter)