org.apache.flink.connector.mongodb.source.config

Class MongoReadOptions.MongoReadOptionsBuilder

java.lang.Object

org.apache.flink.connector.mongodb.source.config.MongoReadOptions.MongoReadOptionsBuilder

Enclosing class:

MongoReadOptions

@PublicEvolving
public static class MongoReadOptions.MongoReadOptionsBuilder
extends Object

Builder for MongoReadOptions.

Method Summary

Modifier and Type	Method and Description
MongoReadOptions	build() Build the MongoReadOptions.
MongoReadOptions.MongoReadOptionsBuilder	setFetchSize(int fetchSize) Sets the number of documents should be fetched per round-trip when reading.
MongoReadOptions.MongoReadOptionsBuilder	setNoCursorTimeout(boolean noCursorTimeout) The MongoDB server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
MongoReadOptions.MongoReadOptionsBuilder	setPartitionRecordSize(Integer partitionRecordSize) Sets the number of records in each partition.
MongoReadOptions.MongoReadOptionsBuilder	setPartitionSize(org.apache.flink.configuration.MemorySize partitionSize) Sets the partition memory size of MongoDB split.
MongoReadOptions.MongoReadOptionsBuilder	setPartitionStrategy(PartitionStrategy partitionStrategy) Sets the partition strategy.
MongoReadOptions.MongoReadOptionsBuilder	setSamplesPerPartition(int samplesPerPartition) Sets the number of samples to take per partition which is only used for the sample partition strategy PartitionStrategy.SAMPLE.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setFetchSize

public MongoReadOptions.MongoReadOptionsBuilder setFetchSize(int fetchSize)

Sets the number of documents should be fetched per round-trip when reading.

Parameters:

fetchSize - the number of documents should be fetched per round-trip when reading.

Returns:

this builder

setNoCursorTimeout

public MongoReadOptions.MongoReadOptionsBuilder setNoCursorTimeout(boolean noCursorTimeout)

The MongoDB server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that. If a session is idle for longer than 30 minutes, the MongoDB server marks that session as expired and may close it at any time. When the MongoDB server closes the session, it also kills any in-progress operations and open cursors associated with the session. This includes cursors configured with noCursorTimeout() or a maxTimeMS() greater than 30 minutes.

Parameters:

noCursorTimeout - Set this option to true to prevent cursor timeout (10 minutes)

Returns:

this builder

setPartitionStrategy

public MongoReadOptions.MongoReadOptionsBuilder setPartitionStrategy(PartitionStrategy partitionStrategy)

Sets the partition strategy. Available partition strategies are single, sample, split-vector, sharded and default. You can see PartitionStrategy for detail.

Parameters:

partitionStrategy - the strategy of a partition.

Returns:

this builder

setPartitionSize

public MongoReadOptions.MongoReadOptionsBuilder setPartitionSize(org.apache.flink.configuration.MemorySize partitionSize)

Sets the partition memory size of MongoDB split. Split a MongoDB collection into multiple partitions according to the partition memory size. Partitions can be read in parallel by multiple MongoScanSourceSplitReader to speed up the overall read time.

Parameters:

partitionSize - the memory size of a partition.

Returns:

this builder

setSamplesPerPartition

public MongoReadOptions.MongoReadOptionsBuilder setSamplesPerPartition(int samplesPerPartition)

Sets the number of samples to take per partition which is only used for the sample partition strategy PartitionStrategy.SAMPLE. The sample partitioner samples the collection, projects and sorts by the partition fields. Then uses every samplesPerPartition as the value to use to calculate the partition boundaries. The total number of samples taken is: samples per partition * ( count of documents / number of documents per partition).

Parameters:

samplesPerPartition - number of samples per partition.

Returns:

this builder

setPartitionRecordSize

public MongoReadOptions.MongoReadOptionsBuilder setPartitionRecordSize(@Nullable
                                                                       Integer partitionRecordSize)

Sets the number of records in each partition. This will only take effect when the partition strategy is set to Pagination.

Parameters:

partitionRecordSize - number of records in each partition.

Returns:

this builder

build

public MongoReadOptions build()

Build the MongoReadOptions.

Returns:

a MongoReadOptions with the settings made for this builder.