Trait

com.mongodb.spark.config

MongoInputConfig

Related Doc: package config

Permalink

trait MongoInputConfig extends MongoCompanionConfig

Mongo input configurations

Configurations used when reading from MongoDB

Configuration Properties

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

Since

1.0

See also

com.mongodb.spark.config.ReadConfig$

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

Type Members

  1. abstract type Self

    Permalink

    The type of the MongoConfig

    The type of the MongoConfig

    Definition Classes
    MongoCompanionConfig

Abstract Value Members

  1. abstract def apply(options: Map[String, String], default: Option[Self]): Self

    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
    MongoCompanionConfig
  2. abstract def create(options: Map[String, String], default: Self): Self

    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
    MongoCompanionConfig
  3. abstract def create(options: Map[String, String]): Self

    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
    MongoCompanionConfig
  4. abstract def create(sparkConf: SparkConf): Self

    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
    MongoCompanionConfig
    See also

    configPrefix

  5. abstract def create(javaSparkContext: JavaSparkContext): Self

    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
    MongoCompanionConfig
    See also

    configPrefix

Concrete 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]): 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
  5. 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

  6. 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

  7. final def asInstanceOf[T0]: T0

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

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

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

    Permalink

    The collection name property

  11. 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
  12. def connectionString(options: Map[String, String]): ConnectionString

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  13. def databaseName(databaseNameProperty: String, options: Map[String, String], default: Option[String] = None): String

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

    Permalink

    The database name property

  15. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  24. 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

  25. 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

  26. 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
  27. final def ne(arg0: AnyRef): Boolean

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

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

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

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

    Permalink

    The ReadConcern level property

    The ReadConcern level property

    See also

    ReadConcernConfig

  32. val readPreferenceNameProperty: String

    Permalink

    The ReadPreference name property

    The ReadPreference name property

    Default: ACKNOWLEDGED

    See also

    ReadPreferenceConfig

  33. val readPreferenceTagSetsProperty: String

    Permalink

    The ReadPreference tags property

    The ReadPreference tags property

    See also

    ReadPreferenceConfig

  34. val sampleSizeProperty: String

    Permalink

    The sample size property

    The sample size property

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

  35. 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

  36. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from MongoCompanionConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped