Démarrage rapide : utiliser Azure Cosmos DB pour NoSQL avec Azure SDK pour Python

Dans ce guide de démarrage rapide, vous déployez une application Azure Cosmos DB for Table de base à l’aide du SDK Azure pour Python. Azure Cosmos DB for Table est un magasin de données sans schéma qui permet aux applications de stocker des données de table structurées dans le cloud. Vous allez apprendre à créer des tables et des lignes, et à effectuer des tâches de base dans votre ressource Azure Cosmos DB à l’aide du kit SDK Azure pour Python.

Documentation de référence API | Code source de la bibliothèque | Package (PyPI) | Azure Developer CLI

Prérequis

• Azure Developer CLI
• Docker Desktop
• Python 3.12

Si vous ne disposez pas d’un compte Azure, créez-en un gratuitement avant de commencer.

Initialiser le projet

Utilisez l’interface Azure Developer CLI (azd) pour créer un compte Azure Cosmos DB for Table et déployer un exemple d’application conteneurisé. L’exemple d’application utilise la bibliothèque de client pour gérer, créer, lire et interroger des exemples de données.

1. Ouvrez un terminal dans un répertoire vide.

2. Si vous n’êtes pas encore authentifié, authentifiez-vous auprès d’Azure Developer CLI à l’aide de azd auth login. Suivez les étapes spécifiées par l’outil pour vous authentifier auprès de l’interface CLI à l’aide de vos informations d’identification Azure préférées.

   azd auth login
   

3. Utilisez azd init pour initialiser le projet.

   azd init --template cosmos-db-nosql-python-quickstart
   

4. Lors de l’initialisation, configurez un nom d’environnement unique.

5. Déployez le compte Azure Cosmos DB en utilisant azd up. Les modèles Bicep déploient également un exemple d’application web.

   azd up
   

6. Pendant le processus d’approvisionnement, sélectionnez votre abonnement, l’emplacement souhaité et le groupe de ressources cible. Attendez la fin du processus de provisionnement. Le processus peut prendre environ cinq minutes.

7. Une fois le provisionnement de vos ressources Azure effectué, une URL vers l’application web en cours d’exécution est incluse dans la sortie.

   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. Utilisez l’URL dans la console pour accéder à votre application web dans le navigateur. Observez la sortie de l’application en cours d’exécution.

Installer la bibliothèque de client

La bibliothèque de client est disponible via le module Python Package Index (PyPI), en tant que bibliothèque azure-cosmos.

1. Ouvrez un terminal, puis accédez au dossier /src.

   cd ./src
   

2. S’il n’est pas déjà installé, installez le package azure-cosmos à l’aide de pip install.

   pip install azure-cosmos
   

3. Installez également le package azure-identity, s’il n’est pas déjà installé.

   pip install azure-identity
   

4. Ouvrez et passez en revue le fichier src/requirements.txt pour vérifier que les entrées azure-cosmos et azure-identity existent.

Modèle objet

Exemples de code

• Authentifier le client
• Obtenir une base de données
• Obtenir un conteneur
• Créer un élément
• Obtenir un élément
• Éléments de requête

L’exemple de code du modèle utilise une base de données nommée cosmicworks et un conteneur nommé products. Le conteneur products contient des détails tels que le nom, la catégorie, la quantité, un identificateur unique et un indicateur de vente pour chaque produit. Le conteneur utilise la propriété /category en tant que clé de partition logique.

Authentifier le client

Cet exemple crée une instance du type CosmosClient, et l’authentifie à l’aide d’une instance de DefaultAzureCredential.

credential = DefaultAzureCredential()

client = CosmosClient(url="<azure-cosmos-db-nosql-account-endpoint>", credential=credential)

Obtenir une base de données

Utilisez client.get_database_client pour récupérer la base de données existante nommée cosmicworks.

database = client.get_database_client("cosmicworks")

Obtenir un conteneur

Récupérez le conteneur products existant à l’aide de database.get_container_client.

container = database.get_container_client("products")

Créer un élément

Créez un objet avec tous les membres à sérialiser au format JSON. Dans cet exemple, le type a un identificateur unique et des champs pour la catégorie, le nom, la quantité, le prix et la vente. Créez un élément dans le conteneur à l’aide de container.upsert_item. Cette méthode fait un « upsert » de l’élément en le remplaçant de manière effective s’il existe déjà.

new_item = {
    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "sale": False,
}

created_item = container.upsert_item(new_item)

Lire un élément

Effectuez une opération de lecture de point à l’aide des champs d’identificateur unique (id) et de clé de partition. Utilisez container.read_item pour récupérer efficacement l’élément spécifique.

existing_item = container.read_item(
    item="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

Éléments de requête

Effectuez une requête sur plusieurs éléments d’un conteneur à l’aide de container.GetItemQueryIterator. Recherchez tous les éléments d’une catégorie spécifique à l’aide de cette requête paramétrable :

SELECT * FROM products p WHERE p.category = @category

queryText = "SELECT * FROM products p WHERE p.category = @category"

results = container.query_items(
    query=queryText,
    parameters=[
        dict(
            name="@category",
            value="gear-surf-surfboards",
        )
    ],
    enable_cross_partition_query=False,
)

Parcourez les résultats de la requête dans une boucle.

items = [item for item in results]

output = json.dumps(items, indent=True)

Nettoyer les ressources

Lorsque vous n’avez plus besoin de l’exemple d’application ou de ressources, supprimez le déploiement correspondant et toutes les ressources.

azd down

Contenu connexe

• Démarrage rapide de .NET
• Démarrage rapide avec Node.js
• Démarrage rapide Java
• Démarrage rapide de Go