Class S3FileItemDBDriver

Use S3 as a DataItemDBDriver for BaseFileItems.

Implements

DataItemDBDriver<BaseFileItem, "id">

Index

Constructors

Methods

createItem deleteItem listItems readItem updateItem

Properties

Constructors

constructor

new S3FileItemDBDriver(
config: DataItemDBDriverConfig<BaseFileItem, "id">,
): S3FileItemDBDriver
Parameters
- config: DataItemDBDriverConfig<BaseFileItem, "id">
  Driver configuration including S3 settings.
Returns S3FileItemDBDriver
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:60

Methods

createItem

createItem(item: Partial<Omit<BaseFileItem, "id">>): Promise<string>
Create a new @BaseFileItem.
Parameters
- item: Partial<Omit<BaseFileItem, "id">>
  New file item payload without the id field.
Returns Promise<string>
Generated file id.
Implementation of DataItemDBDriver.createItem
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:79

deleteItem

deleteItem(id: string): Promise<boolean>
Delete a @BaseFileItem by its id.
Parameters
- id: string
  Unique identifier value for the file.
Returns Promise<boolean>
True when the item was deleted.
Implementation of DataItemDBDriver.deleteItem
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:200

listItems

listItems(
    config: ListItemsConfig,
    selectFields?: (
        | "id"
        | "updatedOn"
        | "mimeType"
        | "sizeInBytes"
        | "isDirectory"
        | "uploadUrl"
        | "downloadUrl"
        | (keyof BaseFileLocationInfo)
    )[],
): Promise<{ cursor: string | undefined; items: Partial<BaseFileItem>[] }>
List @BaseFileItems by a given criteria.
Parameters
- config: ListItemsConfig
  List configuration and criteria.
- OptionalselectFields: (
      | "id"
      | "updatedOn"
      | "mimeType"
      | "sizeInBytes"
      | "isDirectory"
      | "uploadUrl"
      | "downloadUrl"
      | (keyof BaseFileLocationInfo)
  )[]
  Optional fields to select from each file item.
Returns Promise<{ cursor: string | undefined; items: Partial<BaseFileItem>[] }>
List results with items and cursor.
Implementation of DataItemDBDriver.listItems
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:222

readItem

readItem(
    id: string,
    selectFields?: (
        | "id"
        | "updatedOn"
        | "mimeType"
        | "sizeInBytes"
        | "isDirectory"
        | "uploadUrl"
        | "downloadUrl"
        | (keyof BaseFileLocationInfo)
    )[],
): Promise<BaseFileItem>
Read a @BaseFileItem by its id.
Parameters
- id: string
  Unique identifier value for the file.
- OptionalselectFields: (
      | "id"
      | "updatedOn"
      | "mimeType"
      | "sizeInBytes"
      | "isDirectory"
      | "uploadUrl"
      | "downloadUrl"
      | (keyof BaseFileLocationInfo)
  )[]
  Optional fields to select from the file item.
Returns Promise<BaseFileItem>
File item payload (partial when selected fields are used).
Implementation of DataItemDBDriver.readItem
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:106

updateItem

updateItem(
uniqueIdentifier: string,
item: Partial<BaseFileItem>,
): Promise<boolean>
Update a @BaseFileItem.
Parameters
- uniqueIdentifier: string
  Unique identifier value for the file.
- item: Partial<BaseFileItem>
  Partial update payload for the file.
Returns Promise<boolean>
True when the item was updated.
Implementation of DataItemDBDriver.updateItem
- Defined in api/ORM/drivers/S3FileItemDBDriver.ts:158

Properties

`Protected`config

config: DataItemDBDriverConfig<BaseFileItem, "id">

Driver configuration including S3 settings.