Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TableClientLike

Package version

Describes the shape of a TableClient

Hierarchy

  • TableClientLike

Index

Properties

tableName

tableName: string

Name of the table to perform operations on.

Methods

create

createBatch

  • Creates a new Batch to collect sub-operations that can be submitted together via submitBatch

    Parameters

    • partitionKey: string

      partitionKey to which the batch operations will be targetted to

    Returns TableBatch

createEntity

delete

  • delete(options?: DeleteTableOptions): Promise<DeleteTableResponse>
  • Permanently deletes the current table with all of its entities.

    Parameters

    • Optional options: DeleteTableOptions

      The options parameters.

    Returns Promise<DeleteTableResponse>

deleteEntity

  • deleteEntity(partitionKey: string, rowKey: string, options?: DeleteTableEntityOptions): Promise<DeleteTableEntityResponse>
  • Deletes the specified entity in the table.

    Parameters

    • partitionKey: string

      The partition key of the entity.

    • rowKey: string

      The row key of the entity.

    • Optional options: DeleteTableEntityOptions

      The options parameters.

    Returns Promise<DeleteTableEntityResponse>

getEntity

listEntities

updateEntity

  • Update an entity in the table.

    Type parameters

    • T: object

    Parameters

    • entity: TableEntity<T>

      The properties of the entity to be updated.

    • mode: UpdateMode

      The different modes for updating the entity: - Merge: Updates an entity by updating the entity's properties without replacing the existing entity. - Replace: Updates an existing entity by replacing the entire entity.

    • Optional options: UpdateTableEntityOptions

      The options parameters.

    Returns Promise<UpdateEntityResponse>

upsertEntity

  • Upsert an entity in the table.

    Type parameters

    • T: object

    Parameters

    • entity: TableEntity<T>

      The properties for the table entity.

    • mode: UpdateMode

      The different modes for updating the entity: - Merge: Updates an entity by updating the entity's properties without replacing the existing entity. - Replace: Updates an existing entity by replacing the entire entity.

    • Optional options: UpsertTableEntityOptions

      The options parameters.

    Returns Promise<UpsertEntityResponse>

Generated using TypeDoc