TGC.AzureTableStorage 0.1.6

TGC.AzureTableStorage

Disclaimer: This library is still in alpha and is used on your own risk!

Using the library

Before doing anything code related, you'll need to configure your appsettings.

Create the following section (Ensure naming is correct):

"StorageConfiguration": {
	"AccountConnectionString": "DefaultEndpointsProtocol=https;AccountName={StorageAccountName};AccountKey={AccountKey};EndpointSuffix=core.windows.net"
}

In order to use the library you will need to add the following extension methods on your IServiceCollection:

builder.Services.AddAzureTableStorage();

The method above takes care of reading configuration values and setting up context.

Disclaimer: If you are using Azure Function App, the current version does not support Microsoft.Extensions.Configuration.Abstractions which this method is dependent on. If so, you can use:

builder.Services.AddAzureTableStorage("YourConnectionString");

The library maps classes to individual tables in the Azure Storage Account. For each table you will need to define a related DTO. The definition requires adding a custom attribute and inherit from a specific class.

An example looks like this:

namespace Your.Namespace;

[TableItem("FooBars")]
internal class FooBarItem : AzureTableItem
{
	public string Foo { get; set; }
	public string Bar { get; set; }
}

Once your DTO is defined, you will need to register a service for it. That is simply done the on your IServiceProvider as well with the following method:

builder.Services.AddStorageRepository<FooBarItem>();

Now, you can simply use the interface IAzureTableStorageRepository with any of your registered DTOs and your IServiceProvider takes care of the rest:

namespace Your.Namespace;

public class Service
{
	private readonly ILogger<Service> _logger;
	private readonly IAzureTableStorageRepository<FooBarItem> _azureTableStorageRepository;

	public Service(ILogger<Service> log, IAzureTableStorageRepository<FooBarItem> azureTableStorageRepository)
	{
		_logger = log;
		_azureTableStorageRepository = azureTableStorageRepository;
	}
}

Changelog

Patch notes ordered by newest change

0.1.5

Updated versions of TGC.Configuration and TGC.CodingStandards.

0.1.4

Fixed bug with not defining RowKey

0.1.3

Enhanced unit tests and elobrated Readme.md

0.1.2

Added another way of configuring storage context with connectionstring directly

0.1.1

Fixed failing unit tests

0.1.0

Upgraded to .Net 7 and updated readme

0.0.3

First alpha-release