DynamoMapper 1.0.1.22

DynamoMapper

High-performance source generator for DynamoDB attribute mapping

DynamoMapper is a .NET incremental source generator that generates high-performance mapping code between domain models and Amazon DynamoDB AttributeValue dictionaries. Using compile-time code generation, it eliminates runtime reflection, reduces allocations, and provides type-safe mapping for single-table DynamoDB patterns.

Why DynamoMapper?

• ⚡ Zero reflection overhead - All mapping code generated at compile time
• 🎯 Type-safe - Catches configuration errors at compile time with diagnostics
• 🚀 Allocation-free - Uses efficient dictionary operations, no LINQ or unnecessary allocations
• 🔧 Simple - Convention-first with minimal attribute configuration
• 🌐 Single-table friendly - Designed for single-table DynamoDB patterns with customization hooks
• 📦 Clean domain models - No attributes on your domain classes required

📚 View Full Documentation

Installation

Install the NuGet package:

dotnet add package DynamoMapper --prerelease

Ensure your project uses C# 11 or later:

<PropertyGroup>
  <LangVersion>11</LangVersion>
  
</PropertyGroup>

Quick Start

1. Define your domain model

public class Product
{
    public string UserId { get; set; }
    public Guid ProductId { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public string? Description { get; set; }
    public ProductStatus Status { get; set; }
}

2. Create a mapper class

using DynamoMapper.Runtime;
using Amazon.DynamoDBv2.Model;

namespace MyApp.Data;

[DynamoMapper(Convention = DynamoNamingConvention.CamelCase)]
[DynamoField(nameof(Product.Description), OmitIfNull = true, OmitIfEmptyString = true)]
public static partial class ProductMapper
{
    public static partial Dictionary<string, AttributeValue> ToItem(Product source);

    public static partial Product FromItem(Dictionary<string, AttributeValue> item);
}

3. That's it!

At compile time, DynamoMapper generates the mapping code. Use it like this:

var product = new Product
{
    UserId = "user-123",
    ProductId = Guid.NewGuid(),
    Name = "Laptop",
    Price = 999.99m,
    Status = ProductStatus.Available
};

// Convert to DynamoDB item
var item = ProductMapper.ToItem(product);
await dynamoDbClient.PutItemAsync(new PutItemRequest
{
    TableName = "MyTable",
    Item = item
});

// Convert from DynamoDB item
var getResponse = await dynamoDbClient.GetItemAsync(new GetItemRequest
{
    TableName = "MyTable",
    Key = new Dictionary<string, AttributeValue>
    {
        ["pk"] = new AttributeValue { S = $"USER#{product.UserId}" },
        ["sk"] = new AttributeValue { S = $"PRODUCT#{product.ProductId}" }
    }
});
var retrievedProduct = ProductMapper.FromItem(getResponse.Item);

For more examples including single-table patterns and custom converters, see the Quick Start Guide.

Key Features

• Attribute-Based Configuration (Phase 1): Configure mapping via [DynamoField] and [DynamoIgnore] on mapper classes
• Fluent DSL Configuration (Phase 2): Optional strongly-typed DSL for configuration
• Naming Conventions: CamelCase, SnakeCase, or Exact field naming
• Required Field Validation: Compile-time and runtime validation of required fields
• Omission Policies: Flexible null/empty value omission strategies
• Custom Converters: Type-safe converter pattern for custom serialization
• Customization Hooks: Before/After hooks for injecting pk/sk and custom logic
• Single-Table Support: Built for single-table DynamoDB design patterns
• Supported Types: strings, numerics, bool, Guid, DateTime, DateTimeOffset, TimeSpan, enums, plus lists/maps/sets of supported element types
• Comprehensive Diagnostics: Clear compile-time errors with actionable messages
• Zero Configuration: Sensible defaults for most use cases

Learn more in the Core Concepts documentation.

Requirements

• C# 11+ (for partial method generation)
• .NET Standard 2.0+ (package targets)
• AWSSDK.DynamoDBv2 (for AttributeValue types)

See the Requirements page for full details.

Documentation

📖 Full Documentation - Comprehensive guides and API reference

Key sections:

• Installation - Get started with DynamoMapper
• Quick Start - Your first mapper in 5 minutes
• Core Concepts - Understand how it works
• Usage Guide - Detailed usage patterns
• Examples - Real-world DynamoDB scenarios
• Roadmap - Phase 1 and Phase 2 plans

Contributing

Contributions are welcome! See our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ⚡ by the LayeredCraft team