Azure Cosmos DB: Creare un'app per le API SQL con Python e il portale di AzureAzure Cosmos DB: Build a SQL API app with Python and the Azure portal

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 mostra come creare un account API SQL, un database di documenti e una raccolta di Azure Cosmos DB usando il portale di Azure.This quick start demonstrates how to create an Azure Cosmos DB SQL API account, document database, and collection using the Azure portal. Quindi, si creerà ed eseguirà un'app console basata sull'API Python SQL.You then build and run a console app built on the SQL Python API.

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.È possibile provare Microsoft Azure Cosmos DB senza una sottoscrizione di Azure, gratuitamente e senza impegno.You can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments. In alternativa, è possibile usare l'Emulatore di Azure Cosmos DB con l'URI https://localhost:8081.Or, you can use the Azure Cosmos DB Emulator with a URI of https://localhost:8081. La chiave primaria viene fornita in Autenticazione delle richieste.The Primary Key is provided in Authenticating requests.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. È possibile provare Microsoft Azure Cosmos DB senza una sottoscrizione di Azure, gratuitamente e senza impegno.You can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments. In alternativa, è possibile usare l'Emulatore di Azure Cosmos DB con l'URI https://localhost:8081.Or, you can use the Azure Cosmos DB Emulator with a URI of https://localhost:8081. La chiave primaria viene fornita in Autenticazione delle richieste.The Primary Key is provided in Authenticating requests.

prerequisitiPrerequisites

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 Crea una risorsa > Database > Azure Cosmos DB.Click Create a resource > 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 ValoreValue 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 SQLSQL 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, 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 SQL perché in questa guida introduttiva si sta creando un database di documenti su cui è possibile eseguire query tramite la sintassi SQL e a cui è possibile accedere tramite l'API SQL.Select SQL because in this quickstart you are creating a document database that is queryable using SQL syntax and accessible with the SQL API.

    Altre informazioni sull'API SQLLearn more about the SQL 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 Creare un nuovo gruppo di risorseCreate new

    Immettere quindi lo stesso nome univoco specificato sopra in IDThen enter the same unique name as provided above in ID
    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.
    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.

    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 è stato creato.Wait for the portal to display the Congratulations! Your Azure Cosmos DB account was created page.

    Riquadro Notifiche del portale di Azure

Aggiungere una raccoltaAdd a collection

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

  1. Fare clic su Esplora dati > Nuova raccolta.Click Data Explorer > New Collection.

    A destra verrà visualizzata l'area Aggiungi raccolta. Per vederla potrebbe essere necessario scorrere verso destra.The Add Collection area is displayed on the far right, you may need to scroll right to see it.

    Esplora dati nel portale di Azure: pannello Aggiungi raccolta

  2. Nella pagina Aggiungi raccolta immettere le impostazioni per la nuova raccolta.In the Add collection page, enter the settings for the new collection.

    ImpostazioneSetting Valore consigliatoSuggested value DESCRIZIONEDescription
    ID databaseDatabase id AttivitàTasks Immettere Tasks come nome del nuovo database.Enter Tasks 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 contain from 1 through 255 characters, and they cannot contain /, \, #, ?, or a trailing space.
    ID raccoltaCollection id ItemsItems Immettere Items come nome della nuova raccolta.Enter Items as the name for your new collection. Gli ID delle raccolte prevedono gli stessi requisiti relativi ai caratteri dei nomi di database.Collection ids have the same character requirements as database names.
    Capacità di archiviazioneStorage capacity Fissa (10 GB)Fixed (10 GB) Usare il valore predefinito Fissa (10 GB).Use the default value of Fixed (10 GB). Questo valore indica la capacità di archiviazione del database.This value is the storage capacity of the database.
    Velocità effettivaThroughput 400 UR400 RU Modificare la velocità effettiva in 400 unità richiesta al secondo (UR/sec).Change the throughput to 400 request units per second (RU/s). La capacità di archiviazione deve essere impostata su Fisso (10 GB) per impostare la velocità effettiva su 400 UR/sec.Storage capacity must be set to Fixed (10 GB) in order to set throughput to 400 RU/s. Se si vuole ridurre la latenza, è possibile aumentare la velocità effettiva in un secondo momento.If you want to reduce latency, you can scale up the throughput later.

    Oltre alle impostazioni precedenti, è possibile aggiungere Chiavi univoche per la raccolta.In addition to the preceding settings, you can optionally add Unique keys for the collection. In questo esempio il campo viene lasciato vuoto.Let's leave the field empty in this example. Le chiavi univoche consentono agli sviluppatori di aggiungere un livello di integrità dei dati nel database.Unique keys provide developers with the ability to add a layer of data integrity to the database. Se si definiscono criteri di chiave univoca durante la creazione di una raccolta, si ha la sicurezza che uno o più valori siano univoci per ogni chiave di partizione.By creating a unique key policy while creating a collection, you ensure the uniqueness of one or more values per partition key. Per altre informazioni, vedere l'articolo Chiavi univoche in Azure Cosmos DB.To learn more, refer to the Unique keys in Azure Cosmos DB article.

    Fare clic su OK.Click OK.

    In Esplora dati verranno visualizzati il nuovo database e la nuova raccolta.Data Explorer displays the new database and collection.

    Esplora dati nel portale di Azure, con il nuovo database e la nuova raccolta

Aggiungere dati di esempioAdd sample data

È ora possibile aggiungere dati alla nuova raccolta usando Esplora dati.You can now add data to your new collection using Data Explorer.

  1. In Esplora dati il nuovo database viene visualizzato nel riquadro Raccolte.In Data Explorer, the new database appears in the Collections pane. Espandere il database Tasks, espandere la raccolta Items, fare clic su Documenti e quindi su Nuovo documento.Expand the Tasks database, expand the Items collection, click Documents, and then click New Documents.

    Creare nuovi documenti in Esplora dati nel portale di Azure

  2. Aggiungere ora un documento alla raccolta con la struttura seguente.Now add a document to the collection with the following structure.

    {
        "id": "1",
        "category": "personal",
        "name": "groceries",
        "description": "Pick up apples and strawberries.",
        "isComplete": false
    }
    
  3. Dopo avere aggiunto il codice JSON alla scheda Documenti, fare clic su Salva.Once you've added the json to the Documents tab, click Save.

    Copiare i dati JSON e fare clic su Salva in Esplora dati nel portale di Azure

  4. Creare e salvare un altro documento inserendo un valore univoco per la proprietà id e modificando le altre proprietà come si preferisce.Create and save one more document where you insert a unique value for the id property, and change the other properties as you see fit. I nuovi documenti possono avere la struttura desiderata, perché Azure Cosmos DB non impone alcuno schema per i dati.Your new documents can have any structure you want as Azure Cosmos DB doesn't impose any schema on your data.

Eseguire query sui datiQuery your data

È ora possibile usare le query in Esplora dati per recuperare e filtrare i dati.You can now use queries in Data Explorer to retrieve and filter your data.

  1. Per impostazione predefinita, la query è impostata su SELECT * FROM c.See that by default, the query is set to SELECT * FROM c. La query predefinita recupera e visualizza tutti i documenti nella raccolta.This default query retrieves and displays all documents in the collection.

    La query predefinita in Esplora dati è 'SELECT * FROM c'

  2. Restare nella scheda Documenti e modificare la query facendo clic sul pulsante Modifica filtro, aggiungendo ORDER BY c._ts DESC nella casella del predicato della query e quindi facendo clic su Applica filtro.Stay on the Documents tab, and change the query by clicking the Edit Filter button, adding ORDER BY c._ts DESC to the query predicate box, and then clicking Apply Filter.

    Modificare la query predefinita aggiungendo ORDER BY c._ts DESC e facendo clic su Applica filtro.

La query modificata elenca i documenti in ordine decrescente in base al timestamp, pertanto il secondo documento creato appare ora in cima all'elenco.This modified query lists the documents in descending order based on their time stamp, so now your second document is listed first. Se si ha familiarità con la sintassi SQL, è possibile immettere in questa casella una qualsiasi delle query SQL supportate.If you're familiar with SQL syntax, you can enter any of the supported SQL queries in this box.

Con questa azione si completa il lavoro in Esplora dati.That completes our work in Data Explorer. Prima di passare all'uso del codice, si noti che è possibile usare Esplora dati anche per creare stored procedure, UDF e trigger per eseguire la logica di business lato server, nonché scalare la velocità effettiva.Before we move on to working with code, note that you can also use Data Explorer to create stored procedures, UDFs, and triggers to perform server-side business logic as well as scale throughput. Esplora dati espone tutti i tipi di accesso ai dati a livello di codice predefiniti disponibili nelle API, ma consente anche di accedere facilmente ai dati nel portale di Azure.Data Explorer exposes all of the built-in programmatic data access available in the APIs, but provides easy access to your data in the Azure portal.

Clonare l'applicazione di esempioClone the sample application

Clonare ora un'app per le API SQL da GitHub, impostare la stringa di connessione ed eseguirla.Now let's clone a SQL 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/azure-cosmos-db-documentdb-python-getting-started.git
    

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. In alternativa, è possibile passare ad Aggiornare la stringa di connessione.Otherwise, you can skip ahead to Update your connection string.

Tutti i frammenti di codice seguenti sono tratti dal file DocumentDBGetStarted.py.The following snippets are all taken from the DocumentDBGetStarted.py file.

  • Viene inizializzato DocumentClient.The DocumentClient is initialized.

    # Initialize the Python client
    client = document_client.DocumentClient(config['ENDPOINT'], {'masterKey': config['MASTERKEY']})
    
  • Viene creato un nuovo database.A new database is created.

    # Create a database
    db = client.CreateDatabase({ 'id': config['SQL_DATABASE'] })
    
  • Viene creata una nuova raccolta.A new collection is created.

    # Create collection options
    options = {
        'offerEnableRUPerMinuteThroughput': True,
        'offerVersion': "V2",
        'offerThroughput': 400
    }
    
    # Create a collection
    collection = client.CreateCollection(db['_self'], { 'id': config['SQL_COLLECTION'] }, options)
    
  • Vengono creati alcuni documenti.Some documents are created.

    # Create some documents
    document1 = client.CreateDocument(collection['_self'],
        { 
            'id': 'server1',
            'Web Site': 0,
            'Cloud Service': 0,
            'Virtual Machine': 0,
            'name': 'some' 
        })
    
  • Viene eseguita una query con SQLA query is performed using SQL

    # Query them in SQL
    query = { 'query': 'SELECT * FROM server s' }    
    
    options = {} 
    options['enableCrossPartitionQuery'] = True
    options['maxItemCount'] = 2
    
    result_iterable = client.QueryDocuments(collection['_self'], query, options)
    results = list(result_iterable);
    
    print(results)
    

Aggiornare la stringa di connessioneUpdate your connection string

Tornare ora al portale di Azure per recuperare le informazioni sulla stringa di connessione e copiarle nell'app.Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. Nell'account Azure Cosmos DB nel portale di Azure nel riquadro di spostamento a sinistra fare clic su Chiavi.In the Azure portal, in your Azure Cosmos DB account, in the left navigation click Keys. Usare i pulsanti di copia sul lato destro dello schermo per copiare l'URI e la chiave primaria nel file DocumentDBGetStarted.py nel passaggio seguente.You'll use the copy buttons on the right side of the screen to copy the URI and Primary Key into the DocumentDBGetStarted.py file in the next step.

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

  2. Aprire il file C:\git-samples\azure-cosmos-db-documentdb-python-getting-startedDocumentDBGetStarted.py in Visual Studio Code.Open the C:\git-samples\azure-cosmos-db-documentdb-python-getting-startedDocumentDBGetStarted.py file in Visual Studio code.

  3. Copiare il valore di URI dal portale (usando il pulsante di copia) e impostarlo come valore della chiave di endpoint in DocumentDBGetStarted.py.Copy your URI value from the portal (using the copy button) and make it the value of the endpoint key in DocumentDBGetStarted.py.

    'ENDPOINT': 'https://FILLME.documents.azure.com',

  4. Copiare quindi il valore di CHIAVE PRIMARIA dal portale e impostarlo come valore di config.MASTERKEY in DocumentDBGetStarted.py.Then copy your PRIMARY KEY value from the portal and make it the value of the config.MASTERKEY in DocumentDBGetStarted.py. 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.

    'MASTERKEY': 'FILLME',

  5. Salvare il file DocumentDBGetStarted.py.Save the DocumentDBGetStarted.py file.

Esecuzione dell'appRun the app

  1. In Visual Studio Code selezionare Visualizza>Riquadro comandi.In Visual Studio Code, select View>Command Palette.

  2. Al prompt dei comandi immettere Python: Select Interpreter e quindi selezionare la versione di Python da usare.At the prompt, enter Python: Select Interpreter and then select the version of Python to use.

    Il piè di pagina in Visual Studio Code viene aggiornato per indicare l'interprete selezionato.The Footer in Visual Studio Code is updated to indicate the interpreter selected.

  3. Selezionare Visualizza > Terminale integrato per aprire il terminale integrato di Visual Studio Code.Select View > Integrated Terminal to open the Visual Studio SCode integrated terminal.

  4. Nella finestra del terminale integrato verificare di essere in esecuzione nella cartella azure-cosmos-db-documentdb-python-getting-started.In the integrated terminal window, ensure you're in the run the azure-cosmos-db-documentdb-python-getting-started folder. In caso contrario, eseguire il comando seguente per passare alla cartella di esempio.If not, run the following command to switch to the sample folder.

    cd "C:\git-samples\azure-cosmos-db-documentdb-python-getting-started"`
    
  5. Eseguire il comando seguente per installare il pacchetto pydocumentdb.Run the following command to install the pydocumentdb package.

    pip3 install pydocumentdb
    

    Se si riceve un errore di accesso negato durante il tentativo di installazione di pydocumentdb, sarà necessario eseguire VS Code come amministratore.If you get an error about access being denied when attempting to install pydocumentdb, you'll need to run VS Code as an administrator.

  6. Eseguire il comando seguente per eseguire l'esempio e creare e archiviare nuovi documenti in Azure Cosmos DB.Run the following command to run the sample and create and store new documents in Azure Cosmos dB.

    python DocumentDBGetStarted.py
    
  7. Per verificare che i nuovi documenti siano stati creati e salvati, nel portale di Azure selezionare Esplora dati, espandere coll, espandere Documenti e quindi selezionare il documento server1.To confirm the new documents were created and saved, in the Azure portal, select Data Explorer, expand coll, expand Documents, and then select the server1 document. Il contenuto del documento server1 corrisponde al contenuto restituito nella finestra del terminale integrato.The server1 document contents match the content returned in the integrated terminal window.

    Visualizzare i nuovi documenti nel portale di Azure

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 di avvio rapido si è appreso come creare un account Azure Cosmos DB, come creare una raccolta con Esplora dati e come eseguire un'app.In this quickstart, you've learned how to create an Azure Cosmos DB account, create a collection using the Data Explorer, and run an app. È ora possibile importare dati aggiuntivi nell'account Cosmos DB.You can now import additional data to your Cosmos DB account.