Schnellstart: Azure Cosmos DB for Table-Clientbibliothek for Node.js

GILT FÜR: Tabelle

• .NET
• Python
• Node.js
• Java

In dieser Schnellstartanleitung erfahren Sie, wie Sie mit Azure Cosmos DB for Table aus einer Node.js-Anwendung heraus arbeiten. Azure Cosmos DB for Table ist ein schemaloser Datenspeicher, der es Anwendungen ermöglicht, strukturierte NoSQL-Daten in der Cloud zu speichern. Sie erfahren, wie Sie Tabellen, Zeilen und grundlegende Aufgaben innerhalb Ihrer Azure Cosmos DB-Ressource mithilfe des Azure SDK for Node.js erstellen.

API-Referenzdokumentation | Quellcode der Bibliothek | Paket (npm) | Azure Developer CLI

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Azure Developer CLI
• Docker Desktop
• Node.js 22 oder höher

Initialisieren des Projekts

Verwenden Sie die Azure Developer CLI (azd), um ein Azure Cosmos DB for Table-Konto zu erstellen und eine containerisierte Beispielanwendung bereitzustellen. Die Beispielanwendung verwendet die Clientbibliothek zum Verwalten, Erstellen, Lesen und Abfragen von Beispieldaten.

1. Öffnen Sie ein Terminal in einem leeren Verzeichnis.

2. Wenn Sie noch nicht authentifiziert sind, authentifizieren Sie sich mithilfe von azd auth login bei der Azure Developer CLI. Führen Sie die vom Tool angegebenen Schritte aus, um sich mit Ihren bevorzugten Azure-Anmeldeinformationen bei der CLI zu authentifizieren.

   azd auth login
   

3. Verwenden Sie azd init, um das Projekt zu initialisieren.

   azd init --template cosmos-db-table-nodejs-quickstart
   

4. Konfigurieren Sie während der Initialisierung einen eindeutigen Umgebungsnamen.

5. Stellen Sie das Azure Cosmos DB-Konto mit azd up bereit. Die Bicep-Vorlagen stellen auch eine Beispielwebanwendung bereit.

   azd up
   

6. Wählen Sie während des Bereitstellungsprozesses Ihr Abonnement, den gewünschten Standort und die Zielressourcengruppe aus. Warten Sie auf den Abschluss des Bereitstellungsvorgangs. Dieser Prozess kann ca. fünf Minuten dauern.

7. Sobald die Bereitstellung Ihrer Azure-Ressourcen abgeschlossen ist, enthält die Ausgabe eine URL zur ausgeführten Webanwendung.

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
   - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
   
   SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
   

8. Verwenden Sie die URL in der Konsole, um im Browser zu Ihrer Webanwendung zu navigieren. Sehen Sie sich die Ausgabe der ausgeführten App an.

   

Installieren der Clientbibliothek

Die Clientbibliothek ist über npm als @azure/data-tables-Paket verfügbar.

1. Öffnen Sie ein Terminal, und navigieren Sie zum Ordner /src/ts.

   cd ./src/ts
   

2. Installieren Sie das @azure/data-tables-Paket mithilfe von npm install, falls es noch nicht installiert ist.

   npm install --save @azure/data-tables
   

3. Öffnen Sie die Datei src/ts/package.json, um zu überprüfen, ob der @azure/data-tables Eintrag vorhanden ist.

1. Öffnen Sie ein Terminal, und navigieren Sie zum Ordner /src/js.

   cd ./src/js
   

2. Installieren Sie das @azure/data-tables-Paket mithilfe von npm install, falls es noch nicht installiert ist.

   npm install --save @azure/data-tables
   

3. Öffnen Sie die Datei src/js/package.json, um zu überprüfen, ob der @azure/data-tables Eintrag vorhanden ist.

Objektmodell

name	Beschreibung
TableServiceClient	Dieser Typ ist der primäre Clienttyp und wird verwendet, um kontoweite Metadaten oder Datenbanken zu verwalten.
TableClient	Dieser Typ stellt den Client für eine Tabelle innerhalb des Kontos dar.

Codebeispiele

• Authentifizieren des Clients
• Abrufen einer Tabelle
• Erstellen eines Elements
• Abrufen eines Elements
• Abfrageelemente

Der Beispielcode in der Vorlage verwendet eine Tabelle mit dem Namen cosmicworks-products. Die Tabelle cosmicworks-products enthält Details wie Name, Kategorie, Menge, Preis, eindeutiger Bezeichner und ein Verkaufsflag für jedes Produkt. Der Container verwendet einen eindeutigen Bezeichner* als Zeilenschlüssel und Kategorie als Partitionsschlüssel.

Authentifizieren des Clients

Dieses Beispiel erstellt eine neue Instanz des TableServiceClient-Typs.

let client: TableServiceClient = new TableServiceClient("<azure-cosmos-db-table-account-endpoint>", credential);

let client = new TableServiceClient("<azure-cosmos-db-table-account-endpoint>", credential);

Tabelle abrufen

In diesem Beispiel wird eine Instanz des Typs TableClient mithilfe der GetTableClient-Funktion des Typs TableServiceClient erstellt.

let table: TableClient = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

let table = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

Erstellen eines Elements

Die einfachste Möglichkeit zum Erstellen eines neuen Elements in einer Tabelle besteht darin, eine neue Schnittstelle von TableEntity abzuleiten und dann ein neues Objekt dieses Typs zu erstellen.

export interface Product extends TableEntity {
    name: string;
    quantity: number;
    price: number;
    clearance: boolean;
}

const entity: Product = {
    rowKey: '70b63682-b93a-4c77-aad2-65501347265f',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Die einfachste Möglichkeit zum Erstellen eines neuen Elements in einer Tabelle besteht darin, ein JSON-Objekt zu erstellen.

const entity = {
    rowKey: '70b63682-b93a-4c77-aad2-65501347265f',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Erstellen Sie ein Element in der Auflistung mithilfe der upsertEntity-Methode aus der TableService-Instanz.

await table.upsertEntity<Product>(entity, "Replace"); 

await table.upsertEntity(entity, "Replace");

Abrufen eines Elements

Sie können ein bestimmtes Element aus einer Tabelle mithilfe der getEntity -Methode, den Zeilenschlüssel für das Element und Partitionsschlüssel des Elements abrufen.

const response: GetTableEntityResponse<TableEntityResult<Product>> = await table.getEntity<Product>(partitionKey, rowKey);

const entity: Product = response as Product;

const entity = await table.getEntity(partitionKey, rowKey);

Abfrageelemente

Nachdem Sie ein Element eingefügt haben, können Sie auch eine Abfrage ausführen, um alle Elemente abzurufen, die einem bestimmten Filter entsprechen, indem Sie listEntities mit einem OData-Filter verwenden.

const partitionKey: string = 'gear-surf-surfboards';

const filter: string = `PartitionKey eq '${partitionKey}'`

const queryOptions: TableEntityQueryOptions = { filter: filter }

const entities: PagedAsyncIterableIterator<TableEntityResult<Product>, TableEntityResultPage<Product>> = table.listEntities<Product>({ queryOptions: queryOptions });

const partitionKey = 'gear-surf-surfboards';

const entities = table.listEntities({
    queryOptions: {
        filter: `PartitionKey eq '${partitionKey}'`
    }
});

Analysieren Sie die paginierten Ergebnisse der Abfrage mithilfe einer asynchronen for await Schleife für den paginierten Satz von entities.

for await(const entity of entities) {
    // Do something
}

for await(const entity of entities) {
    // Do something
}

Bereinigen von Ressourcen

Wenn Sie die Beispielanwendung oder Ressourcen nicht mehr benötigen, entfernen Sie die entsprechende Bereitstellung und alle Ressourcen.

azd down

Zugehöriger Inhalt

• Schnellstartanleitung für .NET
• Schnellstartanleitung für Python
• Schnellstartanleitung für Java