Sdílet prostřednictvím

Rychlý start: Použití služby Azure Cosmos DB pro tabulky se sadou Azure SDK pro Node.js

  • Článek
  • Platí pro:
    ✅ Table

V tomto rychlém startu nasadíte základní aplikaci Azure Cosmos DB for Table pomocí sady Azure SDK pro Node.js. Azure Cosmos DB for Table je úložiště dat bez schématu, které umožňuje aplikacím ukládat strukturovaná data tabulek v cloudu. Naučíte se vytvářet tabulky, řádky a provádět základní úlohy v rámci prostředku služby Azure Cosmos DB pomocí sady Azure SDK pro Node.js.

Referenční dokumentace k | rozhraní API – Balíček zdrojového kódu | knihovny (npm) | Azure Developer CLI

Požadavky

  • Azure Developer CLI
  • Docker Desktop
  • Node.js 22 nebo novější

Pokud nemáte účet Azure, vytvořte si bezplatný účet před tím, než začnete.

Inicializace projektu

Pomocí Azure Developer CLI (azd) vytvořte účet Azure Cosmos DB for Table a nasaďte kontejnerizovanou ukázkovou aplikaci. Ukázková aplikace používá klientskou knihovnu ke správě, vytváření, čtení a dotazování ukázkových dat.

  1. Otevřete terminál v prázdném adresáři.

  2. Pokud ještě nejste ověřeni, ověřte se v Azure Developer CLI pomocí azd auth login. Postupujte podle kroků určených nástrojem k ověření v rozhraní příkazového řádku pomocí vašich upřednostňovaných přihlašovacích údajů Azure.

    azd auth login

  3. Slouží azd init k inicializaci projektu.

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

  4. Během inicializace nakonfigurujte jedinečný název prostředí.

  5. Nasaďte účet služby Azure Cosmos DB pomocí azd up. Šablony Bicep také nasazují ukázkovou webovou aplikaci.

    azd up

  6. Během procesu zřizování vyberte své předplatné, požadované umístění a cílovou skupinu prostředků. Počkejte na dokončení procesu zřizování. Proces může trvat přibližně pět minut.

  7. Po dokončení zřizování prostředků Azure se do výstupu zahrne adresa URL spuštěné webové aplikace.

    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. Pomocí adresy URL v konzole přejděte do webové aplikace v prohlížeči. Sledujte výstup spuštěné aplikace.

Snímek obrazovky se spuštěnou webovou aplikací

Snímek obrazovky se spuštěnou webovou aplikací

Instalace klientské knihovny

Klientská knihovna je k dispozici prostřednictvím npm jako @azure/data-tables balíček.

  1. Otevřete terminál a přejděte do /src/ts složky.

    cd ./src/ts

  2. Pokud ještě není nainstalovaný, nainstalujte @azure/data-tables balíček pomocí npm install.

    npm install --save @azure/data-tables

  3. Otevřete a zkontrolujte soubor src/ts/package.json a ověřte, že položka @azure/data-tables existuje.

  1. Otevřete terminál a přejděte do /src/js složky.

    cd ./src/js

  2. Pokud ještě není nainstalovaný, nainstalujte @azure/data-tables balíček pomocí npm install.

    npm install --save @azure/data-tables

  3. Otevřete a zkontrolujte soubor src/js/package.json a ověřte, že položka @azure/data-tables existuje.

Objektový model

Název Popis
TableServiceClient Tento typ je primárním typem klienta a slouží ke správě metadat nebo databází pro celý účet.
TableClient Tento typ představuje klienta pro tabulku v rámci účtu.

Příklady kódu

Vzorový kód v šabloně používá tabulku s názvem cosmicworks-products. Tabulka cosmicworks-products obsahuje podrobnosti, jako je název, kategorie, množství, cena, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá jedinečný identifikátor jako klíč řádku a kategorii jako klíč oddílu.

Ověření klienta

Tato ukázka vytvoří novou instanci 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);

Získání tabulky

Tato ukázka vytvoří instanci TableClient typu pomocí GetTableClient funkce TableServiceClient typu.

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

Vytvoření entity

Nejjednodušší způsob, jak vytvořit novou entitu v tabulce, je odvodit nové rozhraní a TableEntity pak vytvořit nový objekt tohoto 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
};

Nejjednodušší způsob, jak vytvořit novou položku v tabulce, je vytvořit objekt JSON.

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

Pomocí metody z instance vytvořte entitu v tabulce upsertEntity TableService .

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

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

Získání entity

Konkrétní entitu můžete z tabulky načíst pomocí getEntity metody, klíče řádku entity a klíče oddílu entity.

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

const entity: Product = response as Product;

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

Dotazování entit

Po vložení entity můžete také spustit dotaz, abyste získali všechny entity, které odpovídají určitému filtru, pomocí listEntities filtru OData.

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

Parsujte stránkované výsledky dotazu pomocí asynchronní for await smyčky na stránkované sadě .entities

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

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

Vyčištění prostředků

Pokud už ukázkovou aplikaci nebo prostředky nepotřebujete, odeberte odpovídající nasazení a všechny prostředky.

azd down

Související obsah