org.apache.iceberg.spark.functions

Class BucketFunction

java.lang.Object

org.apache.iceberg.spark.functions.BucketFunction

All Implemented Interfaces:

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

public class BucketFunction
extends java.lang.Object
implements org.apache.spark.sql.connector.catalog.functions.UnboundFunction

A Spark function implementation for the Iceberg bucket transform.

Example usage: SELECT system.bucket(128, 'abc'), which returns the bucket 122.

Note that for performance reasons, the given input number of buckets is not validated in the implementations used in code-gen. The number of buckets must be positive to give meaningful results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketFunction.BucketBase
static class	BucketFunction.BucketBinary
static class	BucketFunction.BucketDecimal
static class	BucketFunction.BucketInt
static class	BucketFunction.BucketLong
static class	BucketFunction.BucketString

Constructor Summary

Constructors

Constructor and Description
BucketFunction()

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()
java.lang.String	name()

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketFunction

public BucketFunction()

Method Detail

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

description

public java.lang.String description()

Specified by:

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

name

public java.lang.String name()

Specified by:

name in interface org.apache.spark.sql.connector.catalog.functions.Function