AdaskoTheBeAsT.Dapper.NodaTime 6.0.0

AdaskoTheBeAsT.Dapper.NodaTime

Core Dapper type handlers for NodaTime. This package is provider agnostic: it contains the handlers, the configuration abstraction and portable DbType defaults, and depends only on Dapper and NodaTime.

For a ready-to-use database dialect, install one of the provider packages instead (...SqlServer, ...PostgreSql, ...MySql, ...Sqlite, ...Oracle) - each of them references this package.

Installation

dotnet add package AdaskoTheBeAsT.Dapper.NodaTime

What this package provides

Usage

Register requires an explicit configuration, so the dialect is always a conscious decision:

using AdaskoTheBeAsT.Dapper.NodaTime;
using NodaTime;

DapperNodaTimeSetup.Register(DateTimeZoneProviders.Tzdb, new MyConfiguration());

Provider packages wrap exactly that call, e.g. SqlServerDapperNodaTimeSetup.Register(DateTimeZoneProviders.Tzdb).

Writing values (portable defaults)

NodaTimeTypeHandlerConfigurationBase shapes parameters using only System.Data.DbType:

Reading values

Handlers accept several database representations so the same model works across providers and legacy schemas:

null / DBNull and unsupported CLR types throw System.Data.DataException with a descriptive message. Strings are parsed with CultureInfo.InvariantCulture and DateTimeStyles.RoundtripKind.

Custom dialects

Derive from NodaTimeTypeHandlerConfigurationBase and override only what differs:

using System.Data;
using AdaskoTheBeAsT.Dapper.NodaTime;
using NodaTime;
using NodaTime.Text;

public sealed class InstantAsTextConfiguration : NodaTimeTypeHandlerConfigurationBase
{
    public override void SetInstant(IDbDataParameter parameter, Instant value)
    {
        parameter.Value = InstantPattern.ExtendedIso.Format(value);
        parameter.DbType = DbType.AnsiString;
    }
}

protected static TrySetNative<TParameter>(IDbDataParameter parameter, Action<TParameter> set) applies a provider-specific parameter type only when the parameter really is of that provider type, which keeps the configuration usable with wrappers, profilers and mocks.

Not supported

ZonedDateTime has no handler. Persist LocalDateTime + DateTimeZone (+ CalendarSystem) and compose it in your domain layer.

Target frameworks

net10.0, net9.0, net8.0, netstandard2.1, netstandard2.0, net481, net48, net472, net471, net47, net462.

Links

• Repository and full documentation
• Upgrading from 5.x to 6.0
• MIT License