Top Description Fields Constructors Methods
org.postgresql.replication

public final Class ReplicationSlotInfo

extends Object
Class Inheritance
Imports
org.checkerframework.checker.nullness.qual.Nullable
Information returned on replication slot creation.

Returned keys of CREATE_REPLICATION_SLOT:

  1. slot_name String => the slot name
  2. consistent_point String => LSN at which we became consistent
  3. snapshot_name String => exported snapshot's name (may be null)
  4. output_plugin String => output plugin (may be null)
See Also
CREATE_REPLICATION_SLOT documentation

Field Summary

Modifier and TypeField and Description
private final LogSequenceNumber
consistentPoint

private final @Nullable String
outputPlugin

private final ReplicationType
replicationType

private final String
slotName

private final @Nullable String
snapshotName

Constructor Summary

AccessConstructor and Description
public
ReplicationSlotInfo(String slotName, ReplicationType replicationType, LogSequenceNumber consistentPoint, @Nullable String snapshotName, @Nullable String outputPlugin)

Method Summary

Modifier and TypeMethod and Description
public LogSequenceNumber

Returns:

LogSequenceNumber with the consistent_point
getConsistentPoint()

LSN at which we became consistent.

public @Nullable String

Returns:

output_plugin (may be null)
getOutputPlugin()

Output Plugin used on slot creation.

public ReplicationType

Returns:

ReplicationType, PHYSICAL or LOGICAL
getReplicationType()

Replication type of the slot created, might be PHYSICAL or LOGICAL.

public String

Returns:

the slot name
getSlotName()

Replication slot name.

public @Nullable String

Returns:

exported snapshot_name (may be null)
getSnapshotName()

Exported snapshot name at the point of replication slot creation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

consistentPointback to summary
private final LogSequenceNumber consistentPoint
outputPluginback to summary
private final @Nullable String outputPlugin
replicationTypeback to summary
private final ReplicationType replicationType
slotNameback to summary
private final String slotName
snapshotNameback to summary
private final @Nullable String snapshotName

Constructor Detail

ReplicationSlotInfoback to summary
public ReplicationSlotInfo(String slotName, ReplicationType replicationType, LogSequenceNumber consistentPoint, @Nullable String snapshotName, @Nullable String outputPlugin)

Method Detail

getConsistentPointback to summary
public LogSequenceNumber getConsistentPoint()

LSN at which we became consistent.

Returns:LogSequenceNumber

LogSequenceNumber with the consistent_point

getOutputPluginback to summary
public @Nullable String getOutputPlugin()

Output Plugin used on slot creation.

Returns:@Nullable String

output_plugin (may be null)

getReplicationTypeback to summary
public ReplicationType getReplicationType()

Replication type of the slot created, might be PHYSICAL or LOGICAL.

Returns:ReplicationType

ReplicationType, PHYSICAL or LOGICAL

getSlotNameback to summary
public String getSlotName()

Replication slot name.

Returns:String

the slot name

getSnapshotNameback to summary
public @Nullable String getSnapshotName()

Exported snapshot name at the point of replication slot creation.

As long as the exporting transaction remains open, other transactions can import its snapshot, and thereby be guaranteed that they see exactly the same view of the database that the first transaction sees.

Returns:@Nullable String

exported snapshot_name (may be null)