Udostępnij za pośrednictwem

Rozpoczynanie pracy z usługą Azure Cosmos DB dla bazy danych MongoDB przy użyciu języka JavaScript

  • Artykuł

DOTYCZY: MongoDB

W tym artykule pokazano, jak nawiązać połączenie z usługą Azure Cosmos DB dla bazy danych MongoDB przy użyciu natywnego pakietu npm bazy danych MongoDB. Po nawiązaniu połączenia można wykonywać operacje na bazach danych, kolekcjach i dokumentach.

Uwaga

Przykładowe fragmenty kodu są dostępne w witrynie GitHub jako projekt JavaScript.

Dokumentacja referencyjna interfejsu API dla bazy danych | MongoDB — pakiet MongoDB (npm)

Wymagania wstępne

Tworzenie nowej aplikacji JavaScript

  1. Utwórz nową aplikację JavaScript w pustym folderze przy użyciu preferowanego terminalu. npm init Użyj polecenia , aby rozpocząć monity, aby utworzyć package.json plik. Zaakceptuj wartości domyślne dla monitów.

    npm init

  2. Dodaj pakiet npm bazy danych MongoDB do projektu JavaScript. npm install package Użyj polecenia określającego nazwę pakietu npm. Pakiet dotenv służy do odczytywania zmiennych środowiskowych z pliku podczas programowania lokalnego .env .

    npm install mongodb dotenv

  3. Aby uruchomić aplikację, użyj terminalu, aby przejść do katalogu aplikacji i uruchomić aplikację.

    node index.js

Nawiązywanie połączenia za pomocą sterownika natywnego bazy danych MongoDB z usługą Azure Cosmos DB dla bazy danych MongoDB

Aby nawiązać połączenie z natywnym sterownikiem bazy danych MongoDB z usługą Azure Cosmos DB, utwórz wystąpienie MongoClient klasy. Ta klasa jest punktem wyjścia do wykonywania wszystkich operacji względem baz danych.

Najbardziej typowy konstruktor dla bazy danych MongoClient ma dwa parametry:

Parametr Przykładowa wartość opis
url COSMOS_CONNECTION_STRING zmienna środowiskowa Interfejs API dla bazy danych MongoDB parametry połączenia do użycia dla wszystkich żądań
options {ssl: true, tls: true, } Opcje bazy danych MongoDB dla połączenia.

Zapoznaj się z przewodnikiem rozwiązywania problemów z połączeniem.

Uzyskiwanie nazwy zasobu

  1. Utwórz zmienną powłoki dla właściwości resourceGroupName.

    # Variable for resource group name
resourceGroupName="msdocs-cosmos"

  2. az cosmosdb list Użyj polecenia , aby pobrać nazwę pierwszego konta usługi Azure Cosmos DB w grupie zasobów i zapisać je w zmiennej powłoki accountName.

    # Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)

Pobieranie parametrów połączenia

  1. Znajdź interfejs API dla bazy danych MongoDB parametry połączenia z listy parametry połączenia dla konta za az cosmosdb keys list pomocą polecenia .

    az cosmosdb keys list --type connection-strings \
    --resource-group $resourceGroupName \
    --name $accountName

  2. Zapisz wartości KLUCZ PODSTAWOWY. Te poświadczenia będą używane później.

Skonfiguruj zmienne środowiskowe

Aby użyć wartości PARAMETRY POŁĄCZENIA w kodzie, ustaw tę wartość w środowisku lokalnym, w którym uruchomiono aplikację. Aby ustawić zmienną środowiskową, użyj preferowanego terminalu, aby uruchomić następujące polecenia:

$env:COSMOS_CONNECTION_STRING = "<cosmos-connection-string>"

Tworzenie elementu MongoClient przy użyciu parametry połączenia

  1. Dodaj zależności, aby odwoływać się do pakietów npm mongoDB i DotEnv.

    // Read .env file and set environment variables
require('dotenv').config();

// Use official mongodb driver to connect to the server
const { MongoClient } = require('mongodb');

  2. Zdefiniuj nowe wystąpienie MongoClient klasy przy użyciu konstruktora i process.env. użyj parametry połączenia.

    // New instance of MongoClient with connection string
// for Cosmos DB
const url = process.env.COSMOS_CONNECTION_STRING;
const client = new MongoClient(url);

// connect to the server
await client.connect();

// client options
const options = client.options
console.log(`Options:\n${Object.keys(options).map(key => `\t${key}: ${options[key]}\n`)}`);

Aby uzyskać więcej informacji na temat różnych sposobów tworzenia MongoClient wystąpienia, zobacz Przewodnik Szybki start sterownika NodeJS bazy danych MongoDB.

Zamykanie połączenia z klientem MongoClient

Po zakończeniu pracy aplikacji z połączeniem pamiętaj, aby ją zamknąć. Wywołanie powinno być wykonywane po wykonaniu .close() wszystkich wywołań bazy danych.

client.close()

Używanie klas klientów bazy danych MongoDB z usługą Azure Cosmos DB dla interfejsu API dla bazy danych MongoDB

Przed rozpoczęciem tworzenia aplikacji przyjrzyjmy się hierarchii zasobów w usłudze Azure Cosmos DB. Usługa Azure Cosmos DB ma określony model obiektów używany do tworzenia zasobów i uzyskiwania do ich dostępu. Usługa Azure Cosmos DB tworzy zasoby w hierarchii składającej się z kont, baz danych, kolekcji i dokumentów.

Diagram hierarchii usługi Azure Cosmos DB, w tym kont, baz danych, kolekcji i dokumentów.

Każdy typ zasobu jest reprezentowany przez co najmniej jedną skojarzną klasę języka JavaScript. Oto lista najpopularniejszych klas:

Klasa opis
MongoClient Ta klasa zapewnia logiczną reprezentację po stronie klienta dla warstwy interfejsu API dla bazy danych MongoDB w usłudze Azure Cosmos DB. Obiekt klienta służy do konfigurowania i wykonywania żądań względem usługi.
Db Ta klasa jest odwołaniem do bazy danych, która może lub nie istnieje jeszcze w usłudze. Baza danych jest weryfikowana po stronie serwera podczas próby uzyskania do niej dostępu lub wykonania operacji względem niej.
Collection Ta klasa jest odwołaniem do kolekcji, która również może jeszcze nie istnieć w usłudze. Kolekcja jest weryfikowana po stronie serwera podczas próby jej pracy.

W poniższych przewodnikach pokazano, jak utworzyć aplikację przy użyciu każdej z tych klas.

Przewodnik:

Zobacz też

Następne kroki

Po nawiązaniu połączenia z kontem interfejsu API dla bazy danych MongoDB użyj następnego przewodnika, aby utworzyć bazy danych i zarządzać nimi.

Tworzenie bazy danych w usłudze Azure Cosmos DB dla bazy danych MongoDB przy użyciu języka JavaScript