Search Results for

    Show / Hide Table of Contents

    Class NpgsqlMultiHostDataSource

    An NpgsqlDataSource which manages connections for multiple hosts, is aware of their states (primary, secondary, offline...) and can perform failover and load balancing across them.

    Inheritance
    object
    DbDataSource
    NpgsqlDataSource
    NpgsqlMultiHostDataSource
    Implements
    IAsyncDisposable
    Inherited Members
    NpgsqlDataSource.ConnectionString
    NpgsqlDataSource.CreateConnection()
    NpgsqlDataSource.OpenConnection()
    NpgsqlDataSource.OpenDbConnection()
    NpgsqlDataSource.OpenConnectionAsync(CancellationToken)
    NpgsqlDataSource.OpenDbConnectionAsync(CancellationToken)
    NpgsqlDataSource.CreateDbConnection()
    NpgsqlDataSource.CreateDbCommand(string?)
    NpgsqlDataSource.CreateDbBatch()
    NpgsqlDataSource.CreateCommand(string?)
    NpgsqlDataSource.CreateBatch()
    NpgsqlDataSource.Create(string)
    NpgsqlDataSource.Create(NpgsqlConnectionStringBuilder)
    NpgsqlDataSource.Password
    NpgsqlDataSource.Dispose(bool)
    NpgsqlDataSource.DisposeBase()
    NpgsqlDataSource.DisposeAsyncCore()
    NpgsqlDataSource.DisposeAsyncBase()
    DbDataSource.Dispose()
    DbDataSource.DisposeAsync()
    Namespace: Npgsql
    Assembly: Npgsql.dll
    Syntax
    public sealed class NpgsqlMultiHostDataSource : NpgsqlDataSource, IAsyncDisposable
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    Methods

    | Improve this Doc View Source

    ClearDatabaseStates()

    Clears the database state (primary, secondary, offline...) for all data sources managed by this multi-host data source. Can be useful to make Npgsql retry a PostgreSQL instance which was previously detected to be offline.

    Declaration
    public void ClearDatabaseStates()
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    | Improve this Doc View Source

    CreateConnection(TargetSessionAttributes)

    Returns a new, unopened connection from this data source.

    Declaration
    public NpgsqlConnection CreateConnection(TargetSessionAttributes targetSessionAttributes)
    Parameters
    Type Name Description
    TargetSessionAttributes targetSessionAttributes

    Specifies the server type (e.g. primary, standby).

    Returns
    Type Description
    NpgsqlConnection
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    | Improve this Doc View Source

    OpenConnection(TargetSessionAttributes)

    Returns a new, opened connection from this data source.

    Declaration
    public NpgsqlConnection OpenConnection(TargetSessionAttributes targetSessionAttributes)
    Parameters
    Type Name Description
    TargetSessionAttributes targetSessionAttributes

    Specifies the server type (e.g. primary, standby).

    Returns
    Type Description
    NpgsqlConnection
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    | Improve this Doc View Source

    OpenConnectionAsync(TargetSessionAttributes, CancellationToken)

    Returns a new, opened connection from this data source.

    Declaration
    public ValueTask<NpgsqlConnection> OpenConnectionAsync(TargetSessionAttributes targetSessionAttributes, CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    TargetSessionAttributes targetSessionAttributes

    Specifies the server type (e.g. primary, standby).

    CancellationToken cancellationToken

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

    Returns
    Type Description
    ValueTask<><NpgsqlConnection>
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    | Improve this Doc View Source

    WithTargetSession(TargetSessionAttributes)

    Returns an NpgsqlDataSource that wraps this multi-host one with the given server type.

    Declaration
    public NpgsqlDataSource WithTargetSession(TargetSessionAttributes targetSessionAttributes)
    Parameters
    Type Name Description
    TargetSessionAttributes targetSessionAttributes

    Specifies the server type (e.g. primary, standby).

    Returns
    Type Description
    NpgsqlDataSource
    Remarks

    See https://www.npgsql.org/doc/failover-and-load-balancing.html.

    Implements

    IAsyncDisposable

    Extension Methods

    CrsMapExtensions.GetCrsMap(NpgsqlDataSource)
    CrsMapExtensions.GetCrsMapAsync(NpgsqlDataSource)
    • Improve this Doc
    • View Source
    In This Article
    Back to top © Copyright 2023 The Npgsql Development Team