org.apache.flink.connector.mongodb.source

Class MongoSource<OUT>

java.lang.Object

org.apache.flink.connector.mongodb.source.MongoSource<OUT>

Type Parameters:

OUT - The output type of the source.

All Implemented Interfaces:

Serializable, org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>, org.apache.flink.api.connector.source.SourceReaderFactory<OUT,MongoSourceSplit>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>

@PublicEvolving
public class MongoSource<OUT>
extends Object
implements org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>

The Source implementation of MongoDB. Use a MongoSourceBuilder to construct a MongoSource. The following example shows how to create a MongoSource emitting records of String type.

 MongoSource<String> source = MongoSource.<String>builder()
      .setUri("mongodb://user:password@127.0.0.1:27017")
      .setDatabase("db")
      .setCollection("coll")
      .setDeserializationSchema(new MongoJsonDeserializationSchema())
      .build();
 

See MongoSourceBuilder for more details.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <OUT> MongoSourceBuilder<OUT>	builder() Get a MongoSourceBuilder to builder a MongoSource.
org.apache.flink.api.connector.source.SplitEnumerator<MongoSourceSplit,MongoSourceEnumState>	createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<MongoSourceSplit> enumContext)
org.apache.flink.api.connector.source.SourceReader<OUT,MongoSourceSplit>	createReader(org.apache.flink.api.connector.source.SourceReaderContext readerContext)
org.apache.flink.api.connector.source.Boundedness	getBoundedness()
org.apache.flink.core.io.SimpleVersionedSerializer<MongoSourceEnumState>	getEnumeratorCheckpointSerializer()
org.apache.flink.api.common.typeinfo.TypeInformation<OUT>	getProducedType()
org.apache.flink.core.io.SimpleVersionedSerializer<MongoSourceSplit>	getSplitSerializer()
org.apache.flink.api.connector.source.SplitEnumerator<MongoSourceSplit,MongoSourceEnumState>	restoreEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<MongoSourceSplit> enumContext, MongoSourceEnumState checkpoint)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <OUT> MongoSourceBuilder<OUT> builder()

Get a MongoSourceBuilder to builder a MongoSource.

Returns:

a Mongo source builder.

getBoundedness

public org.apache.flink.api.connector.source.Boundedness getBoundedness()

Specified by:

getBoundedness in interface org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>

createReader

public org.apache.flink.api.connector.source.SourceReader<OUT,MongoSourceSplit> createReader(org.apache.flink.api.connector.source.SourceReaderContext readerContext)

Specified by:

createReader in interface org.apache.flink.api.connector.source.SourceReaderFactory<OUT,MongoSourceSplit>

createEnumerator

public org.apache.flink.api.connector.source.SplitEnumerator<MongoSourceSplit,MongoSourceEnumState> createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<MongoSourceSplit> enumContext)

Specified by:

createEnumerator in interface org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>

restoreEnumerator

public org.apache.flink.api.connector.source.SplitEnumerator<MongoSourceSplit,MongoSourceEnumState> restoreEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext<MongoSourceSplit> enumContext,
                                                                                                                      MongoSourceEnumState checkpoint)

Specified by:

restoreEnumerator in interface org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>

getSplitSerializer

public org.apache.flink.core.io.SimpleVersionedSerializer<MongoSourceSplit> getSplitSerializer()

Specified by:

getSplitSerializer in interface org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>

getEnumeratorCheckpointSerializer

public org.apache.flink.core.io.SimpleVersionedSerializer<MongoSourceEnumState> getEnumeratorCheckpointSerializer()

Specified by:

getEnumeratorCheckpointSerializer in interface org.apache.flink.api.connector.source.Source<OUT,MongoSourceSplit,MongoSourceEnumState>

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<OUT> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>