Amazon DynamoDB · Types · Preloading the schema

ArxDynamoPreLoad

Definition

Namespace
ARX.SDK.DynamoDb.Services
Package
ARX.SDK.DynamoDb
C#
public static class ArxDynamoPreLoad

Loads an ArxPreLoadTable from DynamoDB.

Methods

  • static Task<ArxSchemaCatalog> LoadAsync(this ArxPreLoadTable preload, IAmazonDynamoDB client, ArxDynamoModel model, Action<ArxSchemaCatalogBuilder>? configure = null, CancellationToken cancellationToken = default)

    Reads, once at startup, the key schema of each requested entity's table (DescribeTable) and returns a schema catalog: the entity's key as a business key and the key attributes' types as columns. DynamoDB stores no other types, so the other attributes are the ones configure declares (.Column); with Strict they are the allow list.

    Parameter Type Description
    preloadthis ArxPreLoadTableThe entities to read.
    clientIAmazonDynamoDBThe DynamoDB client.
    modelArxDynamoModelThe tables' layout.
    configureAction<ArxSchemaCatalogBuilder>?= nullDeclarations of your own: each entity's id, the columns and their types (DynamoDB keeps none), lookups, versions; null for none. They are kept, and the preload adds only what they leave out.
    cancellationTokenCancellationToken= defaultCancels the call.