Class S3FileItemDBDriver

Use S3 as a DataItemDBDriver for BaseFileItems.

Implements

DataItemDBDriver<BaseFileItem, "id">

Index

Methods

createItem deleteItem listItems readItem updateItem

Methods

createItem

createItem(item): Promise<string>
Create a new @BaseFileItem.
Parameters
- item: Partial<Omit<BaseFileItem, "id">>
Returns Promise<string>
Implementation of DataItemDBDriver.createItem
- Defined in src/api/ORM/drivers/S3FileItemDBDriver.ts:63

deleteItem

deleteItem(id): Promise<boolean>
Delete a @BaseFileItem by its id.
Parameters
- id: string
Returns Promise<boolean>
Implementation of DataItemDBDriver.deleteItem
- Defined in src/api/ORM/drivers/S3FileItemDBDriver.ts:176

listItems

listItems(config, selectFields?): Promise<{
cursor: undefined | string;
items: Partial<BaseFileItem>[];
}>
List @BaseFileItems by a given criteria.
Parameters
- config: ListItemsConfig
- Optional selectFields: ("id" | "updatedOn" | "mimeType" | "sizeInBytes" | "isDirectory" | "uploadUrl" | "downloadUrl" | (keyof BaseFileLocationInfo))[]
Returns Promise<{
cursor: undefined | string;
items: Partial<BaseFileItem>[];
}>
Implementation of DataItemDBDriver.listItems
- Defined in src/api/ORM/drivers/S3FileItemDBDriver.ts:195

readItem

readItem(id, selectFields?): Promise<BaseFileItem>
Read a @BaseFileItem by its id.
Parameters
- id: string
- Optional selectFields: ("id" | "updatedOn" | "mimeType" | "sizeInBytes" | "isDirectory" | "uploadUrl" | "downloadUrl" | (keyof BaseFileLocationInfo))[]
Returns Promise<BaseFileItem>
Implementation of DataItemDBDriver.readItem
- Defined in src/api/ORM/drivers/S3FileItemDBDriver.ts:87

updateItem

updateItem(uniqueIdentifier, item): Promise<boolean>
Update a @BaseFileItem.
Parameters
- uniqueIdentifier: string
- item: Partial<BaseFileItem>
Returns Promise<boolean>
Implementation of DataItemDBDriver.updateItem
- Defined in src/api/ORM/drivers/S3FileItemDBDriver.ts:136