Packages

object SparkSession extends Logging with Serializable

Annotations
@Stable()
Source
SparkSession.scala
Linear Supertypes
Serializable, Serializable, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparkSession
  2. Serializable
  3. Serializable
  4. Logging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Builder extends Logging

    Builder for SparkSession.

    Builder for SparkSession.

    Annotations
    @Stable()

Value Members

  1. def active: SparkSession

    Returns the currently active SparkSession, otherwise the default one.

    Returns the currently active SparkSession, otherwise the default one. If there is no default SparkSession, throws an exception.

    Since

    2.4.0

  2. def builder(): Builder

    Creates a SparkSession.Builder for constructing a SparkSession.

    Creates a SparkSession.Builder for constructing a SparkSession.

    Since

    2.0.0

  3. def clearActiveSession(): Unit

    Clears the active SparkSession for current thread.

    Clears the active SparkSession for current thread. Subsequent calls to getOrCreate will return the first created context instead of a thread-local override.

    Since

    2.0.0

  4. def clearDefaultSession(): Unit

    Clears the default SparkSession that is returned by the builder.

    Clears the default SparkSession that is returned by the builder.

    Since

    2.0.0

  5. def getActiveSession: Option[SparkSession]

    Returns the active SparkSession for the current thread, returned by the builder.

    Returns the active SparkSession for the current thread, returned by the builder.

    Since

    2.2.0

    Note

    Return None, when calling this function on executors

  6. def getDefaultSession: Option[SparkSession]

    Returns the default SparkSession that is returned by the builder.

    Returns the default SparkSession that is returned by the builder.

    Since

    2.2.0

    Note

    Return None, when calling this function on executors

  7. def setActiveSession(session: SparkSession): Unit

    Changes the SparkSession that will be returned in this thread and its children when SparkSession.getOrCreate() is called.

    Changes the SparkSession that will be returned in this thread and its children when SparkSession.getOrCreate() is called. This can be used to ensure that a given thread receives a SparkSession with an isolated session, instead of the global (first created) context.

    Since

    2.0.0

  8. def setDefaultSession(session: SparkSession): Unit

    Sets the default SparkSession that is returned by the builder.

    Sets the default SparkSession that is returned by the builder.

    Since

    2.0.0