Partager via

Exemples spécifiques au kit SDK Azure Cosmos DB for NoSQL pour JS

  • Article

S’APPLIQUE À : NoSQL

Le dépôt GitHub du kit de développement logiciel (SDK) JavaScript pour Azure Cosmos DB contient des exemples de solutions qui exécutent des opérations CRUD, ainsi que d’autres opérations courantes sur des ressources Azure Cosmos DB. Cet article fournit :

  • Des liens vers les tâches dans chacun des exemples de fichiers de projet Node.js.
  • Des liens vers le contenu de référence d’API connexe.

Prérequis

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.

Vous avez également besoin du Kit de développement logiciel (SDK) JavaScript.

Notes

Chaque exemple est autonome, se définit lui-même et se nettoie automatiquement. Les exemples transmettent donc plusieurs appels à Containers.create. À chaque appel, votre abonnement sera facturé pour 1 heure d’utilisation selon le niveau de performances du conteneur en cours de création.

Exemples de base de données

Le fichier DatabaseManagement montre comment effectuer les opérations CRUD sur la base de données. Pour en savoir plus sur les bases de données 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 une base de données si elle n’existe pas Databases.createIfNotExists
Répertorier les bases de données pour un compte Databases.readAll
Lire une base de données par identifiant Database.read
Supprimer une base de données Database.delete

Exemples de conteneur

Le fichier ContainerManagement montre comment effectuer les opérations CRUD sur le conteneur. Pour en savoir plus sur les collections 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 conteneur s’il n’existe pas Containers.createIfNotExists
Liste les conteneurs d’un compte Containers.readAll
Lire une définition de conteneur Container.read
Supprimer un conteneur Container.delete

Exemples d’éléments

Le fichier ItemManagement montre comment effectuer les opérations CRUD sur l’élément. 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 des éléments Items.create
Lire tous les éléments figurant dans un conteneur Items.readAll
Lire un élément par identifiant Item.read
Lire un élément uniquement si l’élément a été modifié Item.read - RequestOptions.accessCondition
Rechercher des documents Items.query
Remplacer un élément Item.replace
Remplacer l’élément par la vérification conditionnelle ETag Item.replace - RequestOptions.accessCondition
Supprimer un élément Item.delete

Exemples d'indexation

Le fichier IndexManagement montre comment gérer l’indexation. Pour en savoir plus sur l’indexation dans Azure Cosmos DB avant d’exécuter les exemples suivants, consultez les articles conceptuels sur les stratégies d’indexation, les types d’indexation et les chemins d’indexation.

Tâche Informations de référence sur l'API
Indexer manuellement un élément spécifique RequestOptions.indexingDirective: 'include'
Exclure manuellement un élément spécifique de l’index RequestOptions.indexingDirective: 'exclude'
Exclure un chemin de l’index IndexingPolicy.ExcludedPath
Créer un index de plage sur un chemin d’accès de la chaîne IndexKind.Range, IndexingPolicy, Items.query
Créer un conteneur avec le indexPolicy par défaut, puis mettre à jour le conteneur en ligne Containers.create

Exemples de programmation côté serveur

Le fichier index.ts montre comment effectuer les tâches suivantes. Pour en savoir plus sur la programmation côté serveur dans Azure Cosmos DB avant d’exécuter les exemples suivants, consultez l’article conceptuel Procédures stockées, déclencheurs et fonctions définies par l’utilisateur.

Tâche Informations de référence sur l'API
Créer une procédure stockée StoredProcedures.create
Exécuter une procédure stockée StoredProcedure.execute
Mise à jour en bloc avec une procédure stockée StoredProcedure.execute

Pour plus d’informations sur la programmation côté serveur, consultez Azure Cosmos DB server-side programming: Stored procedures, database triggers, and UDFs (Programmation Azure Cosmos DB côté serveur : Procédures stockées, déclencheurs de base de données et fonctions définies par l’utilisateur).

Exemples d’authentification Azure Identity (AAD)

Le fichier AADAuth.ts montre comment effectuer les tâches suivantes.

Tâche Informations de référence sur l'API
Create credential object from @azure/identity API
Passer des informations d’identification à l’objet client avec une clé aadCredentials API
Exécuter un client Cosmos avec des informations d’identification aad API

Exemples divers

Les exemples organisés suivants illustrent des cas courants.

Tâche Informations de référence sur l'API
Modifier un débit de requête API
Obtention d’un débit de requête API
Utilisation de SasTokens pour accorder un accès étendu aux ressources Cosmos DB API

É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é.