Package org.apache.spark.sql.connector.expressions

Class ClusterByTransform

Object

org.apache.spark.sql.connector.expressions.ClusterByTransform

All Implemented Interfaces:

Serializable, Expression, RewritableTransform, Transform, scala.Equals, scala.Product

public final class ClusterByTransform
extends Object
implements RewritableTransform, scala.Product, Serializable

This class represents a transform for ClusterBySpec. This is used to bundle ClusterBySpec in CreateTable's partitioning transforms to pass it down to analyzer.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.apache.spark.sql.connector.expressions.Expression

EMPTY_EXPRESSION, EMPTY_NAMED_REFERENCE

Constructor Summary

Constructors

Constructor	Description
ClusterByTransform(scala.collection.immutable.Seq<NamedReference> columnNames)

Method Summary

Modifier and Type	Method	Description
Expression[]	arguments()	Returns the arguments passed to the transform function.
scala.collection.immutable.Seq<NamedReference>	columnNames()
String	name()	Returns the transform function name.
NamedReference[]	references()	List of fields or columns that are referenced by this expression.
String	toString()
static scala.Option<scala.collection.immutable.Seq<NamedReference>>	unapply(Transform transform)
Transform	withReferences(scala.collection.immutable.Seq<NamedReference> newReferences)	Creates a copy of this transform with the new analyzed references.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface org.apache.spark.sql.connector.expressions.Expression

describe

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface org.apache.spark.sql.connector.expressions.Transform

children

Constructor Details

ClusterByTransform

public ClusterByTransform(scala.collection.immutable.Seq<NamedReference> columnNames)

Method Details

unapply

public static scala.Option<scala.collection.immutable.Seq<NamedReference>> unapply(Transform transform)

columnNames

public scala.collection.immutable.Seq<NamedReference> columnNames()

name

public String name()

Description copied from interface: Transform

Returns the transform function name.

Specified by:

name in interface Transform

references

public NamedReference[] references()

Description copied from interface: Expression

List of fields or columns that are referenced by this expression.

Specified by:

references in interface Expression

arguments

public Expression[] arguments()

Description copied from interface: Transform

Returns the arguments passed to the transform function.

Specified by:

arguments in interface Transform

toString

public String toString()

Overrides:

toString in class Object

withReferences

public Transform withReferences(scala.collection.immutable.Seq<NamedReference> newReferences)

Description copied from interface: RewritableTransform

Creates a copy of this transform with the new analyzed references.

Specified by:

withReferences in interface RewritableTransform