vastorbit.sql.functions.overlaps¶

Evaluates two time periods and returns true when they overlap, false otherwise.

Parameters:

start0 (SQLExpression) – DATE, TIME, or TIMESTAMP/TIMESTAMPTZ value that specifies the beginning of a time period.
end0 (SQLExpression) – DATE, TIME, or TIMESTAMP/TIMESTAMPTZ value that specifies the end of a time period.
start1 (SQLExpression) – DATE, TIME, or TIMESTAMP/TIMESTAMPTZ value that specifies the beginning of a time period.
end1 (SQLExpression) – DATE, TIME, or TIMESTAMP/TIMESTAMPTZ value that specifies the end of a time period.

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(
    {
        "start0": ['1993-11-03'],
        "end0": ['1993-03-12'],
        "start1": ['1993-11-30'],
        "end1": ['1994-11-30'],
    },
)
df["start0"].astype("timestamp")
df["start1"].astype("timestamp")
df["end0"].astype("timestamp")
df["end1"].astype("timestamp")

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

df["overlaps"] = vof.overlaps(df["start0"], df["end0"], df["start1"], df["end1"])
display(df)

	📅 start0 Timestamp 100%	📅 end0 Timestamp 100%	📅 start1 Timestamp 100%	📅 end1 Timestamp 100%	0\|1 overlaps Boolean 100%
1	1993-11-03 00:00:00	1993-12-03 00:00:00	1993-11-30 00:00:00	1994-11-30 00:00:00	✓

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.