io.debezium.connector.postgresql.connection

Class PostgresReplicationConnection.ReplicationConnectionBuilder

java.lang.Object

io.debezium.connector.postgresql.connection.PostgresReplicationConnection.ReplicationConnectionBuilder

All Implemented Interfaces:

ReplicationConnection.Builder

Enclosing class:

PostgresReplicationConnection

protected static class PostgresReplicationConnection.ReplicationConnectionBuilder
extends Object
implements ReplicationConnection.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration	config
private boolean	dropSlotOnClose
private boolean	exportSnapshot
private PostgresConnectorConfig.LogicalDecoder	plugin
private String	publicationName
private PostgresSchema	schema
private String	slotName
private Properties	slotStreamParams
private Duration	statusUpdateIntervalVal
private TypeRegistry	typeRegistry

Fields inherited from interface io.debezium.connector.postgresql.connection.ReplicationConnection.Builder

DEFAULT_DROP_SLOT_ON_CLOSE, DEFAULT_EXPORT_SNAPSHOT, DEFAULT_PUBLICATION_NAME, DEFAULT_SLOT_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReplicationConnectionBuilder(Configuration config)

Method Summary

Modifier and Type	Method and Description
ReplicationConnection	build() Creates a new ReplicationConnection instance
PostgresReplicationConnection.ReplicationConnectionBuilder	dropSlotOnClose(boolean dropSlotOnClose) Whether or not to drop the replication slot once the replication connection closes
ReplicationConnection.Builder	exportSnapshotOnCreate(boolean exportSnapshot) Whether or not to export the snapshot when creating the slot
PostgresReplicationConnection.ReplicationConnectionBuilder	statusUpdateInterval(Duration statusUpdateInterval) The number of milli-seconds the replication connection should periodically send updates to the server.
PostgresReplicationConnection.ReplicationConnectionBuilder	streamParams(String slotStreamParams) Optional parameters to pass to the logical decoder when the stream starts.
PostgresReplicationConnection.ReplicationConnectionBuilder	withPlugin(PostgresConnectorConfig.LogicalDecoder plugin) Sets the instance for the PG logical decoding plugin
ReplicationConnection.Builder	withPublication(String publicationName) Sets the publication name for the PG logical publication
ReplicationConnection.Builder	withSchema(PostgresSchema schema) Sets the schema instance
PostgresReplicationConnection.ReplicationConnectionBuilder	withSlot(String slotName) Sets the name for the PG logical replication slot
ReplicationConnection.Builder	withTypeRegistry(TypeRegistry typeRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

config

private final Configuration config

slotName

private String slotName

publicationName

private String publicationName

plugin

private PostgresConnectorConfig.LogicalDecoder plugin

dropSlotOnClose

private boolean dropSlotOnClose

statusUpdateIntervalVal

private Duration statusUpdateIntervalVal

exportSnapshot

private boolean exportSnapshot

typeRegistry

private TypeRegistry typeRegistry

schema

private PostgresSchema schema

slotStreamParams

private Properties slotStreamParams

Constructor Detail

ReplicationConnectionBuilder

protected ReplicationConnectionBuilder(Configuration config)

Method Detail

withSlot

public PostgresReplicationConnection.ReplicationConnectionBuilder withSlot(String slotName)

Description copied from interface: ReplicationConnection.Builder

Sets the name for the PG logical replication slot

Specified by:

withSlot in interface ReplicationConnection.Builder

Parameters:

slotName - the name of the slot, may not be null.

Returns:

this instance

See Also:

ReplicationConnection.Builder.DEFAULT_SLOT_NAME

withPublication

public ReplicationConnection.Builder withPublication(String publicationName)

Description copied from interface: ReplicationConnection.Builder

Sets the publication name for the PG logical publication

Specified by:

withPublication in interface ReplicationConnection.Builder

Parameters:

publicationName - the name of the publication, may not be null.

Returns:

this instance

See Also:

ReplicationConnection.Builder.DEFAULT_PUBLICATION_NAME

withPlugin

public PostgresReplicationConnection.ReplicationConnectionBuilder withPlugin(PostgresConnectorConfig.LogicalDecoder plugin)

Description copied from interface: ReplicationConnection.Builder

Sets the instance for the PG logical decoding plugin

Specified by:

withPlugin in interface ReplicationConnection.Builder

Returns:

this instance

See Also:

#PROTOBUF_PLUGIN_NAME

dropSlotOnClose

public PostgresReplicationConnection.ReplicationConnectionBuilder dropSlotOnClose(boolean dropSlotOnClose)

Description copied from interface: ReplicationConnection.Builder

Whether or not to drop the replication slot once the replication connection closes

Specified by:

dropSlotOnClose in interface ReplicationConnection.Builder

Parameters:

dropSlotOnClose - true if the slot should be dropped once the connection is closed, false otherwise

Returns:

this instance

See Also:

ReplicationConnection.Builder.DEFAULT_DROP_SLOT_ON_CLOSE

streamParams

public PostgresReplicationConnection.ReplicationConnectionBuilder streamParams(String slotStreamParams)

Description copied from interface: ReplicationConnection.Builder

Optional parameters to pass to the logical decoder when the stream starts.

Specified by:

streamParams in interface ReplicationConnection.Builder

Parameters:

slotStreamParams - String of key and value pairs declared with "=". Pairs are separated by ";". Example: "add-tables=public.table,public.table2;include-lsn=true"

Returns:

this instance

See Also:

#STREAM_PARAMS

statusUpdateInterval

public PostgresReplicationConnection.ReplicationConnectionBuilder statusUpdateInterval(Duration statusUpdateInterval)

Description copied from interface: ReplicationConnection.Builder

The number of milli-seconds the replication connection should periodically send updates to the server.

Specified by:

statusUpdateInterval in interface ReplicationConnection.Builder

Parameters:

statusUpdateInterval - a duration; null or non-positive value causes Postgres' default to be applied

Returns:

this instance

exportSnapshotOnCreate

public ReplicationConnection.Builder exportSnapshotOnCreate(boolean exportSnapshot)

Description copied from interface: ReplicationConnection.Builder

Whether or not to export the snapshot when creating the slot

Specified by:

exportSnapshotOnCreate in interface ReplicationConnection.Builder

Parameters:

exportSnapshot - true if a snapshot should be exported, false if otherwise

Returns:

this instance

See Also:

ReplicationConnection.Builder.DEFAULT_EXPORT_SNAPSHOT

build

public ReplicationConnection build()

Description copied from interface: ReplicationConnection.Builder

Creates a new ReplicationConnection instance

Specified by:

build in interface ReplicationConnection.Builder

Returns:

a connection, never null

withTypeRegistry

public ReplicationConnection.Builder withTypeRegistry(TypeRegistry typeRegistry)

Specified by:

withTypeRegistry in interface ReplicationConnection.Builder

withSchema

public ReplicationConnection.Builder withSchema(PostgresSchema schema)

Description copied from interface: ReplicationConnection.Builder

Sets the schema instance

Specified by:

withSchema in interface ReplicationConnection.Builder

Parameters:

schema - the schema, must not be null

Returns:

this instance