Class DynamoDBDataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>

A DataItemDBDriver that uses DynamoDB as its database.

Type Parameters

ItemType extends TypeInfoDataItem
UniquelyIdentifyingFieldName extends keyof ItemType

Implements

DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>

Index

Constructors

Methods

createItem deleteItem listItems readItem updateItem

Properties

Constructors

constructor

new DynamoDBDataItemDBDriver<
    ItemType extends TypeInfoDataItem,
    UniquelyIdentifyingFieldName extends string | number | symbol,
>(
    config: DataItemDBDriverConfig<ItemType, UniquelyIdentifyingFieldName>,
): DynamoDBDataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>
Type Parameters
- ItemType extends TypeInfoDataItem
- UniquelyIdentifyingFieldName extends string | number | symbol
Parameters
- config: DataItemDBDriverConfig<ItemType, UniquelyIdentifyingFieldName>
  Driver configuration including DynamoDB client settings.
Returns DynamoDBDataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:237

Methods

createItem

createItem(
newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>,
): Promise<ItemType[UniquelyIdentifyingFieldName]>
Create an item in the database.
Parameters
- newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>
  New item payload without the identifying field.
Returns Promise<ItemType[UniquelyIdentifyingFieldName]>
Generated identifier for the created item.
Implementation of DataItemDBDriver.createItem
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:257

deleteItem

deleteItem(
uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
): Promise<boolean>
Delete an item from the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
  Unique identifier value for the item.
Returns Promise<boolean>
True when an item was deleted.
Implementation of DataItemDBDriver.deleteItem
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:366

listItems

listItems(
config: ListItemsConfig,
selectedFields?: (keyof ItemType)[],
): Promise<ListItemsResults<ItemType>>
List items from the database.
Parameters
- config: ListItemsConfig
  List configuration and criteria.
- OptionalselectedFields: (keyof ItemType)[]
  Optional fields to select from each item.
Returns Promise<ListItemsResults<ItemType>>
List results with items and cursor.
Implementation of DataItemDBDriver.listItems
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:389

readItem

readItem(
uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
selectedFields?: (keyof ItemType)[],
): Promise<Partial<ItemType>>
Read an item from the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
  Unique identifier value for the item.
- OptionalselectedFields: (keyof ItemType)[]
  Optional fields to select from the item.
Returns Promise<Partial<ItemType>>
Item payload (partial when selected fields are used).
Implementation of DataItemDBDriver.readItem
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:287

updateItem

updateItem(
    uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
    updatedItem: Partial<ItemType>,
    updateConfig?: TypeInfoORMUpdateConfig,
): Promise<boolean>
Update an item in the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
  Unique identifier value for the item.
- updatedItem: Partial<ItemType>
  Partial update payload for the item.
- OptionalupdateConfig: TypeInfoORMUpdateConfig
Returns Promise<boolean>
True when an item was updated.
Implementation of DataItemDBDriver.updateItem
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver.ts:321

Properties

`Protected`config

config: DataItemDBDriverConfig<ItemType, UniquelyIdentifyingFieldName>

Driver configuration including table name and DynamoDB config.