Datetime Extract#

group Extracting

Enums

enum class datetime_component : uint8_t#

Types of datetime components that may be extracted.

Values:

enumerator YEAR#
enumerator MONTH#
enumerator DAY#
enumerator WEEKDAY#
enumerator HOUR#
enumerator MINUTE#
enumerator SECOND#
enumerator MILLISECOND#
enumerator MICROSECOND#
enumerator NANOSECOND#

Functions

std::unique_ptr<cudf::column> extract_datetime_component(cudf::column_view const &column, datetime_component component, rmm::cuda_stream_view stream = cudf::get_default_stream(), rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref())#

Extracts the specified datetime component from any datetime type and returns an int16_t cudf::column.

Parameters:
  • columncudf::column_view of the input datetime values

  • component – The datetime component to extract

  • stream – CUDA stream used for device memory operations and kernel launches

  • mr – Device memory resource used to allocate device memory of the returned column

Throws:

cudf::logic_error – if input column datatype is not TIMESTAMP

Returns:

cudf::column of the extracted int16_t datetime component