Npgsql Api Docs

NpgsqlConnection Members

NpgsqlConnection overview

Public Static (Shared) Methods

ClearAllPools 

Public Instance Constructors

NpgsqlConnection Overloaded. Initializes a new instance of the NpgsqlConnection class.

Public Instance Properties

BackendProtocolVersion Protocol version in use. This can only be called when there is an active connection.
CommandTimeout Gets the time to wait while trying to execute a command before terminating the attempt and generating an error.
ConnectionLifeTime Gets the time to wait before closing unused connections in the pool if the count of all connections exeeds MinPoolSize.
ConnectionString Gets or sets the string used to connect to a PostgreSQL database. Valid values are:
  • Server: Address/Name of Postgresql Server;
  • Port: Port to connect to;
  • Protocol: Protocol version to use, instead of automatic; Integer 2 or 3;
  • Database: Database name. Defaults to user name if not specified;
  • User Id: User name;
  • Password: Password for clear text authentication;
  • SSL: True or False. Controls whether to attempt a secure connection. Default = False;
  • Pooling: True or False. Controls whether connection pooling is used. Default = True;
  • MinPoolSize: Min size of connection pool;
  • MaxPoolSize: Max size of connection pool;
  • Timeout: Time to wait for connection open in seconds. Default is 15.
  • CommandTimeout: Time to wait for command to finish execution before throw an exception. In seconds. Default is 20.
  • Sslmode: Mode for ssl connection control. Can be Prefer, Require, Allow or Disable. Default is Disable. Check user manual for explanation of values.
  • ConnectionLifeTime: Time to wait before closing unused connections in the pool in seconds. Default is 15.
  • SyncNotification: Specifies if Npgsql should use synchronous notifications.
  • SearchPath: Changes search path to specified and public schemas.
ConnectionTimeout Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.
Container (inherited from Component) 
Database Gets the name of the current database or the database to be used after a connection is opened.
DataSource Gets the database server name.
FullState Gets the current state of the connection.
Host Backend server host name.
NpgsqlCompatibilityVersion 
Port Backend server port.
PostgreSqlVersion Version of the PostgreSQL backend. This can only be called when there is an active connection.
PreloadReader Whether datareaders are loaded in their entirety (for compatibility with earlier code).
ProcessID Process id of backend server. This can only be called when there is an active connection.
ServerVersion 
Site (inherited from Component) 
SSL If true, the connection will attempt to use SSL.
State Gets whether the current state of the connection is Open or Closed
SyncNotification Gets flag indicating if we are using Synchronous notification or not. The default value is false.
UseExtendedTypes 

Public Instance Methods

BeginTransactionOverloaded. Begins a database transaction.
ChangeDatabase This method changes the current database by disconnecting from the actual database and connecting to the specified.
ClearPool 
Clone Create a new connection based on this one.
Close Releases the connection to the database. If the connection is pooled, it will be made available for re-use. If it is non-pooled, the actual connection will be shutdown.
CreateCommand Creates and returns a NpgsqlCommand object associated with the NpgsqlConnection.
CreateObjRef (inherited from MarshalByRefObject) 
Dispose (inherited from Component) 
EnlistTransaction 
Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetLifetimeService (inherited from MarshalByRefObject) 
GetSchemaOverloaded. Returns the supported collections
GetType (inherited from Object) 
InitializeLifetimeService (inherited from MarshalByRefObject) 
Open Opens a database connection with the property settings specified by the ConnectionString.
ToString (inherited from Component) 

Public Instance Events

CertificateSelectionCallback Mono.Security.Protocol.Tls.CertificateSelectionCallback delegate.
CertificateValidationCallback Mono.Security.Protocol.Tls.CertificateValidationCallback delegate.
Disposed (inherited from Component) 
Notice Occurs on NoticeResponses from the PostgreSQL backend.
Notification Occurs on NotificationResponses from the PostgreSQL backend.
PrivateKeySelectionCallback Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate.
ProvideClientCertificatesCallback Called to provide client certificates for SSL handshake.
StateChange (inherited from DbConnection) 

See Also

NpgsqlConnection Class | Npgsql Namespace