Azure Cosmos DB: compilare un'app Flask con l'API MongoDBAzure Cosmos DB: Build a Flask app with the MongoDB API

Azure Cosmos DB è il servizio di database di Microsoft multimodello distribuito a livello globale.Azure Cosmos DB is Microsoft’s globally distributed multi-model database service. È 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 usa l'esempio di Flask seguente e illustra come compilare una semplice app Flask To-Do con l'emulatore di Azure Cosmos DB e l'API di MongoDB in Azure Cosmos DB invece che con MongoDB.This quick start guide, uses the following Flask example and demonstrates how to build a simple To-Do Flask app with the Azure Cosmos DB Emulator and the Azure Cosmos DB MongoDB API instead of MongoDB.

PrerequisitiPrerequisites

  • Scaricare l'emulatore di Azure Cosmos DB.Download the Azure Cosmos DB Emulator. L'emulatore è attualmente supportato solo in Windows.The emulator is currently only supported on Windows. Viene illustrato come è possibile usare l'esempio con una chiave di produzione di Azure in qualsiasi piattaforma.The sample shows how to use the sample with a production key from Azure, which can be done on any platform.

  • Se necessario, è possibile installare rapidamente Visual Studio Code per la piattaforma in uso (Windows, Mac, Linux).If you don’t already have Visual Studio Code installed, you can quickly install VS Code for your platform (Windows, Mac, Linux).

  • Assicurarsi di aggiungere il supporto per il linguaggio Python installando una delle più diffuse estensioni Python.Be sure to add Python Language support by installing one of the popular Python extensions.

    1. Selezionare un'estensione.Select an extension.
    2. Installare l'estensione digitando ext install nel riquadro comandi Ctrl+Shift+P.Install the extension by typing ext install into the Command Palette Ctrl+Shift+P.

      Gli esempi di questo documento usano la popolare estensione Python con funzionalità complete di Don Jayamanne.The examples in this document use Don Jayamanne's popular and full featured Python Extension.

Clonare l'applicazione di esempioClone the sample application

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

  1. Aprire un prompt dei comandi, creare una nuova cartella denominata git-samples e quindi chiudere il prompt dei comandi.Open a command prompt, create a new folder named git-samples, then close the command prompt.

    md "C:\git-samples"
    
  2. Aprire una finestra del terminale Git, ad esempio Git Bash, ed eseguire il comando cd per passare a una nuova cartella in cui installare l'app di esempio.Open a git terminal window, such as git bash, and use the cd command to change to the new folder to install the sample app.

    cd "C:\git-samples"
    
  3. Eseguire il comando seguente per clonare l'archivio di esempio.Run the following command to clone the sample repository. Questo comando crea una copia dell'app di esempio nel computer in uso.This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/CosmosDB-Flask-Mongo-Sample.git
    
  4. Eseguire il comando seguente per installare i moduli di Python.Run the following command to install the python modules.

    pip install -r .\requirements.txt
    
  5. Aprire la cartella in Visual Studio Code.Open the folder in Visual Studio Code.

Esaminare il codiceReview the code

Questo passaggio è facoltativo.This step is optional. Per scoprire in che modo le risorse del database vengono create nel codice, è possibile esaminare i frammenti di codice seguenti.If you're interested in learning how the database resources are created in the code, you can review the following snippets. Altrimenti è possibile passare direttamente a Eseguire l'app Web.Otherwise, you can skip ahead to Run the web app.

Tutti i frammenti di codice seguenti sono tratti dal file app.py e usano la stringa di connessione per l'emulatore di Azure Cosmos DB locale.The following snippets are all taken from the app.py file and uses the connection string for the local Azure Cosmos DB Emulator. La password deve essere suddivisa come illustrato sotto per contenere le barre che non possono essere analizzate in altro modo.The password needs to be split up as seen below to accommodate for the forward slashes that cannot be parsed otherwise.

  • Inizializzare il client MongoDB, recuperare il database ed eseguire l'autenticazione.Initialize the MongoDB client, retrieve the database, and authenticate.

    client = MongoClient("mongodb://127.0.0.1:10250/?ssl=true") #host uri
    db = client.test    #Select the database
    db.authenticate(name="localhost",password='C2y6yDjf5' + r'/R' + '+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw' + r'/Jw==')
    
  • Recuperare la raccolta o crearla, se non esiste già.Retrieve the collection or create it if it does not already exist.

    todos = db.todo #Select the collection
    
  • Creare l'appCreate the app

    app = Flask(__name__)
    title = "TODO with Flask"
    heading = "ToDo Reminder"
    

Eseguire l'app WebRun the web app

  1. Verificare che l'emulatore di Azure Cosmos DB sia in esecuzione.Make sure the Azure Cosmos DB Emulator is running.

  2. Aprire una finestra del terminale e usare il comando cd per accedere alla directory in cui l'app è stata salvata.Open a terminal window and cd to the directory that the app is saved in.

  3. Impostare quindi la variabile di ambiente per l'app Flask con set FLASK_APP=app.py o export FLASK_APP=app.py se si usa un Mac.Then set the environment variable for the Flask app with set FLASK_APP=app.py or export FLASK_APP=app.py if you are using a Mac.

  4. Eseguire l'app con flask run e passare a http://127.0.0.1:5000/.Run the app with flask run and browse to http://127.0.0.1:5000/.

  5. Aggiungere e rimuovere le attività e verificare che siano state aggiunte e modificate nella raccolta.Add and remove tasks and see them added and changed in the collection.

Creare un account di databaseCreate a database account

  1. In una nuova finestra accedere al portale di Azure.In a new window, sign in to the Azure portal.
  2. Nel menu a sinistra fare clic su Crea una risorsa, quindi su Database e infine in Azure Cosmos DB fare clic su Crea.In the left menu, click Create a resource, click Databases, and then under Azure Cosmos DB, click Create.

    Screenshot del portale di Azure in cui sono evidenziati Altri servizi e Azure Cosmos DB

  3. Nel pannello Nuovo account specificare MongoDB per l'API e immettere le informazioni relative alla configurazione desiderata per l'account Azure Cosmos DB.In the New account blade, specify MongoDB as the API and fill out your desired configuration for the Azure Cosmos DB account.

    • ID deve essere un nome univoco da usare per identificare l'account Azure Cosmos DB.ID must be a unique name you wish to use to identify your Azure Cosmos DB account. Può contenere solo lettere minuscole, numeri, il carattere "-" e deve essere compreso fra 3 e 50 caratteri.It may only contain lower case letters, numbers, the '-' character, and must be between 3 and 50 characters.
    • Sottoscrizione è la sottoscrizione di AzureSubscription is your Azure subscription. e viene compilata automaticamente.It will be filled out for you.
    • Gruppo di risorse è il nome del gruppo di risorse per l'account Azure Cosmos DB.Resource Group is the resource group name for your Azure Cosmos DB account. Selezionare Crea nuovo, quindi immettere il nome di un nuovo gruppo di risorse per l'account.Select Create New, then 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.
    • Percorso è la posizione geografica in cui si trova l'istanza di Azure Cosmos DB.Location is the geographic location where your Azure Cosmos DB instance is located. Scegliere la località più vicina agli utenti.Choose the location closest to your users.

      Fare quindi clic su Crea.Then click Create.

      Pagina del nuovo account per Azure Cosmos DB

  4. La creazione dell'account richiede alcuni minuti,The account creation takes a few minutes. Attendere che nel portale venga visualizzata la pagina Complimenti, L'account Azure Cosmos DB con l'API MongoDB è pronto.Wait for the portal to display the Congratulations! Your Azure Cosmos DB account with MongoDB API is ready page.

    Riquadro Notifiche del portale di Azure

Aggiornare la stringa di connessioneUpdate your connection string

Per testare il codice in un account Azure Cosmos DB live, passare al portale di Azure per creare un account e ottenere le informazioni della stringa di connessione.If you want to test the code against a live Azure Cosmos DB Account, go to the Azure portal to create an account and get your connection string information. Copiarle quindi nell'app.Then copy it into the app.

  1. Nell'account Azure Cosmos DB nel portale di Azure fare clic su Stringa di connessione nel riquadro di spostamento a sinistra e quindi su Chiavi di lettura/scrittura.In the Azure portal, in your Azure Cosmos DB account, in the left navigation click Connection String, and then click Read-write Keys. Usare i pulsanti di copia sul lato destro dello schermo per copiare nome utente, password e host nel file Dal.cs nel passaggio seguente.You'll use the copy buttons on the right side of the screen to copy the Username, Password, and Host into the Dal.cs file in the next step.

  2. Aprire il file app.py nella directory radice.Open the app.py file in the root directory.

  3. Copiare il valore di nomeutente dal portale (usando il pulsante di copia) e impostarlo come valore di name nel file app.py.Copy your username value from the portal (using the copy button) and make it the value of the name in your app.py file.

  4. Copiare quindi il valore della stringa di connessione dal portale e impostarlo come valore di MongoClient nel file app.py.Then copy your connection string value from the portal and make it the value of the MongoClient in your app.py file.

  5. Copiare infine il valore di password dal portale e impostarlo come valore di password nel file app.py.Finally copy your password value from the portal and make it the value of the password in your app.py file.

L'app è stata aggiornata con tutte le informazioni necessarie per comunicare con Azure Cosmos DB.You've now updated your app with all the info it needs to communicate with Azure Cosmos DB. È possibile eseguirla esattamente come prima.You can run it the same way as before.

Distribuisci in AzureDeploy to Azure

Per distribuire l'app, è possibile creare una nuova app Web in Azure e abilitare la distribuzione continua con un fork di questo repository GitHub.To deploy this app, you can create a new web app in Azure and enable continuous deployment with a fork of this github repo. Seguire questa esercitazione per configurare la distribuzione continua con GitHub in Azure.Follow this tutorial to set up continuous deployment with Github in Azure.

Quando si esegue la distribuzione in Azure, è consigliabile rimuovere le chiavi dell'applicazione e verificare che la sezione seguente non venga impostata come commento:When deploying to Azure, you should remove your application keys and make sure the section below is not commented out:

    client = MongoClient(os.getenv("MONGOURL"))
    db = client.test    #Select the database
    db.authenticate(name=os.getenv("MONGO_USERNAME"),password=os.getenv("MONGO_PASSWORD"))

È quindi necessario aggiungere gli elementi MONGOURL, MONGO_PASSWORD e MONGO_USERNAME alle impostazioni applicazione.You then need to add your MONGOURL, MONGO_PASSWORD, and MONGO_USERNAME to the application settings. È possibile seguire questa esercitazione per altre informazioni sulle impostazioni applicazione nelle app Web di Azure.You can follow this tutorial to learn more about Application Settings in Azure Web Apps.

Se non si vuole creare un fork di questo repository, è anche possibile fare clic sul pulsante Distribuisci in Azure sotto.If you don't want to create a fork of this repo, you can also click the deploy to Azure button below. Si passerà quindi ad Azure per configurare le impostazioni applicazione con le informazioni dell'account Cosmos DB.You should then go into Azure and set up the application settings with your Cosmos DB account info.

Nota

Se si prevede di archiviare il codice in GitHub o in altre opzioni di controllo del codice sorgente, assicurarsi di rimuovere dal codice le stringhe di connessione, che possono essere invece impostate con le impostazioni applicazione per l'app web.

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 resources

Se non si intende continuare a usare l'app, eliminare tutte le risorse create tramite questa guida di avvio rapido eseguendo i passaggi seguenti, per evitare qualsiasi addebito:If you're not going to continue to use this app, delete all resources created by this quickstart with the following steps so you don't incur any charges:

  1. Nel portale di Azure selezionare Gruppi di risorse all'estrema sinistra e quindi selezionare il gruppo di risorse creato.In the Azure portal, select Resource groups on the far left, and then select the resource group you created.

    Se il menu a sinistra è compresso, fare clic sulIf the left menu is collapsed, click pulsante Espandi per espanderlo.to expand it.

    Metriche nel portale di Azure

  2. Nella nuova finestra selezionare il gruppo di risorse e quindi fare clic su Elimina gruppo di risorse.In the new window select the resource group, and then click Delete resource group.

    Metriche nel portale di Azure

  3. Nella nuova finestra digitare il nome del gruppo di risorse da eliminare e quindi fare clic su Elimina.In the new window, type the name of the resource group to delete, and then click Delete.

Passaggi successiviNext steps

In questa guida introduttiva si è appreso come creare un account Azure Cosmos DB ed eseguire un'app Flask con l'API per MongoDB. È ora possibile importare dati aggiuntivi nell'account Cosmos DB.In this quickstart, you've learned how to create an Azure Cosmos DB account and run a Flask app using the API for MongoDB.You can now import additional data to your Cosmos DB account.