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

类 MongoReadOptions.MongoReadOptionsBuilder

java.lang.Object

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

封闭类:

MongoReadOptions

@PublicEvolving
public static class MongoReadOptions.MongoReadOptionsBuilder
extends Object

Builder for MongoReadOptions.

方法概要

限定符和类型	方法和说明
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	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.

从类继承的方法 java.lang.Object

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

方法详细资料

setFetchSize

public MongoReadOptions.MongoReadOptionsBuilder setFetchSize(int fetchSize)

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

参数:

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

返回:

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.

参数:

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

返回:

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.

参数:

partitionStrategy - the strategy of a partition.

返回:

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.

参数:

partitionSize - the memory size of a partition.

返回:

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

参数:

samplesPerPartition - number of samples per partition.

返回:

this builder

build

public MongoReadOptions build()

Build the MongoReadOptions.

返回:

a MongoReadOptions with the settings made for this builder.