Azure Cosmos DB: Creare un'applicazione Node.js tramite l'API GraphAzure Cosmos DB: Build a Node.js application by using Graph API

Azure Cosmos DB è il servizio di database multimodello distribuito a livello globale di Microsoft.Azure Cosmos DB is the globally distributed multimodel database service from Microsoft. È possibile creare ed eseguire rapidamente query su database di documenti, coppie chiave-valore e grafi, sfruttando in ognuno dei casi i vantaggi offerti dalle funzionalità di scalabilità orizzontale e distribuzione globale alla base di Azure Cosmos DB.You can quickly create and query document, key/value, and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Azure Cosmos DB.

Questa guida introduttiva illustra come creare un account Azure Cosmos DB per l'API Graph, un database e un grafo tramite il portale di Azure.This Quick Start article demonstrates how to create an Azure Cosmos DB account for Graph API, database, and graph by using the Azure portal. Si creerà ed eseguirà quindi un'app console usando il driver open source Gremlin Node.js.You then build and run a console app by using the open-source Gremlin Node.js driver.

prerequisitiPrerequisites

Prima di poter eseguire questo esempio, è necessario soddisfare i prerequisiti seguenti:Before you can run this sample, you must have the following prerequisites:

Se non si ha una sottoscrizione di Azure, creare un account gratuito prima di iniziare.If you don't have an Azure subscription, create a free account before you begin.

Creare un account di databaseCreate a database account

  1. In una nuova finestra del browser accedere al portale di Azure.In a new browser window, sign in to the Azure portal.

  2. Fare clic su Nuovo > Database > Azure Cosmos DB.Click New > Databases > Azure Cosmos DB.

    Riquadro "Database" nel portale di Azure

  3. Nella pagina Nuovo account immettere le impostazioni per il nuovo account Azure Cosmos DB.In the New account page, enter the settings for the new Azure Cosmos DB account.

    ImpostazioneSetting Valore consigliatoSuggested value DESCRIZIONEDescription
    IDID Immettere un nome univocoEnter a unique name Immettere un nome univoco per identificare l'account Azure Cosmos DB.Enter a unique name to identify this Azure Cosmos DB account. Poiché alI'ID fornito viene aggiunto documents.azure.com per creare l'URI, usare un ID univoco ma facilmente identificabile.Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique but identifiable ID.

    L'ID può contenere solo lettere minuscole, numeri e il segno meno (-) e deve avere una lunghezza compresa tra 3 e 50 caratteri.The ID can contain only lowercase letters, numbers, and the hyphen (-) character, and it must contain 3 to 50 characters.
    APIAPI Gremlin (graph)Gremlin (graph) L'API determina il tipo di account da creare.The API determines the type of account to create. Azure Cosmos DB offre cinque API per soddisfare le esigenze dell'applicazione, ovvero SQL (database di documenti) Gremlin (grafo), MongoDB, SQL (database di documenti), Tabella di Azure e Cassandra, per ognuna delle quali è attualmente necessario un account separato.Azure Cosmos DB provides five APIs to suits the needs of your application: SQL (document database), Gremlin (graph database), MongoDB (document database), Azure Table, and Cassandra, each which currently require a separate account.

    Selezionare Gremlin (grafo) perché in questa esercitazione si crea un grafo disponibile per query con sintassi Gremlin.Select Gremlin (graph) because in this quickstart you are creating a graph that is queryable using Gremlin syntax.

    Altre informazioni sull'API GraphLearn more about the Graph API
    SottoscrizioneSubscription Sottoscrizione in usoYour subscription Selezionare la sottoscrizione di Azure da usare per l'account Azure Cosmos DB.Select Azure subscription that you want to use for this Azure Cosmos DB account.
    Gruppo di risorseResource group Immettere lo stesso nome univoco specificato sopra in IDEnter the same unique name as provided above in ID Immettere il nome di un nuovo gruppo di risorse per l'account.Enter a new resource-group name for your account. Per semplicità si può usare lo stesso nome usato come ID.For simplicity, you can use the same name as your ID.
    LocalitàLocation Selezionare l'area più vicina agli utentiSelect the region closest to your users Selezionare la posizione geografica in cui ospitare l'account Azure Cosmos DB.Select geographic location in which to host your Azure Cosmos DB account. Usare la località più vicina agli utenti per offrire loro la massima velocità di accesso ai dati.Use the location that's closest to your users to give them the fastest access to the data.
    Abilita ridondanza geograficaEnable geo-redundancy Lasciare vuotoLeave blank Consente di creare una versione replicata del database in una seconda area abbinata.This creates a replicated version of your database in a second (paired) region. Lasciare vuoto.Leave this blank.
    Aggiungi al dashboardPin to dashboard SelectSelect Selezionare questa casella per aggiungere il nuovo account di database al dashboard del portale e accedervi più facilmente.Select this box so that your new database account is added to your portal dashboard for easy access.

    Fare quindi clic su Crea.Then click Create.

    Pannello Nuovo account per Azure Cosmos DB

  4. La creazione dell'account richiede alcuni minuti,The account creation takes a few minutes. Durante la creazione dell'account il portale visualizza il riquadro Deploying Azure Cosmos DB (Distribuzione di Azure Cosmos DB) a destra, quindi potrebbe essere necessario scorrere a destra del dashboard per visualizzare il riquadro.During account creation the portal displays the Deploying Azure Cosmos DB tile on the right side, you may need to scroll right on your dashboard to see the tile. È presente anche un indicatore di stato nella parte superiore della schermata.There is also a progress bar displayed near the top of the screen. È possibile esaminare lo stato di avanzamento nelle due aree.You can watch either area for progress.

    Riquadro Notifiche del portale di Azure

    Al termine della creazione dell'account verrà visualizzata la pagina L'account Azure Cosmos DB è stato creato.Once the account is created, the Congratulations! Your Azure Cosmos DB account was created page is displayed.

Aggiungere un grafoAdd a graph

È ora possibile usare lo strumento Esplora dati nel portale di Azure per creare un database a grafo.You can now use the Data Explorer tool in the Azure portal to create a graph database.

  1. Dal menu a sinistra del portale di Azure scegliere Esplora dati (anteprima).In the Azure portal, in the menu on the left, select Data Explorer (Preview).

  2. In Esplora dati (anteprima) selezionare New Graph (Nuovo grafo).Under Data Explorer (Preview), select New Graph. Compilare quindi la pagina usando le informazioni seguenti:Then fill in the page by using the following information:

    Esplora dati nel portale di Azure

    ImpostazioneSetting Valore consigliatoSuggested value DESCRIZIONEDescription
    ID databaseDatabase id sample-databasesample-database Immettere sample-database come nome del nuovo database.Enter sample-database as the name for the new database. I nomi dei database devono avere una lunghezza compresa tra 1 e 255 caratteri e non possono contenere / \ # ? o spazi finali.Database names must be between 1 and 255 characters and can't contain / \ # ? or a trailing space.
    Graph id (ID grafo)Graph id sample-graphsample-graph Immettere sample-graph come nome della nuova raccolta.Enter sample-graph as the name for your new collection. I nomi dei grafi presentano gli stessi requisiti relativi ai caratteri degli ID di database.Graph names have the same character requirements as database IDs.
    Capacità di archiviazioneStorage capacity 10 GB10 GB Lasciare il valore predefinito.Leave the default value. Indica la capacità di archiviazione del database.This is the storage capacity of the database.
    Velocità effettivaThroughput 400 UR/s400 RUs Lasciare il valore predefinito.Leave the default value. È possibile aumentare la velocità effettiva in un secondo momento se si desidera ridurre la latenza.You can scale up the throughput later if you want to reduce latency.
  3. Dopo avere compilato il modulo, fare clic su OK.After the form is filled out, select OK.

Clonare l'applicazione di esempioClone the sample application

Clonare ora un'app per le API Graph da GitHub, impostare la stringa di connessione ed eseguirla.Now let's clone a Graph API app from GitHub, set the connection string, and run it. Come si noterà, è facile usare i dati a livello di codice.You'll see how easy it is to work with data programmatically.

  1. Aprire una finestra del terminale Git, ad esempio Git Bash, e usare il comando cd per passare a una directory di lavoro.Open a Git terminal window, such as Git Bash, and change (via cd command) to a working directory.

  2. Eseguire il comando seguente per clonare il repository di esempio:Run the following command to clone the sample repository:

    git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-nodejs-getting-started.git
    
  3. Aprire il file della soluzione in Visual Studio.Open the solution file in Visual Studio.

Esaminare il codiceReview the code

Ecco una breve panoramica delle operazioni eseguire nell'app.Let's make a quick review of what's happening in the app. Aprire il file app.js. Verranno visualizzate le righe di codice seguenti.Open the app.js file, and you see the following lines of code.

  • Viene creato il client di Gremlin.The Gremlin client is created.

    const client = Gremlin.createClient(
        443, 
        config.endpoint, 
        { 
            "session": false, 
            "ssl": true, 
            "user": `/dbs/${config.database}/colls/${config.collection}`,
            "password": config.primaryKey
        });
    

    Le configurazioni sono tutte incluse in config.js, che verrà modificato nella sezione seguente.The configurations are all in config.js, which we edit in the following section.

  • Sono definite varie funzioni per eseguire diverse operazioni Gremlin.A series of functions are defined to execute different Gremlin operations. Questa è una di esse:This is one of them:

    function addVertex1(callback)
    {
        console.log('Running Add Vertex1'); 
        client.execute("g.addV('person').property('id', 'thomas').property('firstName', 'Thomas').property('age', 44).property('userid', 1)", { }, (err, results) => {
          if (err) callback(console.error(err));
          console.log("Result: %s\n", JSON.stringify(results));
          callback(null)
        });
    }
    
  • Ogni funzione esegue un metodo client.execute con un parametro di stringa della query Gremlin.Each function executes a client.execute method with a Gremlin query string parameter. Di seguito è riportato un esempio di come g.V().count() viene eseguito:Here is an example of how g.V().count() is executed:

    console.log('Running Count'); 
    client.execute("g.V().count()", { }, (err, results) => {
        if (err) return console.error(err);
        console.log(JSON.stringify(results));
        console.log();
    });
    
  • Alla fine del file vengono richiamati tutti i metodi usando il metodo async.waterfall().At the end of the file, all methods are then invoked using the async.waterfall() method. In questo modo vengono eseguiti uno dopo l'altro:This will execute them one after the other:

    try{
        async.waterfall([
            dropGraph,
            addVertex1,
            addVertex2,
            addEdge,
            countVertices
            ], finish);
    } catch(err) {
        console.log(err)
    }
    

Aggiornare la stringa di connessioneUpdate your connection string

  1. Aprire il file config.js.Open the config.js file.

  2. In config.js compilare la chiave config.endpoint con il valore URI Gremlin disponibile nella pagina Panoramica del portale di Azure.In config.js, fill in the config.endpoint key with the Gremlin URI value from the Overview page of the Azure portal.

    config.endpoint = "GRAPHENDPOINT";

    Visualizzazione e copia di una chiave di accesso nel portale di Azure, pannello Chiavi

    Se il valore di URI Gremlin è vuoto, è possibile generarlo dalla pagina Chiavi nel portale.If the Gremlin URI value is blank, you can generate the value from the Keys page in the portal. Usare il valore di URI, rimuovere https:// e sostituire documents con gremlin.cosmosdb.Use the URI value, remove https://, and change documents to gremlin.cosmosdb. Se l'account Graph è stato creato prima del 20 dicembre 2017, sostituire documents con graphs.If your graph account was created before December 20th, 2017, change documents to graphs.

    L'endpoint Gremlin deve essere solo il nome host senza protocollo/numero di porta, ad esempio mygraphdb.gremlin.cosmosdb.azure.com (non https://mygraphdb.gremlin.cosmosdb.azure.com o mygraphdb.gremlin.cosmosdb.azure.com:433).The Gremlin endpoint must be only the host name without the protocol/port number, like mygraphdb.gremlin.cosmosdb.azure.com (not https://mygraphdb.gremlin.cosmosdb.azure.com or mygraphdb.gremlin.cosmosdb.azure.com:433).

  3. Nel file config.js compilare il valore di config.primaryKey con il valore Chiave primaria disponibile nella pagina Chiavi del portale di Azure.In config.js, fill in the config.primaryKey value with the Primary Key value from the Keys page of the Azure portal.

    config.primaryKey = "PRIMARYKEY";

    Pannello "Chiavi" del portale di Azure

  4. Immettere il nome del database e il nome del grafo (contenitore) per il valore di config.database e config.collection.Enter the database name, and graph (container) name for the value of config.database and config.collection.

Ecco un esempio dell'aspetto che dovrebbe avere il file config.js completato:Here's an example of what your completed config.js file should look like:

var config = {}

// Note that this must not have HTTPS or the port number
config.endpoint = "testgraphacct.gremlin.cosmosdb.azure.com";
config.primaryKey = "Pams6e7LEUS7LJ2Qk0fjZf3eGo65JdMWHmyn65i52w8ozPX2oxY3iP0yu05t9v1WymAHNcMwPIqNAEv3XDFsEg==";
config.database = "graphdb"
config.collection = "Persons"

module.exports = config;

Eseguire l'app consoleRun the console app

  1. Aprire una finestra del terminale e usare il comando cd per passare alla directory di installazione del file package.json incluso nel progetto.Open a terminal window and change (via cd command) to the installation directory for the package.json file that's included in the project.

  2. Eseguire npm install per installare i moduli npm necessari, tra cui gremlin.Run npm install to install the required npm modules, including gremlin.

  3. Eseguire node app.js in un terminale per avviare l'applicazione Node.js.Run node app.js in a terminal to start your node application.

Esplorare con Esplora datiBrowse with Data Explorer

È ora possibile tornare a Esplora dati nel portale di Azure per visualizzare, modificare e usare i nuovi dati del grafo ed eseguire query su di essi.You can now go back to Data Explorer in the Azure portal to view, query, modify, and work with your new graph data.

In Esplora dati il nuovo database viene visualizzato nel riquadro Graph.In Data Explorer, the new database appears in the Graphs pane. Espandere il database e la raccolta, quindi fare clic su Graph.Expand the database, followed by the collection, and then select Graph.

I dati generati dall'app di esempio vengono visualizzati nel riquadro successivo nella scheda Graph quando si fa clic su Applica filtro.The data generated by the sample app is displayed in the next pane within the Graph tab when you select Apply Filter.

Provare a completare g.V() con .has('firstName', 'Thomas') per testare il filtro.Try completing g.V() with .has('firstName', 'Thomas') to test the filter. Il valore distingue tra maiuscole e minuscole.Note that the value is case sensitive.

Esaminare i contratti di servizio nel portale di AzureReview SLAs in the Azure portal

La velocità effettiva, lo spazio di archiviazione, la disponibilità, la latenza e la coerenza delle risorse nell'account vengono monitorati nel portale di Azure.The throughput, storage, availability, latency, and consistency of the resources in your account are monitored in the Azure portal. Di seguito vengono illustrate brevemente queste metriche.Let's take a quick look at these metrics.

  1. Fare clic su Metriche nel menu di spostamento.Click Metrics in the navigation menu.

    Metriche nel portale di Azure

  2. Fare clic su ogni scheda per conoscere le metriche offerte da Azure Cosmos DB.Click through each of the tabs so you're aware of the metrics Azure Cosmos DB provides.

    Ogni grafico associato ai contratti di servizio per Azure Cosmos DB contiene una linea che indica le eventuali violazioni dei contratti di servizio.Each chart that's associated with the Azure Cosmos DB Service Level Agreements (SLAs) provides a line that shows if any of the SLAs have been violated. Con questo gruppo di metriche, Azure Cosmos DB garantisce trasparenza nel monitoraggio dei contratti di servizio.Azure Cosmos DB makes monitoring your SLAs transparent with this suite of metrics.

    Gruppo di metriche di Azure Cosmos DB

Pulire le risorseClean up your resources

Se non si prevede di continuare a usare questa app, eliminare tutte le risorse create in questo articolo eseguendo la procedura illustrata di seguito:If you do not plan to continue using this app, delete all resources that you created in this article by doing the following:

  1. Nel portale di Azure, nel menu di spostamento di sinistra selezionare Gruppi di risorse.In the Azure portal, on the left navigation menu, select Resource groups. Selezionare quindi il nome della risorsa che è stata creata.Then select the name of the resource that you created.

  2. Nella pagina del gruppo di risorse selezionare Elimina.On your resource group page, select Delete. Digitare il nome della risorsa da eliminare, quindi selezionare Elimina.Type the name of the resource to be deleted, and then select Delete.

Passaggi successiviNext steps

In questo articolo si è appreso come creare un account Azure Cosmos DB, come creare un grafo con Esplora dati e come eseguire un'app.In this article, you learned how to create an Azure Cosmos DB account, create a graph by using Data Explorer, and run an app. È ora possibile creare query più complesse e implementare la potente logica di attraversamento dei grafi usando Gremlin.You can now build more complex queries and implement powerful graph traversal logic by using Gremlin.