Démarrage rapide : Bibliothèque Azure Cosmos DB for NoSQL pour Python

Article
03/29/2024

S’APPLIQUE À : NoSQL

Bien démarrer avec la bibliothèque de client Azure Cosmos DB for NoSQL pour Python afin d’interroger des données dans vos conteneurs, et effectuer des opérations courantes sur des éléments individuels. Suivez ces étapes pour déployer une solution minimale sur votre environnement à l’aide de l’interface Azure Developer CLI.

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

Prérequis

Compte Azure avec un abonnement actif. Créez un compte gratuitement.
Compte GitHub

Compte Azure avec un abonnement actif. Créez un compte gratuitement.
Azure Developer CLI
Docker Desktop

Configuration

Déployez le conteneur de développement de ce projet sur votre environnement. Utilisez ensuite l’interface Azure Developer CLI (azd) pour créer un compte Azure Cosmos DB for NoSQL, 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.

Important

Les comptes GitHub incluent un droit d’utilisation relatif au stockage et aux heures cœur gratuites. Pour plus d’informations, consultez Stockage et heures cœur inclus pour les comptes GitHub.

Ouvrez un terminal dans le répertoire racine du projet.
Authentifiez-vous auprès de l’interface Azure Developer CLI en utilisant 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
```
Utilisez azd init pour initialiser le projet.
```
azd init
```
Lors de l’initialisation, configurez un nom d’environnement unique.

Conseil

Le nom de l’environnement sera également utilisé comme nom du groupe de ressources cible. Pour ce guide de démarrage rapide, utilisez msdocs-cosmos-db.
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
```
Pendant le processus d’approvisionnement, sélectionnez votre abonnement et l’emplacement souhaité. Attendez la fin du processus de provisionnement. Le processus peut prendre environ cinq minutes.

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.

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.

Ouvrez un terminal, puis accédez au dossier /src.
```
cd ./src
```
S’il n’est pas déjà installé, installez le package azure-cosmos à l’aide de pip install.
```
pip install azure-cosmos
```
Installez également le package azure-identity, s’il n’est pas déjà installé.
```
pip install azure-identity
```
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

Nom	Description
`CosmosClient`	Il s’agit de la classe cliente principale utilisée pour gérer les métadonnées ou les bases de données à l’échelle du compte.
`DatabaseProxy`	Cette classe représente une base de données dans le compte.
`ContainerProxy`	Cette classe est principalement utilisée pour effectuer des opérations de lecture, de mise à jour et de suppression sur le conteneur ou les éléments stockés dans le conteneur.
`PartitionKey`	Cette classe représente une clé de partition logique. Cette classe est nécessaire pour de nombreuses opérations et requêtes courantes.

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

Les requêtes d’application vers les Services Azure doivent être autorisées. Utilisez le type DefaultAzureCredential en tant que méthode privilégiée pour implémenter une connexion sans mot de passe entre vos applications et Azure Cosmos DB for NoSQL. DefaultAzureCredential prend en charge plusieurs méthodes d’authentification et détermine quelle méthode doit être utilisée au moment de l’exécution.

Important

Vous pouvez également autoriser directement les requêtes adressées aux services Azure à l’aide de mots de passe, de chaînes de connexion ou d’autres informations d’identification. Toutefois, cette approche doit être utilisée avec prudence. Les développeurs doivent être vigilants pour ne jamais exposer les secrets dans un emplacement non sécurisé. Toute personne ayant accès au mot de passe ou à la clé secrète peut s’authentifier auprès du service de base de données. DefaultAzureCredential offre des avantages améliorés aux niveaux de la gestion et de la sécurité par rapport à la clé de compte pour permettre une authentification sans mot de passe sans les risques liés au stockage des clés.

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

credential = DefaultAzureCredential()
client = CosmosClient(url=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": "70b63682-b93a-4c77-aad2-65501347265f",
    "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="70b63682-b93a-4c77-aad2-65501347265f",
    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)

Étape suivante

Package PyPI