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 aggregate
Definition Classes
expressions
AggregateExpression
AggregateFunction
AggregateMode
AnyValue
ApproxCountDistinctForIntervals
ApproximatePercentile
Average
BitAggregate
BitAndAgg
BitOrAgg
BitXorAgg
BloomFilterAggregate
BoolAnd
BoolOr
CentralMomentAgg
Collect
CollectList
CollectSet
CollectTopK
Complete
Corr
Count
CountIf
CountMinSketchAgg
CountMinSketchAggExpressionBuilder
CovPopulation
CovSample
Covariance
DeclarativeAggregate
Final
First
FirstLast
HistogramNumeric
HllSketchAgg
HllUnionAgg
HyperLogLogPlusPlus
ImperativeAggregate
Kurtosis
Last
ListAgg
Max
MaxBy
MaxMinBy
Median
Min
MinBy
Mode
ModeBuilder
NoOp
NumericHistogramSerializer
PandasCovar
PandasKurtosis
PandasMode
PandasProduct
PandasSkewness
PandasStddev
PandasVariance
Partial
PartialMerge
PearsonCorrelation
Percentile
PercentileBase
PercentileCont
PercentileContBuilder
PercentileDisc
PercentileDiscBuilder
PivotFirst
Product
RegrAvgX
RegrAvgY
RegrCount
RegrIntercept
RegrR2
RegrReplacement
RegrSXX
RegrSXY
RegrSYY
RegrSlope
Skewness
StddevPop
StddevSamp
Sum
SupportsOrderingWithinGroup
TryAverageExpressionBuilder
TrySumExpressionBuilder
TypedAggregateWithHashMapAsBuffer
TypedImperativeAggregate
V2Aggregator
VariancePop
VarianceSamp

t

org.apache.spark.sql.catalyst.expressions.aggregate

SupportsOrderingWithinGroup

trait SupportsOrderingWithinGroup extends AnyRef

The trait used to set the SortOrder for supporting functions.

Self Type: SupportsOrderingWithinGroup with AggregateFunction

Linear Supertypes

AnyRef, Any

Known Subclasses

ListAgg, Mode, PercentileCont, PercentileDisc

Ordering

Alphabetic
By Inheritance

Inherited

SupportsOrderingWithinGroup
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def isDistinctSupported: Boolean
Tells Analyzer that DISTINCT is supported.
Tells Analyzer that DISTINCT is supported. The DISTINCT can conflict with order so some functions can ban it.
See also
QueryCompilationErrors.distinctWithOrderingFunctionUnsupportedError
abstract def isOrderingMandatory: Boolean
Tells Analyzer that WITHIN GROUP (ORDER BY ...) is mandatory for function.
Tells Analyzer that WITHIN GROUP (ORDER BY ...) is mandatory for function.
See also
QueryCompilationErrors.functionMissingWithinGroupError
abstract def orderingFilled: Boolean
Indicator that ordering was set.
abstract def withOrderingWithinGroup(orderingWithinGroup: Seq[SortOrder]): AggregateFunction

Concrete 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]) @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 hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
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()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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)

Inherited from AnyRef

Inherited from Any

Ungrouped