ArxDynamoSingleTableBuilder

Definition

Namespace

ARX.SDK.DynamoDb.Model

Package

ARX.SDK.DynamoDb

public sealed class ArxDynamoSingleTableBuilder

Methods

• ArxDynamoSingleTableBuilder Entity(string name, string pk, string? sk = null)

  An entity of the table, its keys made from templates: pk: "CUSTOMER#{customer_id}", sk: "ORDER#{order_id}".

  Parameter	Type	Description
  name	string	The entity's name.
  pk	string	The partition key's template, such as CUSTOMER#{customer_id}.
  sk	string?= null	The sort key's template, such as ORDER#{order_id}; null when the table has no sort key.

• ArxDynamoSingleTableBuilder Index(string name, string partitionKey, string? sortKey = null)

  A global secondary index of the table, keyed by its own attributes (often GSI1PK, GSI1SK).

  Parameter	Type	Description
  name	string	The index's name in DynamoDB.
  partitionKey	string	The index's partition key attribute (often GSI1PK).
  sortKey	string?= null	The index's sort key attribute (often GSI1SK); null for none.

• ArxDynamoSingleTableBuilder EntityIndex(string entity, string index, string pk, string? sk = null)

  The index keys an entity writes, from templates: .EntityIndex("order", "GSI1", pk: "STATUS#{status}", sk: "{ordered_on}").

  Parameter	Type	Description
  entity	string	The entity that writes the index keys.
  index	string	The index, declared with Index.
  pk	string	The template of the index's partition key, such as STATUS#{status}.
  sk	string?= null	The template of its sort key; null for none.