Szybki start: używanie usługi Azure Cosmos DB dla bazy danych MongoDB z usługą Node.js

• .NET
• Node.js
• Python

W tym przewodniku Szybki start wdrożysz podstawową aplikację usługi Azure Cosmos DB dla bazy danych MongoDB przy użyciu języka Python. Usługa Azure Cosmos DB dla bazy danych MongoDB to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie dokumentów bez struktury w chmurze przy użyciu bibliotek MongoDB. Dowiesz się, jak tworzyć dokumenty i wykonywać podstawowe zadania w ramach zasobu usługi Azure Cosmos DB przy użyciu języka Python.

Biblioteka kodu źródłowego | 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ć 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ę w Azure Developer CLI przy użyciu 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-mongodb-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.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem narzędzia npm jako mongodb pakiet.

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

   cd ./src/ts
   

2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj mongodb przy użyciu polecenia npm install.

   npm install --save mongodb
   

3. Otwórz i przejrzyj plik src/ts/package.json , aby sprawdzić, czy mongodb wpis istnieje.

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

   cd ./src/js
   

2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj mongodb przy użyciu polecenia npm install.

   npm install --save mongodb
   

3. Otwórz i przejrzyj plik src/js/package.json , aby sprawdzić, czy mongodb wpis istnieje.

Importowanie bibliotek

Zaimportuj MongoClient typ do kodu aplikacji.

import { MongoClient } from 'mongodb';

Zaimportuj wszystkie wymagane typy do kodu aplikacji.

import { Collection, Db, Filter, FindCursor, MongoClient, UpdateFilter, UpdateOptions, UpdateResult, WithId } from 'mongodb';

Model obiektów

Nazwa/nazwisko	opis
MongoClient	Typ używany do nawiązywania połączenia z bazą danych MongoDB.
Database	Reprezentuje bazę danych na koncie.
Collection	Oznacza kolekcję w bazie danych w ramach konta.

Przykłady kodu

• Uwierzytelnianie użytkownika
• Pobieranie bazy danych
• Uzyskaj kolekcję
• Tworzenie dokumentu
• Pobieranie dokumentu
• Wyszukiwanie w dokumentach

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

Uwierzytelnianie użytkownika

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

const connectionString = "<azure-cosmos-db-for-mongodb-connection-string>";

const client = new MongoClient(connectionString);

const connectionString = "<azure-cosmos-db-for-mongodb-connection-string>";

const client = new MongoClient(connectionString);

Pobieranie bazy danych

Ten przykład tworzy wystąpienie typu Db przy użyciu funkcji db typu MongoClient.

const database: Db = client.db("<database-name>");

const database = client.db("<database-name>");

Zdobądź kolekcję

Ten przykład tworzy wystąpienie typu Collection przy użyciu funkcji collection typu Db.

Ta funkcja ma ogólny parametr, który używa Product typu zdefiniowanego w interfejsie.

const collection: Collection<Product> = database.collection<Product>("<collection-name>");

export interface Product {
    _id: string;
    category: string;
    name: string;
    quantity: number;
    price: number;
    clearance: boolean;
}

const collection = database.collection("<collection-name>");

Tworzenie dokumentu

Utwórz dokument w kolekcji używając collection.updateOne. Ta metoda efektywnie zastępuje element, "aktualizując" go lub "wstawiając" nowy, jeśli już istnieje.

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

var query: Filter<Product> = {
    _id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    category: 'gear-surf-surfboards'
};
var payload: UpdateFilter<Product> = {
    $set: document
};
var options: UpdateOptions = {
    upsert: true
};
var response: UpdateResult<Product> = await collection.updateOne(query, payload, options);

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

const query = {
    _id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    category: 'gear-surf-surfboards'
};
const payload = {
    $set: document
};
const options = {
    upsert: true,
    new: true
};
var response = await collection.updateOne(query, payload, options);

Odczytywanie dokumentu

Wykonaj operację odczytu punktu przy użyciu pól unikatowego identyfikatora (id) i klucza shardu. Użyj collection.findOne do wydajnego pobierania określonego elementu.

var query: Filter<Product> = { 
    _id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb', 
    category: 'gear-surf-surfboards' 
};

var response: WithId<Product> | null = await collection.findOne(query);

var query = { 
    _id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb', 
    category: 'gear-surf-surfboards' 
};

var response = await collection.findOne(query);

Dokumenty z zapytaniami

Wykonaj zapytanie dotyczące wielu elementów w kontenerze przy użyciu polecenia collection.find. To zapytanie znajduje wszystkie elementy w określonej kategorii (klucz shardu).

var query: Filter<Product> = { 
    category: 'gear-surf-surfboards' 
};

var response: FindCursor<WithId<Product>> = await collection.find(query);

for await (const item of response) {
    // Do something with each item
}

var query = { 
    category: 'gear-surf-surfboards' 
};

var response = await collection.find(query);

for await (const item of response) {
    // Do something with each item
}

Eksplorowanie danych

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

• Wykonywanie zapytań przy użyciu scrapbooka lub edytora zapytań
• Modyfikowanie, aktualizowanie, tworzenie i usuwanie dokumentów
• Importowanie danych zbiorczych z innych źródeł
• Zarządzanie bazami danych i kolekcjami

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

Czyszczenie zasobów

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

azd down --force --purge

Powiązana zawartość

• Przewodnik Szybki start dla platformy .NET
• Przewodnik Szybki start dla języka Python