Interface MetaAttributeNames

The attribute names on the underlying table for various "meta" attributes Note that only pk is required These values can change for multi-table stores. E.g. one table may be a multi-entity "standard" configuration, and another might be more customized for one specific entity This type is included in this file since MetaAttributeNames are parsed to an Entity's parser function "Standard" configuration for a multi-entity / single-table configuration, is defined in setupSupport.ts, but in brief is: pk: 'PK' sk: 'SK' gsisById: { gsi: { pk: 'GSIPK', sk: 'GSISK' } } ttl: 'ttl', entityType: '_et', lastUpdated: '_lastUpdated'

Hierarchy

  • MetaAttributeNames

Properties

entityType? gsisById? lastUpdated? pk sk? ttl?

Properties

Optional entityType

entityType?: string

Optional gsisById

gsisById?: Record<string, {
    pk: string;
    sk?: string;
}>

Map of GSI ID (which might be different from the underlying index name) to corresponding GSI PK / GSI SK attribute names If no GSIs are defined for the table this map should be undefined or empty

Type declaration

  • pk: string
  • Optional sk?: string

Optional lastUpdated

lastUpdated?: string

pk

pk: string

Optional sk

sk?: string

Optional ttl

ttl?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc