Amazon DynamoDB · Types · Other public types

ArxDynamoEntityMap

Definition

Namespace
ARX.SDK.DynamoDb.Model
Package
ARX.SDK.DynamoDb
C#
public sealed class ArxDynamoEntityMap

One entity's layout: its table, how its keys are made, its index keys, its type name and its sharding.

Properties

  • string Name { get; }

    The entity's name.

  • ArxDynamoTableMap Table { get; }

    The table the entity's items are in.

  • ArxDynamoKeyTemplate PartitionKey { get; }

    How the entity's partition key is made: one attribute, or a template.

  • ArxDynamoKeyTemplate SortKey { get; }

    The sort key; null when the table has none.

  • IReadOnlyDictionary<string, (ArxDynamoKeyTemplate PartitionKey, ArxDynamoKeyTemplate SortKey)> IndexKeys { get; }

    The index keys this entity writes: index name → (partition key template, sort key template or null).

  • int Shards { get; }

    How many shards the partition key is spread over (1: no sharding).

  • string? ShardBy { get; }

    The attribute the shard is computed from; null without sharding.

  • IReadOnlyList<string> KeyAttributes { get; }

    The attributes that make the item's primary key, in order and without repeats.