TableClient | @azure/data-tables

A TableClient represents a Client to the Azure Tables service allowing you to perform operations on a single table.

Hierarchy

TableClient

Index

Constructors

constructor

Properties

tableName

Methods

Constructors

constructor

new TableClient(url: string, tableName: string, credential: TablesSharedKeyCredential, options?: TableClientOptions): TableClient
new TableClient(url: string, tableName: string, options?: TableClientOptions): TableClient

- Defined in TableClient.ts:50
Creates a new instance of the TableClient class.

Parameters
- url: string
  
  The URL of the service account that is the target of the desired operation., such as "https://myaccount.table.core.windows.net".
- tableName: string
  
  the name of the table
- credential: TablesSharedKeyCredential
  
  TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
- Optional options: TableClientOptions
  Optional. Options to configure the HTTP pipeline.
  
  Example using an account name/key:
```
const account = "<storage account name>";
const tableName = "<table name>";
const sharedKeyCredential = new TablesSharedKeyCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  `${tableName}`
  sharedKeyCredential
);
```
Returns TableClient
- Defined in TableClient.ts:81
Creates an instance of TableClient.

Parameters
- url: string
  
  The URL of the service account that is the target of the desired operation., such as "https://myaccount.table.core.windows.net".
- tableName: string
  
  the name of the table
- Optional options: TableClientOptions
  Optional. Options to configure the HTTP pipeline.
  
  Example using an account name/key:
```
const account = "<storage account name>";
const tableName = "<table name>";
const sharedKeyCredential = new TablesSharedKeyCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  `${tableName}`
  sharedKeyCredential
);
```
Returns TableClient

Properties

tableName

tableName: string

Name of the table to perform operations on.

Methods

create

create(options?: CreateTableOptions): Promise<CreateTableItemResponse>

- Defined in TableClient.ts:170
Creates the current table it it doesn't exist

Parameters
- Default value options: CreateTableOptions = {}
  
  The options parameters.
Returns Promise<CreateTableItemResponse>

createEntity

createEntity<T>(entity: TableEntity<T>, options?: CreateTableEntityOptions): Promise<CreateTableEntityResponse>

- Defined in TableClient.ts:330
Insert entity in the table.

Type parameters
- T: object
Parameters
- entity: TableEntity<T>
  
  The properties for the table entity.
- Default value options: CreateTableEntityOptions = {}
  
  The options parameters.
Returns Promise<CreateTableEntityResponse>

delete

delete(options?: DeleteTableOptions): Promise<DeleteTableResponse>

- Defined in TableClient.ts:153
Permanently deletes the current table with all of its entities.

Parameters
- Default value options: DeleteTableOptions = {}
  
  The options parameters.
Returns Promise<DeleteTableResponse>

deleteEntity

deleteEntity(partitionKey: string, rowKey: string, options?: DeleteTableEntityOptions): Promise<DeleteTableEntityResponse>

- Defined in TableClient.ts:359
Deletes the specified entity in the table.

Parameters
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- Default value options: DeleteTableEntityOptions = {}
  
  The options parameters.
Returns Promise<DeleteTableEntityResponse>

getEntity

getEntity<T>(partitionKey: string, rowKey: string, options?: GetTableEntityOptions): Promise<GetTableEntityResponse<T>>

- Defined in TableClient.ts:188
Returns a single entity in the table.

Type parameters
- T: object
Parameters
- partitionKey: string
  
  The partition key of the entity.
- rowKey: string
  
  The row key of the entity.
- Default value options: GetTableEntityOptions = {}
  
  The options parameters.
Returns Promise<GetTableEntityResponse<T>>

listEntities

listEntities<T>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<T, ListEntitiesResponse<T>>

- Defined in TableClient.ts:223
Queries entities in a table.

Type parameters
- T: object
Parameters
- Default value options: ListTableEntitiesOptions = {}
  
  The options parameters.
Returns PagedAsyncIterableIterator<T, ListEntitiesResponse<T>>

updateEntity

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

- Defined in TableClient.ts:390
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.
- Default value options: UpdateTableEntityOptions = {}
  
  The options parameters.
Returns Promise<UpdateEntityResponse>

upsertEntity

upsertEntity<T>(entity: TableEntity<T>, mode: UpdateMode, options?: UpsertTableEntityOptions): Promise<UpsertEntityResponse>

- Defined in TableClient.ts:437
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.
- Default value options: UpsertTableEntityOptions = {}
  
  The options parameters.
Returns Promise<UpsertEntityResponse>

Static fromConnectionString

fromConnectionString(connectionString: string, tableName: string, options?: TableClientOptions): TableClient

- Defined in TableClient.ts:497
Creates an instance of TableClient from connection string.

Parameters
- connectionString: string
  
  Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.table.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- tableName: string
- Optional options: TableClientOptions
Returns TableClient

A new TableClient from the given connection string.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

tableName: string

credential: TablesSharedKeyCredential

Optional options: TableClientOptions

Returns TableClient

Parameters

url: string

tableName: string

Optional options: TableClientOptions

Returns TableClient

Properties

tableName

Methods

create

Parameters

Default value options: CreateTableOptions = {}

Returns Promise<CreateTableItemResponse>

createEntity

Type parameters

T: object

Parameters

entity: TableEntity<T>

Default value options: CreateTableEntityOptions = {}

Returns Promise<CreateTableEntityResponse>

delete

Parameters

Default value options: DeleteTableOptions = {}

Returns Promise<DeleteTableResponse>

deleteEntity

Parameters

partitionKey: string

rowKey: string

Default value options: DeleteTableEntityOptions = {}

Returns Promise<DeleteTableEntityResponse>

getEntity

Type parameters

T: object

Parameters

partitionKey: string

rowKey: string

Default value options: GetTableEntityOptions = {}

Returns Promise<GetTableEntityResponse<T>>

listEntities

Type parameters

T: object

Parameters

Default value options: ListTableEntitiesOptions = {}

Returns PagedAsyncIterableIterator<T, ListEntitiesResponse<T>>

updateEntity

Type parameters

T: object

Parameters

entity: TableEntity<T>

mode: UpdateMode

Default value options: UpdateTableEntityOptions = {}

Returns Promise<UpdateEntityResponse>

upsertEntity

Type parameters

T: object

Parameters

entity: TableEntity<T>

mode: UpdateMode

Default value options: UpsertTableEntityOptions = {}

Returns Promise<UpsertEntityResponse>

Static fromConnectionString

Parameters

connectionString: string

tableName: string

Optional options: TableClientOptions

Returns TableClient