Provides Entity Framework Core integration for the UUID library, enabling efficient database storage and mapping of UUID values. Features include binary (16 bytes), string (32 characters), and base64 (24 characters) storage formats, global configuration options, and per-property customization through value converters.
Get Started
$ dotnet add package UUID.Serialization.EntityReadme
UUID.Serialization.Entity
Entity Framework Core value converters for UUID types. This package provides converters for storing UUID values in different formats:
- Binary (16 bytes)
- Base64 (24 characters)
- String (32 characters)
Installation
dotnet add package UUID.Serialization.Entity
Usage
Global Configuration
Configure all UUID properties in your DbContext to use a specific storage format:
public class MyDbContext : DbContext
{
protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder)
{
// Use binary storage (most efficient, 16 bytes)
configurationBuilder.UseUUIDAsBinary();
// Or use string storage (32 characters)
// configurationBuilder.UseUUIDAsString();
// Or use base64 storage (24 characters)
// configurationBuilder.UseUUIDAsBase64();
}
}
Per-Property Configuration
Configure individual properties to use specific storage formats:
public class MyDbContext : DbContext
{
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<User>()
.Property(e => e.Id)
.UseUUIDAsBinary();
modelBuilder.Entity<AuditLog>()
.Property(e => e.Id)
.UseUUIDAsString();
modelBuilder.Entity<Session>()
.Property(e => e.Id)
.UseUUIDAsBase64();
}
}
Database Schema Examples
-- For binary storage (most efficient, 16 bytes)
CREATE TABLE Users (
Id INTEGER PRIMARY KEY,
UserId BLOB -- SQLite
-- or: UserId BINARY(16) -- SQL Server
-- or: UserId BYTEA -- PostgreSQL
);
-- For string storage (32 characters)
CREATE TABLE AuditLogs (
Id INTEGER PRIMARY KEY,
UserId CHAR(32) -- Fixed-length string
);
-- For base64 storage (24 characters)
CREATE TABLE Sessions (
Id INTEGER PRIMARY KEY,
UserId VARCHAR(24) -- Base64 encoded
);
Features
-
Multiple Storage Formats