org.apache.flink.connector.mongodb.sink

Class MongoSinkBuilder<IN>

java.lang.Object

org.apache.flink.connector.mongodb.sink.MongoSinkBuilder<IN>

Type Parameters:

IN - type of the records converted to MongoDB bulk request

@PublicEvolving
public class MongoSinkBuilder<IN>
extends Object

Base builder to construct a MongoSink.

Method Summary

Modifier and Type	Method and Description
MongoSink<IN>	build() Constructs the MongoSink with the properties configured this builder.
MongoSinkBuilder<IN>	setBatchIntervalMs(long batchIntervalMs) Sets the batch flush interval, in milliseconds.
MongoSinkBuilder<IN>	setBatchSize(int batchSize) Sets the maximum number of actions to buffer for each batch request.
MongoSinkBuilder<IN>	setCollection(String collection) Sets the collection to sink of MongoDB.
MongoSinkBuilder<IN>	setDatabase(String database) Sets the database to sink of MongoDB.
MongoSinkBuilder<IN>	setDeliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee) Sets the wanted DeliveryGuarantee.
MongoSinkBuilder<IN>	setMaxRetries(int maxRetries) Sets the max retry times if writing records failed.
MongoSinkBuilder<IN>	setSerializationSchema(MongoSerializationSchema<IN> serializationSchema) Sets the serialization schema which is invoked on every record to convert it to MongoDB bulk request.
MongoSinkBuilder<IN>	setUri(String uri) Sets the connection string of MongoDB.

Methods inherited from class java.lang.Object

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

Method Detail

setUri

public MongoSinkBuilder<IN> setUri(String uri)

Sets the connection string of MongoDB.

Parameters:

uri - connection string of MongoDB

Returns:

this builder

setDatabase

public MongoSinkBuilder<IN> setDatabase(String database)

Sets the database to sink of MongoDB.

Parameters:

database - the database to sink of MongoDB.

Returns:

this builder

setCollection

public MongoSinkBuilder<IN> setCollection(String collection)

Sets the collection to sink of MongoDB.

Parameters:

collection - the collection to sink of MongoDB.

Returns:

this builder

setBatchSize

public MongoSinkBuilder<IN> setBatchSize(int batchSize)

Sets the maximum number of actions to buffer for each batch request. You can pass -1 to disable batching.

Parameters:

batchSize - the maximum number of actions to buffer for each batch request.

Returns:

this builder

setBatchIntervalMs

public MongoSinkBuilder<IN> setBatchIntervalMs(long batchIntervalMs)

Sets the batch flush interval, in milliseconds. You can pass -1 to disable it.

Parameters:

batchIntervalMs - the batch flush interval, in milliseconds.

Returns:

this builder

setMaxRetries

public MongoSinkBuilder<IN> setMaxRetries(int maxRetries)

Sets the max retry times if writing records failed.

Parameters:

maxRetries - the max retry times.

Returns:

this builder

setDeliveryGuarantee

public MongoSinkBuilder<IN> setDeliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee)

Sets the wanted DeliveryGuarantee. The default delivery guarantee is DeliveryGuarantee.AT_LEAST_ONCE

Parameters:

deliveryGuarantee - which describes the record emission behaviour

Returns:

this builder

setSerializationSchema

public MongoSinkBuilder<IN> setSerializationSchema(MongoSerializationSchema<IN> serializationSchema)

Sets the serialization schema which is invoked on every record to convert it to MongoDB bulk request.

Parameters:

serializationSchema - to process records into MongoDB bulk WriteModel.

Returns:

this builder

build

public MongoSink<IN> build()

Constructs the MongoSink with the properties configured this builder.

Returns:

MongoSink