Class/Object

com.mongodb.spark.config

ReadConfig

Related Docs: object ReadConfig | package config

Permalink

case class ReadConfig(databaseName: String, collectionName: String, connectionString: Option[String] = None, sampleSize: Int = ReadConfig.DefaultSampleSize, partitioner: MongoPartitioner = ReadConfig.DefaultPartitioner, partitionerOptions: Map[String, String] = ..., localThreshold: Int = ..., readPreferenceConfig: ReadPreferenceConfig = ReadPreferenceConfig(), readConcernConfig: ReadConcernConfig = ReadConcernConfig(), registerSQLHelperFunctions: Boolean = ...) extends MongoCollectionConfig with MongoClassConfig with Product with Serializable

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

partitioner

the class name of the partitioner to use to create partitions

partitionerOptions

the configuration options for the partitioner

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.

readPreferenceConfig

the readPreference configuration

readConcernConfig

the readConcern configuration

Since

1.0

Linear Supertypes
Product, Equals, MongoClassConfig, MongoCollectionConfig, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReadConfig
  2. Product
  3. Equals
  4. MongoClassConfig
  5. MongoCollectionConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReadConfig(databaseName: String, collectionName: String, connectionString: Option[String] = None, sampleSize: Int = ReadConfig.DefaultSampleSize, partitioner: MongoPartitioner = ReadConfig.DefaultPartitioner, partitionerOptions: Map[String, String] = ..., localThreshold: Int = ..., readPreferenceConfig: ReadPreferenceConfig = ReadPreferenceConfig(), readConcernConfig: ReadConcernConfig = ReadConcernConfig(), registerSQLHelperFunctions: Boolean = ...)

    Permalink

    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

    partitioner

    the class name of the partitioner to use to create partitions

    partitionerOptions

    the configuration options for the partitioner

    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.

    readPreferenceConfig

    the readPreference configuration

    readConcernConfig

    the readConcern configuration

Type Members

  1. type Self = ReadConfig

    Permalink

    Defines Self as a type that can be used to return a copy of the object i.e.

    Defines Self as a type that can be used to return a copy of the object i.e. a different instance of the same type

    Definition Classes
    ReadConfigMongoClassConfig

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def asJavaOptions: Map[String, String]

    Permalink

    Creates a map of options representing the configuration

    Creates a map of options representing the configuration

    returns

    the map representing the configuration values

    Definition Classes
    ReadConfigMongoClassConfig
  6. def asOptions: Map[String, String]

    Permalink

    Creates a map of options representing this config.

    Creates a map of options representing this config.

    returns

    the map representing the config

    Definition Classes
    ReadConfigMongoClassConfig
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val collectionName: String

    Permalink

    the collection name

    the collection name

    Definition Classes
    ReadConfigMongoCollectionConfig
  9. val connectionString: Option[String]

    Permalink

    the optional connection string used in the creation of this configuration

  10. val databaseName: String

    Permalink

    the database name

    the database name

    Definition Classes
    ReadConfigMongoCollectionConfig
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  15. val localThreshold: Int

    Permalink

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request.

    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.

  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. val partitioner: MongoPartitioner

    Permalink

    the class name of the partitioner to use to create partitions

  20. val partitionerOptions: Map[String, String]

    Permalink

    the configuration options for the partitioner

  21. def readConcern: ReadConcern

    Permalink

    The ReadConcern to use

    The ReadConcern to use

    returns

    the ReadConcern

  22. val readConcernConfig: ReadConcernConfig

    Permalink

    the readConcern configuration

  23. def readPreference: ReadPreference

    Permalink

    The ReadPreference to use

    The ReadPreference to use

    returns

    the ReadPreference

  24. val readPreferenceConfig: ReadPreferenceConfig

    Permalink

    the readPreference configuration

  25. val registerSQLHelperFunctions: Boolean

    Permalink
  26. val sampleSize: Int

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withOption(key: String, value: String): ReadConfig

    Permalink

    Creates a new config with the options applied

    Creates a new config with the options applied

    key

    the configuration key

    value

    the configuration value

    returns

    an updated config

    Definition Classes
    ReadConfigMongoClassConfig
  32. def withOptions(options: Map[String, String]): ReadConfig

    Permalink

    Creates a new config with the options applied

    Creates a new config with the options applied

    options

    a map of options to be applied to the config

    returns

    an updated config

    Definition Classes
    ReadConfigMongoClassConfig
  33. def withOptions(options: Map[String, String]): ReadConfig

    Permalink

    Creates a new config with the options applied

    Creates a new config with the options applied

    options

    a map of options to be applied to the config

    returns

    an updated config

    Definition Classes
    ReadConfigMongoClassConfig

Inherited from Product

Inherited from Equals

Inherited from MongoClassConfig

Inherited from MongoCollectionConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped