Table | @azure/data-tables

Class representing a Table.

Hierarchy

Table

Index

Constructors

constructor

Methods

Constructors

constructor

new Table(client: GeneratedClient): Table

- Defined in generated/operations/table.ts:43
Initialize a new instance of the class Table class.

Parameters
- client: GeneratedClient
  
  Reference to the service client
Returns Table

Methods

create

create(tableProperties: TableProperties, options?: TableCreateOptionalParams): Promise<TableCreateResponse>

- Defined in generated/operations/table.ts:74
Creates a new table under the given account.

Parameters
- tableProperties: TableProperties
  
  The Table properties.
- Optional options: TableCreateOptionalParams
  
  The options parameters.
Returns Promise<TableCreateResponse>

delete

delete(table: string, options?: TableDeleteOptionalParams): Promise<TableDeleteResponse>

- Defined in generated/operations/table.ts:92
Operation permanently deletes the specified table.

Parameters
- table: string
  
  The name of the table.
- Optional options: TableDeleteOptionalParams
  
  The options parameters.
Returns Promise<TableDeleteResponse>

deleteEntity

deleteEntity(table: string, partitionKey: string, rowKey: string, ifMatch: string, options?: TableDeleteEntityOptionalParams): Promise<TableDeleteEntityResponse>

- Defined in generated/operations/table.ts:199
Deletes the specified entity in a table.

Parameters
- table: string
  
  The name of the table.
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- ifMatch: string
  
  Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).
- Optional options: TableDeleteEntityOptionalParams
  
  The options parameters.
Returns Promise<TableDeleteEntityResponse>

getAccessPolicy

getAccessPolicy(table: string, options?: TableGetAccessPolicyOptionalParams): Promise<TableGetAccessPolicyResponse>

- Defined in generated/operations/table.ts:239
Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.

Parameters
- table: string
  
  The name of the table.
- Optional options: TableGetAccessPolicyOptionalParams
  
  The options parameters.
Returns Promise<TableGetAccessPolicyResponse>

insertEntity

insertEntity(table: string, options?: TableInsertEntityOptionalParams): Promise<TableInsertEntityResponse>

- Defined in generated/operations/table.ts:220
Insert entity in a table.

Parameters
- table: string
  
  The name of the table.
- Optional options: TableInsertEntityOptionalParams
  
  The options parameters.
Returns Promise<TableInsertEntityResponse>

mergeEntity

mergeEntity(table: string, partitionKey: string, rowKey: string, options?: TableMergeEntityOptionalParams): Promise<TableMergeEntityResponse>

- Defined in generated/operations/table.ts:174
Merge entity in a table.

Parameters
- table: string
  
  The name of the table.
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- Optional options: TableMergeEntityOptionalParams
  
  The options parameters.
Returns Promise<TableMergeEntityResponse>

query

query(options?: TableQueryOptionalParams): Promise<TableQueryOperationResponse>

- Defined in generated/operations/table.ts:57
Queries tables under the given account.

Parameters
- Optional options: TableQueryOptionalParams
  
  The options parameters.
Returns Promise<TableQueryOperationResponse>

queryEntities

queryEntities(table: string, options?: TableQueryEntitiesOptionalParams): Promise<TableQueryEntitiesResponse>

- Defined in generated/operations/table.ts:110
Queries entities in a table.

Parameters
- table: string
  
  The name of the table.
- Optional options: TableQueryEntitiesOptionalParams
  
  The options parameters.
Returns Promise<TableQueryEntitiesResponse>

queryEntitiesWithPartitionAndRowKey

queryEntitiesWithPartitionAndRowKey(table: string, partitionKey: string, rowKey: string, options?: TableQueryEntitiesWithPartitionAndRowKeyOptionalParams): Promise<TableQueryEntitiesWithPartitionAndRowKeyResponse>

- Defined in generated/operations/table.ts:130
Queries entities in a table.

Parameters
- table: string
  
  The name of the table.
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- Optional options: TableQueryEntitiesWithPartitionAndRowKeyOptionalParams
  
  The options parameters.
Returns Promise<TableQueryEntitiesWithPartitionAndRowKeyResponse>

setAccessPolicy

setAccessPolicy(table: string, options?: TableSetAccessPolicyOptionalParams): Promise<TableSetAccessPolicyResponse>

- Defined in generated/operations/table.ts:257
Sets stored access policies for the table that may be used with Shared Access Signatures.

Parameters
- table: string
  
  The name of the table.
- Optional options: TableSetAccessPolicyOptionalParams
  
  The options parameters.
Returns Promise<TableSetAccessPolicyResponse>

updateEntity

updateEntity(table: string, partitionKey: string, rowKey: string, options?: TableUpdateEntityOptionalParams): Promise<TableUpdateEntityResponse>

- Defined in generated/operations/table.ts:152
Update entity in a table.

Parameters
- table: string
  
  The name of the table.
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- Optional options: TableUpdateEntityOptionalParams
  
  The options parameters.
Returns Promise<TableUpdateEntityResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: GeneratedClient

Returns Table

Methods

create

Parameters

tableProperties: TableProperties

Optional options: TableCreateOptionalParams

Returns Promise<TableCreateResponse>

delete

Parameters

table: string

Optional options: TableDeleteOptionalParams

Returns Promise<TableDeleteResponse>

deleteEntity

Parameters

table: string

partitionKey: string

rowKey: string

ifMatch: string

Optional options: TableDeleteEntityOptionalParams

Returns Promise<TableDeleteEntityResponse>

getAccessPolicy

Parameters

table: string

Optional options: TableGetAccessPolicyOptionalParams

Returns Promise<TableGetAccessPolicyResponse>

insertEntity

Parameters

table: string

Optional options: TableInsertEntityOptionalParams

Returns Promise<TableInsertEntityResponse>

mergeEntity

Parameters

table: string

partitionKey: string

rowKey: string

Optional options: TableMergeEntityOptionalParams

Returns Promise<TableMergeEntityResponse>

query

Parameters

Optional options: TableQueryOptionalParams

Returns Promise<TableQueryOperationResponse>

queryEntities

Parameters

table: string

Optional options: TableQueryEntitiesOptionalParams

Returns Promise<TableQueryEntitiesResponse>

queryEntitiesWithPartitionAndRowKey

Parameters

table: string

partitionKey: string

rowKey: string

Optional options: TableQueryEntitiesWithPartitionAndRowKeyOptionalParams

Returns Promise<TableQueryEntitiesWithPartitionAndRowKeyResponse>

setAccessPolicy

Parameters

table: string

Optional options: TableSetAccessPolicyOptionalParams

Returns Promise<TableSetAccessPolicyResponse>

updateEntity

Parameters

table: string

partitionKey: string

rowKey: string

Optional options: TableUpdateEntityOptionalParams

Returns Promise<TableUpdateEntityResponse>