vastorbit.sql.functions.week¶

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

Returns the week of the year for the specified date as an integer, where the first week begins on the first Sunday on or preceding January 1.

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": [
            '1993-11-03 12:05:10.23',
            '1959-09-05 03:10:20.12',
        ],
    },
)
df["x"].astype("timestamp")

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

df["week_x"] = vof.week(df["x"])
display(df)

	📅 x Timestamp 100%	123 week_x Bigint 100%
1	1993-11-03 12:05:10.230000	44
2	1959-09-05 03:10:20.120000	36

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.