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 analysis

    Provides a logical query plan Analyzer and supporting classes for performing analysis.

    Provides a logical query plan Analyzer and supporting classes for performing analysis. Analysis consists of translating UnresolvedAttributes and UnresolvedRelations into fully typed objects using information in a schema Catalog.

    Definition Classes
    catalyst
  • package catalog
    Definition Classes
    catalyst
  • package csv
    Definition Classes
    catalyst
  • package dsl

    A collection of implicit conversions that create a DSL for constructing catalyst data structures.

    A collection of implicit conversions that create a DSL for constructing catalyst data structures.

    scala> import org.apache.spark.sql.catalyst.dsl.expressions._

// Standard operators are added to expressions.
scala> import org.apache.spark.sql.catalyst.expressions.Literal
scala> Literal(1) + Literal(1)
res0: org.apache.spark.sql.catalyst.expressions.Add = (1 + 1)

// There is a conversion from 'symbols to unresolved attributes.
scala> 'a.attr
res1: org.apache.spark.sql.catalyst.analysis.UnresolvedAttribute = 'a

// These unresolved attributes can be used to create more complicated expressions.
scala> 'a === 'b
res2: org.apache.spark.sql.catalyst.expressions.EqualTo = ('a = 'b)

// SQL verbs can be used to construct logical query plans.
scala> import org.apache.spark.sql.catalyst.plans.logical._
scala> import org.apache.spark.sql.catalyst.dsl.plans._
scala> LocalRelation($"key".int, $"value".string).where('key === 1).select('value).analyze
res3: org.apache.spark.sql.catalyst.plans.logical.LogicalPlan =
Project [value#3]
 Filter (key#2 = 1)
  LocalRelation [key#2,value#3], []
    Definition Classes
    catalyst
  • package encoders
    Definition Classes
    catalyst
  • 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 json
    Definition Classes
    catalyst
  • package optimizer
    Definition Classes
    catalyst
  • package parser
    Definition Classes
    catalyst
  • package planning

    Contains classes for enumerating possible physical plans for a given logical query plan.

    Contains classes for enumerating possible physical plans for a given logical query plan.

    Definition Classes
    catalyst
  • ExtractEquiJoinKeys
  • ExtractFiltersAndInnerJoins
  • ExtractSingleColumnNullAwareAntiJoin
  • GenericStrategy
  • GroupBasedRowLevelOperation
  • NodeWithOnlyDeterministicProjectAndFilter
  • OperationHelper
  • PhysicalAggregation
  • PhysicalOperation
  • PhysicalWindow
  • QueryPlanner
  • ScanOperation
  • package plans

    A collection of common abstractions for query plans as well as a base logical plan representation.

    A collection of common abstractions for query plans as well as a base logical plan representation.

    Definition Classes
    catalyst
  • package rules

    A framework for applying batches rewrite rules to trees, possibly to fixed point.

    A framework for applying batches rewrite rules to trees, possibly to fixed point.

    Definition Classes
    catalyst
  • package streaming
    Definition Classes
    catalyst
  • package trees

    A library for easily manipulating trees of operators.

    A library for easily manipulating trees of operators. Operators that extend TreeNode are granted the following interface:

    • Scala collection like methods (foreach, map, flatMap, collect, etc)

    - transform - accepts a partial function that is used to generate a new tree. When the partial function can be applied to a given tree segment, that segment is replaced with the result. After attempting to apply the partial function to a given node, the transform function recursively attempts to apply the function to that node's children.

    • debugging support - pretty printing, easy splicing of trees, etc.
    Definition Classes
    catalyst
  • package types
    Definition Classes
    catalyst
  • package util
    Definition Classes
    catalyst

package planning

Contains classes for enumerating possible physical plans for a given logical query plan.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. planning
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract class GenericStrategy[PhysicalPlan <: TreeNode[PhysicalPlan]] extends Logging

    Given a LogicalPlan, returns a list of PhysicalPlans that can be used for execution.

    Given a LogicalPlan, returns a list of PhysicalPlans that can be used for execution. If this strategy does not apply to the given logical operation then an empty list should be returned.

  2. trait OperationHelper extends AliasHelper with PredicateHelper
  3. abstract class QueryPlanner[PhysicalPlan <: TreeNode[PhysicalPlan]] extends AnyRef

    Abstract class for transforming LogicalPlans into physical plans.

    Abstract class for transforming LogicalPlans into physical plans. Child classes are responsible for specifying a list of GenericStrategy objects that each of which can return a list of possible physical plan options. If a given strategy is unable to plan all of the remaining operators in the tree, it can call planLater, which returns a placeholder object that will be collected and filled in using other available strategies.

    TODO: RIGHT NOW ONLY ONE PLAN IS RETURNED EVER... PLAN SPACE EXPLORATION WILL BE IMPLEMENTED LATER.

    PhysicalPlan

    The type of physical plan produced by this QueryPlanner

Value Members

  1. object ExtractEquiJoinKeys extends Logging with PredicateHelper

    A pattern that finds joins with equality conditions that can be evaluated using equi-join.

    A pattern that finds joins with equality conditions that can be evaluated using equi-join.

    Null-safe equality will be transformed into equality as joining key (replace null with default value).

  2. object ExtractFiltersAndInnerJoins extends PredicateHelper

    A pattern that collects the filter and inner joins.

    A pattern that collects the filter and inner joins.

    Filter | inner Join / \ ----> (Seq(plan0, plan1, plan2), conditions) Filter plan2 | inner join / \ plan0 plan1

    Note: This pattern currently only works for left-deep trees.

  3. object ExtractSingleColumnNullAwareAntiJoin extends JoinSelectionHelper with PredicateHelper
  4. object GroupBasedRowLevelOperation

    An extractor for row-level commands such as DELETE, UPDATE, MERGE that were rewritten using plans that operate on groups of rows.

    An extractor for row-level commands such as DELETE, UPDATE, MERGE that were rewritten using plans that operate on groups of rows.

    This class extracts the following entities:

    • the group-based rewrite plan;
    • the condition that defines matching groups;
    • the read relation that can be either DataSourceV2Relation or DataSourceV2ScanRelation depending on whether the planning has already happened;
  5. object NodeWithOnlyDeterministicProjectAndFilter
  6. object PhysicalAggregation

    An extractor used when planning the physical execution of an aggregation.

    An extractor used when planning the physical execution of an aggregation. Compared with a logical aggregation, the following transformations are performed:

    • Unnamed grouping expressions are named so that they can be referred to across phases of aggregation
    • Aggregations that appear multiple times are deduplicated.
    • The computation of the aggregations themselves is separated from the final result. For example, the count in count + 1 will be split into an AggregateExpression and a final computation that computes count.resultAttribute + 1.
  7. object PhysicalOperation extends OperationHelper

    A pattern that matches any number of project or filter operations even if they are non-deterministic, as long as they satisfy the requirement of CollapseProject and CombineFilters.

    A pattern that matches any number of project or filter operations even if they are non-deterministic, as long as they satisfy the requirement of CollapseProject and CombineFilters. All filter operators are collected and their conditions are broken up and returned together with the top project operator. Aliases are in-lined/substituted if necessary.

  8. object PhysicalWindow

    An extractor used when planning physical execution of a window.

    An extractor used when planning physical execution of a window. This extractor outputs the window function type of the logical window.

    The input logical window must contain same type of window functions, which is ensured by the rule ExtractWindowExpressions in the analyzer.

  9. object ScanOperation extends OperationHelper

    A variant of PhysicalOperation which can match multiple Filters that are not combinable due to non-deterministic predicates.

    A variant of PhysicalOperation which can match multiple Filters that are not combinable due to non-deterministic predicates. This is useful for scan operations as we need to match a bunch of adjacent Projects/Filters to apply column pruning, even if the Filters can't be combined, such as Project(a, Filter(rand() > 0.5, Filter(rand() < 0.8, TableScan))), which we should only read column a from the relation.

Inherited from AnyRef

Inherited from Any

Ungrouped