👁 Image
Devlooped.TableStorage.Protobuf 5.5.0

👁 GitHub

A Protocol Buffers binary serializer for use with document-based repositories.

Usage:

 var repo = DocumentRepository.Create<Product>(..., serializer: ProtobufDocumentSerializer.Default);

Document Storage

The DocumentRepository.Create and DocumentPartition.Create factory methods provide access to document-based storage, exposing the a similar API as column-based storage.

Document repositories cause entities to be persisted as a single document column, alongside type and version information to handle versioning at the app level as needed.

The API is mostly the same as for column-based repositories (document repositories implement the same underlying ITableStorage interface):

public record Product(string Category, string Id) 
{
 public string? Title { get; init; }
 public double Price { get; init; }
 public DateOnly CreatedAt { get; init; }
}

var book = new Product("book", "9781473217386")
{
 Title = "Neuromancer",
 Price = 7.32
};

// Column-based storage
var repo = TableRepository.Create<Product>(
 CloudStorageAccount.DevelopmentStorageAccount,
 tableName: "Products",
 partitionKey: p => p.Category,
 rowKey: p => p.Id);

await repo.PutAsync(book);

// Document-based storage
var docs = DocumentRepository.Create<Product>(
 CloudStorageAccount.DevelopmentStorageAccount,
 tableName: "Documents",
 partitionKey: p => p.Category,
 rowKey: p => p.Id
 serializer: [SERIALIZER]);

await docs.PutAsync(book);

If not provided, the serializer defaults to the System.Text.Json-based DocumentSerializer.Default.

The resulting differences in storage can be seen in the following screenshots of the Azure Storage Explorer:

👁 Screenshot of entity persisted with separate columns for properties

👁 Screenshot of entity persisted as a document

The Type column persisted in the documents table is the Type.FullName of the persisted entity, and the Version is the [Major].[Minor] of its assembly, which could be used for advanced data migration scenarios. The major and minor version components are also provided as individual columns for easier querying by various version ranges, using IDocumentRepository.EnumerateAsync(predicate).

If the serialized documents need to access the Timestamp managed by Azure Table Storage, you can implement IDocumentTimestamp in your entity type.

Sponsors

👁 Clarius Org
👁 MFB Technologies, Inc.
👁 DRIVE.NET, Inc.
👁 Keith Pickford
👁 Thomas Bolon
👁 Kori Francis
👁 Uno Platform
👁 Reuben Swartz
👁 Jacob Foshee
👁 alternate text is missing from this package README image
👁 Eric Johnson
👁 David JENNI
👁 Jonathan
👁 Charley Wu
👁 Ken Bonny
👁 Simon Cropp
👁 agileworks-eu
👁 Zheyu Shen
👁 Vezel
👁 ChilliCream
👁 4OTC
👁 Vincent Limo
👁 domischell
👁 Justin Wendlandt
👁 Adrian Alonso
👁 Michael Hagedorn
👁 torutek
👁 mccaffers

👁 Sponsor this project

Learn more about GitHub Sponsors