AshDynamo.DataLayer.SecondaryIndex (ash_dynamo v0.5.0)

Copy Markdown View Source

Struct representing a secondary index (GSI or LSI) definition.

Built automatically by the Spark DSL from global_secondary_index and local_secondary_index blocks inside the dynamodb section.

The :type field is auto-set by the entity definition:

  • :global for Global Secondary Indexes
  • :local for Local Secondary Indexes

Summary

Types

t()

Types

t()

@type t() :: %AshDynamo.DataLayer.SecondaryIndex{
  __spark_metadata__: map() | nil,
  name: atom(),
  partition_key: atom(),
  sort_key: atom() | nil,
  type: :global | :local
}