Packages

c

org.apache.spark.sql.internal

BaseSessionStateBuilder

abstract class BaseSessionStateBuilder extends AnyRef

Builder class that coordinates construction of a new SessionState.

The builder explicitly defines all components needed by the session state, and creates a session state when build is called. Components should only be initialized once. This is not a problem for most components as they are only used in the build function. However some components (conf, catalog, functionRegistry, experimentalMethods & sqlParser) are as dependencies for other components and are shared as a result. These components are defined as lazy vals to make sure the component is created only once.

A developer can modify the builder by providing custom versions of components, or by using the hooks provided for the analyzer, optimizer & planner. There are some dependencies between the components (they are documented per dependency), a developer should respect these when making modifications in order to prevent initialization problems.

A parent SessionState can be used to initialize the new SessionState. The new session state will clone the parent sessions state's conf, functionRegistry, experimentalMethods and catalog fields. Note that the state is cloned when build is called, and not before.

Annotations
@Unstable()
Linear Supertypes
AnyRef, Any
Known Subclasses
SessionStateBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseSessionStateBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BaseSessionStateBuilder(session: SparkSession, parentState: Option[SessionState])

Type Members

  1. type NewBuilder = (SparkSession, Option[SessionState]) => BaseSessionStateBuilder

Abstract Value Members

  1. abstract def newBuilder: NewBuilder

    Function that produces a new instance of the BaseSessionStateBuilder.

    Function that produces a new instance of the BaseSessionStateBuilder. This is used by the SessionState's clone functionality. Make sure to override this when implementing your own SessionStateBuilder.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def analyzer: Analyzer

    Logical query plan analyzer for resolving unresolved attributes and relations.

    Logical query plan analyzer for resolving unresolved attributes and relations.

    Note: this depends on the conf and catalog fields.

    Attributes
    protected
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def build(): SessionState

    Build the SessionState.

  7. lazy val catalog: SessionCatalog

    Catalog for managing table and database states.

    Catalog for managing table and database states. If there is a pre-existing catalog, the state of that catalog (temp tables & current database) will be copied into the new catalog.

    Note: this depends on the conf, functionRegistry and sqlParser fields.

    Attributes
    protected
  8. lazy val catalogManager: CatalogManager
    Attributes
    protected
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def columnarRules: Seq[ColumnarRule]
    Attributes
    protected
  11. lazy val conf: SQLConf

    SQL-specific key-value configurations.

    SQL-specific key-value configurations.

    These either get cloned from a pre-existing instance or newly created. The conf is merged with its SparkConf only when there is no parent session.

    Attributes
    protected
  12. def createClone: (SparkSession, SessionState) => SessionState

    Function used to make clones of the session state.

    Function used to make clones of the session state.

    Attributes
    protected
  13. def createQueryExecution: (LogicalPlan, execution.CommandExecutionMode.Value) => QueryExecution

    Create a query execution object.

    Create a query execution object.

    Attributes
    protected
  14. def customCheckRules: Seq[(LogicalPlan) => Unit]

    Custom check rules to add to the Analyzer.

    Custom check rules to add to the Analyzer. Prefer overriding this instead of creating your own Analyzer.

    Note that this may NOT depend on the analyzer function.

    Attributes
    protected
  15. def customEarlyScanPushDownRules: Seq[Rule[LogicalPlan]]

    Custom early scan push down rules to add to the Optimizer.

    Custom early scan push down rules to add to the Optimizer. Prefer overriding this instead of creating your own Optimizer.

    Note that this may NOT depend on the optimizer function.

    Attributes
    protected
  16. def customOperatorOptimizationRules: Seq[Rule[LogicalPlan]]

    Custom operator optimization rules to add to the Optimizer.

    Custom operator optimization rules to add to the Optimizer. Prefer overriding this instead of creating your own Optimizer.

    Note that this may NOT depend on the optimizer function.

    Attributes
    protected
  17. def customPlanningStrategies: Seq[Strategy]

    Custom strategies to add to the planner.

    Custom strategies to add to the planner. Prefer overriding this instead of creating your own Planner.

    Note that this may NOT depend on the planner function.

    Attributes
    protected
  18. def customPostHocResolutionRules: Seq[Rule[LogicalPlan]]

    Custom post resolution rules to add to the Analyzer.

    Custom post resolution rules to add to the Analyzer. Prefer overriding this instead of creating your own Analyzer.

    Note that this may NOT depend on the analyzer function.

    Attributes
    protected
  19. def customPreCBORules: Seq[Rule[LogicalPlan]]

    Custom rules for rewriting plans after operator optimization and before CBO.

    Custom rules for rewriting plans after operator optimization and before CBO. Prefer overriding this instead of creating your own Optimizer.

    Note that this may NOT depend on the optimizer function.

    Attributes
    protected
  20. def customResolutionRules: Seq[Rule[LogicalPlan]]

    Custom resolution rules to add to the Analyzer.

    Custom resolution rules to add to the Analyzer. Prefer overriding this instead of creating your own Analyzer.

    Note that this may NOT depend on the analyzer function.

    Attributes
    protected
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. lazy val experimentalMethods: ExperimentalMethods

    Experimental methods that can be used to define custom optimization rules and custom planning strategies.

    Experimental methods that can be used to define custom optimization rules and custom planning strategies.

    This either gets cloned from a pre-existing version or newly created.

    Attributes
    protected
  24. def extensions: SparkSessionExtensions

    Session extensions defined in the SparkSession.

    Session extensions defined in the SparkSession.

    Attributes
    protected
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. lazy val functionRegistry: FunctionRegistry

    Internal catalog managing functions registered by the user.

    Internal catalog managing functions registered by the user.

    This either gets cloned from a pre-existing version or cloned from the built-in registry.

    Attributes
    protected
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def listenerManager: ExecutionListenerManager

    An interface to register custom org.apache.spark.sql.util.QueryExecutionListeners that listen for execution metrics.

    An interface to register custom org.apache.spark.sql.util.QueryExecutionListeners that listen for execution metrics.

    This gets cloned from parent if available, otherwise a new instance is created.

    Attributes
    protected
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def optimizer: Optimizer

    Logical query plan optimizer.

    Logical query plan optimizer.

    Note: this depends on catalog and experimentalMethods fields.

    Attributes
    protected
  35. val parentState: Option[SessionState]
  36. def planner: SparkPlanner

    Planner that converts optimized logical plans to physical plans.

    Planner that converts optimized logical plans to physical plans.

    Note: this depends on the conf and experimentalMethods fields.

    Attributes
    protected
  37. def queryStagePrepRules: Seq[Rule[SparkPlan]]
    Attributes
    protected
  38. lazy val resourceLoader: SessionResourceLoader

    ResourceLoader that is used to load function resources and jars.

    ResourceLoader that is used to load function resources and jars.

    Attributes
    protected
  39. val session: SparkSession
  40. lazy val sqlParser: ParserInterface

    Parser that extracts expressions, plans, table identifiers etc.

    Parser that extracts expressions, plans, table identifiers etc. from SQL texts.

    Note: this depends on the conf field.

    Attributes
    protected
  41. def streamingQueryManager: StreamingQueryManager

    Interface to start and stop streaming queries.

    Interface to start and stop streaming queries.

    Attributes
    protected
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. lazy val tableFunctionRegistry: TableFunctionRegistry

    Internal catalog managing functions registered by the user.

    Internal catalog managing functions registered by the user.

    This either gets cloned from a pre-existing version or cloned from the built-in registry.

    Attributes
    protected
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. def udfRegistration: UDFRegistration

    Interface exposed to the user for registering user-defined functions.

    Interface exposed to the user for registering user-defined functions.

    Note 1: The user-defined functions must be deterministic. Note 2: This depends on the functionRegistry field.

    Attributes
    protected
  46. lazy val v2SessionCatalog: V2SessionCatalog
    Attributes
    protected
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped