org.apache.iceberg.spark.functions

Class MonthsFunction

java.lang.Object

org.apache.iceberg.spark.functions.MonthsFunction

All Implemented Interfaces:

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

public class MonthsFunction
extends java.lang.Object

A Spark function implementation for the Iceberg month transform.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonthsFunction.DateToMonthsFunction
static class	MonthsFunction.TimestampToMonthsFunction

Constructor Summary

Constructors

Constructor and Description
MonthsFunction()

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

MonthsFunction

public MonthsFunction()

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