Class NpgsqlConnection

This class represents a connection to a PostgreSQL server.

Inheritance

Object

NpgsqlConnection

Implements

ICloneable

IComponent

Namespace: Npgsql

Assembly: Npgsql.dll

Syntax

public sealed class NpgsqlConnection : DbConnection, ICloneable, IComponent

Constructors

NpgsqlConnection()

Initializes a new instance of the NpgsqlConnection class.

Declaration

public NpgsqlConnection()

NpgsqlConnection(Nullable<String>)

Initializes a new instance of NpgsqlConnection with the given connection string.

Declaration

public NpgsqlConnection(string? connectionString)

Parameters

Type	Name	Description
Nullable<String>	connectionString	The connection used to open the PostgreSQL database.

Fields

DefaultPort

The default TCP/IP port for PostgreSQL.

Declaration

public const int DefaultPort = null

Field Value

Type	Description
Int32

Properties

GlobalTypeMapper

The global type mapper, which contains defaults used by all new connections. Modify mappings on this mapper to affect your entire application.

Declaration

public static INpgsqlTypeMapper GlobalTypeMapper { get; }

Property Value

Type	Description
INpgsqlTypeMapper

Settings

The parsed connection string. Set only after the connection is opened.

Declaration

public NpgsqlConnectionStringBuilder Settings { get; }

Property Value

Type	Description
NpgsqlConnectionStringBuilder

TypeMapper

The connection-specific type mapper - all modifications affect this connection only, and are lost when it is closed.

Declaration

public INpgsqlTypeMapper TypeMapper { get; }

Property Value

Type	Description
INpgsqlTypeMapper

Methods

Open()

Opens a database connection with the property settings specified by the .

Declaration

public override void Open()

OpenAsync(CancellationToken)

This is the asynchronous version of Open().

Declaration

public override Task OpenAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	An optional token to cancel the asynchronous operation. The default value is .

Returns

Type	Description
Task	A task representing the asynchronous operation.

Remarks

Do not invoke other methods and properties of the NpgsqlConnection object until the returned Task is complete.

Implements

ICloneable

IComponent