Evodim/Azure.EntityServices

Services to manage pure entities in Azure storage table and blob

Azure Entity Services

Manage your entities in Azure Storage without tears !

• AzureEntityServices.Tables

• AzureEntityServices.Tables.Extensions.DependencyInjection

• AzureEntityServices.Blobs

• AzureEntityServices.Blobs.Extensions.DependencyInjection

• AzureEntityServices.Queries

What is Azure Entity Services?

Azure Entity Services is an abstraction layer library which help you to store, query, update any entities classes in Azure Storage Table and Blob

This library was written in C# Core and based on official Azure SDK

Focused on performance and productivity

The library was designed to offer optimized performance and memory consumption to allow batched reading and writing operations on large entities store

Moreover, abstraction layers for Table and Blob will simplify implementation of your applications and provide simple and fast integration

This will allow you to focus on you application business logic

What the meaning of Entity ?

An entity class is essentially an object wrapper for a database table.

Attributes of an entity are mapped automatically into storage table or metadata of a blob Managing your entities by using various basic and advanced operations such as: read, insert, modify, remove, paginate, bulk read and bulk add/update

With this Library you can map any data entities (C# class) into a table or a blob item

EntityTableClient features

based on Azure.Data.Tables sdk library

• You can manage any generic C# entities without Azure SDK dependencies: no needs to inehrit from ITableEntity or TableEntity neither
• You can extend entity properties with dynamic properties (to simplify search and indexing nested objects)
• You can tag any entity or dynamic properties to be indexed for faster search for tables with large amount of items
• Handle more primitive types that are not supported by default in azure table storage
• Lightweight and extensible query expression builder, used to build advanced filter expressions and indexed tags
• Observe entity changes, subscribe and apply any side effects like CQRS patterns
• It Could be injected and configured with Microsoft Azure extensions: AzureClientFactoryBuilder

How it works?

EntityTableClient use custom entity adapter to map any C# entity classes into Azure Table Entity Model (TableEntity)

This adapter allows to have more control when entity was stored of readed from the table storage

To handle additional indexes (range tags), we use Azure storage ETG feature (entity transaction group) to keep indexed tags synchronized with the main entity.

EntityTableClient configuration example

            //==============Entity options and configuratin section====================================================
            //set here for your technical stuff: table name, connection, parallelization
            var entityClient = EntityTableClient.Create<PersonEntity>(
             options =>
            {
                options.ConnectionString = TestEnvironment.ConnectionString;
                options.TableName = $"{nameof(PersonEntity)}";
                options.CreateTableIfNotExists = true;
            }

            //set here your entity behavior dynamic fields, tags, observers
            , config =>
            {
                config
                .SetPartitionKey(p => p.TenantId)
                .SetPrimaryKeyProp(p => p.PersonId)
                .IgnoreProp(p => p.OtherAddress)

                //add tag to generate indexed and sorted entities through rowKey
                .AddTag(p => p.Created)
                .AddTag(p => p.LastName)
                .AddTag(p => p.Distance)
                .AddTag(p => p.Enabled)

                //add computed props to store and compute dynamically additional fields of the entity
                .AddComputedProp("_IsInFrance", p => p.Address?.State == "France")
                .AddComputedProp("_MoreThanOneAddress", p => p.OtherAddress?.Count > 1)
                .AddComputedProp("_CreatedNext6Month", p => p.Created > DateTimeOffset.UtcNow.AddMonths(-6))
                .AddComputedProp("_FirstLastName3Chars", p => p.LastName?.ToLower()[..3])

                //computed props could also be tagged 
                .AddTag("_FirstLastName3Chars")

                //add an entity oberver to track entity changes and apply any action (projection, logging, etc.)
                .AddObserver("EntityLoggerObserver", new EntityLoggerObserver<PersonEntity>());
            });
            //===============================================================================================

Sample projects

Sample projects

Performance tests Sample console based on a table with 1.5 million of entities and 5 partitions (standard storageV2)

EntityBlobClient package features

Based on Azure.Data.Blobs sdk library

• Like EntityTableClient, you can manage any generic C# entities without Azure SDK dependencies
• Entities properties was mapped and stored directly into Blob metadata, no need to maintain a relation with blob and any additional tables
• You can tag any entity or dynamic properties to be indexed natively by Azure Blob Storage service
• It use also same query expression builder of EntityTableClient to query Blobs inside a container
• It could be injected and configured with Microsoft Azure extensions: AzureClientFactoryBuilder
• Abstract and simplify Blob reference path by using dynamic path delegate based on your entity properties (SetBlobPath and SetBlobName)

EntityTableClient configuration example

     var options = new EntityBlobClientOptions($"{nameof(DocumentEntity)}Container".ToLower());

            //Configure entity binding in the table storage
            var client = EntityBlobClient.Create<DocumentEntity>(TestEnvironment.ConnectionString)
                .Configure(options, config =>
             config
                .SetBlobContentProp(p => p.Content)
                .SetBlobPath(p => $"{p.Created:yyyy/MM/dd}")
                .SetBlobName(p => $"{p.Name}-{p.Reference}.{p.Extension}")
                .AddTag(p => p.Reference)
                .AddTag(p => p.Name));

Upcoming:

• Expand test coverage
• Add more validation rules according to azure storage limitations
• Gradually improvement of EntityBlobClient
• More description of the internal implementation of this library
• Entity migration services, usefull for data or structural migration