iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
iceberg::YearTransform Class Reference

Year transform that extracts the number of years from timestamp inputs since the epoch. More...

#include <transform_function.h>

Inheritance diagram for iceberg::YearTransform:
iceberg::TransformFunction

Public Member Functions

 YearTransform (std::shared_ptr< Type > const &source_type)
 
Result< LiteralTransform (const Literal &literal) override
 Extract a date or timestamp year, as years from 1970.
 
std::shared_ptr< TypeResultType () const override
 Returns INT32 as the output type.
 
- Public Member Functions inherited from iceberg::TransformFunction
 TransformFunction (TransformType transform_type, std::shared_ptr< Type > source_type)
 
TransformType transform_type () const
 Get the transform type.
 
const std::shared_ptr< Type > & source_type () const
 Get the source type of transform function.
 

Static Public Member Functions

static Result< std::unique_ptr< TransformFunction > > Make (std::shared_ptr< Type > const &source_type)
 Create a YearTransform.
 

Detailed Description

Year transform that extracts the number of years from timestamp inputs since the epoch.

Constructor & Destructor Documentation

◆ YearTransform()

iceberg::YearTransform::YearTransform ( std::shared_ptr< Type > const &  source_type)
explicit
Parameters
source_typeMust be a timestamp type.

Member Function Documentation

◆ Make()

Result< std::unique_ptr< TransformFunction > > iceberg::YearTransform::Make ( std::shared_ptr< Type > const &  source_type)
static

Create a YearTransform.

Parameters
source_typeType of the input data.
Returns
A Result containing the YearTransform or an error.

◆ ResultType()

std::shared_ptr< Type > iceberg::YearTransform::ResultType ( ) const
overridevirtual

Returns INT32 as the output type.

Implements iceberg::TransformFunction.

◆ Transform()

Result< Literal > iceberg::YearTransform::Transform ( const Literal literal)
overridevirtual

Extract a date or timestamp year, as years from 1970.

Implements iceberg::TransformFunction.


The documentation for this class was generated from the following files: