object SparkSession extends Logging with Serializable
- Annotations
- @Stable()
- Source
- SparkSession.scala
- Alphabetic
- By Inheritance
- SparkSession
- Serializable
- Serializable
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
Builder extends Logging
Builder for SparkSession.
Builder for SparkSession.
- Annotations
- @Stable()
Value Members
-
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
-
def
builder(): Builder
Creates a SparkSession.Builder for constructing a SparkSession.
Creates a SparkSession.Builder for constructing a SparkSession.
- Since
2.0.0
-
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
-
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
-
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
-
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
-
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
-
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