pyarrow.compute.day_of_week¶
-
pyarrow.compute.day_of_week(values, *, memory_pool=None, options=None, count_from_zero=True, week_start=1)¶ Extract day of the week number.
By default, the week starts on Monday represented by 0 and ends on Sunday represented by 6. DayOfWeekOptions.week_start can be used to set another starting day using the ISO numbering convention (1=start week on Monday, 7=start week on Sunday). Day numbers can start at 0 or 1 based on DayOfWeekOptions.count_from_zero. Null values emit null. An error is returned if the values have a defined timezone but it cannot be found in the timezone database.
- Parameters
values (Array-like or scalar-like) – Argument to compute function
memory_pool (pyarrow.MemoryPool, optional) – If not passed, will allocate memory from the default memory pool.
options (pyarrow.compute.DayOfWeekOptions, optional) – Parameters altering compute function semantics.
count_from_zero (optional) – Parameter for DayOfWeekOptions constructor. Either options or count_from_zero can be passed, but not both at the same time.
week_start (optional) – Parameter for DayOfWeekOptions constructor. Either options or week_start can be passed, but not both at the same time.