Class DateHandler
A type handler for the PostgreSQL date data type.
Inheritance
Inherited Members
Namespace: Npgsql.TypeHandlers.DateTimeHandlers
Assembly: Npgsql.dll
Syntax
public class DateHandler : NpgsqlSimpleTypeHandlerWithPsv<DateTime, NpgsqlDate>, INpgsqlTypeHandler<DateTime>, INpgsqlSimpleTypeHandler<DateTime>, INpgsqlSimpleTypeHandler<NpgsqlDate>
Remarks
See http://www.postgresql.org/docs/current/static/datatype-datetime.html.
The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. Use it at your own risk.
Constructors
DateHandler(PostgresType, Boolean)
Constructs a DateHandler
Declaration
public DateHandler(PostgresType postgresType, bool convertInfinityDateTime)
Parameters
Type | Name | Description |
---|---|---|
PostgresType | postgresType | |
System.Boolean | convertInfinityDateTime |
Methods
Read(NpgsqlReadBuffer, Int32, FieldDescription)
Reads a value of type TDefault
with the given length from the provided buffer,
with the assumption that it is entirely present in the provided memory buffer and no I/O will be
required.
Declaration
public override DateTime Read(NpgsqlReadBuffer buf, int len, FieldDescription fieldDescription = null)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlReadBuffer | buf | The buffer from which to read. |
System.Int32 | len | The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. |
FieldDescription | fieldDescription | Additional PostgreSQL information about the type, such as the length in varchar(30). |
Returns
Type | Description |
---|---|
System.DateTime | The fully-read value. |
Overrides
ReadPsv(NpgsqlReadBuffer, Int32, FieldDescription)
Declaration
protected override NpgsqlDate ReadPsv(NpgsqlReadBuffer buf, int len, FieldDescription fieldDescription = null)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlReadBuffer | buf | |
System.Int32 | len | |
FieldDescription | fieldDescription |
Returns
Type | Description |
---|---|
NpgsqlDate |
Overrides
Remarks
Copied wholesale from Postgresql backend/utils/adt/datetime.c:j2date
ValidateAndGetLength(NpgsqlDate, 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.
Declaration
public override int ValidateAndGetLength(NpgsqlDate value, NpgsqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlDate | value | |
NpgsqlParameter | parameter | The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size). |
Returns
Type | Description |
---|---|
System.Int32 | The number of bytes required to write the value. |
Overrides
ValidateAndGetLength(DateTime, 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.
Declaration
public override int ValidateAndGetLength(DateTime value, NpgsqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
System.DateTime | value | |
NpgsqlParameter | parameter | The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size). |
Returns
Type | Description |
---|---|
System.Int32 | The number of bytes required to write the value. |
Overrides
Write(NpgsqlDate, NpgsqlWriteBuffer, NpgsqlParameter)
Writes a value to the provided buffer, with the assumption that there is enough space in the buffer (no I/O will occur). The Npgsql core will have taken care of that.
Declaration
public override void Write(NpgsqlDate value, NpgsqlWriteBuffer buf, NpgsqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlDate | value | |
NpgsqlWriteBuffer | buf | The buffer to which to write. |
NpgsqlParameter | parameter | The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size). |
Overrides
Write(DateTime, NpgsqlWriteBuffer, NpgsqlParameter)
Writes a value to the provided buffer, with the assumption that there is enough space in the buffer (no I/O will occur). The Npgsql core will have taken care of that.
Declaration
public override void Write(DateTime value, NpgsqlWriteBuffer buf, NpgsqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
System.DateTime | value | |
NpgsqlWriteBuffer | buf | The buffer to which to write. |
NpgsqlParameter | parameter | The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size). |