UUID.Serialization.Dapper 1.1.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher. 
dotnet add package UUID.Serialization.Dapper --version 1.1.0                

                    
                

            
NuGet\Install-Package UUID.Serialization.Dapper -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="UUID.Serialization.Dapper" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add UUID.Serialization.Dapper --version 1.1.0                

                    
                

            
#r "nuget: UUID.Serialization.Dapper, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install UUID.Serialization.Dapper as a Cake Addin
#addin nuget:?package=UUID.Serialization.Dapper&version=1.1.0

// Install UUID.Serialization.Dapper as a Cake Tool
#tool nuget:?package=UUID.Serialization.Dapper&version=1.1.0

UUID.Serialization.Dapper

A Dapper type handler provider for the UUID library.

Installation

dotnet add package UUID.Serialization.Dapper

Usage

Basic Usage

using Dapper;

// Register the binary handler (recommended for storage efficiency)
SqlMapper.AddTypeHandler(new BinaryUUIDHandler());

// Or register the string handler (if you need human-readable values)
SqlMapper.AddTypeHandler(new StringUUIDHandler());

// Or register the Base64 handler (for compact string representation)
SqlMapper.AddTypeHandler(new Base64UUIDHandler());

// Example query
var user = connection.QuerySingle<User>("SELECT * FROM Users WHERE Id = @Id", new { Id = UUID.New() });

With Models

public class UserModel
{
    public UUID Id { get; set; }
    public string Name { get; set; }
}

// Example insert
var user = new UserModel 
{ 
    Id = UUID.New(),
    Name = "John Doe"
};

connection.Execute("INSERT INTO Users (Id, Name) VALUES (@Id, @Name)", user);

// Example select
var users = connection.Query<UserModel>("SELECT * FROM Users");

Features

  • Thread-safe implementation
  • Comprehensive error handling
  • Seamless integration with Dapper
  • Full documentation with XML comments
  • Custom error messages for better debugging
  • Base64 UUID Handler: Store UUIDs as 24-character strings (compact)
  • Binary UUID Handler: Store UUIDs as 16-byte binary data (most efficient)
  • String UUID Handler: Store UUIDs as 32-character fixed-length strings (human-readable)

Storage Options

  • Ideal for database indexing
  • Most efficient storage (16 bytes)
  • Perfect for high-performance scenarios

String Handler

  • Human-readable format
  • Useful for debugging and logging
  • 32-character hexadecimal representation

Base64 Handler

  • URL-safe encoding
  • Balance between readability and size
  • Compact string representation (24 characters)

Requirements

  • UUID library
  • Dapper 2.1.35 or later
  • Supports .NET 6.0+, .NET Standard 2.0+, and .NET Framework 4.8+

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the terms of the LICENSE file included in the root directory.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

All changes are detailed at https://github.com/Taiizor/UUID/wiki/Changelog.