Loading...

verticapy.sql.functions.week#

verticapy.sql.functions.week(expr: 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#

StringSQL

SQL string.

Examples#

First, let’s import the vDataFrame in order to create a dummy dataset.

from verticapy import vDataFrame

Now, let’s import the VerticaPy SQL functions.

import verticapy.sql.functions as vpf

We can now build a dummy dataset.

df = vDataFrame(
    {
        "x": [
            '11-03-1993 12:05:10.23',
            '09-05-1959 03:10:20.12',
        ],
    },
)
df["x"].astype("timestamp")

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

df["week_x"] = vpf.week(df["x"])
display(df)
📅
x
Timestamp
100%
123
week_x
Integer
100%
11993-11-03 12:05:10.23000045
21959-09-05 03:10:20.12000036

Note

It’s crucial to utilize VerticaPy 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. VerticaPy effectively manages these changes, a task not achievable with pure SQL.

See also

vDataFrame.eval() : Evaluates the expression.