Szybki start: używanie usługi Azure DocumentDB ze sterownikiem MongoDB na potrzeby Node.js

• TypeScript
• JavaScript
• Python
• C#
• Java
• Idź

W tym przewodniku szybkiego startu utworzysz podstawową aplikację Azure DocumentDB przy użyciu Node.js. Azure DocumentDB to magazyn danych NoSQL, który umożliwia aplikacjom przechowywanie dokumentów w chmurze i uzyskiwanie do nich dostępu przy użyciu oficjalnych sterowników bazy danych MongoDB. W tym przewodniku przedstawiono sposób tworzenia dokumentów i wykonywania podstawowych zadań w klastrze usługi Azure DocumentDB przy użyciu Node.js.

Dokumentacja interfejsu | APIKod źródłowy | Pakiet (npm)

Wymagania wstępne

• Subskrypcja platformy Azure

  • Jeśli nie masz subskrypcji platformy Azure, utwórz bezpłatne konto

• Node.js 22 lub nowsze

Tworzenie klastra usługi Azure DocumentDB

Aby rozpocząć, musisz najpierw utworzyć klaster usługi Azure DocumentDB, który służy jako podstawa do przechowywania danych NoSQL i zarządzania nimi.

1. Zaloguj się do witryny Azure Portal (https://portal.azure.com).

2. W menu witryny Azure Portal lub na stronie głównej wybierz pozycję Utwórz zasób.

3. Na stronie Nowy wyszukaj i wybierz pozycję Azure DocumentDB.

   

4. Na stronie Tworzenie klastra usługi Azure DocumentDB i w sekcji Podstawy wybierz opcję Konfiguruj w sekcji Warstwa klastra .

   

5. Na stronie Skalowanie skonfiguruj te opcje, a następnie wybierz Zapisz aby zapisać zmiany w warstwie klastra.

   	Wartość
   Warstwa klastra	M30 tier, 2 vCore, 8-GiB RAM
   Przechowywanie na odłam	128 GiB

   

6. W sekcji Podstawowe skonfiguruj następujące opcje:

   	Wartość
   Subscription	Wybierz subskrypcję platformy Azure
   Grupa zasobów	Utwórz nową grupę zasobów lub wybierz istniejącą grupę zasobów
   Nazwa klastra	Podaj globalnie unikatową nazwę
   Lokalizacja	Wybieranie obsługiwanego regionu platformy Azure dla subskrypcji
   Wersja bazy danych MongoDB	Wybierz pozycję 8.0
   Nazwa użytkownika administratora	Tworzenie nazwy użytkownika w celu uzyskania dostępu do klastra jako administrator użytkownika
   Hasło	Używanie unikatowego hasła skojarzonego z nazwą użytkownika

   

   Wskazówka

   Zapisz wartości używane dla nazwy użytkownika i hasła. Te wartości są używane w dalszej części tego przewodnika. Aby uzyskać więcej informacji na temat prawidłowych wartości, zobacz ograniczenia klastra.

7. Wybierz Dalej: Sieć.

8. W sekcji Reguły zapory na karcie Sieć skonfiguruj następujące opcje:

   	Wartość
   Metoda łączności	Public access
   Zezwól na publiczny dostęp do tego klastra z usług i zasobów w ramach platformy Azure	Enabled

9. Dodaj regułę zapory dla bieżącego urządzenia klienckiego, aby udzielić dostępu do klastra, wybierając pozycję + Dodaj bieżący adres IP klienta.

   

   Wskazówka

   W wielu środowiskach firmowych adresy IP maszyny deweloperów są ukryte z powodu sieci VPN lub innych ustawień sieci firmowych. W takich przypadkach można tymczasowo zezwolić na dostęp do wszystkich adresów IP, dodając 0.0.0.0 - 255.255.255.255 zakres adresów IP jako regułę zapory. Użyj tej reguły zapory tylko tymczasowo w ramach testowania i programowania połączeń.

10. Wybierz opcję Recenzja i utwórz.

11. Przejrzyj ustawienia, które podałeś, a następnie wybierz Utwórz. Utworzenie klastra trwa kilka minut. Poczekaj na zakończenie wdrażania zasobów.

12. Na koniec wybierz pozycję Przejdź do zasobu , aby przejść do klastra usługi Azure DocumentDB w portalu.

Pobieranie poświadczeń klastra

Pobierz poświadczenia używane do nawiązania połączenia z klastrem.

1. Na stronie klastra wybierz opcję Parametry połączenia w menu zasobów.

2. W sekcji Parametry połączenia skopiuj lub zarejestruj wartość z pola Parametry połączenia .

Ważne

Parametry połączenia w portalu nie zawierają wartości hasła. Musisz zastąpić element zastępczy <password> poświadczeniami, które wprowadziłeś podczas tworzenia klastra, lub wprowadzić hasło interaktywnie.

Inicjowanie projektu

Utwórz nowy projekt Node.js w bieżącym katalogu.

1. Rozpocznij w pustym katalogu.

2. Otwórz terminal w bieżącym katalogu.

3. Inicjowanie projektu Node.js.

   npm init -y
   

4. Zainstaluj język TypeScript i zainicjuj konfigurację języka TypeScript (opcjonalnie dla obsługi języka TypeScript).

   npm install -D typescript @types/node
   npx tsc --init
   

Instalowanie biblioteki klienta

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

1. Zainstaluj sterownik Node.js bazy danych MongoDB przy użyciu narzędzia npm.

   npm install mongodb
   

2. Otwórz i przejrzyj plik package.json , aby sprawdzić, czy wpis pakietu istnieje.

3. Zaimportuj wymagane moduły do kodu aplikacji:

   import { MongoClient, Db, Collection, Document } from 'mongodb';
   

   const { MongoClient } = require('mongodb');
   

Model obiektów

Name	Description
MongoClient	Typ używany do nawiązywania połączenia z bazą danych MongoDB.
Db	Reprezentuje bazę danych w klastrze.
Collection<Document>	Reprezentuje kolekcję w bazie danych w klastrze.

Przykłady kodu

• Uwierzytelnianie użytkownika
• Zdobądź kolekcję
• Tworzenie dokumentu
• Pobieranie dokumentu
• Wyszukiwanie w dokumentach

Kod w tej aplikacji łączy się z bazą danych o nazwie adventureworks i kolekcją o nazwie products. Kolekcja products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Przykłady kodu w tym miejscu wykonują najbardziej typowe operacje podczas pracy z kolekcją.

Uwierzytelnianie klienta

Najpierw połącz się z klientem przy użyciu podstawowych parametrów połączenia.

1. Utwórz funkcję main i skonfiguruj parametry połączenia. Zastąp <your-cluster-name>, <your-username> i <your-password> rzeczywistymi informacjami o klastrze.

   async function main(): Promise<void> {
       // Connection string for Azure DocumentDB cluster
       const connectionString = "mongodb+srv://<your-username>:<your-password>@<your-cluster-name>.global.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000";
   
       // Create a new client and connect to the server
       const client = new MongoClient(connectionString);
   

   async function main() {
       // Connection string for Azure DocumentDB cluster
       const connectionString = "mongodb+srv://<your-username>:<your-password>@<your-cluster-name>.global.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000";
   
       // Create a new client and connect to the server
       const client = new MongoClient(connectionString);
   

2. Połącz się z klientem bazy danych MongoDB i sprawdź połączenie.

       try {
           // Connect to the MongoDB cluster
           await client.connect();
   
           // Ping the server to verify connection
           await client.db("admin").command({ ping: 1 });
           console.log("Successfully connected and pinged Azure DocumentDB");
   

       try {
           // Connect to the MongoDB cluster
           await client.connect();
   
           // Ping the server to verify connection
           await client.db("admin").command({ ping: 1 });
           console.log("Successfully connected and pinged Azure DocumentDB");
   

Zdobądź kolekcję

Teraz pobierz bazę danych i kolekcję. Jeśli baza danych i kolekcja jeszcze nie istnieją, użyj sterownika, aby utworzyć ją automatycznie.

1. Uzyskaj referencję do bazy danych.

           // Get database reference
           const database: Db = client.db("adventureworks");
           console.log(`Connected to database: ${database.databaseName}`);
   

           // Get database reference
           const database = client.db("adventureworks");
           console.log(`Connected to database: ${database.databaseName}`);
   

2. Pobierz odwołanie do kolekcji w bazie danych.

           // Get collection reference
           const collection: Collection<Document> = database.collection("products");
           console.log("Connected to collection: products");
   

           // Get collection reference
           const collection = database.collection("products");
           console.log("Connected to collection: products");
   

Tworzenie dokumentu

Następnie utwórz kilka nowych dokumentów w kolekcji. Aktualizuj lub wstaw dokumenty, aby upewnić się, że zastępują one te istniejące dokumenty, które mają ten sam unikatowy identyfikator.

1. Tworzenie przykładowych dokumentów produktu.

           // Create sample products
           interface Product {
               _id: string;
               name: string;
               category: string;
               quantity: number;
               price: number;
               sale: boolean;
           }
   
           const products: Product[] = [
               {
                   _id: "00000000-0000-0000-0000-000000004018",
                   name: "Windry Mittens",
                   category: "apparel-accessories-gloves-and-mittens",
                   quantity: 121,
                   price: 35.00,
                   sale: false,
               },
               {
                   _id: "00000000-0000-0000-0000-000000004318",
                   name: "Niborio Tent",
                   category: "gear-camp-tents",
                   quantity: 140,
                   price: 420.00,
                   sale: true,
               }
           ];
   

           // Create sample products
           const products = [
               {
                   _id: "00000000-0000-0000-0000-000000004018",
                   name: "Windry Mittens",
                   category: "apparel-accessories-gloves-and-mittens",
                   quantity: 121,
                   price: 35.00,
                   sale: false,
               },
               {
                   _id: "00000000-0000-0000-0000-000000004318",
                   name: "Niborio Tent",
                   category: "gear-camp-tents",
                   quantity: 140,
                   price: 420.00,
                   sale: true,
               }
           ];
   

2. Wstaw dokumenty przy użyciu operacji upsert.

           // Insert documents with upsert
           for (const product of products) {
               const filter = { _id: product._id };
               const options = { upsert: true };
   
               await collection.replaceOne(filter, product, options);
               console.log(`Upserted product: ${product.name}`);
           }
   

           // Insert documents with upsert
           for (const product of products) {
               const filter = { _id: product._id };
               const options = { upsert: true };
   
               await collection.replaceOne(filter, product, options);
               console.log(`Upserted product: ${product.name}`);
           }
   

Pobieranie dokumentu

Następnie wykonaj operację odczytu punktowego, aby zlokalizować i pobrać określony dokument z kolekcji.

1. Zdefiniuj filtr, aby znaleźć określony dokument według identyfikatora.

           // Retrieve a specific document by ID
           const filter = { _id: "00000000-0000-0000-0000-000000004018" };
   

           // Retrieve a specific document by ID
           const filter = { _id: "00000000-0000-0000-0000-000000004018" };
   

2. Wykonaj zapytanie i pobierz wynik.

           const retrievedProduct = await collection.findOne(filter);
   
           if (retrievedProduct) {
               console.log(`Retrieved product: ${retrievedProduct.name} - $${retrievedProduct.price}`);
           } else {
               console.log("Product not found");
           }
   

           const retrievedProduct = await collection.findOne(filter);
   
           if (retrievedProduct) {
               console.log(`Retrieved product: ${retrievedProduct.name} - $${retrievedProduct.price}`);
           } else {
               console.log("Product not found");
           }
   

Zapytanie o dokumenty

Na koniec wykonaj zapytanie o wiele dokumentów przy użyciu języka zapytań MongoDB (MQL).

1. Zdefiniuj zapytanie, aby znaleźć dokumenty spełniające określone kryteria.

           // Query for products on sale
           const saleFilter = { sale: true };
           const saleProducts = await collection.find(saleFilter).toArray();
   

           // Query for products on sale
           const saleFilter = { sale: true };
           const saleProducts = await collection.find(saleFilter).toArray();
   

2. Iteruj wyniki, aby wyświetlić pasujące dokumenty.

           console.log("Products on sale:");
           for (const product of saleProducts) {
               console.log(`- ${product.name}: $${product.price.toFixed(2)} (Category: ${product.category})`);
           }
   
       } catch (error) {
           console.error("An error occurred:", error);
       } finally {
           await client.close();
       }
   }
   
   main().catch(console.error);
   

           console.log("Products on sale:");
           for (const product of saleProducts) {
               console.log(`- ${product.name}: $${product.price.toFixed(2)} (Category: ${product.category})`);
           }
   
       } catch (error) {
           console.error("An error occurred:", error);
       } finally {
           await client.close();
       }
   }
   
   main().catch(console.error);
   

Eksplorowanie danych przy użyciu programu Visual Studio Code

Użyj rozszerzenia DocumentDB w programie Visual Studio Code, aby wykonywać podstawowe operacje bazy danych, w tym wykonywanie zapytań, wstawianie, aktualizowanie i usuwanie danych.

1. Otwórz program Visual Studio Code.

2. Przejdź do widoku Rozszerzenia i wyszukaj termin DocumentDB. Znajdź rozszerzenie DocumentDB dla programu VS Code .

3. Wybierz przycisk Zainstaluj dla rozszerzenia. Poczekaj na zakończenie instalacji. Załaduj ponownie program Visual Studio Code, jeśli zostanie wyświetlony monit.

4. Przejdź do rozszerzenia usługi DocumentDB , wybierając odpowiednią ikonę na pasku działań.

5. W okienku Połączenia usługi DocumentDB wybierz pozycję + Nowe połączenie....

6. W oknie dialogowym wybierz pozycję Odnajdywanie usług , a następnie Pozycję Azure DocumentDB — Azure Service Discovery.

7. Wybierz subskrypcję platformy Azure i nowo utworzony klaster usługi Azure DocumentDB.

   Wskazówka

   W wielu środowiskach firmowych adresy IP maszyny deweloperów są ukryte z powodu sieci VPN lub innych ustawień sieci firmowych. W takich przypadkach można tymczasowo zezwolić na dostęp do wszystkich adresów IP, dodając 0.0.0.0 - 255.255.255.255 zakres adresów IP jako regułę zapory. Użyj tej reguły zapory tylko tymczasowo w ramach testowania i programowania połączeń. Aby uzyskać więcej informacji, zobacz konfigurowanie zapory.

8. Wróć do panelu Połączenia DocumentDB, rozwiń węzeł klastra i przejdź do istniejących dokumentów i kolekcji.

9. Otwórz menu kontekstowe kolekcji, a następnie wybierz pozycję >.

10. Wprowadź następujące polecenia języka zapytań bazy danych MongoDB (MQL), a następnie wybierz pozycję Uruchom wszystko. Zwróć uwagę na dane wyjściowe poleceń.

    db.products.find({
      price: { $gt: 200 },
      sale: true
    })
    .sort({ price: -1 })
    .limit(3)
    

Uprzątnij zasoby

Po zakończeniu pracy z klastrem usługi Azure DocumentDB możesz usunąć utworzone zasoby platformy Azure, aby nie ponosić dodatkowych opłat.

1. Na pasku wyszukiwania witryny Azure Portal wyszukaj i wybierz pozycję Grupy zasobów.

   

2. Na liście wybierz grupę zasobów używana dla tego szybkiego startu.

   

3. Na stronie grupa zasobów wybierz pozycję Usuń grupę zasobów.

4. W oknie dialogowym potwierdzenia usunięcia wprowadź nazwę grupy zasobów, aby potwierdzić, że zamierzasz ją usunąć. Na koniec wybierz pozycję Usuń , aby trwale usunąć grupę zasobów.

   

Treści powiązane

• Co to jest usługa Azure DocumentDB?