year()#
relationalai.std.dates
#year(date: date | datetime | Producer, tz: str = "UTC") -> Expression
Extracts the year component from a Date
or DateTime
value.
If date
is a Python date
or datetime
object, the tz
parameter is ignored.
Must be called in a rule or query context.
Parameters#
Name | Type | Description |
---|---|---|
date | date or datetime or Producer | The Date or DateTime value from which to extract the year. |
tz | str | Optional timezone component for DateTime values (default is “UTC”). Ignored if date is a Python date or datetime object. |
Returns#
An Expression
that produces the year component of the given Date
or DateTime
value.
Raises#
TypeError
if the date
parameter is not a date
, datetime
, or Producer
object.
Example#
Use year()
to extract the year component from a Date
value:
#import relationalai as rai
from relationalai.std import alias
from relationalai.std.dates import year, date
# Create a model named "people" with a `Person` type.
model = rai.Model("people")
Person = model.Type("Person")
# Add a person with a birth date.
with model.rule():
Person.add(name="Alice", birth_date=date(1990, 5, 23))
# Extract the year from birth_date.
with model.query() as select:
person = Person()
birth_year = year(person.birth_date)
response = select(person.name, alias(birth_year, "birth_year"))
print(response.results)
# Output:
# name birth_year
# 0 Alice 1990
You can also use year()
to extract the year component from a DateTime
value:
#import relationalai as rai
from relationalai.std import alias
from relationalai.std.dates import year, datetime
# Create a model named "people" with a `Person` type.
model = rai.Model("people")
Person = model.Type("Person")
# Add a person with a birth datetime.
with model.rule():
Person.add(
name="Bob",
born_at=datetime(1985, 8, 15, 15, 45, 0, tz="UTC")
)
# Extract the year from born_at.
with model.query() as select:
person = Person()
birth_year = year(person.born_at)
response = select(person.name, alias(birth_year, "birth_year"))
print(response.results)
# Output:
# name birth_year
# 0 Bob 1985