Class S3FileItemDBDriver

constructor

• new S3FileItemDBDriver(
      config: DataItemDBDriverConfig<BaseFileItem, "id">,
  ): S3FileItemDBDriver

  Parameters

  • config: DataItemDBDriverConfig<BaseFileItem, "id">

    Driver configuration including S3 settings.

  Returns S3FileItemDBDriver

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.

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.

listItems

• listItems(
      config: ListItemsConfig,
      selectFields?: (
          | "id"
          | "updatedOn"
          | "mimeType"
          | "sizeInBytes"
          | "isDirectory"
          | (keyof BaseFileLocationInfo)
          | "uploadUrl"
          | "downloadUrl"
      )[],
  ): 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"
        | (keyof BaseFileLocationInfo)
        | "uploadUrl"
        | "downloadUrl"
    )[]

    Optional fields to select from each file item.

  Returns Promise<{ cursor: string | undefined; items: Partial<BaseFileItem>[] }>

  List results with items and cursor.

readItem

• readItem(
      id: string,
      selectFields?: (
          | "id"
          | "updatedOn"
          | "mimeType"
          | "sizeInBytes"
          | "isDirectory"
          | (keyof BaseFileLocationInfo)
          | "uploadUrl"
          | "downloadUrl"
      )[],
  ): Promise<BaseFileItem>

  Read a @BaseFileItem by its id.

  Parameters

  • id: string

    Unique identifier value for the file.

  • OptionalselectFields: (
        | "id"
        | "updatedOn"
        | "mimeType"
        | "sizeInBytes"
        | "isDirectory"
        | (keyof BaseFileLocationInfo)
        | "uploadUrl"
        | "downloadUrl"
    )[]

    Optional fields to select from the file item.

  Returns Promise<BaseFileItem>

  File item payload (partial when selected fields are used).

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.

readItemStronglyConsistent