Table of Contents

Namespace Npgsql

Classes

NpgsqlBinaryExporter

Provides an API for a binary COPY TO operation, a high-performance data export mechanism from a PostgreSQL table. Initiated by BeginBinaryExport(string)

NpgsqlBinaryImporter

Provides an API for a binary COPY FROM operation, a high-performance data import mechanism to a PostgreSQL table. Initiated by BeginBinaryImport(string)

NpgsqlCommand

Represents a SQL statement or function (stored procedure) to execute against a PostgreSQL database. This class cannot be inherited.

NpgsqlCommandBuilder

This class is responsible to create database commands for automatic insert, update and delete operations.

NpgsqlConnection

This class represents a connection to a PostgreSQL server.

NpgsqlConnectionStringBuilder

Provides a simple way to create and manage the contents of connection strings used by the NpgsqlConnection class.

NpgsqlConnectionStringPropertyAttribute

Marks on NpgsqlConnectionStringBuilder which participate in the connection string. Optionally holds a set of synonyms for the property.

NpgsqlCopyTextReader

Reader for a text export, initiated by BeginTextExport(string).

NpgsqlCopyTextWriter

Writer for a text import, initiated by BeginTextImport(string).

NpgsqlDataAdapter

This class represents an adapter from many commands: select, update, insert and delete to fill Datasets.

NpgsqlDataReader

Reads a forward-only stream of rows from a data source.

NpgsqlDatabaseInfo

Base class for implementations which provide information about PostgreSQL and PostgreSQL-like databases (e.g. type definitions, capabilities...).

NpgsqlException

The exception that is thrown when server-related issues occur.

NpgsqlFactory

A factory to create instances of various Npgsql objects.

NpgsqlLargeObjectManager

Large object manager. This class can be used to store very large files in a PostgreSQL database.

NpgsqlLargeObjectStream

An interface to remotely control the seekable stream for an opened large object on a PostgreSQL server. Note that the OpenRead/OpenReadWrite method as well as all operations performed on this stream must be wrapped inside a database transaction.

NpgsqlLengthCache

An array of cached lengths for the parameters sending process.

When sending parameters, lengths need to be calculated more than once (once for Bind, once for an array, once for the string within that array). This cache optimized that. Lengths are added to the cache, and then retrieved at the same order.

NpgsqlNoticeEventArgs

Provides data for a PostgreSQL notice event.

NpgsqlNotificationEventArgs

Provides information on a PostgreSQL notification. Notifications are sent when your connection has registered for notifications on a specific channel via the LISTEN command. NOTIFY can be used to generate such notifications, allowing for an inter-connection communication channel.

NpgsqlOperationInProgressException

Thrown when trying to use a connection that is already busy performing some other operation. Provides information on the already-executing operation to help with debugging.

NpgsqlParameter

This class represents a parameter to a command that will be sent to server

NpgsqlParameterCollection

Represents a collection of parameters relevant to a NpgsqlCommand as well as their respective mappings to columns in a DataSet. This class cannot be inherited.

NpgsqlParameter<T>

A generic version of NpgsqlParameter which provides more type safety and avoids boxing of value types. Use TypedValue instead of Value.

NpgsqlRawCopyStream

Provides an API for a raw binary COPY operation, a high-performance data import/export mechanism to a PostgreSQL table. Initiated by BeginRawBinaryCopy(string)

NpgsqlReadBuffer

A buffer used by Npgsql to read data from the socket efficiently. Provides methods which decode different values types and tracks the current position.

NpgsqlRowUpdatedEventArgs
NpgsqlRowUpdatingEventArgs
NpgsqlStatement

Represents a single SQL statement within Npgsql.

Instances aren't constructed directly; users should construct an NpgsqlCommand object and populate its CommandText property as in standard ADO.NET. Npgsql will analyze that property and constructed instances of NpgsqlStatement internally.

Users can retrieve instances from Statements and access information about statement execution (e.g. affected rows).

NpgsqlTransaction

Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited.

NpgsqlWriteBuffer

A buffer used by Npgsql to write data to the socket efficiently. Provides methods which encode different values types and tracks the current position.

PostgresException

The exception that is thrown when the PostgreSQL backend reports errors (e.g. query SQL issues, constraint violations).

PostgresNotice

PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator initiates a "fast" database shutdown).

Structs

NpgsqlTimeout

Represents a timeout that will expire at some point.

Interfaces

INpgsqlDatabaseInfoFactory

A factory which get generate instances of NpgsqlDatabaseInfo, which describe a database and the types it contains. When first connecting to a database, Npgsql will attempt to load information about it via this factory.

INpgsqlNameTranslator

A component which translates a CLR name (e.g. SomeClass) into a database name (e.g. some_class) according to some scheme. Used for mapping enum and composite types.

Enums

ServerCompatibilityMode

An option specified in the connection string that activates special compatibility features.

SslMode

Specifies how to manage SSL.

StatementType

Specifies the type of SQL statement, e.g. SELECT

Delegates

NoticeEventHandler

Represents a method that handles the Notice event.

NotificationEventHandler

Represents a method that handles the Notification event.

NpgsqlRowUpdatedEventHandler

Represents the method that handles the RowUpdated events.

NpgsqlRowUpdatingEventHandler

Represents the method that handles the RowUpdating events.

ProvideClientCertificatesCallback

Represents the method that allows the application to provide a certificate collection to be used for SSL client authentication