HUMANiT.Azure.Data 2.0.2

HUMANiT Azure Data

Features

• Cosmos: Simlified access to Azure Cosmos.
• Cosmos Items: Simplifies and size-optimizes serialization into to Azure Cosmos documents.

Version 2.0 (Upgrade from 1.2)

• Breaking: Explicit .NET 6 target framework removed. Use .NET 8 instead.
• Breaking: HUMANiT.Azure.Data.IDataAccess interface removed. Use DataAccess instead.
• New: Option added to CosmosContext that items are no longer filtered by item type name when read from a container.
• Improved: HUMANiT.Azure.Data.Cosmos.Items.BasicPersistableCosmosItem inherits from EmbeddedCosmosItem now.
• Improved: Inline documentation.
• Obsolete: HUMANiT.Azure.Data.Cosmos.ICosmosContext interface deprecated. Use CosmosContext instead.
• Obsolete: HUMANiT.Azure.Data.Cosmos.Items.*CosmosItem.HealthState property deprecated. Use Health instead.
• Obsolete: HUMANiT.Azure.Data.Cosmos.Items.EmbeddedPersistableCosmosItem class deprecated. Use EmbeddedCosmosItem instead.

Contact

This package contains features which we require for our own software; therefore, some features are highly custom. If you require a fix, an enhancement, or a more configurable solution, please contact us: support@humanit.nz.

License

MIT -- free software, hell yeah 🤩

Quickstarts

Cosmos

Simlified access to Azure Cosmos.

Located in namespace HUMANiT.Azure.Data.Cosmos.

Quickstart guidance will come.

Cosmos Items

Simplifies and size-optimizes serialization into to Azure Cosmos documents.

Located in namespace HUMANiT.Azure.Data.Cosmos.Items.

Purpose will be explained later.

The parameterless constructor CosmosItem() ... explained later.

The constructor CosmosItem(TDomainObject) ... explained later.

The property ItemTypeName is a built-in object/document type identifier. It is based on the underlying domain object. Its purpose is to deal with Cosmos DB specifics. Different items have different item type names which allows to select all items of one item type when querying data. However, that requirement is only rarely required. To disable their rendering into Cosmos documents and therefore save storage space, override this property and mark it with Newtonsoft.Json.JsonIgnoreAttribute. Example:

// We override this property, so we can exclude it from the serialization into our Cosmos docs.
[JsonIgnore]
public override string ItemTypeName
{
    get => base.ItemTypeName;
    set => base.ItemTypeName = value;
}

The DetermineItemTypeName() method ... explained later.

The Extract() methods ... explained later.

The ExtractProperties() method ... explained later.

The Restore() method ... explained later.

The Restore...() methods ... explained later.

More guidance will come.