Table of Contents

Class ByteaHandler

Namespace
Npgsql.TypeHandlers
Assembly
Npgsql.dll
public class ByteaHandler : NpgsqlTypeHandler<byte[]>, INpgsqlTypeHandler<byte[]>, INpgsqlTypeHandler<ArraySegment<byte>>
Inheritance
ByteaHandler
Implements
Inherited Members

Remarks

http://www.postgresql.org/docs/current/static/datatype-binary.html

Constructors

ByteaHandler() 

public ByteaHandler()

Methods

Read(NpgsqlReadBuffer, int, bool, FieldDescription)

Reads a value of type TDefault with the given length from the provided buffer, using either sync or async I/O.

public override ValueTask<byte[]> Read(NpgsqlReadBuffer buf, int len, bool async, FieldDescription fieldDescription = null)

Parameters

buf NpgsqlReadBuffer

The buffer from which to read.

len int

The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.

async bool

If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously.

fieldDescription FieldDescription

Additional PostgreSQL information about the type, such as the length in varchar(30).

Returns

ValueTask<byte[]>

The fully-read value.

ValidateAndGetLength(ArraySegment<byte>, ref NpgsqlLengthCache, NpgsqlParameter)

Responsible for validating that a value represents a value of the correct and which can be written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. Also returns the byte length needed to write the value.

public int ValidateAndGetLength(ArraySegment<byte> value, ref NpgsqlLengthCache lengthCache, NpgsqlParameter parameter)

Parameters

value ArraySegment<byte>

The value to be written to PostgreSQL

lengthCache NpgsqlLengthCache

A cache where the length calculated during the validation phase can be stored for use at the writing phase.

parameter NpgsqlParameter

The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size).

Returns

int

The number of bytes required to write the value.

ValidateAndGetLength(byte[], ref NpgsqlLengthCache, NpgsqlParameter)

Called to validate and get the length of a value of a generic NpgsqlParameter<T>.

public override int ValidateAndGetLength(byte[] value, ref NpgsqlLengthCache lengthCache, NpgsqlParameter parameter)

Parameters

value byte[]
lengthCache NpgsqlLengthCache
parameter NpgsqlParameter

Returns

int

Write(ArraySegment<byte>, NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, bool)

Writes a value to the provided buffer.

public Task Write(ArraySegment<byte> value, NpgsqlWriteBuffer buf, NpgsqlLengthCache lengthCache, NpgsqlParameter parameter, bool async)

Parameters

value ArraySegment<byte>

The value to write.

buf NpgsqlWriteBuffer

The buffer to which to write.

lengthCache NpgsqlLengthCache

A cache where the length calculated during the validation phase can be stored for use at the writing phase.

parameter NpgsqlParameter

The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size).

async bool

If I/O will be necessary (i.e. the buffer is full), determines whether it will be done synchronously or asynchronously.

Returns

Task

Write(byte[], NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, bool)

Called to write the value of a generic NpgsqlParameter<T>.

public override Task Write(byte[] value, NpgsqlWriteBuffer buf, NpgsqlLengthCache lengthCache, NpgsqlParameter parameter, bool async)

Parameters

value byte[]
buf NpgsqlWriteBuffer
lengthCache NpgsqlLengthCache
parameter NpgsqlParameter
async bool

Returns

Task