Delen via

TableClient class

Pakket:
@azure/data-tables

Een TableClient vertegenwoordigt een client naar de Azure Tables-service, zodat u bewerkingen op één tabel kunt uitvoeren.

Constructors

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.
TableClient(string, string, SASCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.
TableClient(string, string, TableServiceClientOptions)

Hiermee maakt u een exemplaar van TableClient.
TableClient(string, string, TokenCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.

Eigenschappen

pipeline

Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het bewerken van elke aanvraag voor en nadat deze op de server is aangebracht.
tableName

Naam van de tabel waarop bewerkingen moeten worden uitgevoerd.
url

URL van tabelaccount

Methoden

createEntity<T>(TableEntity<T>, OperationOptions)

Voeg de entiteit in de tabel in.
createTable(OperationOptions)

Hiermee maakt u een tabel met de tableName die is doorgegeven aan de clientconstructor
deleteEntity(string, string, DeleteTableEntityOptions)

Hiermee verwijdert u de opgegeven entiteit in de tabel.
deleteTable(OperationOptions)

Hiermee verwijdert u de huidige tabel definitief met alle bijbehorende entiteiten.
fromConnectionString(string, string, TableServiceClientOptions)

Hiermee maakt u een exemplaar van TableClient op basis van de verbindingsreeks.
getAccessPolicy(OperationOptions)

Hiermee worden details opgehaald over opgeslagen toegangsbeleidsregels die zijn opgegeven in de tabel die kunnen worden gebruikt met Shared Access Signatures.
getEntity<T>(string, string, GetTableEntityOptions)

Retourneert één entiteit in de tabel.
listEntities<T>(ListTableEntitiesOptions)

Query's uitvoeren op entiteiten in een tabel.
setAccessPolicy(SignedIdentifier[], OperationOptions)

Hiermee stelt u opgeslagen toegangsbeleid in voor de tabel die kan worden gebruikt met Shared Access Signatures.
submitTransaction(TransactionAction[], OperationOptions)

Hiermee verzendt u een transactie die bestaat uit een set acties. U kunt de acties opgeven als een lijst of u kunt TableTransaction- gebruiken om de transactie te bouwen.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient, TransactionAction } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const actions: TransactionAction[] = [
  ["create", { partitionKey: "p1", rowKey: "1", data: "test1" }],
  ["delete", { partitionKey: "p1", rowKey: "2" }],
  ["update", { partitionKey: "p1", rowKey: "3", data: "newTest" }, "Merge"],
];
const result = await client.submitTransaction(actions);

Voorbeeld van gebruik met TableTransaction:

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient, TableTransaction } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const transaction = new TableTransaction();

// Call the available action in the TableTransaction object
transaction.createEntity({ partitionKey: "p1", rowKey: "1", data: "test1" });
transaction.deleteEntity("p1", "2");
transaction.updateEntity({ partitionKey: "p1", rowKey: "3", data: "newTest" }, "Merge");

// submitTransaction with the actions list on the transaction.
const result = await client.submitTransaction(transaction.actions);
updateEntity<T>(TableEntity<T>, UpdateMode, UpdateTableEntityOptions)

Een entiteit in de tabel bijwerken.
upsertEntity<T>(TableEntity<T>, UpdateMode, OperationOptions)

Upsert een entiteit in de tabel.

Constructordetails

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.

new TableClient(url: string, tableName: string, credential: NamedKeyCredential, options?: TableServiceClientOptions)

Parameters

url

string

De URL van het serviceaccount dat het doel is van de gewenste bewerking, zoals 'https://myaccount.table.core.windows.net".

tableName

string

de naam van de tabel

credential
NamedKeyCredential

NamedKeyCredential gebruikt voor het verifiëren van aanvragen. Alleen ondersteund voor Node

options
TableServiceClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld van een accountnaam/-sleutel:

import { AzureNamedKeyCredential, TableClient } from "@azure/data-tables";

// Enter your storage account name and shared key
const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

// Use AzureNamedKeyCredential with storage account and account key
// AzureNamedKeyCredential is only available in Node.js runtime, not in browsers
const credential = new AzureNamedKeyCredential(account, accountKey);
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

TableClient(string, string, SASCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.

new TableClient(url: string, tableName: string, credential: SASCredential, options?: TableServiceClientOptions)

Parameters

url

string

De URL van het serviceaccount dat het doel is van de gewenste bewerking, zoals 'https://myaccount.table.core.windows.net".

tableName

string

de naam van de tabel

credential
SASCredential

SASCredential gebruikt voor het verifiëren van aanvragen

options
TableServiceClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld van een SAS-token:

import { TableClient, AzureSASCredential } from "@azure/data-tables";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";
const tableName = "<tableName>";

const clientWithSAS = new TableClient(
  `https://${account}.table.core.windows.net`,
  tableName,
  new AzureSASCredential(sas),
);

TableClient(string, string, TableServiceClientOptions)

Hiermee maakt u een exemplaar van TableClient.

new TableClient(url: string, tableName: string, options?: TableServiceClientOptions)

Parameters

url

string

Een clienttekenreeks die verwijst naar de Azure Storage-tabelservice, zoals 'https://myaccount.table.core.windows.net". U kunt een SAS toevoegen, zoals 'https://myaccount.table.core.windows.net?sasString".

tableName

string

de naam van de tabel

options
TableServiceClientOptions

Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld van het toevoegen van een SAS-token:

import { TableClient } from "@azure/data-tables";

const account = "<account name>";
const sasToken = "<SAS token>";
const tableName = "<tableName>";

const clientWithSAS = new TableClient(
  `https://${account}.table.core.windows.net?${sasToken}`,
  tableName,
);

TableClient(string, string, TokenCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de TableClient-klasse.

new TableClient(url: string, tableName: string, credential: TokenCredential, options?: TableServiceClientOptions)

Parameters

url

string

De URL van het serviceaccount dat het doel is van de gewenste bewerking, zoals 'https://myaccount.table.core.windows.net".

tableName

string

de naam van de tabel

credential
TokenCredential

Azure Active Directory-referentie die wordt gebruikt voor het verifiëren van aanvragen

options
TableServiceClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld met behulp van een Azure Active Directory-referentie:

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const credential = new DefaultAzureCredential();
const account = "<account name>";
const tableName = "<tableName>";

const clientWithAAD = new TableClient(
  `https://${account}.table.core.windows.net`,
  tableName,
  credential,
);

Eigenschapdetails

pipeline

Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het bewerken van elke aanvraag voor en nadat deze op de server is aangebracht.

pipeline: Pipeline

Waarde van eigenschap

Pipeline

tableName

Naam van de tabel waarop bewerkingen moeten worden uitgevoerd.

tableName: string

Waarde van eigenschap

string

url

URL van tabelaccount

url: string

Waarde van eigenschap

string

Methodedetails

createEntity<T>(TableEntity<T>, OperationOptions)

Voeg de entiteit in de tabel in.

function createEntity<T>(entity: TableEntity<T>, options?: OperationOptions): Promise<TableInsertEntityHeaders>

Parameters

entity

TableEntity<T>

De eigenschappen voor de tabelentiteit.

options
OperationOptions

De optiesparameters.

Voorbeeld van het maken van een entiteit

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const testEntity = {
  partitionKey: "P1",
  rowKey: "R1",
  foo: "foo",
  bar: 123,
};
await client.createEntity(testEntity);

Retouren

Promise<TableInsertEntityHeaders>

createTable(OperationOptions)

Hiermee maakt u een tabel met de tableName die is doorgegeven aan de clientconstructor

function createTable(options?: OperationOptions): Promise<void>

Parameters

options
OperationOptions

De optiesparameters.

Voorbeeld van het maken van een tabel

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

// If the table 'newTable' already exists, createTable doesn't throw
await client.createTable();

Retouren

Promise<void>

deleteEntity(string, string, DeleteTableEntityOptions)

Hiermee verwijdert u de opgegeven entiteit in de tabel.

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

Parameters

partitionKey

string

De partitiesleutel van de entiteit.

rowKey

string

De rijsleutel van de entiteit.

options
DeleteTableEntityOptions

De optiesparameters.

Voorbeeld van het verwijderen van een entiteit

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

// deleteEntity deletes the entity that matches exactly the partitionKey and rowKey
await client.deleteEntity("<partitionKey>", "<rowKey>");

Retouren

Promise<TableDeleteEntityHeaders>

deleteTable(OperationOptions)

Hiermee verwijdert u de huidige tabel definitief met alle bijbehorende entiteiten.

function deleteTable(options?: OperationOptions): Promise<void>

Parameters

options
OperationOptions

De optiesparameters.

Voorbeeld van het verwijderen van een tabel

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

await client.deleteTable();

Retouren

Promise<void>

fromConnectionString(string, string, TableServiceClientOptions)

Hiermee maakt u een exemplaar van TableClient op basis van de verbindingsreeks.

static function fromConnectionString(connectionString: string, tableName: string, options?: TableServiceClientOptions): TableClient

Parameters

connectionString

string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

options
TableServiceClientOptions

Opties voor het configureren van de HTTP-pijplijn.

Retouren

TableClient

Een nieuwe TableClient van de opgegeven verbindingsreeks.

getAccessPolicy(OperationOptions)

Hiermee worden details opgehaald over opgeslagen toegangsbeleidsregels die zijn opgegeven in de tabel die kunnen worden gebruikt met Shared Access Signatures.

function getAccessPolicy(options?: OperationOptions): Promise<GetAccessPolicyResponse>

Parameters

options
OperationOptions

De optiesparameters.

Retouren

Promise<GetAccessPolicyResponse>

getEntity<T>(string, string, GetTableEntityOptions)

Retourneert één entiteit in de tabel.

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

Parameters

partitionKey

string

De partitiesleutel van de entiteit.

rowKey

string

De rijsleutel van de entiteit.

options
GetTableEntityOptions

De optiesparameters.

Voorbeeld van het verkrijgen van een entiteit

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const entity = await client.getEntity("<partitionKey>", "<rowKey>");
console.log(`Entity: PartitionKey: ${entity.partitionKey} RowKey: ${entity.rowKey}`);

Retouren

Promise<GetTableEntityResponse<TableEntityResult<T>>>

listEntities<T>(ListTableEntitiesOptions)

Query's uitvoeren op entiteiten in een tabel.

function listEntities<T>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>, PageSettings>

Parameters

options
ListTableEntitiesOptions

De optiesparameters.

Voorbeeld van een lijst met entiteiten

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

let i = 0;
const entities = client.listEntities();
for await (const entity of entities) {
  console.log(`Entity${++i}: PartitionKey: ${entity.partitionKey} RowKey: ${entity.rowKey}`);
}

Retouren

PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>, PageSettings>

setAccessPolicy(SignedIdentifier[], OperationOptions)

Hiermee stelt u opgeslagen toegangsbeleid in voor de tabel die kan worden gebruikt met Shared Access Signatures.

function setAccessPolicy(tableAcl: SignedIdentifier[], options?: OperationOptions): Promise<TableSetAccessPolicyHeaders>

Parameters

tableAcl

SignedIdentifier[]

De toegangsbeheerlijst voor de tabel.

options
OperationOptions

De optiesparameters.

Retouren

Promise<TableSetAccessPolicyHeaders>

submitTransaction(TransactionAction[], OperationOptions)

Hiermee verzendt u een transactie die bestaat uit een set acties. U kunt de acties opgeven als een lijst of u kunt TableTransaction- gebruiken om de transactie te bouwen.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient, TransactionAction } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const actions: TransactionAction[] = [
  ["create", { partitionKey: "p1", rowKey: "1", data: "test1" }],
  ["delete", { partitionKey: "p1", rowKey: "2" }],
  ["update", { partitionKey: "p1", rowKey: "3", data: "newTest" }, "Merge"],
];
const result = await client.submitTransaction(actions);

Voorbeeld van gebruik met TableTransaction:

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient, TableTransaction } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const transaction = new TableTransaction();

// Call the available action in the TableTransaction object
transaction.createEntity({ partitionKey: "p1", rowKey: "1", data: "test1" });
transaction.deleteEntity("p1", "2");
transaction.updateEntity({ partitionKey: "p1", rowKey: "3", data: "newTest" }, "Merge");

// submitTransaction with the actions list on the transaction.
const result = await client.submitTransaction(transaction.actions);

function submitTransaction(actions: TransactionAction[], options?: OperationOptions): Promise<TableTransactionResponse>

Parameters

actions

TransactionAction[]

tuple die de actie bevat die moet worden uitgevoerd en de entiteit waarmee de actie moet worden uitgevoerd

options
OperationOptions

Opties voor de aanvraag.

Retouren

Promise<TableTransactionResponse>

updateEntity<T>(TableEntity<T>, UpdateMode, UpdateTableEntityOptions)

Een entiteit in de tabel bijwerken.

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

Parameters

entity

TableEntity<T>

De eigenschappen van de entiteit die moeten worden bijgewerkt.

mode
UpdateMode

De verschillende modi voor het bijwerken van de entiteit: - Samenvoegen: werkt een entiteit bij door de eigenschappen van de entiteit bij te werken zonder de bestaande entiteit te vervangen. - Vervangen: Hiermee wordt een bestaande entiteit bijgewerkt door de hele entiteit te vervangen.

options
UpdateTableEntityOptions

De optiesparameters.

Voorbeeld van het bijwerken van een entiteit

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const entity = { partitionKey: "p1", rowKey: "r1", bar: "updatedBar" };

// Update uses update mode "Merge" as default
// merge means that update will match a stored entity
// that has the same partitionKey and rowKey as the entity
// passed to the method and then will only update the properties present in it.
// Any other properties that are not defined in the entity passed to updateEntity
// will remain as they are in the service
await client.updateEntity(entity);

// We can also set the update mode to Replace, which will match the entity passed
// to updateEntity with one stored in the service and replace with the new one.
// If there are any missing properties in the entity passed to updateEntity, they
// will be removed from the entity stored in the service
await client.updateEntity(entity, "Replace");

Retouren

Promise<TableUpdateEntityHeaders>

upsertEntity<T>(TableEntity<T>, UpdateMode, OperationOptions)

Upsert een entiteit in de tabel.

function upsertEntity<T>(entity: TableEntity<T>, mode?: UpdateMode, options?: OperationOptions): Promise<TableMergeEntityHeaders>

Parameters

entity

TableEntity<T>

De eigenschappen voor de tabelentiteit.

mode
UpdateMode

De verschillende modi voor het bijwerken van de entiteit: - Samenvoegen: werkt een entiteit bij door de eigenschappen van de entiteit bij te werken zonder de bestaande entiteit te vervangen. - Vervangen: Hiermee wordt een bestaande entiteit bijgewerkt door de hele entiteit te vervangen.

options
OperationOptions

De optiesparameters.

Voorbeeld van upserting van een entiteit

import { DefaultAzureCredential } from "@azure/identity";
import { TableClient } from "@azure/data-tables";

const account = "<account>";
const accountKey = "<accountkey>";
const tableName = "<tableName>";

const credential = new DefaultAzureCredential();
const client = new TableClient(`https://${account}.table.core.windows.net`, tableName, credential);

const entity = { partitionKey: "p1", rowKey: "r1", bar: "updatedBar" };

// Upsert uses update mode "Merge" as default.
// This behaves similarly to update but creates the entity
// if it doesn't exist in the service
await client.upsertEntity(entity);

// We can also set the update mode to Replace.
// This behaves similarly to update but creates the entity
// if it doesn't exist in the service
await client.upsertEntity(entity, "Replace");

Retouren

Promise<TableMergeEntityHeaders>