Interface ReplicationRequest.LogicalReplicationRequestBuilder

All Superinterfaces:

ReplicationRequest.LogicalReplicationStep1, ReplicationRequest.LogicalReplicationStep2, ReplicationRequest.WithSlotName, ReplicationRequest.WithSlotOption, ReplicationRequest.WithStartPosition, ReplicationRequest.WithStatusInterval

Enclosing class:

ReplicationRequest

public static interface ReplicationRequest.LogicalReplicationRequestBuilder
extends ReplicationRequest.LogicalReplicationStep1, ReplicationRequest.LogicalReplicationStep2, ReplicationRequest.WithSlotName, ReplicationRequest.WithStartPosition, ReplicationRequest.WithStatusInterval, ReplicationRequest.WithSlotOption

Fluent builder interface to configure a logical replication stream.

Method Summary

Modifier and Type	Method	Description
ReplicationRequest	build()	Returns the logical ReplicationRequest.
ReplicationRequest.LogicalReplicationRequestBuilder	slotName(String slotName)	Replication slots provide an automated way to ensure that the primary does not remove WAL segments until they have been received by all standbys, and that the primary does not remove rows which could cause a recovery conflict even when the standby is disconnected.
ReplicationRequest.LogicalReplicationRequestBuilder	slotOption(String option, Object value)	Configure slot option.
ReplicationRequest.LogicalReplicationRequestBuilder	startPosition(LogSequenceNumber lsn)	Specify start position from which backend will start stream changes.
ReplicationRequest.LogicalReplicationRequestBuilder	statusInterval(Duration interval)	Specifies the number of time between status packets sent back to the server.

Method Details

slotName

ReplicationRequest.LogicalReplicationRequestBuilder slotName(String slotName)

Replication slots provide an automated way to ensure that the primary does not remove WAL segments until they have been received by all standbys, and that the primary does not remove rows which could cause a recovery conflict even when the standby is disconnected.

Specified by:

slotName in interface ReplicationRequest.LogicalReplicationStep1

Specified by:

slotName in interface ReplicationRequest.WithSlotName

Parameters:

slotName - not null replication slot already exists on server

Returns:

this builder

startPosition

ReplicationRequest.LogicalReplicationRequestBuilder startPosition(LogSequenceNumber lsn)

Specify start position from which backend will start stream changes. If parameter will not specify, streaming starts from restart_lsn. For more details see pg_replication_slots description.

Specified by:

startPosition in interface ReplicationRequest.LogicalReplicationStep2

Specified by:

startPosition in interface ReplicationRequest.WithStartPosition

Parameters:

lsn - not null position from which need start replicate changes

Returns:

this builder

statusInterval

ReplicationRequest.LogicalReplicationRequestBuilder statusInterval(Duration interval)

Specifies the number of time between status packets sent back to the server. This allows for easier monitoring of the progress from server. A value of zero disables the periodic status updates completely, although an update will still be sent when requested by the server, to avoid timeout disconnect. The default value is 10 seconds.

Specified by:

statusInterval in interface ReplicationRequest.WithStatusInterval

Parameters:

interval - positive time

Returns:

this builder.

slotOption

ReplicationRequest.LogicalReplicationRequestBuilder slotOption(String option,
 Object value)

Configure slot option.

Specified by:

slotOption in interface ReplicationRequest.WithSlotOption

Parameters:

option - slot option name

value - option value

Returns:

this instance as a fluent interface

build

ReplicationRequest build()

Returns the logical ReplicationRequest.

Returns:

the logical ReplicationRequest.