README.md

JSON columns for the Dapper

The full article

It is a small library that simplifies JSON column handling inside the Dapper.

Read a list of items:

public class UserData
{
    public int Id { get; set; }
    public string Login { get; set; }
    public Json<EmailData[]> Emails { get; set; }
}

public class EmailData
{
    public string Email { get; set; }
    public EmailKind Kind { get; set; }
}

var users = await connection.QueryAsync<UserData>("""
        select Id,
               Login,
               (select Text as Email, Kind from Emails e where e.UserId = u.Id FOR JSON PATH) as Emails
        from Users u
    """);
    

Read a single item:

public class Book
{
    public string ISBN { get; set; }
    public Json<Person> Author { get; set; }
}

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

var books = await connection.QueryAsync<Book>("""
        SELECT 
            ISBN,
            (SELECT FirstName, LastName FROM Authors a where a.Id = b.AuthorEntityId  FOR JSON PATH, WITHOUT_ARRAY_WRAPPER) AS Author
        FROM Books b
    """);  

Write json to column:

var settings = new UserSettings
{
    Update = DateTimeOffset.Now,
    HideSearchBar = true
};

var rows = await connection.ExecuteAsync(
    """
        UPDATE Users SET 
            SettingsJson = @Settings
        WHERE Id = @Id
       """,
    new { Id = id, Settings = settings.AsJson() });

Installation

You will need to install two packages to make it work. First one:

dotnet add package Apparatus.Dapper.Json

It contains core classes and a source generator(about it later).

For the second one, there are two choices right now.

dotnet add package Apparatus.Dapper.Json.Newtonsoft or dotnet add package Apparatus.Dapper.Json.System

As you may guess, the first one will use Newtonsoft.Json for deserialization and the second one the System.Text.Json.

Done! You are ready to go.

How it works

By itself, the implementation is straightforward. We have a source generator that looks for Json<T> and generates a module initializer like that:

using System;

namespace Dapper.Json
{
    public static class DapperJsonModuleInitializer
    {
        [global::System.Runtime.CompilerServices.ModuleInitializer]
        public static void Init()
        {
            SqlMapper.AddTypeHandler(new JsonTypeHandler<global::EmailData[]>());
        }
    }
}

The JsonTypeHandler<T> can be insatlled via Apparatus.Dapper.Json.* packages, or you can write your own. Here is the sample for the Newtonsoft.Json:

using System.Data;
using Newtonsoft.Json;

namespace Dapper.Json
{
    public class JsonTypeHandler<T> : SqlMapper.TypeHandler<Json<T>>
    {
        public override void SetValue(IDbDataParameter parameter, Json<T> value)
        {
            parameter.Value = JsonConvert.SerializeObject(value.Value, JsonSettings.Settings);
        }

        public override Json<T> Parse(object value)
        {
            if (value is string json)
            {
                return new Json<T>(JsonConvert.DeserializeObject<T>(json, JsonSettings.Settings));
            }

            return new Json<T>(default);
        }
    }
}