Class NpgsqlBinaryImporter
Provides an API for a binary COPY FROM operation, a high-performance data import mechanism to a PostgreSQL table. Initiated by BeginBinaryImport(String)
Inheritance
Implements
Inherited Members
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlBinaryImporter : ICancelable, IDisposable
Remarks
Methods
Close()
Completes the import process and signals to the database to write everything.
Declaration
public void Close()
Complete()
Completes the import operation. The writer is unusable after this operation.
Declaration
public void Complete()
Dispose()
Cancels that binary import and sets the connection back to idle state
Declaration
public void Dispose()
StartRow()
Starts writing a single row, must be invoked before writing any columns.
Declaration
public void StartRow()
Write<T>(T)
Writes a single column in the current row.
Declaration
public void Write<T>(T value)
Parameters
Type | Name | Description |
---|---|---|
T | value | The value to be written |
Type Parameters
Name | Description |
---|---|
T | The type of the column to be written. This must correspond to the actual type or data corruption will occur. If in doubt, use Write<T>(T, NpgsqlDbType) to manually specify the type. |
Write<T>(T, NpgsqlDbType)
Writes a single column in the current row as type npgsqlDbType
.
Declaration
public void Write<T>(T value, NpgsqlDbType npgsqlDbType)
Parameters
Type | Name | Description |
---|---|---|
T | value | The value to be written |
NpgsqlDbType | npgsqlDbType | In some cases |
Type Parameters
Name | Description |
---|---|
T | The .NET type of the column to be written. |
Write<T>(T, String)
Writes a single column in the current row as type dataTypeName
.
Declaration
public void Write<T>(T value, string dataTypeName)
Parameters
Type | Name | Description |
---|---|---|
T | value | The value to be written |
System.String | dataTypeName | In some cases |
Type Parameters
Name | Description |
---|---|
T | The .NET type of the column to be written. |
WriteNull()
Writes a single null column value.
Declaration
public void WriteNull()
WriteRow(Object[])
Writes an entire row of columns. Equivalent to calling StartRow(), followed by multiple Write<T>(T) on each value.
Declaration
public void WriteRow(params object[] values)
Parameters
Type | Name | Description |
---|---|---|
System.Object[] | values | An array of column values to be written as a single row |