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

Methods

createItem deleteItem listItems readItem updateItem

Methods

createItem

createItem(newItem): Promise<ItemType[UniquelyIdentifyingFieldName]>
Create an item in the database.
Parameters
- newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>
Returns Promise<ItemType[UniquelyIdentifyingFieldName]>
Implementation of DataItemDBDriver.createItem
- Defined in src/api/ORM/drivers/DynamoDBDataItemDBDriver.ts:193

deleteItem

deleteItem(uniqueIdentifier): Promise<boolean>
Delete an item from the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
Returns Promise<boolean>
Implementation of DataItemDBDriver.deleteItem
- Defined in src/api/ORM/drivers/DynamoDBDataItemDBDriver.ts:282

listItems

listItems(config, selectedFields?): Promise<ListItemsResults<ItemType>>
List items from the database.
Parameters
- config: ListItemsConfig
- Optional selectedFields: (keyof ItemType)[]
Returns Promise<ListItemsResults<ItemType>>
Implementation of DataItemDBDriver.listItems
- Defined in src/api/ORM/drivers/DynamoDBDataItemDBDriver.ts:301

readItem

readItem(uniqueIdentifier, selectedFields?): Promise<Partial<ItemType>>
Read an item from the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
- Optional selectedFields: (keyof ItemType)[]
Returns Promise<Partial<ItemType>>
Implementation of DataItemDBDriver.readItem
- Defined in src/api/ORM/drivers/DynamoDBDataItemDBDriver.ts:219

updateItem

updateItem(uniqueIdentifier, updatedItem): Promise<boolean>
Update an item in the database.
Parameters
- uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
- updatedItem: Partial<ItemType>
Returns Promise<boolean>
Implementation of DataItemDBDriver.updateItem
- Defined in src/api/ORM/drivers/DynamoDBDataItemDBDriver.ts:246