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

• Platí pro:

  ✅ NoSQL

• .NET
• Node.js
• Java
• Python
• Přejít

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

Instalace klientské knihovny

Klientská knihovna je k dispozici prostřednictvím Správce balíčků Node jako @azure/cosmos balíček.

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

   cd ./src
   

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

   npm install --save @azure/cosmos
   

3. Pokud ještě není nainstalovaný, nainstalujte @azure/identity balíček.

   npm install --save @azure/identity
   

4. Otevřete a zkontrolujte soubor src/package.json a ověřte, že azure-cosmos azure-identity obě položky existují.

Objektový model

Název	Popis
CosmosClient	Tato třída je primární klientskou třídou a slouží ke správě metadat nebo databází pro celý účet.
Database	Tato třída představuje databázi v rámci účtu.
Container	Tato třída se primárně používá k provádění operací čtení, aktualizace a odstraňování v kontejneru nebo v položkách uložených v kontejneru.
PartitionKey	Tato třída představuje klíč logického oddílu. Tato třída se vyžaduje pro mnoho běžných operací a dotazů.
SqlQuerySpec	Toto rozhraní představuje dotaz SQL a všechny parametry dotazu.

Příklady kódu

• Ověření klienta
• Získání databáze
• Získání kontejneru
• Vytvoření položky
• Získání položky
• Dotazování položek

Vzorový kód v šabloně používá databázi pojmenovanou cosmicworks a kontejner s názvem products. Kontejner products obsahuje podrobnosti, jako je název, kategorie, množství, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá /category vlastnost jako klíč logického oddílu.

Ověření klienta

Tato ukázka vytvoří novou instanci CosmosClient typu a ověří se pomocí DefaultAzureCredential instance.

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

const credential: TokenCredential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

Získání databáze

Slouží client.database k načtení existující databáze s názvem cosmicworks.

const database = client.database('cosmicworks');

const database: Database = client.database('cosmicworks');

Získání kontejneru

Načtení existujícího products kontejneru pomocí database.container.

const container = database.container('products');

const container: Container = database.container('products');

Vytvoření položky

Sestavte nový objekt se všemi členy, které chcete serializovat do formátu JSON. V tomto příkladu má typ jedinečný identifikátor a pole pro kategorii, název, množství, cenu a prodej. Vytvoření položky v kontejneru pomocí container.items.upsert. Tato metoda "upserts" položku účinně nahradí položku, pokud již existuje.

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

let response = await container.items.upsert(item);

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

let response: ItemResponse<Product> = await container.items.upsert<Product>(item);

Čtení položky

Proveďte operaci čtení bodu pomocí polí jedinečného identifikátoru (id) i klíče oddílu. Umožňuje container.item získat ukazatel na položku a item.read efektivně načíst konkrétní položku.

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response = await container.item(id, partitionKey).read();
let read_item = response.resource;

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response: ItemResponse<Product> = await container.item(id, partitionKey).read<Product>();
let read_item: Product = response.resource!;

Dotazování položek

Proveďte dotaz na více položek v kontejneru pomocí container.items.query. Pomocí tohoto parametrizovaného dotazu vyhledejte všechny položky v zadané kategorii:

SELECT * FROM products p WHERE p.category = @category

Načtěte všechny výsledky dotazu pomocí query.fetchAll. Projděte výsledky dotazu.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response = await container.items.query(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

const querySpec: SqlQuerySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response: FeedResponse<Product> = await container.items.query<Product>(querySpec).fetchAll();
for (let item of response.resources) {
    // 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

• Rychlý start k .NET
• Rychlý start pro Javu
• Rychlý start pro Python
• Rychlý start pro Go