Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TableBatch

Package version

Defines the shape of a TableBatch

Hierarchy

  • TableBatch

Implemented by

Index

Properties

Properties

createEntities

createEntities: <T>(entitites: TableEntity<T>[]) => void

Adds a createEntity operation to the batch per each entity in the entities array

param

Array of entities to create

Type declaration

    • Type parameters

      • T: object

      Parameters

      Returns void

createEntity

createEntity: <T>(entity: TableEntity<T>) => void

Adds a createEntity operation to the batch

param

Entity to create

Type declaration

deleteEntity

deleteEntity: (partitionKey: string, rowKey: string, options?: DeleteTableEntityOptions) => void

Adds a deleteEntity operation to the batch

param

partition key of the entity to delete

param

row key of the entity to delete

param

options for the delete operation

Type declaration

partitionKey

partitionKey: string

Partition key tagetted by the batch

submitBatch

submitBatch: () => Promise<TableBatchResponse>

Submits the operations in the batch

Type declaration

updateEntity

updateEntity: <T>(entity: TableEntity<T>, mode: UpdateMode, options?: UpdateTableEntityOptions) => void

Adds an updateEntity operation to the batch

param

entity to update

param

update mode (Merge or Replace)

param

options for the update operation

Type declaration

Generated using TypeDoc