Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TableSchema

Describes the DynamoDB table structure and configures settings.

Hierarchy

  • TableSchema

Index

Properties

Methods

Properties

Optional indexName

indexName?: string

The name of the secondary index, when this schema represents a secondary index.

Optional indexProperties

indexProperties?: { projectedAttributes?: string[]; projectionType: "ALL" | "KEYS_ONLY" | "INCLUDE"; type: "GLOBAL" | "LOCAL" }

Additional information about the secondary index. This is only used to fill in the createTable call.

Type declaration

  • Optional projectedAttributes?: string[]

    A list of attributes to include in the secondary index. Only specify if using projectionType="INCLUDE".

  • projectionType: "ALL" | "KEYS_ONLY" | "INCLUDE"

    "ALL" to include all table attributes, "KEYS_ONLY" to include only the primary keys or "INCLUDE" to specify included attributes using 'projectedAttributes'.

  • type: "GLOBAL" | "LOCAL"

    "GLOBAL" for a global secondary index or "LOCAL" for a local secondary index.

partitionKeyField

partitionKeyField: string

The name of the partition key field.

partitionKeyType

partitionKeyType: "string" | "number"

The type of the partition key field.

Optional sortKeyField

sortKeyField?: string

The name of the sort key field. Optional. If set the sortKeyType must also be set.

Optional sortKeyType

sortKeyType?: "string" | "number"

The type of the sort key field. Optional. If set the sortKeyField must also be set.

tableName

tableName: string

The name of the table.

Optional ttlField

ttlField?: string

The name of a field to use as the TTL (time to live) field. Items with this field set will have the value converted to seconds since 12:00:00 AM January 1st, 1970 UTC. DynamoDB will automatically delete items whose ttl has passed (within about 48 hours).

Optional versionKeyField

versionKeyField?: string

The name of a field to use as the version key for optimistic locking. If set on an item, the type of the value must be number. If set and the field is not on an item during a put then there must not be an existing item in the table. If set and the field is present on an item during put/update/delete then the existing value in the table must match.

Methods

Optional dateSerializationFunction

  • dateSerializationFunction(d: Date): string | number

  • How to serialize Dates when encountered. Defaults to ISO8601.

    Parameters

    • d: Date

      the Date to serialize

    Returns string | number

    a serialization of the Date

Generated using TypeDoc