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
  • package codegen

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

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

    Definition Classes
    expressions
  • package csv
    Definition Classes
    expressions
  • package json
    Definition Classes
    expressions
  • package objects
    Definition Classes
    expressions
  • package st
    Definition Classes
    expressions
  • GeospatialInputTypes
  • ST_AsBinary
  • ST_GeogFromWKB
  • ST_GeomFromWKB
  • ST_SetSrid
  • ST_Srid
  • package url
    Definition Classes
    expressions
  • package variant
    Definition Classes
    expressions
  • package xml
    Definition Classes
    expressions

package st

Type Members

  1. sealed trait GeospatialInputTypes extends Expression with ImplicitCastInputTypes

    ST expressions are behind a feature flag while the geospatial module is under development.

  2. case class ST_AsBinary(geo: Expression) extends Expression with RuntimeReplaceable with GeospatialInputTypes with UnaryLike[Expression] with Product with Serializable

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format.

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format. See https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary for more details on the WKB format.

    Annotations
    @ExpressionDescription()
  3. case class ST_GeogFromWKB(wkb: Expression) extends Expression with RuntimeReplaceable with GeospatialInputTypes with UnaryLike[Expression] with Product with Serializable

    Parses the WKB description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the WKB description of a geography and returns the corresponding GEOGRAPHY value. The SRID value of the returned GEOGRAPHY value is 4326. See https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary for more details on the WKB format.

    Annotations
    @ExpressionDescription()
  4. case class ST_GeomFromWKB(wkb: Expression) extends Expression with RuntimeReplaceable with GeospatialInputTypes with UnaryLike[Expression] with Product with Serializable

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is 0. See https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary for more details on the WKB format.

    Annotations
    @ExpressionDescription()
  5. case class ST_SetSrid(geo: Expression, srid: Expression) extends Expression with RuntimeReplaceable with GeospatialInputTypes with BinaryLike[Expression] with Product with Serializable

    Returns a new GEOGRAPHY or GEOMETRY value whose SRID is the specified SRID value.

    Returns a new GEOGRAPHY or GEOMETRY value whose SRID is the specified SRID value.

    Annotations
    @ExpressionDescription()
  6. case class ST_Srid(geo: Expression) extends Expression with RuntimeReplaceable with GeospatialInputTypes with UnaryLike[Expression] with Product with Serializable

    Returns the SRID of the input GEOGRAPHY or GEOMETRY value.

    Returns the SRID of the input GEOGRAPHY or GEOMETRY value. Returns NULL if the input is NULL. See https://en.wikipedia.org/wiki/Spatial_reference_system#Identifier for more details on the Spatial Reference System Identifier (SRID).

    Annotations
    @ExpressionDescription()

Ungrouped