relationalai.std.dates.minute()

minute(date: datetime|Producer, tz: str|Producer = "UTC") -> Expression

Extracts the minute component from a UTC datetime value. If tz is specified, then date is converted from UTC to the specified timezone before extracting the minute. tz is ignored if date is a Python datetime object. If any of the arguments are Producer objects, then minute() also acts as a filter and removes invalid values from the producer, including dates. Must be called in a rule or query context.

Parameters

Name	Type	Description
date	Producer or Python datetime object	The datetime value from which to extract the minute.
tz	Producer or Python str object	Optional timezone string (e.g., "America/New_York"), offset string (e.g., "+0600"), or Python tzinfo object. Refer to the timezone database for a list of valid timezone identifiers. Ignored if date is a Python date or datetime object. (Default: "UTC").

Returns

An Expression object.

Raises

TypeError if the date parameter is not a Producer object or Python date or datetime object.

Example

Use minute() to extract the minute component from UTC datetime values:

import relationalai as rai
from relationalai.std import alias, dates


# =====
# SETUP
# =====

model = rai.Model("MyModel2")
Event = model.Type("Event")

with model.rule():
    Event.add(id=1).set(time=dates.datetime(2021, 1, 1, 1, 30))
    Event.add(id=2).set(time="invalid")


# =======
# EXAMPLE
# =======

with model.rule():
    event = Event()
    # minute() filters out any events with invalid time values, so the
    # following only sets the minute property for Event 1.
    event.set(minute=dates.minute(event.time))
    # Since Event 2 is filtered out above, the following only sets the
    # has_valid_time property for Event 1.
    event.set(has_valid_time=True)

with model.query() as select:
    event = Event()
    response = select(event.id, event.time, event.minute, event.has_valid_time)

print(response.results)
#    id                 time  minute has_valid_time
# 0   1  2021-01-01 01:30:00    30.0           True
# 1   2              invalid     NaN            NaN

If the tz parameter is specified, the datetime is converted from UTC to the specified timezone before extracting the minute:

with model.query() as select:
    event = Event()
    minute1 = dates.minute(event.time, tz="America/New_York")
    minute2 = dates.minute(event.time, tz="+0600")
    response = select(event.id, event.time, alias(minute1, "minute1"), alias(minute2, "minute2"))

print(response.results)
#    id                time  minute1  minute2
# 0   1 2021-01-01 01:30:00       30       30

Note that minute() does not return 0 for date values. Instead, because minute() expects a datetime value, date values are filtered out:

with model.query() as select:
    date = dates.date(2021, 1, 1)
    response = select(dates.minute(date))

print(response.results)
# Empty DataFrame
# Columns: []
# Index: []

See Also

• year()
• month()
• day()
• hour()
• second()