Guida introduttiva: Usare Azure Cosmos DB per MongoDB con Node.js

Importante

Si vuole eseguire la migrazione di un'applicazione MongoDB esistente o usare le funzionalità MQL (MongoDB Query Language) ? Prendere in considerazione Azure DocumentDB.

Si sta cercando una soluzione di database per scenari su larga scala con un contratto di servizio di disponibilità 99.999%, scalabilità automatica immediata e failover automatico in più aree? Prendere in considerazione Azure Cosmos DB per NoSQL.

In questa guida introduttiva si distribuisce un'applicazione Azure Cosmos DB per MongoDB di base usando Python. Azure Cosmos DB per MongoDB è un archivio dati senza schema che consente alle applicazioni di archiviare documenti non strutturati nel cloud con librerie MongoDB. Si apprenderà come creare documenti ed eseguire attività di base all'interno della risorsa di Azure Cosmos DB usando Python.

Codice sorgente della libreria | Pacchetto (npm) | Interfaccia della riga di comando per sviluppatori di Azure

Prerequisiti

  • CLI per sviluppatori di Azure
  • Docker Desktop
  • Node.js 22 o versione successiva

Se non si ha un account Azure, creare un account gratuito prima di iniziare.

Inizializzare il progetto

Usare l'interfaccia della riga di comando per sviluppatori di Azure (azd) per creare un account Azure Cosmos DB per tabelle e distribuire un'applicazione di esempio in contenitori. L'applicazione di esempio usa la libreria client per gestire, creare, leggere ed eseguire query sui dati di esempio.

  1. Aprire un terminale in una directory vuota.

  2. Se non si è già autenticati, eseguire l'autenticazione all'interfaccia della riga di comando per sviluppatori di Azure usando azd auth login. Seguire i passaggi specificati dallo strumento per eseguire l'autenticazione all'interfaccia della riga di comando usando le credenziali di Azure preferite.

    azd auth login
    
  3. Usare azd init per inizializzare il progetto.

    azd init --template cosmos-db-mongodb-nodejs-quickstart
    
  4. Durante l'inizializzazione, configurare un nome di ambiente univoco.

  5. Distribuire l'account Azure Cosmos DB usando azd up. I modelli Bicep distribuiscono anche un'applicazione Web di esempio.

    azd up
    
  6. Durante il processo di configurazione, seleziona il tuo abbonamento, la località desiderata e il gruppo di risorse destinato. Attendere il completamento del processo di provisioning. Per il processo sono necessari circa 5 minuti.

  7. Al termine del provisioning delle risorse di Azure, nell'output viene incluso un URL dell'applicazione Web in esecuzione.

    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. Usare l'URL nella console per passare all'applicazione Web nel browser. Osservare l'output dell'app in esecuzione.

Screenshot dell'applicazione Web in esecuzione.

Screenshot dell'applicazione Web in esecuzione.

Installare la libreria client

La libreria client è disponibile tramite npm, come mongodb pacchetto.

  1. Aprire un terminale e passare alla cartella /src/ts.

    cd ./src/ts
    
  2. Se non è già installato, installare il pacchetto mongodb usando npm install.

    npm install --save mongodb
    
  3. Aprire ed esaminare il file src/ts/package.json per verificare che la mongodb voce esista.

  1. Aprire un terminale e passare alla cartella /src/js.

    cd ./src/js
    
  2. Se non è già installato, installare il pacchetto mongodb usando npm install.

    npm install --save mongodb
    
  3. Aprire ed esaminare il file src/js/package.json per verificare che la mongodb voce esista.

Importare le librerie

Importare il MongoClient tipo nel codice dell'applicazione.

import { MongoClient } from 'mongodb';

Importare tutti i tipi necessari nel codice dell'applicazione.

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

Modello a oggetti

Name Description
MongoClient Tipo usato per connettersi a MongoDB.
Database Rappresenta un database nell'account.
Collection Rappresenta una raccolta all'interno di un database nell'account.

Esempi di codice

Il codice di esempio nel modello utilizza un database denominato cosmicworks e una raccolta denominata products. La products raccolta contiene dettagli quali nome, categoria, quantità e identificatore univoco per ogni prodotto. La raccolta usa la proprietà /category come chiave di partizione.

Autenticare il client

In questo esempio viene creata una nuova istanza del MongoClient tipo .

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

Ottenere un database

In questo esempio viene creata un'istanza del tipo Db utilizzando la funzione db del tipo MongoClient.

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

Ottieni una raccolta

In questo esempio viene creata un'istanza del tipo Collection utilizzando la funzione collection del tipo Db.

Questa funzione ha un parametro generico che usa il Product tipo definito in un'interfaccia.

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

Creare un documento

Creare un documento nella raccolta usando collection.updateOne. Questo metodo esegue l'upsert dell'elemento, in pratica sostituendolo, se esiste già.

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

Leggere un documento

Eseguire un'operazione di lettura puntuale utilizzando sia l'identificatore univoco (id) sia i campi chiave di partizione. Usare collection.findOne per recuperare in modo efficiente l'elemento specifico.

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

Eseguire query su documenti

Eseguire una query su più elementi in un contenitore usando collection.find. Questa query trova tutti gli elementi all'interno di una categoria specificata (chiave di partizione).

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
}

Esplora i tuoi dati

Usare l'estensione Di Visual Studio Code per Azure Cosmos DB per esplorare i dati di MongoDB. È possibile eseguire operazioni di database di base, tra cui:

  • Esecuzione di query usando un scrapbook o l'editor di query
  • Modifica, aggiornamento, creazione ed eliminazione di documenti
  • Importazione di dati in blocco da altre origini
  • Gestione di database e raccolte

Per altre informazioni, vedere How-to use Visual Studio Code extension to explore Azure Cosmos DB for MongoDB data (Come usare l'estensione Visual Studio Code per esplorare i dati di Azure Cosmos DB per MongoDB).

Pulire le risorse

Quando l'applicazione o le risorse di esempio non sono più necessarie, rimuovere la distribuzione corrispondente e tutte le risorse.

azd down --force --purge