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 codegen

A collection of generators that build custom bytecode at runtime for performing the evaluation of catalyst expression.

Definition Classes: expressions

BaseMutableProjection

ExpressionCanonicalizer

FalseLiteral

GenerateMutableProjection

GenerateOrdering

GeneratePredicate

GenerateSafeProjection

GenerateUnsafeProjection

GenerateUnsafeRowJoiner

LazilyGeneratedOrdering

LiteralValue

SimpleExprValue

SubExprCodes

SubExprEliminationState

org.apache.spark.sql.catalyst.expressions.codegen

ExprCode

Companion object ExprCode

case class ExprCode(code: Block, isNull: ExprValue, value: ExprValue) extends Product with Serializable

Java source for evaluating an Expression given a InternalRow of input.

code: The sequence of statements required to evaluate the expression. It should be empty string, if isNull and value are already existed, or no code needed to evaluate them (literals).
isNull: A term that holds a boolean value representing whether the expression evaluated to null.
value: A term for a (possibly primitive) value of the result of the evaluation. Not valid if isNull is set to true.

Linear Supertypes

Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ExprCode
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new ExprCode(code: Block, isNull: ExprValue, value: ExprValue)
code
The sequence of statements required to evaluate the expression. It should be empty string, if isNull and value are already existed, or no code needed to evaluate them (literals).
isNull
A term that holds a boolean value representing whether the expression evaluated to null.
value
A term for a (possibly primitive) value of the result of the evaluation. Not valid if isNull is set to true.

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 clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
var code: Block
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
var isNull: ExprValue
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def productElementNames: Iterator[String]
Definition Classes
Product
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
var value: ExprValue
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
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()

Packages

Standard Expressions

Named Expressions

Evaluation

ExprCode

Companion object ExprCode

case class ExprCode(code: Block, isNull: ExprValue, value: ExprValue) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Standard Expressions

Named Expressions

Evaluation

ExprCode

Companion object ExprCode

case class ExprCode(code: Block, isNull: ExprValue, value: ExprValue) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

ExprCode