Class TableBatchImpl

Package version

TableBatch collects sub-operations that can be submitted together via submitBatch

Hierarchy

TableBatchImpl

Implements

TableBatch

Index

Constructors

constructor

Properties

partitionKey

Methods

Constructors

constructor

new TableBatchImpl(url: string, partitionKey: string, interceptClient: TableClientLike, batchGuid: string, batchRequest: InnerBatchRequest, credential?: TablesSharedKeyCredentialLike): TableBatchImpl

- Defined in TableBatch.ts:51
Parameters
- url: string
  
  Tables account url
- partitionKey: string
  
  partition key
- interceptClient: TableClientLike
- batchGuid: string
- batchRequest: InnerBatchRequest
- Optional credential: TablesSharedKeyCredentialLike
  
  credential to authenticate the batch request
Returns TableBatchImpl

Properties

partitionKey

partitionKey: string

Partition key tagetted by the batch

Methods

createEntities

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

- Defined in TableBatch.ts:101
Adds a createEntity operation to the batch per each entity in the entities array

Type parameters
- T: object
Parameters
- entitites: TableEntity<T>[]
  
  Array of entities to create
Returns void

createEntity

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

- Defined in TableBatch.ts:92
Adds a createEntity operation to the batch

Type parameters
- T: object
Parameters
- entity: TableEntity<T>
  
  Entity to create
Returns void

deleteEntity

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

- Defined in TableBatch.ts:114
Adds a deleteEntity operation to the batch

Parameters
- partitionKey: string
  
  partition key of the entity to delete
- rowKey: string
  
  row key of the entity to delete
- Optional options: DeleteTableEntityOptions
  
  options for the delete operation
Returns void

submitBatch

submitBatch(): Promise<any>

- Defined in TableBatch.ts:141
Submits the operations in the batch

Returns Promise<any>

updateEntity

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

- Defined in TableBatch.ts:129
Adds an updateEntity operation to the batch

Type parameters
- T: object
Parameters
- entity: TableEntity<T>
  
  entity to update
- mode: UpdateMode
  
  update mode (Merge or Replace)
- Optional options: UpdateTableEntityOptions
  
  options for the update operation
Returns void

Generated using TypeDoc