ReadConfig

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
aggregationConfig: the aggregation configuration
registerSQLHelperFunctions: true to register sql helper functions
inferSchemaMapTypesEnabled: true to detect MapTypes when inferring Schema.
inferSchemaMapTypesMinimumKeys: the minimum number of keys before a document can be inferred as a MapType.
pipelineIncludeNullFilters: true to include and push down null and exists filters into the pipeline when using sql.
pipelineIncludeFiltersAndProjections: true to push down filters and projections into the pipeline when using sql.
samplePoolSize: the size of the pool to take a sample from, used when there is no $sample support or if there is a pushed down aggregation

Since: 1.0

Linear Supertypes

Product, Equals, MongoClassConfig, MongoCollectionConfig, Serializable, Serializable, AnyRef, Any

Instance Constructors

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(), aggregationConfig: AggregationConfig = AggregationConfig(), registerSQLHelperFunctions: Boolean = ..., inferSchemaMapTypesEnabled: Boolean = ..., inferSchemaMapTypesMinimumKeys: Int = ..., pipelineIncludeNullFilters: Boolean = ..., pipelineIncludeFiltersAndProjections: Boolean = ..., samplePoolSize: Int = ReadConfig.DefaultSamplePoolSize)

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
aggregationConfig
the aggregation configuration
registerSQLHelperFunctions
true to register sql helper functions
inferSchemaMapTypesEnabled
true to detect MapTypes when inferring Schema.
inferSchemaMapTypesMinimumKeys
the minimum number of keys before a document can be inferred as a MapType.
pipelineIncludeNullFilters
true to include and push down null and exists filters into the pipeline when using sql.
pipelineIncludeFiltersAndProjections
true to push down filters and projections into the pipeline when using sql.
samplePoolSize
the size of the pool to take a sample from, used when there is no $sample support or if there is a pushed down aggregation

Type Members

type Self = ReadConfig

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
ReadConfig → MongoClassConfig

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val aggregationConfig: AggregationConfig

the aggregation configuration
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asJavaOptions: Map[String, String]

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
ReadConfig → MongoClassConfig
def asOptions: Map[String, String]

Creates a map of options representing this config.
Creates a map of options representing this config.
returns
the map representing the config

Definition Classes
ReadConfig → MongoClassConfig
def clone(): AnyRef

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

the collection name
the collection name

Definition Classes
ReadConfig → MongoCollectionConfig
val connectionString: Option[String]

the optional connection string used in the creation of this configuration
val databaseName: String

the database name
the database name

Definition Classes
ReadConfig → MongoCollectionConfig
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val inferSchemaMapTypesEnabled: Boolean

true to detect MapTypes when inferring Schema.
val inferSchemaMapTypesMinimumKeys: Int

the minimum number of keys before a document can be inferred as a MapType.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val localThreshold: Int

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val partitioner: MongoPartitioner

the class name of the partitioner to use to create partitions
val partitionerOptions: Map[String, String]

the configuration options for the partitioner
def pipeline: List[BsonDocument]

returns
the aggregation pipeline to use from the aggregation config or an empty list
val pipelineIncludeFiltersAndProjections: Boolean

true to push down filters and projections into the pipeline when using sql.
val pipelineIncludeNullFilters: Boolean

true to include and push down null and exists filters into the pipeline when using sql.
def readConcern: ReadConcern

The ReadConcern to use
The ReadConcern to use
returns
the ReadConcern
val readConcernConfig: ReadConcernConfig

the readConcern configuration
def readPreference: ReadPreference

The ReadPreference to use
The ReadPreference to use
returns
the ReadPreference
val readPreferenceConfig: ReadPreferenceConfig

the readPreference configuration
val registerSQLHelperFunctions: Boolean

true to register sql helper functions
val samplePoolSize: Int

the size of the pool to take a sample from, used when there is no $sample support or if there is a pushed down aggregation
val sampleSize: Int

a positive integer sample size to draw from the collection when inferring the schema
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

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

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
ReadConfig → MongoClassConfig
def withOptions(options: Map[String, String]): ReadConfig

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
ReadConfig → MongoClassConfig
def withOptions(options: Map[String, String]): ReadConfig

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
ReadConfig → MongoClassConfig
def withPipeline[B <: Bson](pipeline: Seq[B]): ReadConfig

Returns a copy with the specified aggregation pipeline applied to the aggregation config
Returns a copy with the specified aggregation pipeline applied to the aggregation config
pipeline
the aggregation pipeline to use
returns
the updated Read Config

Related Docs: object ReadConfig | package config

Instance Constructors

Type Members

type Self = ReadConfig

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val aggregationConfig: AggregationConfig

final def asInstanceOf[T0]: T0

def asJavaOptions: Map[String, String]

def asOptions: Map[String, String]

def clone(): AnyRef

val collectionName: String

val connectionString: Option[String]

val databaseName: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val inferSchemaMapTypesEnabled: Boolean

val inferSchemaMapTypesMinimumKeys: Int

final def isInstanceOf[T0]: Boolean

val localThreshold: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val partitioner: MongoPartitioner

val partitionerOptions: Map[String, String]

def pipeline: List[BsonDocument]

val pipelineIncludeFiltersAndProjections: Boolean

val pipelineIncludeNullFilters: Boolean

def readConcern: ReadConcern

val readConcernConfig: ReadConcernConfig

def readPreference: ReadPreference

val readPreferenceConfig: ReadPreferenceConfig

val registerSQLHelperFunctions: Boolean

val samplePoolSize: Int

val sampleSize: Int

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withOption(key: String, value: String): ReadConfig

def withOptions(options: Map[String, String]): ReadConfig

def withOptions(options: Map[String, String]): ReadConfig

def withPipeline[B <: Bson](pipeline: Seq[B]): ReadConfig

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