daft.functions.date_diff#

def date_diff(end: Expression, start: Expression) -> Expression:
    """Returns the number of days between two dates.

    Args:
        end: The end date or timestamp expression.
        start: The start date or timestamp expression.

    Returns:
        Expression: an Int32 expression with the number of days (end - start).

    Examples:
        >>> import daft
        >>> from daft.functions import date_diff
        >>> df = daft.from_pydict({"a": ["2021-01-10"], "b": ["2021-01-01"]})
        >>> df = df.with_column("a", df["a"].cast(daft.DataType.date()))
        >>> df = df.with_column("b", df["b"].cast(daft.DataType.date()))
        >>> df = df.with_column("diff", date_diff(df["a"], df["b"]))
        >>> df.schema()["diff"].dtype == daft.DataType.int32()
        True
    """
    return Expression._call_builtin_scalar_fn("date_diff", end, start)