pyarrow.compute.floor_temporal#
- pyarrow.compute.floor_temporal(timestamps,/,multiple=1,unit='day',*,week_starts_monday=True,ceil_is_strictly_greater=False,calendar_based_origin=False,options=None,memory_pool=None)#
Round temporal values down to nearest multiple of specified time unit.
Null values emit null.An error is returned if the values have a defined timezone but itcannot be found in the timezone database.
- Parameters:
- timestampsArray-like or scalar-like
Argument to compute function.
- multiple
int, default 1 Number of units to round to.
- unit
str, default “day” The unit in whichmultiple is expressed.Accepted values are “year”, “quarter”, “month”, “week”, “day”,“hour”, “minute”, “second”, “millisecond”, “microsecond”,“nanosecond”.
- week_starts_mondaybool, default
True If True, weeks start on Monday; if False, on Sunday.
- ceil_is_strictly_greaterbool, default
False If True, ceil returns a rounded value that is strictly greater than theinput. For example: ceiling 1970-01-01T00:00:00 to 3 hours wouldyield 1970-01-01T03:00:00 if set to True and 1970-01-01T00:00:00if set to False.This applies to the ceil_temporal function only.
- calendar_based_originbool, default
False By default, the origin is 1970-01-01T00:00:00. By setting this to True,rounding origin will be beginning of one less precise calendar unit.E.g.: rounding to hours will use beginning of day as origin.
By default time is rounded to a multiple of units since1970-01-01T00:00:00. By setting calendar_based_origin to true,time will be rounded to number of units since the last greatercalendar unit.For example: rounding to multiple of days since the beginning of themonth or to hours since the beginning of the day.Exceptions: week and quarter are not used as greater units,therefore days will be rounded to the beginning of the month notweek. Greater unit of week is a year.Note that ceiling and rounding might change sorting order of an arraynear greater unit change. For example rounding YYYY-mm-dd 23:00:00 to5 hours will ceil and round to YYYY-mm-dd+1 01:00:00 and floor toYYYY-mm-dd 20:00:00. On the other hand YYYY-mm-dd+1 00:00:00 willceil, round and floor to YYYY-mm-dd+1 00:00:00. This can break theorder of an already ordered array.
- options
pyarrow.compute.RoundTemporalOptions, optional Alternative way of passing options.
- memory_pool
pyarrow.MemoryPool, optional If not passed, will allocate memory from the default memory pool.