io.debezium.connector.postgresql.connection

Interface ReplicationConnection.Builder

All Known Implementing Classes:

PostgresReplicationConnection.ReplicationConnectionBuilder

Enclosing interface:

ReplicationConnection

public static interface ReplicationConnection.Builder

A builder for ReplicationConnection

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DROP_SLOT_ON_CLOSE
static String	DEFAULT_PLUGIN_NAME
static String	DEFAULT_SLOT_NAME Default replication settings

Method Summary

Modifier and Type	Method and Description
ReplicationConnection	build() Creates a new ReplicationConnection instance
ReplicationConnection.Builder	dropSlotOnClose(boolean dropSlotOnClose) Whether or not to drop the replication slot once the replication connection closes
ReplicationConnection.Builder	statusUpdateIntervalMillis(Integer statusUpdateIntervalMillis) The number of milli-seconds the replication connection should periodically send updates to the server.
ReplicationConnection.Builder	withPlugin(String pluginName) Sets the name for the PG logical decoding plugin
ReplicationConnection.Builder	withSlot(String slotName) Sets the name for the PG logical replication slot

Field Detail

DEFAULT_SLOT_NAME

static final String DEFAULT_SLOT_NAME

Default replication settings

See Also:

Constant Field Values

DEFAULT_PLUGIN_NAME

static final String DEFAULT_PLUGIN_NAME

See Also:

Constant Field Values

DEFAULT_DROP_SLOT_ON_CLOSE

static final boolean DEFAULT_DROP_SLOT_ON_CLOSE

See Also:

Constant Field Values

Method Detail

withSlot

ReplicationConnection.Builder withSlot(String slotName)

Sets the name for the PG logical replication slot

Parameters:

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

Returns:

this instance

See Also:

DEFAULT_SLOT_NAME

withPlugin

ReplicationConnection.Builder withPlugin(String pluginName)

Sets the name for the PG logical decoding plugin

Parameters:

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

Returns:

this instance

See Also:

DEFAULT_PLUGIN_NAME

dropSlotOnClose

ReplicationConnection.Builder dropSlotOnClose(boolean dropSlotOnClose)

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

Parameters:

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

Returns:

this instance

See Also:

DEFAULT_DROP_SLOT_ON_CLOSE

statusUpdateIntervalMillis

ReplicationConnection.Builder statusUpdateIntervalMillis(Integer statusUpdateIntervalMillis)

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

Parameters:

statusUpdateIntervalMillis - a number of milli-seconds; null or non-positive value causes Postgres' default to be applied

Returns:

this instance

build

ReplicationConnection build()

Creates a new ReplicationConnection instance

Returns:

a connection, never null