Megosztás a következőn keresztül:

TableClient class

Csomag:
@azure/data-tables

A TableClient az Azure Tables szolgáltatás ügyfele, amely lehetővé teszi a műveletek végrehajtását egyetlen táblán.

Konstruktorok

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Létrehozza a TableClient osztály új példányát.
TableClient(string, string, SASCredential, TableServiceClientOptions)

Létrehozza a TableClient osztály új példányát.
TableClient(string, string, TableServiceClientOptions)

Létrehozza a TableClient egy példányát.
TableClient(string, string, TokenCredential, TableServiceClientOptions)

Létrehozza a TableClient osztály új példányát.

Tulajdonságok

pipeline

EGY URL-címre irányuló HTTP-kérést kérő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak a kérések kiszolgálóra történő létrehozása előtt és után történő módosításának kezelésére.
tableName

Annak a táblának a neve, amelyen műveleteket szeretne végrehajtani.
url

Táblafiók URL-címe

Metódusok

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

Entitás beszúrása a táblába.
createTable(OperationOptions)

Létrehoz egy táblát az ügyfélkonstruktornak átadott tableName azonosítóval
deleteEntity(string, string, DeleteTableEntityOptions)

Törli a megadott entitást a táblában.
deleteTable(OperationOptions)

Véglegesen törli az aktuális táblát az összes entitásával együtt.
fromConnectionString(string, string, TableServiceClientOptions)

Létrehoz egy TableClient-példányt a kapcsolati sztringből.
getAccessPolicy(OperationOptions)

Lekéri a megosztott hozzáférésű jogosultságkódokkal használható táblában megadott tárolt hozzáférési szabályzatok részleteit.
getEntity<T>(string, string, GetTableEntityOptions)

Egyetlen entitást ad vissza a táblában.
listEntities<T>(ListTableEntitiesOptions)

Egy tábla entitásainak lekérdezése.
setAccessPolicy(SignedIdentifier[], OperationOptions)

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható tábla tárolt hozzáférési szabályzatait.
submitTransaction(TransactionAction[], OperationOptions)

Egy műveletkészletből álló tranzakciót küld el. A műveleteket listaként is megadhatja, vagy TableTransaction használatával segíthet a tranzakció felépítésében.

Példahasználat:

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);

Példa a TableTransaction használatára:

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)

Frissítsen egy entitást a táblában.
upsertEntity<T>(TableEntity<T>, UpdateMode, OperationOptions)

Entitás létrehozása a táblában.

Konstruktor adatai

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Létrehozza a TableClient osztály új példányát.

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

Paraméterek

url

string

Annak a szolgáltatásfióknak az URL-címe, amely a kívánt művelet célja, például: "https://myaccount.table.core.windows.net".

tableName

string

a tábla neve

credential
NamedKeyCredential

A kérések hitelesítéséhez használt NamedKeyCredential. Csak csomópont esetén támogatott

options
TableServiceClientOptions

Szabadon választható. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Példa fióknév/kulcs használatával:

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)

Létrehozza a TableClient osztály új példányát.

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

Paraméterek

url

string

Annak a szolgáltatásfióknak az URL-címe, amely a kívánt művelet célja, például: "https://myaccount.table.core.windows.net".

tableName

string

a tábla neve

credential
SASCredential

A kérések hitelesítéséhez használt SASCredential

options
TableServiceClientOptions

Szabadon választható. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Példa SAS-jogkivonat használatával:

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)

Létrehozza a TableClient egy példányát.

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

Paraméterek

url

string

Az Azure Storage táblaszolgáltatásra mutató ügyfélsztring, például "https://myaccount.table.core.windows.net". Hozzáfűzhet egy SAS-t, például "https://myaccount.table.core.windows.net?sasString".

tableName

string

a tábla neve

options
TableServiceClientOptions

A HTTP-folyamat konfigurálására vonatkozó beállítások.

Példa SAS-jogkivonat hozzáfűzésével:

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)

Létrehozza a TableClient osztály új példányát.

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

Paraméterek

url

string

Annak a szolgáltatásfióknak az URL-címe, amely a kívánt művelet célja, például: "https://myaccount.table.core.windows.net".

tableName

string

a tábla neve

credential
TokenCredential

A kérések hitelesítéséhez használt Azure Active Directory-hitelesítő adatok

options
TableServiceClientOptions

Szabadon választható. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Példa Azure Active Directory-hitelesítő adatok használatával:

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,
);

Tulajdonság adatai

pipeline

EGY URL-címre irányuló HTTP-kérést kérő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak a kérések kiszolgálóra történő létrehozása előtt és után történő módosításának kezelésére.

pipeline: Pipeline

Tulajdonság értéke

Pipeline

tableName

Annak a táblának a neve, amelyen műveleteket szeretne végrehajtani.

tableName: string

Tulajdonság értéke

string

url

Táblafiók URL-címe

url: string

Tulajdonság értéke

string

Metódus adatai

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

Entitás beszúrása a táblába.

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

Paraméterek

entity

TableEntity<T>

A táblaentitás tulajdonságai.

options
OperationOptions

A beállítások paraméterei.

Példa entitás létrehozására

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);

Válaszok

Promise<TableInsertEntityHeaders>

createTable(OperationOptions)

Létrehoz egy táblát az ügyfélkonstruktornak átadott tableName azonosítóval

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

Paraméterek

options
OperationOptions

A beállítások paraméterei.

Példa tábla létrehozására

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();

Válaszok

Promise<void>

deleteEntity(string, string, DeleteTableEntityOptions)

Törli a megadott entitást a táblában.

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

Paraméterek

partitionKey

string

Az entitás partíciókulcsa.

rowKey

string

Az entitás sorkulcsa.

options
DeleteTableEntityOptions

A beállítások paraméterei.

Példa egy entitás törlésére

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>");

Válaszok

Promise<TableDeleteEntityHeaders>

deleteTable(OperationOptions)

Véglegesen törli az aktuális táblát az összes entitásával együtt.

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

Paraméterek

options
OperationOptions

A beállítások paraméterei.

Példa tábla törlésére

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();

Válaszok

Promise<void>

fromConnectionString(string, string, TableServiceClientOptions)

Létrehoz egy TableClient-példányt a kapcsolati sztringből.

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

Paraméterek

connectionString

string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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

A HTTP-folyamat konfigurálására vonatkozó beállítások.

Válaszok

TableClient

Új TableClient a megadott kapcsolati sztringből.

getAccessPolicy(OperationOptions)

Lekéri a megosztott hozzáférésű jogosultságkódokkal használható táblában megadott tárolt hozzáférési szabályzatok részleteit.

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

Paraméterek

options
OperationOptions

A beállítások paraméterei.

Válaszok

Promise<GetAccessPolicyResponse>

getEntity<T>(string, string, GetTableEntityOptions)

Egyetlen entitást ad vissza a táblában.

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

Paraméterek

partitionKey

string

Az entitás partíciókulcsa.

rowKey

string

Az entitás sorkulcsa.

options
GetTableEntityOptions

A beállítások paraméterei.

Példa entitás lekérése

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}`);

Válaszok

Promise<GetTableEntityResponse<TableEntityResult<T>>>

listEntities<T>(ListTableEntitiesOptions)

Egy tábla entitásainak lekérdezése.

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

Paraméterek

options
ListTableEntitiesOptions

A beállítások paraméterei.

Példa entitások felsorolására

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}`);
}

Válaszok

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

setAccessPolicy(SignedIdentifier[], OperationOptions)

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható tábla tárolt hozzáférési szabályzatait.

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

Paraméterek

tableAcl

SignedIdentifier[]

A tábla hozzáférés-vezérlési listája.

options
OperationOptions

A beállítások paraméterei.

Válaszok

Promise<TableSetAccessPolicyHeaders>

submitTransaction(TransactionAction[], OperationOptions)

Egy műveletkészletből álló tranzakciót küld el. A műveleteket listaként is megadhatja, vagy TableTransaction használatával segíthet a tranzakció felépítésében.

Példahasználat:

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);

Példa a TableTransaction használatára:

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>

Paraméterek

actions

TransactionAction[]

a végrehajtandó műveletet tartalmazó rekordot, valamint a műveletet végrehajtó entitást

options
OperationOptions

A kérés beállításai.

Válaszok

Promise<TableTransactionResponse>

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

Frissítsen egy entitást a táblában.

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

Paraméterek

entity

TableEntity<T>

A frissíteni kívánt entitás tulajdonságai.

mode
UpdateMode

Az entitás frissítésének különböző módjai: - Egyesítés: Az entitás tulajdonságainak frissítésével frissíti az entitást a meglévő entitás cseréje nélkül. - Csere: Meglévő entitás frissítése a teljes entitás lecserélésével.

options
UpdateTableEntityOptions

A beállítások paraméterei.

Példa egy entitás frissítésére

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");

Válaszok

Promise<TableUpdateEntityHeaders>

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

Entitás létrehozása a táblában.

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

Paraméterek

entity

TableEntity<T>

A táblaentitás tulajdonságai.

mode
UpdateMode

Az entitás frissítésének különböző módjai: - Egyesítés: Az entitás tulajdonságainak frissítésével frissíti az entitást a meglévő entitás cseréje nélkül. - Csere: Meglévő entitás frissítése a teljes entitás lecserélésével.

options
OperationOptions

A beállítások paraméterei.

Entitások feltöltése példaként

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");

Válaszok

Promise<TableMergeEntityHeaders>