daft.functions.uuid#

def uuid(version: Literal["v4", "v7"] = "v4") -> Expression:
    """Generates a column of UUID strings.

    Each call to `uuid()` generates a fresh UUID per row. Multiple calls in the same query
    (e.g. two separate columns) are independent and will produce different values.

    Use the ``version`` argument to choose the UUID version:

    - ``uuid()`` or ``uuid(version="v4")`` generates random UUIDv4 values.
    - ``uuid(version="v7")`` generates time-ordered UUIDv7 values.

    Args:
        version: UUID version to generate. Supported values are ``"v4"`` and ``"v7"``.

    Returns:
        Expression (UUID Expression): An expression that generates UUID values.

    Examples:
        >>> import daft
        >>> from daft.functions import uuid
        >>> df = daft.from_pydict({"row": [1, 2]}).select(uuid_v4=uuid(), uuid_v7=uuid(version="v7"))
        >>> df.show()  # doctest: +SKIP
        ╭────────────────────────────────┬────────────────────────────────╮
        │ uuid_v4                        ┆ uuid_v7                        │
        │ ---                            ┆ ---                            │
        │ UUID                           ┆ UUID                           │
        ╞════════════════════════════════╪════════════════════════════════╡
        │ 06b4460f-d44e-4f37-bb71-edb3b… ┆ 019eb73f-58c8-7f50-b31d-46f02… │
        ├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
        │ 74648614-aebf-41f3-9591-781d5… ┆ 019eb73f-58c8-7f50-b31d-47002… │
        ╰────────────────────────────────┴────────────────────────────────╯
        <BLANKLINE>
        (Showing first 2 of 2 rows)
    """
    if version == "v4":
        return Expression._call_builtin_scalar_fn("uuid")
    if version == "v7":
        return Expression._call_builtin_scalar_fn("uuidv7")
    raise ValueError("`version` must be 'v4' or 'v7'")