Search Results for

    Show / Hide Table of Contents

    Class PgOutputReplicationOptions

    Options to be passed to the pgoutput plugin

    Inheritance
    Object
    PgOutputReplicationOptions
    Implements
    IEquatable<PgOutputReplicationOptions>
    Inherited Members
    Object.Equals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Npgsql.Replication.PgOutput
    Assembly: Npgsql.dll
    Syntax
    public class PgOutputReplicationOptions : IEquatable<PgOutputReplicationOptions>

    Constructors

    PgOutputReplicationOptions(IEnumerable<String>, UInt64, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

    Creates a new instance of PgOutputReplicationOptions.

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

    The publication names to include into the stream

    UInt64 protocolVersion

    The version of the logical streaming replication protocol

    Nullable<Boolean> binary

    Send values in binary representation

    Nullable<Boolean> streaming

    Enable streaming of in-progress transactions

    Nullable<Boolean> messages

    Write logical decoding messages into the replication stream

    PgOutputReplicationOptions(String, UInt64, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

    Creates a new instance of PgOutputReplicationOptions.

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

    The publication names to include into the stream

    UInt64 protocolVersion

    The version of the logical streaming replication protocol

    Nullable<Boolean> binary

    Send values in binary representation

    Nullable<Boolean> streaming

    Enable streaming of in-progress transactions

    Nullable<Boolean> messages

    Write logical decoding messages into the replication stream

    Properties

    Binary

    Send values in binary representation

    Declaration
    public bool? Binary { get; }
    Property Value
    Type Description
    Nullable<Boolean>
    Remarks

    This works in PostgreSQL versions 14+

    Messages

    Write logical decoding messages into the replication stream

    Declaration
    public bool? Messages { get; }
    Property Value
    Type Description
    Nullable<Boolean>
    Remarks

    This works in PostgreSQL versions 14+

    ProtocolVersion

    The version of the Logical Streaming Replication Protocol

    Declaration
    public ulong ProtocolVersion { get; }
    Property Value
    Type Description
    UInt64

    PublicationNames

    The publication names to stream

    Declaration
    public List<string> PublicationNames { get; }
    Property Value
    Type Description
    List<String>

    Streaming

    Enable streaming of in-progress transactions

    Declaration
    public bool? Streaming { get; }
    Property Value
    Type Description
    Nullable<Boolean>
    Remarks

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

    Methods

    Equals(PgOutputReplicationOptions)

    Declaration
    public bool Equals(PgOutputReplicationOptions other)
    Parameters
    Type Name Description
    PgOutputReplicationOptions other
    Returns
    Type Description
    Boolean

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()

    Implements

    System.IEquatable<T>
    In This Article
    Back to top © Copyright 2022 The Npgsql Development Team