DatasetBackend <Data>

Index

Methods

• drop
• getData
• getMetadata
• purge
• pushData

Methods

drop

• drop(): Promise<void>

• Remove the dataset and all its data.

  ---

  Returns Promise<void>

getData

• getData(options): Promise<PaginatedList<Data>>

• Fetch a page of items from the dataset.

  ---

  Parameters

  • optionaloptions: DatasetBackendListOptions

  Returns Promise<PaginatedList<Data>>

getMetadata

• getMetadata(): Promise<DatasetInfo>

• Returns metadata about the dataset (id, name, timestamps, item count, etc.).

  Implementations should throw if the underlying storage no longer exists (e.g. it was deleted externally). This method should never return stale data for a storage that has been removed.

  ---

  Returns Promise<DatasetInfo>

purge

• purge(): Promise<void>

• Remove all items from the dataset but keep the dataset itself.

  ---

  Returns Promise<void>

pushData

• pushData(items): Promise<void>

• Add items to the dataset.

  ---

  Parameters

  • items: Data[]

  Returns Promise<void>