Package org.apache.spark.sql

Interface SQLContextCompanion

public interface SQLContextCompanion
This SQLContext object contains utility functions to create a singleton SQLContext instance, or to get the created SQLContext instance.

It also provides utility functions to support preference for threads in multiple sessions scenario, setActive could set a SQLContext for current thread, which will be returned by getOrCreate instead of the global one.

  • Method Details

    • clearActive

      void clearActive()
      Deprecated.
      Use SparkSession.clearActiveSession instead. Since 2.0.0.
      Clears the active SQLContext for current thread. Subsequent calls to getOrCreate will return the first created context instead of a thread-local override.

      Since:
      1.6.0

    • getOrCreate

      SQLContextCompanion getOrCreate(SparkContext sparkContext)
      Deprecated.
      Use SparkSession.builder instead. Since 2.0.0.
      Get the singleton SQLContext if it exists or create a new one using the given SparkContext.

      This function can be used to create a singleton SQLContext object that can be shared across the JVM.

      If there is an active SQLContext for current thread, it will be returned instead of the global one.

      Parameters:
      sparkContext - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.5.0

    • setActive

      void setActive(SQLContextCompanion sqlContext)
      Deprecated.
      Use SparkSession.setActiveSession instead. Since 2.0.0.
      Changes the SQLContext that will be returned in this thread and its children when SQLContext.getOrCreate() is called. This can be used to ensure that a given thread receives a SQLContext with an isolated session, instead of the global (first created) context.

      Parameters:
      sqlContext - (undocumented)
      Since:
      1.6.0