Skip to content

daft.functions.date_sub#

date_sub #

date_sub(expr: Expression, days: Expression) -> Expression

Subtracts a number of days from a date.

Parameters:

Name Type Description Default
expr Expression

A date expression.

required
days Expression

An integer expression representing the number of days to subtract.

required

Returns:

Name Type Description
Expression Expression

a Date expression.

Examples:

1
2
3
4
5
6
>>> import daft
>>> from daft.functions import date_sub
>>> df = daft.from_pydict({"d": ["2021-01-10", "2021-06-15"], "n": [5, 10]})
>>> df = df.with_column("d", df["d"].cast(daft.DataType.date()))
>>> df = df.with_column("result", date_sub(df["d"], df["n"]))
>>> df.schema()["result"].dtype == daft.DataType.date()
True
Source code in daft/functions/datetime.py
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
def date_sub(expr: Expression, days: Expression) -> Expression:
    """Subtracts a number of days from a date.

    Args:
        expr: A date expression.
        days: An integer expression representing the number of days to subtract.

    Returns:
        Expression: a Date expression.

    Examples:
        >>> import daft
        >>> from daft.functions import date_sub
        >>> df = daft.from_pydict({"d": ["2021-01-10", "2021-06-15"], "n": [5, 10]})
        >>> df = df.with_column("d", df["d"].cast(daft.DataType.date()))
        >>> df = df.with_column("result", date_sub(df["d"], df["n"]))
        >>> df.schema()["result"].dtype == daft.DataType.date()
        True
    """
    return Expression._call_builtin_scalar_fn("date_sub", expr, days)