Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byme8/dapper.json
Add JSON support for Dapper
https://github.com/byme8/dapper.json
csharp dapper json sourcegenerator sql
Last synced: about 9 hours ago
JSON representation
Add JSON support for Dapper
- Host: GitHub
- URL: https://github.com/byme8/dapper.json
- Owner: byme8
- License: mit
- Created: 2021-11-17T22:44:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-14T16:10:02.000Z (6 months ago)
- Last Synced: 2025-01-01T15:07:23.350Z (7 days ago)
- Topics: csharp, dapper, json, sourcegenerator, sql
- Language: C#
- Homepage:
- Size: 46.9 KB
- Stars: 22
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON columns for the Dapper
[The full article](https://dev.to/byme8/making-dapper-and-json-friends-5afc)
It is a small library that simplifies JSON column handling inside the Dapper.
Read a list of items:
``` cs
public class UserData
{
public int Id { get; set; }
public string Login { get; set; }
public Json Emails { get; set; }
}
public class EmailData
{
public string Email { get; set; }
public EmailKind Kind { get; set; }
}
var users = await connection.QueryAsync("""
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:
``` csharp
public class Book
{
public string ISBN { get; set; }
public Json Author { get; set; }
}
public class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
}
var books = await connection.QueryAsync("""
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:
``` csharp
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 `` and generates a module initializer like that:
``` cs
using System;
namespace Dapper.Json
{
public static class DapperJsonModuleInitializer
{
[global::System.Runtime.CompilerServices.ModuleInitializer]
public static void Init()
{
SqlMapper.AddTypeHandler(new JsonTypeHandler());
}
}
}
```
The `` JsonTypeHandler `` can be insatlled via `` Apparatus.Dapper.Json.* `` packages, or you can write your own.
Here is the sample for the `` Newtonsoft.Json ``:
``` cs
using System.Data;
using Newtonsoft.Json;
namespace Dapper.Json
{
public class JsonTypeHandler : SqlMapper.TypeHandler>
{
public override void SetValue(IDbDataParameter parameter, Json value)
{
parameter.Value = JsonConvert.SerializeObject(value.Value, JsonSettings.Settings);
}
public override Json Parse(object value)
{
if (value is string json)
{
return new Json(JsonConvert.DeserializeObject(json, JsonSettings.Settings));
}
return new Json(default);
}
}
}
```