org.apache.iceberg.spark.functions

Class YearsFunction

java.lang.Object

org.apache.iceberg.spark.functions.YearsFunction

All Implemented Interfaces:

java.io.Serializable, org.apache.spark.sql.connector.catalog.functions.Function, org.apache.spark.sql.connector.catalog.functions.UnboundFunction

public class YearsFunction
extends java.lang.Object

A Spark function implementation for the Iceberg year transform.

Example usage: SELECT system.years('source_col').

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YearsFunction.DateToYearsFunction
static class	YearsFunction.TimestampNtzToYearsFunction
static class	YearsFunction.TimestampToYearsFunction

Constructor Summary

Constructors

Constructor and Description
YearsFunction()

Method Summary

Modifier and Type	Method and Description
org.apache.spark.sql.connector.catalog.functions.BoundFunction	bind(org.apache.spark.sql.types.StructType inputType)
java.lang.String	description()
protected org.apache.spark.sql.connector.catalog.functions.BoundFunction	doBind(org.apache.spark.sql.types.DataType valueType)
java.lang.String	name()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YearsFunction

public YearsFunction()

Method Detail

doBind

protected org.apache.spark.sql.connector.catalog.functions.BoundFunction doBind(org.apache.spark.sql.types.DataType valueType)

description

public java.lang.String description()

name

public java.lang.String name()

bind

public org.apache.spark.sql.connector.catalog.functions.BoundFunction bind(org.apache.spark.sql.types.StructType inputType)

Specified by:

bind in interface org.apache.spark.sql.connector.catalog.functions.UnboundFunction