Skip to content

Class PostgresLogicalReplicationCaptureOptions

Namespace: Cephalon.Data.Postgres.Configuration
Assembly: Cephalon.Data.Postgres.dll

Declares one provider-native PostgreSQL logical-replication capture for the active runtime.

public sealed class PostgresLogicalReplicationCaptureOptions

object ← PostgresLogicalReplicationCaptureOptions

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Gets or sets the logical outbox channel that receives emitted publications.

public string ChannelId { get; set; }

string

Gets or sets a value indicating whether the pack should create the logical replication slot when it does not exist yet.

public bool CreateSlotIfMissing { get; set; }

bool

Gets or sets the human-readable CDC capture description.

public string Description { get; set; }

string

Gets or sets the operator-facing CDC capture name.

public string DisplayName { get; set; }

string

Gets or sets the operator-facing event format projected on the CDC descriptor.

public string EventFormat { get; set; }

string

Gets or sets the stable CDC capture identifier.

public string Id { get; set; }

string

Gets or sets the initial position used when the logical replication slot must be created.

public string InitialPosition { get; set; }

string

Supported values are slot-consistent-point and latest-available.

Gets or sets the maximum number of seconds to await committed WAL messages during one provider-native iteration.

public int MaxAwaitTimeSeconds { get; set; }

int

Gets or sets the maximum number of committed logical-replication changes to stage during one iteration.

public int MaxChangesPerRead { get; set; }

int

Gets or sets the logical message type emitted for each captured change event.

public string MessageType { get; set; }

string

Gets arbitrary operator-facing metadata that should flow through the capture descriptor.

public IDictionary<string, string> Metadata { get; }

IDictionary<string, string>

Gets or sets the outbox identifier that receives emitted publications.

public string OutboxId { get; set; }

string

Gets or sets the polling interval, in seconds, between hosted-service iterations.

public int PollingIntervalSeconds { get; set; }

int

Gets or sets the PostgreSQL publication that should emit the tracked table changes.

public string PublicationName { get; set; }

string

Gets or sets a value indicating whether the pack should drop and recreate the logical replication slot when it exists but is no longer usable.

public bool RecreateSlotIfInvalidated { get; set; }

bool

This only applies when the slot is inactive. Active slots still fail fast because PostgreSQL allows only one logical decoding consumer at a time.

Gets the resource identifiers observed by the capture.

public IList<string> ResourceIds { get; }

IList<string>

Gets or sets the PostgreSQL logical replication slot used for durable progress.

public string SlotName { get; set; }

string

Gets or sets the logical source identifier when it should differ from the watched table path.

public string SourceId { get; set; }

string

Gets or sets the module identifier that owns the capture surface.

public string SourceModuleId { get; set; }

string

Gets or sets the table name of the tracked table.

public string TableName { get; set; }

string

Gets or sets the schema name of the tracked table.

public string TableSchema { get; set; }

string

Gets the descriptive tags associated with the capture.

public IList<string> Tags { get; }

IList<string>