Object/Class

com.mongodb.spark.config

ReadConfig

Related Docs: class ReadConfig | package config

Permalink

object ReadConfig extends MongoInputConfig

The ReadConfig companion object

Configuration Properties

The prefix when using sparkConf is: spark.mongodb.input. followed by the property name:

Since

1.0

Linear Supertypes
MongoInputConfig, MongoCompanionConfig, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReadConfig
  2. MongoInputConfig
  3. MongoCompanionConfig
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type Self = ReadConfig

    Permalink

    The type of the MongoConfig

    The type of the MongoConfig

    Definition Classes
    ReadConfigMongoCompanionConfig

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(options: Map[String, String], default: Option[ReadConfig]): ReadConfig

    Permalink

    Create a configuration from the values in the Map, using the optional default configuration for any default values.

    Create a configuration from the values in the Map, using the optional default configuration for any default values.

    *Note:* Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    default

    the optional default configuration, used for determining the default values for the properties

    returns

    the configuration

    Definition Classes
    ReadConfigMongoCompanionConfig
  5. def apply(options: Map[String, String]): Self

    Permalink

    Create a configuration from the values in the Map

    Create a configuration from the values in the Map

    *Note:* Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
  6. def apply(sparkConf: SparkConf, options: Map[String, String]): Self

    Permalink

    Create a configuration from the sparkConf

    Create a configuration from the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    options

    overloaded parameters

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  7. def apply(sparkConf: SparkConf): Self

    Permalink

    Create a configuration from the sparkConf

    Create a configuration from the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  8. def apply(sparkContext: SparkContext): Self

    Permalink

    Create a configuration from the sparkContext

    Create a configuration from the sparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkContext

    the spark context

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collectionName(collectionNameProperty: String, options: Map[String, String], default: Option[String] = None): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  12. val collectionNameProperty: String

    Permalink

    The collection name property

    The collection name property

    Definition Classes
    MongoInputConfig
  13. val configPrefix: String

    Permalink

    The configuration prefix string for the current configuration scope

    The configuration prefix string for the current configuration scope

    Definition Classes
    MongoInputConfigMongoCompanionConfig
  14. def connectionString(options: Map[String, String]): ConnectionString

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  15. def create(options: Map[String, String], default: ReadConfig): ReadConfig

    Permalink

    Create a configuration easily from the Java API using the values in the Map, using the optional default configuration for any default values.

    Create a configuration easily from the Java API using the values in the Map, using the optional default configuration for any default values.

    *Note:* Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    default

    the optional default configuration, used for determining the default values for the properties

    returns

    the configuration

    Definition Classes
    ReadConfigMongoCompanionConfig
  16. def create(options: Map[String, String]): ReadConfig

    Permalink

    Create a configuration easily from the Java API using the values in the Map

    Create a configuration easily from the Java API using the values in the Map

    *Note:* Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    returns

    the configuration

    Definition Classes
    ReadConfigMongoCompanionConfig
  17. def create(sparkConf: SparkConf): ReadConfig

    Permalink

    Create a configuration easily from the Java API using the sparkConf

    Create a configuration easily from the Java API using the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    returns

    the configuration

    Definition Classes
    ReadConfigMongoCompanionConfig
    See also

    configPrefix

  18. def create(javaSparkContext: JavaSparkContext): ReadConfig

    Permalink

    Create a configuration easily from the Java API using the JavaSparkContext

    Create a configuration easily from the Java API using the JavaSparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    javaSparkContext

    the java spark context

    returns

    the configuration

    Definition Classes
    ReadConfigMongoCompanionConfig
    See also

    configPrefix

  19. def create(databaseName: String, collectionName: String, connectionString: String, sampleSize: Int, maxChunkSize: Int, splitKey: String, localThreshold: Int, readPreference: ReadPreference, readConcern: ReadConcern): ReadConfig

    Permalink

    Read Configuration used when reading data from MongoDB

    Read Configuration used when reading data from MongoDB

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    sampleSize

    a positive integer sample size to draw from the collection when inferring the schema

    maxChunkSize

    the maximum chunkSize for non-sharded collections

    splitKey

    the key to split the collection by for non-sharded collections or the "shard key" for sharded collection

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    readPreference

    the readPreference configuration

    readConcern

    the readConcern configuration

    Since

    1.0

  20. def databaseName(databaseNameProperty: String, options: Map[String, String], default: Option[String] = None): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  21. val databaseNameProperty: String

    Permalink

    The database name property

    The database name property

    Definition Classes
    MongoInputConfig
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def getBoolean(newValue: Option[String], existingValue: Option[Boolean] = None, defaultValue: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def getInt(newValue: Option[String], existingValue: Option[Int] = None, defaultValue: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  28. def getString(newValue: Option[String], existingValue: Option[String] = None, defaultValue: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. val localThresholdProperty: String

    Permalink

    The localThreshold property

    The localThreshold property

    The local threshold in milliseconds is used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time *plus* the local threshold will be chosen.

    For example when choosing which MongoS to send a request through a localThreshold of 0 would pick the MongoS with the fastest ping time.

    Default: 15 ms

    Definition Classes
    MongoInputConfig
  32. val maxChunkSizeProperty: String

    Permalink

    The max chunk size property

    The max chunk size property

    Represents the max size (in MB) for each partition. Only used when partitioning non-sharded collections. Default: 64

    Definition Classes
    MongoInputConfig
  33. val mongoURIProperty: String

    Permalink

    The mongo URI property

    The mongo URI property

    Represents a connection string.

    Any values set in the connection string will override any default values for the configuration.

    Definition Classes
    MongoCompanionConfig
  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. def prefixLessOptions(options: Map[String, String]): Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  38. val readConcernLevelProperty: String

    Permalink

    The ReadConcern level property

    The ReadConcern level property

    Definition Classes
    MongoInputConfig
    See also

    ReadConcernConfig

  39. val readPreferenceNameProperty: String

    Permalink

    The ReadPreference name property

    The ReadPreference name property

    Default: ACKNOWLEDGED

    Definition Classes
    MongoInputConfig
    See also

    ReadPreferenceConfig

  40. val readPreferenceTagSetsProperty: String

    Permalink

    The ReadPreference tags property

    The ReadPreference tags property

    Definition Classes
    MongoInputConfig
    See also

    ReadPreferenceConfig

  41. val sampleSizeProperty: String

    Permalink

    The sample size property

    The sample size property

    Used when sampling data from MongoDB to determine the Schema. Default: 1000

    Definition Classes
    MongoInputConfig
  42. val splitKeyProperty: String

    Permalink

    The split key property

    The split key property

    Represents the key to be used when partitioning the data in the collection. Default: _id

    Definition Classes
    MongoInputConfig
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  44. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  45. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MongoInputConfig

Inherited from MongoCompanionConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped