Packages

c

org.apache.spark.sql

RuntimeConfig

abstract class RuntimeConfig extends AnyRef

Runtime configuration interface for Spark. To access this, use SparkSession.conf.

Options set here are automatically propagated to the Hadoop configuration during I/O.

Annotations
@Stable()
Since

2.0.0

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

Instance Constructors

  1. new RuntimeConfig()

Abstract Value Members

  1. abstract def get(key: String, default: String): String

    Returns the value of Spark runtime configuration property for the given key.

    Returns the value of Spark runtime configuration property for the given key. If the key is not set yet, return the user given default. This is useful when its default value defined by Apache Spark is not the desired one.

    Since

    2.0.0

  2. abstract def get(key: String): String

    Returns the value of Spark runtime configuration property for the given key.

    Returns the value of Spark runtime configuration property for the given key. If the key is not set yet, return its default value if possible, otherwise NoSuchElementException will be thrown.

    Annotations
    @throws("if the key is not set and there is no default value")
    Since

    2.0.0

    Exceptions thrown

    java.util.NoSuchElementException if the key is not set and does not have a default value

  3. abstract def getAll: Map[String, String]

    Returns all properties set in this conf.

    Returns all properties set in this conf.

    Since

    2.0.0

  4. abstract def getOption(key: String): Option[String]

    Returns the value of Spark runtime configuration property for the given key.

    Returns the value of Spark runtime configuration property for the given key. If the key is not set yet, return its default value if possible, otherwise None will be returned.

    Since

    2.0.0

  5. abstract def isModifiable(key: String): Boolean

    Indicates whether the configuration property with the given key is modifiable in the current session.

    Indicates whether the configuration property with the given key is modifiable in the current session.

    returns

    true if the configuration property is modifiable. For static SQL, Spark Core, invalid (not existing) and other non-modifiable configuration properties, the returned value is false.

    Since

    2.4.0

  6. abstract def set(key: String, value: String): Unit

    Sets the given Spark runtime configuration property.

    Sets the given Spark runtime configuration property.

    Since

    2.0.0

  7. abstract def unset(key: String): Unit

    Resets the configuration property for the given key.

    Resets the configuration property for the given key.

    Since

    2.0.0

Concrete Value Members

  1. def set(key: String, value: Long): Unit

    Sets the given Spark runtime configuration property.

    Sets the given Spark runtime configuration property.

    Since

    2.0.0

  2. def set(key: String, value: Boolean): Unit

    Sets the given Spark runtime configuration property.

    Sets the given Spark runtime configuration property.

    Since

    2.0.0