Udostępnij za pośrednictwem

TableClient class

  • Odwołanie
Pakiet:
@azure/data-tables

Obiekt TableClient reprezentuje klienta w usłudze Azure Tables, umożliwiając wykonywanie operacji w jednej tabeli.

Konstruktory

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Tworzy nowe wystąpienie klasy TableClient.
TableClient(string, string, SASCredential, TableServiceClientOptions)

Tworzy nowe wystąpienie klasy TableClient.
TableClient(string, string, TableServiceClientOptions)

Tworzy wystąpienie klasy TableClient.
TableClient(string, string, TokenCredential, TableServiceClientOptions)

Tworzy nowe wystąpienie klasy TableClient.

Właściwości

pipeline

Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.
tableName

Nazwa tabeli do wykonania operacji.
url

Adres URL konta tabeli

Metody

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

Wstaw jednostkę w tabeli.
createTable(OperationOptions)

Tworzy tabelę z tabelą tableName przekazaną do konstruktora klienta
deleteEntity(string, string, DeleteTableEntityOptions)

Usuwa określoną jednostkę w tabeli.
deleteTable(OperationOptions)

Trwale usuwa bieżącą tabelę ze wszystkimi jej jednostkami.
fromConnectionString(string, string, TableServiceClientOptions)

Tworzy wystąpienie klasy TableClient na podstawie parametrów połączenia.
getAccessPolicy(OperationOptions)

Pobiera szczegółowe informacje o wszelkich przechowywanych zasadach dostępu określonych w tabeli, które mogą być używane z sygnaturami dostępu współdzielonego.
getEntity<T>(string, string, GetTableEntityOptions)

Zwraca pojedynczą jednostkę w tabeli.
listEntities<T>(ListTableEntitiesOptions)

Wysyła zapytania do jednostek w tabeli.
setAccessPolicy(SignedIdentifier[], OperationOptions)

Ustawia przechowywane zasady dostępu dla tabeli, które mogą być używane z sygnaturami dostępu współdzielonego.
submitTransaction(TransactionAction[])

Przesyła transakcję składającą się z zestawu akcji. Możesz podać akcje jako listę lub użyć metody TableTransaction , aby ułatwić tworzenie transakcji.

Przykład użycia: 

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

Przykładowe użycie za pomocą funkcji TableTransaction:

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)

Zaktualizuj jednostkę w tabeli.
upsertEntity<T>(TableEntity<T>, UpdateMode, OperationOptions)

Upsert jednostka w tabeli.

Szczegóły konstruktora

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Tworzy nowe wystąpienie klasy TableClient.

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

Parametry

url

string

Adres URL konta usługi, który jest celem żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

tableName

string

nazwa tabeli

credential
NamedKeyCredential

NamedKeyCredential używany do uwierzytelniania żądań. Obsługiwane tylko w przypadku węzła

options
TableServiceClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Przykład użycia nazwy/klucza konta:

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)

Tworzy nowe wystąpienie klasy TableClient.

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

Parametry

url

string

Adres URL konta usługi, który jest celem żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

tableName

string

nazwa tabeli

credential
SASCredential

Sygnatura dostępu współdzielonego używana do uwierzytelniania żądań

options
TableServiceClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Przykład użycia tokenu SAS:

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)

Tworzy wystąpienie klasy TableClient.

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

Parametry

url

string

Ciąg klienta wskazujący usługę tabel usługi Azure Storage, taką jak "https://myaccount.table.core.windows.net". Możesz dołączyć sygnaturę dostępu współdzielonego, taką jak "https://myaccount.table.core.windows.net?sasString".

tableName

string

nazwa tabeli

options
TableServiceClientOptions

Opcje konfigurowania potoku HTTP.

Przykład dołączania tokenu SAS:

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)

Tworzy nowe wystąpienie klasy TableClient.

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

Parametry

url

string

Adres URL konta usługi, który jest celem żądanej operacji, na przykład "https://myaccount.table.core.windows.net"".

tableName

string

nazwa tabeli

credential
TokenCredential

Poświadczenia usługi Azure Active Directory używane do uwierzytelniania żądań

options
TableServiceClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Przykład użycia poświadczeń usługi Azure Active Directory:

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

Szczegóły właściwości

pipeline

Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.

pipeline: Pipeline

Wartość właściwości

Pipeline

tableName

Nazwa tabeli do wykonania operacji.

tableName: string

Wartość właściwości

string

url

Adres URL konta tabeli

url: string

Wartość właściwości

string

Szczegóły metody

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

Wstaw jednostkę w tabeli.

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

Parametry

entity

TableEntity<T>

Właściwości jednostki tabeli.

options
OperationOptions

Parametry opcji.

Przykład tworzenia jednostki

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

Zwraca

Promise<TableInsertEntityHeaders>

createTable(OperationOptions)

Tworzy tabelę z tabelą tableName przekazaną do konstruktora klienta

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

Parametry

options
OperationOptions

Parametry opcji.

Przykład tworzenia tabeli

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

Zwraca

Promise<void>

deleteEntity(string, string, DeleteTableEntityOptions)

Usuwa określoną jednostkę w tabeli.

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

Parametry

partitionKey

string

Klucz partycji jednostki.

rowKey

string

Klucz wiersza jednostki.

options
DeleteTableEntityOptions

Parametry opcji.

Przykład usuwania jednostki

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

Zwraca

Promise<TableDeleteEntityHeaders>

deleteTable(OperationOptions)

Trwale usuwa bieżącą tabelę ze wszystkimi jej jednostkami.

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

Parametry

options
OperationOptions

Parametry opcji.

Przykład usuwania tabeli

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

Zwraca

Promise<void>

fromConnectionString(string, string, TableServiceClientOptions)

Tworzy wystąpienie klasy TableClient na podstawie parametrów połączenia.

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

Parametry

connectionString

string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Opcje konfigurowania potoku HTTP.

Zwraca

TableClient

Nowy obiekt TableClient z podanych parametrów połączenia.

getAccessPolicy(OperationOptions)

Pobiera szczegółowe informacje o wszelkich przechowywanych zasadach dostępu określonych w tabeli, które mogą być używane z sygnaturami dostępu współdzielonego.

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

Parametry

options
OperationOptions

Parametry opcji.

Zwraca

Promise<GetAccessPolicyResponse>

getEntity<T>(string, string, GetTableEntityOptions)

Zwraca pojedynczą jednostkę w tabeli.

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

Parametry

partitionKey

string

Klucz partycji jednostki.

rowKey

string

Klucz wiersza jednostki.

options
GetTableEntityOptions

Parametry opcji.

Przykład pobierania jednostki

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

Zwraca

Promise<GetTableEntityResponse<TableEntityResult<T>>>

listEntities<T>(ListTableEntitiesOptions)

Wysyła zapytania do jednostek w tabeli.

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

Parametry

options
ListTableEntitiesOptions

Parametry opcji.

Przykładowe wyświetlanie listy jednostek

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

Zwraca

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

setAccessPolicy(SignedIdentifier[], OperationOptions)

Ustawia przechowywane zasady dostępu dla tabeli, które mogą być używane z sygnaturami dostępu współdzielonego.

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

Parametry

tableAcl

SignedIdentifier[]

Lista Access Control dla tabeli.

options
OperationOptions

Parametry opcji.

Zwraca

Promise<TableSetAccessPolicyHeaders>

submitTransaction(TransactionAction[])

Przesyła transakcję składającą się z zestawu akcji. Możesz podać akcje jako listę lub użyć metody TableTransaction , aby ułatwić tworzenie transakcji.

Przykład użycia: 

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

Przykładowe użycie za pomocą funkcji TableTransaction:

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>

Parametry

actions

TransactionAction[]

Krotka zawierająca akcję do wykonania oraz jednostkę do wykonania akcji za pomocą polecenia

Zwraca

Promise<TableTransactionResponse>

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

Zaktualizuj jednostkę w tabeli.

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

Parametry

entity

TableEntity<T>

Właściwości jednostki do zaktualizowania.

mode
UpdateMode

Różne tryby aktualizowania jednostki: — Scal: Aktualizacje jednostkę przez zaktualizowanie właściwości jednostki bez zastępowania istniejącej jednostki. - Zastąp: Aktualizacje istniejącą jednostkę, zastępując całą jednostkę.

options
UpdateTableEntityOptions

Parametry opcji.

Przykład aktualizacji jednostki

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

Zwraca

Promise<TableUpdateEntityHeaders>

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

Upsert jednostka w tabeli.

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

Parametry

entity

TableEntity<T>

Właściwości jednostki tabeli.

mode
UpdateMode

Różne tryby aktualizowania jednostki: — Scal: Aktualizacje jednostkę przez zaktualizowanie właściwości jednostki bez zastępowania istniejącej jednostki. - Zastąp: Aktualizacje istniejącą jednostkę, zastępując całą jednostkę.

options
OperationOptions

Parametry opcji.

Przykład upserting jednostki

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

Zwraca

Promise<TableMergeEntityHeaders>