org.apache.flink.connector.mongodb.sink.writer.serializer

Interface MongoSerializationSchema<IN>

Type Parameters:

IN - The message type send to MongoDB.

All Superinterfaces:

Serializable

All Known Implementing Classes:

MongoRowDataSerializationSchema

@PublicEvolving
public interface MongoSerializationSchema<IN>
extends Serializable

The serialization schema for how to serialize records into MongoDB.

Method Summary

Modifier and Type	Method and Description
default void	open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext initializationContext, MongoSinkContext sinkContext, MongoWriteOptions sinkConfiguration) Initialization method for the schema.
com.mongodb.client.model.WriteModel<org.bson.BsonDocument>	serialize(IN element, MongoSinkContext sinkContext) Serializes the given element into WriteModel.

Method Detail

open

default void open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext initializationContext,
                  MongoSinkContext sinkContext,
                  MongoWriteOptions sinkConfiguration)
           throws Exception

Initialization method for the schema. It is called before the actual working methods serialize(Object, MongoSinkContext) and thus suitable for one-time setup work.

The provided SerializationSchema.InitializationContext can be used to access additional features such as registering user metrics.

Parameters:

initializationContext - Contextual information that can be used during initialization.

sinkContext - Runtime information i.e. partitions, subtaskId.

sinkConfiguration - All the configure options for the MongoDB sink.

Throws:

Exception

serialize

com.mongodb.client.model.WriteModel<org.bson.BsonDocument> serialize(IN element,
                                                                     MongoSinkContext sinkContext)

Serializes the given element into WriteModel.

Parameters:

element - Element to be serialized.

sinkContext - Context to provide extra information.