CheesyTot.AzureTables.SimpleIndex 0.1.35

CheesyTot.AzureTables.SimpleIndex

This project provides a simple way to add simple indexing to your Azure Table Storage entities.

Decorate properties to be indexed

public class Cat : ITableEntity
{
    public Cat(string partitionKey, string rowKey)
    { }

    public string PartitionKey { get; set;}
    public string RowKey { get; set; }
    public DateTimeOffset? Timestamp { get; set; }
    public ETag ETag { get; set; }
    
    [SimpleIndex]
    public string Breed { get; set; }
    
    [SingleIndex]
    public int YearBorn {get; set;}

    public string Name { get; set; }
}

Add SimpleIndexRepository to your project

Program.cs

builder.Services.Configure<RepositoryOptions>(options =>
{
    options.StorageConnectionString = "UseDevelopmentStorage=true";
    options.TablePrefix = "Example";
    options.IndexTableSuffix = "Index";
});

builder.Services.AddScoped<ISimpleIndexRepository<Cat>, SimpleIndexRepository<Cat>>();

Query by indexed property

public class MyDataAccess
{
    private readonly ISimpleIndexRepository<Cat> _catRepository;

    public MyDataAccess(ISimpleIndexRepository<Cat> catRepository)
    {
        _catRepository = catRepository;
    }
    
    public async Task<IEnumerable<Cat>> GetCatsByBreed(string breed)
    {
        return await _cat.GetByIndexedPropertyAsync("Breed", breed);
    }
}

Query by multiple indexed properties

    public async Task<IEnumerable<Cat>> GetCatsByBreedAndBirthYear(string breed, int birthYear)
    {
        var breedResults = await _cat.GetByIndexedPropertyAsync("Breed", breed);
        var yearResults = await _cat.GetByIndexedPropertyAsync("BirthYear", birthYear);
        return breedResults.Intersect(yearResults);
    }

    public async Task<IEnumerable<Cat>> GetCatsByBreedOrBirthYear(string breed, int birthYear)
    {
        var breedResults = await _cat.GetByIndexedPropertyAsync("Breed", breed);
        var yearResults = await _cat.GetByIndexedPropertyAsync("BirthYear", birthYear);
        return breedResults.Union(yearResults);
    }

Specify the tableName instead of using the class name

[TableName("Feline")]
public class Cat : ITableEntity
{
    ...
}