TableClient class

Csomag:

@azure/data-tables

A TableClient az Azure Tables szolgáltatáshoz tartozó ügyfelet jelöli, amely lehetővé teszi a műveletek egyetlen táblán történő végrehajtását.

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üldő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak az egyes kérések a kiszolgálóra történő létrehozása előtt és után történő kezeléséhez.
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 értékkel
deleteEntity(string, string, DeleteTableEntityOptions)	Törli a táblában megadott entitást.
deleteTable(OperationOptions)	Véglegesen törli az aktuális táblát az összes entitásával együtt.
fromConnectionString(string, string, TableServiceClientOptions)	Létrehozza a TableClient egy példányát kapcsolati sztring.
getAccessPolicy(OperationOptions)	Lekéri a táblában megadott tárolt hozzáférési szabályzatok részleteit, amelyek közös hozzáférésű jogosultságkódokkal használhatók.
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áblához tartozó tárolt hozzáférési szabályzatokat.
submitTransaction(TransactionAction[])	Elküld egy tranzakciót, amely egy műveletkészletből áll. A műveleteket listaként is megadhatja, vagy a TableTransaction használatával is létrehozhatja a tranzakciót. Példahasználat: const { TableClient } = require("@azure/data-tables"); const connectionString = "<connection-string>" const tableName = "<tableName>" const client = TableClient.fromConnectionString(connectionString, tableName); const actions = [ ["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éldahasználat a TableTransaction használatával: const { TableClient } = require("@azure/data-tables"); const connectionString = "<connection-string>" const tableName = "<tableName>" const client = TableClient.fromConnectionString(connectionString, tableName); const transaction = new TableTransaction(); // Call the available action in the TableTransaction object transaction.create({partitionKey: "p1", rowKey: "1", data: "test1"}); transaction.delete("p1", "2"); transaction.update({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 a Node esetében támogatott

options

TableServiceClientOptions

Választható. A HTTP-folyamat konfigurálásának lehetőségei.

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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables");
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

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

Választható. A HTTP-folyamat konfigurálásának lehetőségei.

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

const { AzureSASCredential, TableClient } = require("@azure/data-tables");
const account = "<storage account name>";
const sasToken = "<sas-token>";
const tableName = "<table name>";
const sasCredential = new AzureSASCredential(sasToken);

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

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 table service-re 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ának lehetőségei.

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

const { TableClient } = require("@azure/data-tables");
const account = "<storage account name>";
const sasToken = "<SAS token>";
const tableName = "<table name>";

const client = 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

Választható. A HTTP-folyamat konfigurálásának lehetőségei.

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

cons { DefaultAzureCredential } = require("@azure/identity");
const { AzureSASCredential, TableClient } = require("@azure/data-tables");
const account = "<storage account name>";
const sasToken = "<sas-token>";
const tableName = "<table name>";
const credential = new DefaultAzureCredential();

const client = 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üldő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak az egyes kérések a kiszolgálóra történő létrehozása előtt és után történő kezeléséhez.

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ási paraméterek.

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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// partitionKey and rowKey are required properties of the entity to create
// and accepts any other properties
await client.createEntity({partitionKey: "p1", rowKey: "r1", foo: "Hello!"});

Válaszok

Promise<TableInsertEntityHeaders>

createTable(OperationOptions)

Létrehoz egy táblát az ügyfélkonstruktornak átadott tableName értékkel

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

Paraméterek

options

OperationOptions

A beállítási paraméterek.

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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// calling create table will create the table used
// to instantiate the TableClient.
// Note: If the table already
// exists this function doesn't throw.
await client.createTable();

Válaszok

Promise<void>

deleteEntity(string, string, DeleteTableEntityOptions)

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

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ási paraméterek.

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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// deleteEntity deletes the entity that matches
// exactly the partitionKey and rowKey passed as parameters
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ási paraméterek.

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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// calling deleteTable will delete the table used
// to instantiate the TableClient.
// Note: If the table doesn't exist this function doesn't fail.
await client.deleteTable();

Válaszok

Promise<void>

fromConnectionString(string, string, TableServiceClientOptions)

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

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

Paraméterek

connectionString

string

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

Válaszok

TableClient

Új TableClient az adott kapcsolati sztring.

getAccessPolicy(OperationOptions)

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

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

Paraméterek

options

OperationOptions

A beállítási paraméterek.

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 beolvasására

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// getEntity will get a single entity stored in the service that
// matches exactly the partitionKey and rowKey used as parameters
// to the method.
const entity = await client.getEntity("<partitionKey>", "<rowKey>");
console.log(entity);

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 listázására

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

// list entities returns a AsyncIterableIterator
// this helps consuming paginated responses by
// automatically handling getting the next pages
const entities = client.listEntities();

// this loop will get all the entities from all the pages
// returned by the service
for await (const entity of entities) {
   console.log(entity);
}

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áblához tartozó tárolt hozzáférési szabályzatokat.

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

Paraméterek

tableAcl

SignedIdentifier[]

A tábla Access Control listája.

options

OperationOptions

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

Válaszok

Promise<TableSetAccessPolicyHeaders>

submitTransaction(TransactionAction[])

Elküld egy tranzakciót, amely egy műveletkészletből áll. A műveleteket listaként is megadhatja, vagy a TableTransaction használatával is létrehozhatja a tranzakciót.

Példahasználat:

const { TableClient } = require("@azure/data-tables");
const connectionString = "<connection-string>"
const tableName = "<tableName>"
const client = TableClient.fromConnectionString(connectionString, tableName);
const actions = [
   ["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éldahasználat a TableTransaction használatával:

const { TableClient } = require("@azure/data-tables");
const connectionString = "<connection-string>"
const tableName = "<tableName>"
const client = TableClient.fromConnectionString(connectionString, tableName);
const transaction = new TableTransaction();
// Call the available action in the TableTransaction object
transaction.create({partitionKey: "p1", rowKey: "1", data: "test1"});
transaction.delete("p1", "2");
transaction.update({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[]): Promise<TableTransactionResponse>

Paraméterek

actions

TransactionAction[]

elemet, amely tartalmazza a végrehajtandó műveletet, valamint azt az entitást, amely a következővel hajtja végre a műveletet:

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: egy entitás Frissítések az entitás tulajdonságainak frissítésével a meglévő entitás cseréje nélkül. - Csere: egy meglévő entitás Frissítések 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

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

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: egy entitás Frissítések az entitás tulajdonságainak frissítésével a meglévő entitás cseréje nélkül. - Csere: egy meglévő entitás Frissítések a teljes entitás lecserélésével.

options

OperationOptions

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

Entitások példaképezése

const { AzureNamedKeyCredential, TableClient } = require("@azure/data-tables")
const account = "<storage account name>";
const accountKey = "<account key>"
const tableName = "<table name>";
const sharedKeyCredential = new AzureNamedKeyCredential(account, accountKey);

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

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>