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

• .NET
• Node.js
• Jawa
• Pyton
• Przejdź
• Rdza

W tym szybkim przewodniku wdrożysz podstawową aplikację Azure Cosmos DB for NoSQL przy użyciu zestawu Azure SDK dla Node.js. Usługa Azure Cosmos DB for NoSQL to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie danych bez struktury w chmurze. Wykonywanie zapytań o dane w kontenerach i wykonywanie typowych operacji na poszczególnych elementach 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

Wymagania wstępne

• 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ć konto usługi Azure Cosmos DB for NoSQL 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ę w 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, aby zainicjować projekt.

   azd init --template cosmos-db-nosql-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 udostępniania. 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.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem menedżera pakietów Node jako pakiet @azure/cosmos.

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

   cd ./src
   

2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj go @azure/cosmos używając npm install.

   npm install --save @azure/cosmos
   

3. Ponadto zainstaluj @azure/identity pakiet, jeśli nie został jeszcze zainstalowany.

   npm install --save @azure/identity
   

4. Otwórz i przejrzyj plik src/package.json, aby sprawdzić, czy zarówno wpis azure-cosmos, jak i wpis azure-identity istnieją.

Importowanie bibliotek

Zaimportuj typy DefaultAzureCredential i CosmosClient do kodu aplikacji.

import { DefaultAzureCredential } from '@azure/identity';
import { CosmosClient } from '@azure/cosmos';

Zaimportuj wszystkie wymagane typy do kodu aplikacji.

import { PagedAsyncIterableIterator } from '@azure/core-paging';
import { DefaultAzureCredential, TokenCredential } from '@azure/identity';
import { Container, CosmosClient, Database, FeedResponse, ItemResponse, SqlQuerySpec } from '@azure/cosmos';

Model obiektów

Nazwa/nazwisko	opis
CosmosClient	Ta klasa jest podstawową klasą klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
Database	Ta klasa reprezentuje bazę danych w ramach konta.
Container	Ta klasa jest używana głównie do wykonywania operacji odczytu, aktualizacji i usuwania w kontenerze lub elementach przechowywanych w kontenerze.
PartitionKey	Ta klasa reprezentuje klucz partycji logicznej. Ta klasa jest wymagana w przypadku wielu typowych operacji i zapytań.
SqlQuerySpec	Ten interfejs reprezentuje zapytanie SQL i wszystkie parametry zapytania.

Przykłady kodu

• Uwierzytelnianie użytkownika
• Pobieranie bazy danych
• Weź kontener
• Tworzenie elementu
• Pobierz element
• Elementy zapytań

Przykładowy kod w szablonie używa bazy danych o nazwie cosmicworks oraz kontenera o nazwie products. Kontener products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa właściwości /category jako logicznego klucza partycji.

Uwierzytelnianie użytkownika

Ten przykład tworzy nowe wystąpienie typu CosmosClient i uwierzytelnia przy użyciu wystąpienia DefaultAzureCredential.

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

Pobieranie bazy danych

Użyj client.database polecenia , aby pobrać istniejącą bazę danych o nazwie cosmicworks.

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

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

Weź kontener

Pobierz istniejący products kontener przy użyciu polecenia database.container.

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

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

Tworzenie elementu

Skompiluj nowy obiekt ze wszystkimi elementami członkowskimi, które chcesz serializować w formacie JSON. W tym przykładzie typ ma unikatowy identyfikator i pola dla kategorii, nazwy, ilości, ceny i sprzedaży. Utwórz element w kontenerze przy użyciu polecenia container.items.upsert. Ta metoda skutecznie wstawia lub zastępuje element, jeśli już istnieje.

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

Przeczytaj element

Wykonaj operację odczytu punktowego, korzystając jednocześnie z pól unikatowego identyfikatora (id) oraz klucza partycji. Użyj container.item do uzyskania wskaźnika do elementu oraz item.read do wydajnego pobrania określonego elementu.

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

Elementy zapytania

Wykonaj zapytanie dotyczące wielu elementów w kontenerze przy użyciu polecenia container.items.query. Znajdź wszystkie elementy w określonej kategorii przy użyciu tego sparametryzowanego zapytania:

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

Pobierz wszystkie wyniki zapytania przy użyciu polecenia query.fetchAll. Przeiteruj przez wyniki zapytania.

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
}

Eksplorowanie danych

Użyj rozszerzenia programu Visual Studio Code dla usługi Azure Cosmos DB, aby eksplorować dane NoSQL. Możesz wykonywać podstawowe operacje na bazie danych, w tym między innymi:

• Wykonywanie zapytań za pomocą scrapbooka lub edytora zapytań
• Modyfikowanie, aktualizowanie, tworzenie i usuwanie elementów
• Importowanie danych zbiorczych z innych źródeł
• Zarządzanie bazami danych i kontenerami

Aby uzyskać więcej informacji, zobacz How-to use Visual Studio Code extension to explore Azure Cosmos DB for NoSQL data (Jak używać rozszerzenia programu Visual Studio Code do eksplorowania danych usługi Azure Cosmos DB for NoSQL).

Czyszczenie zasobów

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

azd down

Powiązana zawartość

• Przewodnik Szybki start dla platformy .NET
• Przewodnik Szybki start dla języka Java
• Przewodnik Szybki start dla języka Python
• Szybki start dla języka Go
• Rust — szybki start