Class NpgsqlBinaryExporter

Namespace

Npgsql

Assembly

Npgsql.dll

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

public sealed class NpgsqlBinaryExporter : IDisposable

Inheritance

object

NpgsqlBinaryExporter

Implements

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

IsNull

Returns whether the current column is null.

public bool IsNull { get; }

Property Value

bool

Methods

Cancel()

Cancels an ongoing export.

public void Cancel()

Dispose()

Completes that binary export and sets the connection back to idle state

public void Dispose()

Read<T>()

Reads the current column, returns its value and moves ahead to the next column. If the column is null an exception is thrown.

public T Read<T>()

Returns

T

The value of the column

Type Parameters

T

The type of the column to be read. This must correspond to the actual type or data corruption will occur. If in doubt, use Read<T>(NpgsqlDbType) to manually specify the type.

Read<T>(NpgsqlDbType)

Reads the current column, returns its value according to type and moves ahead to the next column. If the column is null an exception is thrown.

public T Read<T>(NpgsqlDbType type)

Parameters

type NpgsqlDbType

In some cases T isn't enough to infer the data type coming in from the database. This parameter and be used to unambiguously specify the type. An example is the JSONB type, for which T will be a simple string but for which type must be specified as Jsonb.

Returns

T

The value of the column

Type Parameters

T

The .NET type of the column to be read.

Skip()

Skips the current column without interpreting its value.

public void Skip()

StartRow()

Starts reading a single row, must be invoked before reading any columns.

public int StartRow()

Returns

int

The number of columns in the row. -1 if there are no further rows. Note: This will currently be the same value for all rows, but this may change in the future.