Search Results for

    Show / Hide Table of Contents

    Class PgOutputReplicationOptions

    Options to be passed to the pgoutput plugin

    Inheritance
    object
    PgOutputReplicationOptions
    Namespace: Npgsql.Replication.PgOutput
    Assembly: Npgsql.dll
    Syntax
    public class PgOutputReplicationOptions : IEquatable<PgOutputReplicationOptions>

    Constructors

    | Improve this Doc View Source

    PgOutputReplicationOptions(IEnumerable<string>, ulong, bool?, bool?, bool?, bool?)

    Creates a new instance of PgOutputReplicationOptions.

    Declaration
    public PgOutputReplicationOptions(IEnumerable<string> publicationNames, ulong protocolVersion, bool? binary = null, bool? streaming = null, bool? messages = null, bool? twoPhase = null)
    Parameters
    Type Name Description
    IEnumerable<><string> publicationNames

    The publication names to include into the stream

    ulong protocolVersion

    The version of the logical streaming replication protocol

    bool? binary

    Send values in binary representation

    bool? streaming

    Enable streaming of in-progress transactions

    bool? messages

    Write logical decoding messages into the replication stream

    bool? twoPhase

    Enable streaming of prepared transactions

    | Improve this Doc View Source

    PgOutputReplicationOptions(string, ulong, bool?, bool?, bool?, bool?)

    Creates a new instance of PgOutputReplicationOptions.

    Declaration
    public PgOutputReplicationOptions(string publicationName, ulong protocolVersion, bool? binary = null, bool? streaming = null, bool? messages = null, bool? twoPhase = null)
    Parameters
    Type Name Description
    string publicationName

    The publication names to include into the stream

    ulong protocolVersion

    The version of the logical streaming replication protocol

    bool? binary

    Send values in binary representation

    bool? streaming

    Enable streaming of in-progress transactions

    bool? messages

    Write logical decoding messages into the replication stream

    bool? twoPhase

    Enable streaming of prepared transactions

    Properties

    | Improve this Doc View Source

    Binary

    Send values in binary representation

    Declaration
    public bool? Binary { get; }
    Property Value
    Type Description
    bool?
    Remarks

    This works in PostgreSQL versions 14+

    | Improve this Doc View Source

    Messages

    Write logical decoding messages into the replication stream

    Declaration
    public bool? Messages { get; }
    Property Value
    Type Description
    bool?
    Remarks

    This works in PostgreSQL versions 14+

    | Improve this Doc View Source

    ProtocolVersion

    The version of the Logical Streaming Replication Protocol

    Declaration
    public ulong ProtocolVersion { get; }
    Property Value
    Type Description
    ulong
    | Improve this Doc View Source

    PublicationNames

    The publication names to stream

    Declaration
    public List<string> PublicationNames { get; }
    Property Value
    Type Description
    List<><string>
    | Improve this Doc View Source

    Streaming

    Enable streaming of in-progress transactions

    Declaration
    public bool? Streaming { get; }
    Property Value
    Type Description
    bool?
    Remarks

    This works as of logical streaming replication protocol version 2 (PostgreSQL 14+)

    | Improve this Doc View Source

    TwoPhase

    Enable streaming of prepared transactions

    Declaration
    public bool? TwoPhase { get; }
    Property Value
    Type Description
    bool?
    Remarks

    This works in PostgreSQL versions 15+

    Methods

    | Improve this Doc View Source

    Equals(PgOutputReplicationOptions?)

    Declaration
    public bool Equals(PgOutputReplicationOptions? other)
    Parameters
    Type Name Description
    PgOutputReplicationOptions other
    Returns
    Type Description
    bool
    | Improve this Doc View Source

    Equals(object?)

    Declaration
    public override bool Equals(object? obj)
    Parameters
    Type Name Description
    object? obj
    Returns
    Type Description
    bool
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    • Improve this Doc
    • View Source
    In This Article
    Back to top © Copyright 2023 The Npgsql Development Team