Szybki start: używanie usługi Azure Cosmos DB dla tabel z zestawem Azure SDK na potrzeby Node.js

  • Dotyczy: ✅ Table

Ważna

Szukasz rozwiązania bazy danych dla scenariuszy o dużej skali z umową SLA gwarantującą poziom dostępności na poziomie 99,999%, natychmiastowym skalowaniem automatycznym i automatycznym przełączaniem awaryjnym między wieloma regionami? Rozważmy usługę Azure Cosmos DB dla noSQL.

W tym przewodniku Szybki start wdrożysz podstawową aplikację usługi Azure Cosmos DB dla tabel przy użyciu zestawu Azure SDK dla Node.js. Usługa Azure Cosmos DB dla tabel to magazyn danych bez schematu, który umożliwia aplikacjom przechowywanie uporządkowanych danych tabelarycznych w chmurze. Dowiesz się, jak tworzyć tabele, wiersze i wykonywać podstawowe zadania w ramach zasobu usługi Azure Cosmos DB przy użyciu zestawu Azure SDK dla Node.js.

Dokumentacja referencyjna API | Kod źródłowy biblioteki | Pakiet (npm) | Interfejs wiersza polecenia dla deweloperów platformy Azure

Prerequisites

  • Azure Developer CLI
  • Docker Desktop
  • Node.js 22 lub nowsze

Jeśli nie masz jeszcze konta platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Inicjowanie projektu

Użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć usługę Azure Cosmos DB dla konta tabeli i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

  1. Otwórz terminal w pustym katalogu.

  2. Jeśli jeszcze nie jesteś uwierzytelniony, uwierzytelnij się za pomocą Azure Developer CLI przy użyciu polecenia azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

    azd auth login

  3. Użyj azd init do zainicjowania projektu.

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

  4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

  5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

    azd up

  6. Podczas procesu aprowizacji wybierz subskrypcję, żądaną lokalizację i docelową grupę zasobów. Poczekaj na zakończenie procesu konfiguracji. Proces może potrwać około pięciu minut.

  7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

    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. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

Zrzut ekranu przedstawiający uruchomioną aplikację internetową.

Zrzut ekranu przedstawiający uruchomioną aplikację internetową.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem narzędzia npm jako pakiet @azure/data-tables.

  1. Otwórz terminal i przejdź do /src/ts folderu.

    cd ./src/ts

  2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj @azure/data-tables przy użyciu polecenia npm install.

    npm install --save @azure/data-tables

  3. Otwórz i przejrzyj plik src/ts/package.json , aby sprawdzić, czy @azure/data-tables wpis istnieje.

  1. Otwórz terminal i przejdź do /src/js folderu.

    cd ./src/js

  2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj @azure/data-tables przy użyciu polecenia npm install.

    npm install --save @azure/data-tables

  3. Otwórz i przejrzyj plik src/js/package.json , aby sprawdzić, czy @azure/data-tables wpis istnieje.

Importowanie bibliotek

Zaimportuj typy DefaultAzureCredential, TableServiceClienti TableClient do kodu aplikacji.

import { DefaultAzureCredential } from '@azure/identity';
import { TableServiceClient, TableClient } from '@azure/data-tables';

Zaimportuj wszystkie wymagane typy do kodu aplikacji.

import { DefaultAzureCredential, TokenCredential } from '@azure/identity';
import { TableServiceClient, TableClient, TableEntityResult, GetTableEntityResponse, TableEntityResultPage, TableEntityQueryOptions } from '@azure/data-tables';

Model obiektów

Name Description
TableServiceClient Ten typ jest podstawowym typem klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
TableClient Ten typ reprezentuje klienta dla tabeli w ramach konta.

Przykłady kodu

Przykładowy kod w szablonie używa tabeli o nazwie cosmicworks-products. Tabela cosmicworks-products zawiera szczegółowe informacje, takie jak nazwa, kategoria, ilość, cena, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa unikatowego identyfikatora jako klucza wiersza i kategorii jako klucza partycji.

Uwierzytelnianie klienta

Ten przykład tworzy nowe wystąpienie TableServiceClient typu.

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

const credential = new DefaultAzureCredential();

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

Zdobądź stolik

Ten przykład tworzy wystąpienie typu TableClient przy użyciu funkcji GetTableClient typu TableServiceClient.

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

Tworzenie jednostki

Najprostszym sposobem utworzenia nowej jednostki w tabeli jest pochodzenie nowego interfejsu z TableEntity i następnie utworzenie nowego obiektu tego typu.

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

const entity: Product = {
    rowKey: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Najprostszym sposobem utworzenia nowego elementu w tabeli jest utworzenie obiektu JSON.

const entity = {
    rowKey: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Utwórz jednostkę w tabeli metodą upsertEntity z egzemplarza TableService.

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

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

Pobierz jednostkę

Określoną jednostkę można pobrać z tabeli przy użyciu getEntity metody , klucza wiersza dla jednostki i klucza partycji jednostki.

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

const entity: Product = response as Product;

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

Wykonywanie zapytań o jednostki

Po wstawieniu jednostki można również uruchomić zapytanie, aby pobrać wszystkie jednostki zgodne z określonym filtrem przy użyciu listEntities filtru OData.

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

const filter: string = odata`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: odata`PartitionKey eq '${partitionKey}'`
    }
});

Przeanalizuj wyniki zapytania podzielone na strony, używając asynchronicznej pętli for await na zestawie elementów podzielonych na strony entities.

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

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

Uprzątnij zasoby

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down

Treści powiązane

  • Last updated on