The type of the output column depends on the component extracted. Where the component is a name (e.g. of the day of week), the result will be a categorical column. Otherwise it will be numeric.

component
string
default: "day"required

The name of the date component to extract.

Values must be one of the following:

date day day_name dayofmonth dayofweek dayofyear hour minute month month_name part_of_day partofday period_of_day periodofday quarter season second time week weekday weekday_name weekofyear year

tz
string
default: "UTC"

The timezone to use when extracting the date component. The timezone to use when extracting the date component. If not specified, the timezone of the column metadata will be used. If the column metadata does not specify a timezone, UTC will be used. The expected format is [+/-]HH:MM, e.g. +01:00, 02:00, -05:00, +00:00, etc.

Was this page helpful?