Aicrosoft.DataAccess.AzureTable 8.0.0-beta.260130.2

Aicrosoft.DataAccess.AzureTable

Aicrosoft.DataAccess.AzureTable is a lightweight repository-based abstraction layer over the official Azure Data Tables SDK. It provides a standardized way to interact with Azure Table Storage using the Repository pattern, simplifying entity management and service registration within the Aicrosoft framework.

Design Goals

1. Repository Pattern for NoSQL: Adapt the familiar Repository pattern to Azure Table Storage, offering a consistent API for CRUD operations.
2. Simplified Entity Definition: Provide TableEntityBase to handle mandatory ITableEntity properties like PartitionKey, RowKey, and ETag.
3. Convention-Based Table Naming: Automatically derive table names from entity type names (e.g., UserEntity maps to a table named User).
4. Automated Infrastructure: Ensure tables are created automatically (CreateIfNotExists) when the repository is initialized.
5. Clean DI Integration: Offer easy-to-use extension methods for registering repositories in the .NET Dependency Injection container.

Key Features

• ITableRepository<T>: A generic interface for asynchronous Add, Get, Update, Delete, and GetAll operations.
• TableEntityBase: An abstract base class that implements ITableEntity and provides built-in concurrency support via ETag.
• AzureTableExtensions: DI extensions to register entities with their corresponding connection strings.

Usage

1. Installation

Reference the Aicrosoft.DataAccess.AzureTable package in your project.

2. Define an Entity

Inherit from TableEntityBase:

using Aicrosoft.DataAccess.Data;

public class LogEntity : TableEntityBase
{
    public string Message { get; set; }
    public string Level { get; set; }
}

3. Register the Repository

In your Program.cs or service configuration:

using Microsoft.Extensions.DependencyInjection;

// Registers ITableRepository<LogEntity> as a Singleton
services.RegisterToAzureTable<LogEntity>("UseDevelopmentStorage=true");

4. Inject and Use

public class MyService
{
    private readonly ITableRepository<LogEntity> _repo;

    public MyService(ITableRepository<LogEntity> repo)
    {
        _repo = repo;
    }

    public async Task SaveLog(string msg)
    {
        var entity = new LogEntity 
        { 
            PartitionKey = "System", 
            RowKey = Guid.NewGuid().ToString(),
            Message = msg,
            Level = "Info"
        };
        await _repo.AddAsync(entity);
    }
}

Important Notes

• Concurrency: UpdateAsync uses ETag.All by default if not specified, otherwise it respects the ETag on the entity for optimistic concurrency control.
• Naming: The library automatically strips the "Entity" suffix from your class name to determine the Azure Table name. For example, MyDataEntity will target a table named MyData.
• Table Creation: The repository calls CreateIfNotExists() upon instantiation, so there's no need to manually create tables in the portal beforehand.

Related Projects

• Aicrosoft.Extensions.Hosting: For base DI support.
• Aicrosoft.DataAccess.Abstractions: For shared data contracts.