jorisvandenbossche commented on a change in pull request #10176:
URL: https://github.com/apache/arrow/pull/10176#discussion_r648336148
##########
File path: docs/source/cpp/compute.rst
##########
@@ -860,6 +860,58 @@ null input value is converted into a null output value.
available).
+Temporal component extraction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These functions extract datetime components (year, month, day, etc) from
timestamp type.
+Note: this is currently not supported for timestamps with timezone information.
+
++--------------------+------------+-------------------+---------------+--------+
+| Function name | Arity | Input types | Output type | Notes
|
++====================+============+===================+===============+========+
+| year | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| month | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| day | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| day_of_week | Unary | Temporal | Int64 | \(1)
|
++--------------------+------------+-------------------+---------------+--------+
+| day_of_year | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| iso_year | Unary | Temporal | Int64 | \(2)
|
++--------------------+------------+-------------------+---------------+--------+
+| iso_week | Unary | Temporal | Int64 | \(2)
|
++--------------------+------------+-------------------+---------------+--------+
+| iso_calendar | Unary | Temporal | Struct | \(3)
|
++--------------------+------------+-------------------+---------------+--------+
+| quarter | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| hour | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| minute | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| second | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| millisecond | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| microsecond | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| nanosecond | Unary | Temporal | Int64 |
|
++--------------------+------------+-------------------+---------------+--------+
+| subsecond | Unary | Temporal | Double |
|
++--------------------+------------+-------------------+---------------+--------+
+
+* \(1) Outputs the number of the day of the week. Week begins on Monday and is
denoted
+ by 0 and ends on Sunday denoted by 6.
+* \(2) First ISO week has the majority (4 or more) of it's days in January.
ISO year
+ starts with the first ISO week.
+ See `ISO 8601 week date definition`_ for more details.
+* \(3) Output is a ``{"iso_year": output type, "iso_week": output type,
"day_of_week": output type}`` Struct.
Review comment:
```suggestion
* \(3) Output is a ``{"iso_year": output type, "iso_week": output type,
"iso_day_of_week": output type}`` Struct.
```
Just noted one last detail, but @rok let's leave this for your next PR to
fix this, so we can let CI continue here and get this merged ;)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
