Spark Project Catalyst 4.0.2 API < Back

Packages

package root
Definition Classes
root
package org
Definition Classes
root
package apache
Definition Classes
org
package spark
Definition Classes
apache
package sql
Definition Classes
spark
package catalyst
Catalyst is a library for manipulating relational query plans.
Catalyst is a library for manipulating relational query plans. All classes in catalyst are considered an internal API to Spark SQL and are subject to change between minor releases.
Definition Classes
sql
package expressions
A set of classes that can be used to represent trees of relational expressions.
A set of classes that can be used to represent trees of relational expressions. A key goal of the expression library is to hide the details of naming and scoping from developers who want to manipulate trees of relational operators. As such, the library defines a special type of expression, a NamedExpression in addition to the standard collection of expressions.
Standard Expressions
A library of standard expressions (e.g., Add, EqualTo), aggregates (e.g., SUM, COUNT), and other computations (e.g. UDFs). Each expression type is capable of determining its output schema as a function of its children's output schema.
Named Expressions
Some expression are named and thus can be referenced by later operators in the dataflow graph. The two types of named expressions are AttributeReferences and Aliases. AttributeReferences refer to attributes of the input tuple for a given operator and form the leaves of some expression trees. Aliases assign a name to intermediate computations. For example, in the SQL statement SELECT a+b AS c FROM ..., the expressions a and b would be represented by AttributeReferences and c would be represented by an Alias.
During analysis, all named expressions are assigned a globally unique expression id, which can be used for equality comparisons. While the original names are kept around for debugging purposes, they should never be used to check if two attributes refer to the same value, as plan transformations can result in the introduction of naming ambiguity. For example, consider a plan that contains subqueries, both of which are reading from the same table. If an optimization removes the subqueries, scoping information would be destroyed, eliminating the ability to reason about which subquery produced a given attribute.
Evaluation
The result of expressions can be evaluated using the Expression.apply(Row) method.
Definition Classes
catalyst
package variant
Definition Classes
expressions
ArrayExtraction
IsVariantNull
ObjectExtraction
ParseJson
ParseJsonExpressionBuilder
ParseJsonExpressionBuilderBase
SchemaOfVariant
SchemaOfVariantAgg
ToVariantObject
TryParseJsonExpressionBuilder
TryVariantGetExpressionBuilder
VariantCastArgs
VariantExplode
VariantExplodeGeneratorBuilder
VariantExplodeGeneratorBuilderBase
VariantExplodeOuterGeneratorBuilder
VariantExpressionEvalUtils
VariantGet
VariantGetExpressionBuilder
VariantGetExpressionBuilderBase
VariantPathParser
VariantPathSegment

org.apache.spark.sql.catalyst.expressions.variant

VariantGet

Companion class VariantGet

case object VariantGet extends Product with Serializable

Linear Supertypes

Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

VariantGet
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def cast(v: Variant, dataType: DataType, castArgs: VariantCastArgs): Any
Cast a variant v into a target data type dataType.
Cast a variant v into a target data type dataType. If the variant represents a variant null, the result is always a SQL NULL. The cast may fail due to an illegal type combination (e.g., cast a variant int to binary), or an invalid input valid (e.g, cast a variant string "hello" to int). If the cast fails, throw an exception when failOnError is true, or return a SQL NULL when it is false.
def cast(input: VariantVal, dataType: DataType, castArgs: VariantCastArgs): Any
A simple wrapper of the cast function that takes Variant rather than VariantVal.
A simple wrapper of the cast function that takes Variant rather than VariantVal. The Cast expression uses it and makes the implementation simpler.
def castDecimalToString(input: Decimal): UTF8String
def castDecimalToTimestamp(input: Decimal): Long
def castLongToTimestamp(input: Long): Long
def checkDataType(dataType: DataType, allowStructsAndMaps: Boolean = true): Boolean
Returns whether a data type can be cast into/from variant.
Returns whether a data type can be cast into/from variant. For scalar types, we allow a subset of them. For nested types, we reject map types with a non-string key type.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def getParsedPath(pathValue: String, prettyName: String): Array[VariantPathSegment]
Get parsed Array[VariantPathSegment] from string representing path
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
def productElementName(n: Int): String
Definition Classes
Product
def productElementNames: Iterator[String]
Definition Classes
Product
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def variantGet(input: VariantVal, path: UTF8String, dataType: DataType, castArgs: VariantCastArgs, prettyName: String): Any
Implementation of the VariantGet expression where the path is provided as a UTF8String
def variantGet(input: VariantVal, parsedPath: Array[VariantPathSegment], dataType: DataType, castArgs: VariantCastArgs): Any
The actual implementation of the VariantGet expression.
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

Standard Expressions

Named Expressions

Evaluation

VariantGet

Companion class VariantGet

case object VariantGet extends Product with Serializable

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Standard Expressions

Named Expressions

Evaluation

VariantGet

Companion class VariantGet

case object VariantGet extends Product with Serializable

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

VariantGet