TableClient class

Pakket:

@azure/data-tables

Een TableClient vertegenwoordigt een client voor 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 klasse TableClient.
TableClient(string, string, SASCredential, TableServiceClientOptions)	Hiermee maakt u een nieuw exemplaar van de klasse TableClient.
TableClient(string, string, TableServiceClientOptions)	Hiermee maakt u een exemplaar van TableClient.
TableClient(string, string, TokenCredential, TableServiceClientOptions)	Hiermee maakt u een nieuw exemplaar van de klasse TableClient.

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 manipuleren van elke aanvraag voor en nadat deze naar de server is verzonden.
tableName	Naam van de tabel waarop bewerkingen moeten worden uitgevoerd.
url	URL van tabelaccount

Methoden

createEntity<T>(TableEntity<T>, OperationOptions)	Entiteit invoegen in de tabel.
createTable(OperationOptions)	Hiermee maakt u een tabel met de tableName 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 met alle bijbehorende entiteiten definitief.
fromConnectionString(string, string, TableServiceClientOptions)	Hiermee maakt u een exemplaar van TableClient op basis van connection string.
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 toegangsbeleidsregels in voor de tabel die kan worden gebruikt met Shared Access Signatures.
submitTransaction(TransactionAction[])	Verzendt 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. Gebruiksvoorbeeld: 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); Voorbeeld van gebruik met 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)	Een entiteit in de tabel bijwerken.
upsertEntity<T>(TableEntity<T>, UpdateMode, OperationOptions)	Een entiteit in de tabel upsert.

Constructordetails

TableClient(string, string, NamedKeyCredential, TableServiceClientOptions)

Hiermee maakt u een nieuw exemplaar van de klasse TableClient.

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 die wordt gebruikt voor het verifiëren van aanvragen. Alleen ondersteund voor Node

options

TableServiceClientOptions

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

Voorbeeld met behulp van een accountnaam/-sleutel:

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)

Hiermee maakt u een nieuw exemplaar van de klasse TableClient.

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 om aanvragen te verifiëren

options

TableServiceClientOptions

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

Voorbeeld van het gebruik van een SAS-token:

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)

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:

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)

Hiermee maakt u een nieuw exemplaar van de klasse TableClient.

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-referenties die worden gebruikt voor het verifiëren van aanvragen

options

TableServiceClientOptions

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

Voorbeeld met behulp van een Azure Active Directory-referentie:

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

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 manipuleren van elke aanvraag voor en nadat deze naar de server is verzonden.

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)

Entiteit invoegen in de tabel.

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

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

Retouren

Promise<TableInsertEntityHeaders>

createTable(OperationOptions)

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

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

Parameters

options

OperationOptions

De optiesparameters.

Voorbeeld van het maken van een tabel

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

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

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

Retouren

Promise<TableDeleteEntityHeaders>

deleteTable(OperationOptions)

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

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

Parameters

options

OperationOptions

De optiesparameters.

Voorbeeld van het verwijderen van een tabel

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

Retouren

Promise<void>

fromConnectionString(string, string, TableServiceClientOptions)

Hiermee maakt u een exemplaar van TableClient op basis van connection string.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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 connection string.

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

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

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 vermeldingentiteiten

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

Retouren

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

setAccessPolicy(SignedIdentifier[], OperationOptions)

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

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

Parameters

tableAcl

SignedIdentifier[]

De Access Control Lijst voor de tabel.

options

OperationOptions

De optiesparameters.

Retouren

Promise<TableSetAccessPolicyHeaders>

submitTransaction(TransactionAction[])

Verzendt 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.

Gebruiksvoorbeeld:

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

Voorbeeld van gebruik met 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>

Parameters

actions

TransactionAction[]

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

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 moet worden bijgewerkt.

mode

UpdateMode

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

options

UpdateTableEntityOptions

De optiesparameters.

Voorbeeld van het bijwerken van een entiteit

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

Retouren

Promise<TableUpdateEntityHeaders>

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

Een entiteit in de tabel upsert.

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: Updates een entiteit door de eigenschappen van de entiteit bij te werken zonder de bestaande entiteit te vervangen. - Vervangen: Updates een bestaande entiteit door de hele entiteit te vervangen.

options

OperationOptions

De optiesparameters.

Voorbeeld van upserting van een entiteit

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

Retouren

Promise<TableMergeEntityHeaders>