Search Results for

    Show / Hide Table of Contents

    Class ReplicationValue

    Represents a column value in a logical replication session.

    Inheritance
    object
    ReplicationValue
    Namespace: Npgsql.Replication.PgOutput
    Assembly: Npgsql.dll
    Syntax
    public class ReplicationValue

    Properties

    | Improve this Doc View Source

    IsDBNull

    Gets a value that indicates whether the column contains nonexistent or missing values.

    Declaration
    public bool IsDBNull { get; }
    Property Value
    Type Description
    bool

    true if the specified column is equivalent to ; otherwise false.

    | Improve this Doc View Source

    IsUnchangedToastedValue

    Gets a value that indicates whether the column contains an unchanged TOASTed value (the actual value is not sent).

    Declaration
    public bool IsUnchangedToastedValue { get; }
    Property Value
    Type Description
    bool

    Whether the specified column is an unchanged TOASTed value.

    | Improve this Doc View Source

    Kind

    The kind of data transmitted for a tuple in a Logical Replication Protocol message.

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

    Length

    The length of the value in bytes.

    Declaration
    public int Length { get; }
    Property Value
    Type Description
    int

    Methods

    | Improve this Doc View Source

    Get(CancellationToken)

    Gets the value of the specified column as an instance of .

    Declaration
    public ValueTask<object> Get(CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    CancellationToken cancellationToken

    An optional token to cancel the asynchronous operation. The default value is .

    Returns
    Type Description
    ValueTask<><object>
    | Improve this Doc View Source

    Get<T>(CancellationToken)

    Gets the value of the specified column as a type.

    Declaration
    public ValueTask<T> Get<T>(CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    CancellationToken cancellationToken

    An optional token to cancel the asynchronous operation. The default value is .

    Returns
    Type Description
    ValueTask<><T>
    Type Parameters
    Name Description
    T

    The type of the value to be returned.

    | Improve this Doc View Source

    GetDataTypeName()

    Gets the data type information for the specified field. This is be the PostgreSQL type name (e.g. double precision), not the .NET type (see GetFieldType() for that).

    Declaration
    public string GetDataTypeName()
    Returns
    Type Description
    string
    | Improve this Doc View Source

    GetFieldType()

    Gets the data type of the specified column.

    Declaration
    public Type GetFieldType()
    Returns
    Type Description
    Type

    The data type of the specified column.

    | Improve this Doc View Source

    GetPostgresType()

    Gets a representation of the PostgreSQL data type for the specified field. The returned representation can be used to access various information about the field.

    Declaration
    public PostgresType GetPostgresType()
    Returns
    Type Description
    PostgresType
    | Improve this Doc View Source

    GetStream()

    Retrieves data as a .

    Declaration
    public Stream GetStream()
    Returns
    Type Description
    Stream
    | Improve this Doc View Source

    GetTextReader()

    Retrieves data as a .

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