Azure Cosmos DB for NoSQL : exemples Spring Data Azure Cosmos DB V5

  • Article

S’APPLIQUE À : NoSQL

Important

Ces notes de publication sont destinées à la version 5 de Spring Data Azure Cosmos DB. Vous trouverez les notes de publication de la version 3 ici et la version 2 ici.

Spring Data Azure Cosmos DB prend uniquement en charge l’API pour NoSQL.

Pour plus d’informations concernant Spring Data sur d’autres API d’Azure Cosmos DB, consultez les articles suivants :

Important

Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.

Vous pouvez essayer Azure Cosmos DB gratuitement sans abonnement Azure, et sans engagement requis. Vous pouvez également créer un compte de niveau gratuit Azure Cosmos DB qui propose gratuitement 1000 RU et 25 Go de stockage. Vous pouvez également utiliser l’émulateur Azure Cosmos DB avec l’URI https://localhost:8081. Pour obtenir la clé à utiliser avec l’émulateur, consultez Authentification des demandes.

Le référentiel GitHub azure-spring-boot-samples contient la dernière version des exemples d’applications qui exécutent des opérations CRUD, ainsi que d’autres opérations courantes sur les ressources Azure Cosmos DB. Cet article fournit :

  • Des liens vers les tâches dans chacun des exemples de fichiers de projet Spring Data Azure Cosmos DB.
  • Des liens vers le contenu de référence d’API connexe.

Composants requis

Pour exécuter cet exemple d’application, vous avez besoin de ce qui suit :

  • Kit de développement Java 8
  • Spring Data Azure Cosmos DB V5

Vous pouvez également utiliser Maven pour obtenir les tout derniers fichiers binaires Spring Data Azure Cosmos DB v3 et les utiliser dans votre projet. Maven ajoute automatiquement toutes les dépendances nécessaires. Sinon, vous pouvez directement télécharger les dépendances répertoriées dans le fichier pom.xml et les ajouter à votre chemin d’accès de build.

<dependency>
	<groupId>com.azure</groupId>
	<artifactId>azure-spring-data-cosmos</artifactId>
	<version>LATEST</version>
</dependency>

Exécution des exemples d'applications

Clonez l’exemple de référentiel :

$ git clone https://github.com/Azure-Samples/azure-spring-boot-samples

$ cd cosmos/azure-spring-data-cosmos/spring3-samples/cosmos-quickstart-samples

Vous pouvez exécuter les échantillons à l’aide d’un IDE (Eclipse, IntelliJ ou Visual Studio Code) ou à partir de la ligne de commande en utilisant Maven.

Dans application.properties, ces variables d’environnement doivent être définies

cosmos.uri=${ACCOUNT_HOST}
cosmos.key=${ACCOUNT_KEY}
cosmos.secondaryKey=${SECONDARY_ACCOUNT_KEY}

dynamic.collection.name=spel-property-collection
# Populate query metrics
cosmos.queryMetricsEnabled=true

afin d’accorder aux exemples un accès en lecture/écriture à votre compte, vos bases de données et vos conteneurs.

Votre IDE peut offrir la possibilité d’exécuter l’exemple de code Spring Data. Dans le cas contraire, vous pouvez utiliser la commande de terminal suivante pour exécuter l’exemple :

mvn spring-boot:run

Exemples de CRUD de document

Le fichier samples montre comment effectuer les tâches suivantes. Pour en savoir plus sur les documents Azure Cosmos DB avant d’exécuter les exemples suivants, consultez l’article conceptuel Utiliser des bases de données, des conteneurs et des éléments.

Tâche Informations de référence sur l'API
Créer un document CosmosRepository.save
Lire un document par identifiant CosmosRepository.derivedQueryMethod
Enregistrer tous les documents CosmosRepository.deleteAll

Exemples de méthodes de requête dérivées

Le fichier exemples montre comment effectuer les tâches suivantes. Pour en savoir plus sur les requêtes Azure Cosmos DB avant d’exécuter les exemples suivants, il peut s’avérer utile de lire l’article sur les méthodes de requête dérivées de Baeldung dans Spring.

| Rechercher des documents | CosmosRepository.derivedQueryMethod |

Exemples de requêtes personnalisées

Le fichier exemples indique comment effectuer les tâches suivantes à l’aide de la syntaxe de requête SQL. Pour en savoir plus sur les informations de référence sur les requêtes SQL dans Azure Cosmos DB avant d’exécuter les exemples suivants, consultez Exemples de requêtes SQL pour Azure Cosmos DB.

Tâche Informations de référence sur l'API
Rechercher tous les documents Annotation @Query
Demander une égalité à l’aide de == Annotation @Query
Demander une inégalité à l’aide des opérateurs != et NOT Annotation @Query
Soumettre des requêtes à l’aide d’opérateurs de plage comme >, <, >=, <= Annotation @Query
Interroger en utilisant des opérateurs de plage sur des chaînes Annotation @Query
Soumettre des requêtes avec la clause ORDER BY Annotation @Query
Requête avec DISTINCT Annotation @Query
Soumettre des requêtes avec des fonctions d’agrégation Annotation @Query
Utiliser des sous-documents Annotation @Query
Interroger avec des jointures à l’intérieur d’un document Annotation @Query
Effectuer des requêtes à l’aide d’opérateurs de chaîne, d’opérateurs mathématiques et d’opérateurs de tableau Annotation @Query

Étapes suivantes

Vous tentez d’effectuer une planification de la capacité pour une migration vers Azure Cosmos DB ? Vous pouvez utiliser les informations sur votre cluster de bases de données existant pour la planification de la capacité.