Show / Hide Table of Contents

    Class PgConnectionPropertiesBase

    Inheritance
    System.Object
    DataConnectionConfigurationBase
    PgConnectionPropertiesBase
    PgConnectionConfiguration
    PgDbConnectionConfiguration
    PgGlobalPropertiesOptions
    PgShardConnectionOptions<TShard>.PgShardConnectionConfiguration
    PgShardConnectionOptions<TShard>.PgShardConnectionsConfiguration
    Implements
    System.ComponentModel.INotifyPropertyChanged
    Inherited Members
    DataConnectionConfigurationBase.GetRetryTimespan(Int32)
    DataConnectionConfigurationBase.RaisePropertyChanged(String)
    DataConnectionConfigurationBase.UserName
    DataConnectionConfigurationBase.Password
    DataConnectionConfigurationBase.WindowsAuth
    DataConnectionConfigurationBase.RetryCount
    DataConnectionConfigurationBase.RetryInterval
    DataConnectionConfigurationBase.RetryLengthening
    DataConnectionConfigurationBase.CircuitBreakerFailureCount
    DataConnectionConfigurationBase.CircuitBreakerTestInterval
    DataConnectionConfigurationBase.PropertyChanged
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: ArgentSea.Pg
    Assembly: ArgentSea.Pg.dll
    Syntax
    public abstract class PgConnectionPropertiesBase : DataConnectionConfigurationBase, INotifyPropertyChanged

    Properties

    | Improve this Doc View Source

    ApplicationName

    The optional application name parameter to be sent to the backend during connection initiation.

    Declaration
    public string ApplicationName { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    AutoPrepareMinUsages

    The minimum number of usages an SQL statement is used before it's automatically prepared. Defaults to 5

    Declaration
    public int? AutoPrepareMinUsages { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    CheckCertificateRevocation

    Whether to check the certificate revocation list during authentication. False by default.

    Declaration
    public bool? CheckCertificateRevocation { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    ClientEncoding

    Gets or sets the client_encoding parameter.

    Declaration
    public string ClientEncoding { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    CommandTimeout

    The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Defaults to 30 seconds.

    Declaration
    public int? CommandTimeout { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    ConnectionIdleLifetime

    The time to wait before closing idle connections in the pool if the count of all connections exceeds MinPoolSize.

    Declaration
    public int? ConnectionIdleLifetime { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    ConnectionPruningInterval

    How many seconds the pool waits before attempting to prune idle connections that are beyond idle lifetime.

    Declaration
    public int? ConnectionPruningInterval { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    ConvertInfinityDateTime

    Makes MaxValue and MinValue timestamps and dates readable as infinity and negative infinity.

    Declaration
    public bool? ConvertInfinityDateTime { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    Database

    The PostgreSQL database to connect to.

    Declaration
    public string Database { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Encoding

    Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data.

    Declaration
    public string Encoding { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Enlist

    Whether to enlist in an ambient TransactionScope.

    Declaration
    public bool? Enlist { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    Host

    The hostname or IP address of the PostgreSQL server to connect to.

    Declaration
    public string Host { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    IncludeRealm

    The Kerberos realm to be used for authentication

    Declaration
    public bool? IncludeRealm { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    InternalCommandTimeout

    The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error.

    Declaration
    public int? InternalCommandTimeout { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    KeepAlive

    The number of seconds of connection inactivity before Npgsql sends a keepalive query. Set to 0 (the default) to disable.

    Declaration
    public int? KeepAlive { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    KerberosServiceName

    The Kerberos service name to be used for authentication.

    Declaration
    public string KerberosServiceName { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    LoadTableComposites

    Load table composite type definitions, and not just free-standing composite types.

    Declaration
    public bool? LoadTableComposites { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    MaxAutoPrepare

    The maximum number SQL statements that can be automatically prepared at any given point. Beyond this number the least-recently-used statement will be recycled. Zero (the default) disables automatic preparation.

    Declaration
    public int? MaxAutoPrepare { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    MaxPoolSize

    The maximum connection pool size.

    Declaration
    public int? MaxPoolSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    MinPoolSize

    The minimum connection pool size.

    Declaration
    public int? MinPoolSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    NoResetOnClose

    If set to true, a pool connection's state won't be reset when it is closed (improves performance). Do not specify this unless you know what you're doing.

    Declaration
    public bool? NoResetOnClose { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    PersistSecurityInfo

    Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

    Declaration
    public bool? PersistSecurityInfo { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    Pooling

    Whether connection pooling should be used.

    Declaration
    public bool? Pooling { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    Port

    The TCP/IP port of the PostgreSQL server.

    Declaration
    public int? Port { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    ReadBufferSize

    Determines the size of the internal buffer Npgsql uses when reading. Increasing may improve performance if transferring large values from the database.

    Declaration
    public int? ReadBufferSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    SearchPath

    Gets or sets the schema search path.

    Declaration
    public string SearchPath { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    ServerCompatibilityMode

    A compatibility mode for special PostgreSQL server types.

    Declaration
    public ServerCompatibilityMode? ServerCompatibilityMode { get; set; }
    Property Value
    Type Description
    System.Nullable<Npgsql.ServerCompatibilityMode>
    | Improve this Doc View Source

    SocketReceiveBufferSize

    Determines the size of socket read buffer.

    Declaration
    public int? SocketReceiveBufferSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    SocketSendBufferSize

    Determines the size of socket send buffer.

    Declaration
    public int? SocketSendBufferSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    SslMode

    Controls whether SSL is required, disabled or preferred, depending on server support.

    Declaration
    public SslMode? SslMode { get; set; }
    Property Value
    Type Description
    System.Nullable<Npgsql.SslMode>
    | Improve this Doc View Source

    TcpKeepAlive

    Whether to use TCP keepalive with system defaults if overrides isn't specified.

    Declaration
    public bool? TcpKeepAlive { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    TcpKeepAliveInterval

    The interval, in milliseconds, between when successive keep-alive packets are sent if no acknowledgement is received. Defaults to the value of TcpKeepAliveTime. TcpKeepAliveTime must be non-zero as well. Supported only on Windows.

    Declaration
    public int? TcpKeepAliveInterval { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    TcpKeepAliveTime

    The number of seconds of connection inactivity before a TCP keepalive query is sent. Use of this option is discouraged, use KeepAlive instead if possible. Set to 0 (the default) to disable. Supported only on Windows.

    Declaration
    public int? TcpKeepAliveTime { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    Timeout

    The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Defaults to 15 seconds.

    Declaration
    public int? Timeout { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    Timezone

    Gets or sets the session timezone, PGTZ environment variable can be used instead.

    Declaration
    public string Timezone { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    TrustServerCertificate

    Whether to trust the server certificate without validating it.

    Declaration
    public bool? TrustServerCertificate { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    UsePerfCounters

    Writes connection performance information to performance counters.

    Declaration
    public bool? UsePerfCounters { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    UseSslStream

    Npgsql uses its own internal implementation of TLS/SSL. Turn this on to use .NET SslStream instead.

    Declaration
    public bool? UseSslStream { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    WriteBufferSize

    Determines the size of the internal buffer Npgsql uses when writing. Increasing may improve performance if transferring large values to the database.

    Declaration
    public int? WriteBufferSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    Implements

    System.ComponentModel.INotifyPropertyChanged
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX