cosmos Paquet

Paquets

aio

Modules

auth

Fonctions d’assistance d’autorisation dans le service de base de données Azure Cosmos.

container

Créez, lisez, mettez à jour et supprimez des éléments dans le service d’API SQL Azure Cosmos DB.

cosmos_client

Créez, lisez et supprimez des bases de données dans le service d’API SQL Azure Cosmos DB.

database

Interagissez avec les bases de données dans le service d’API SQL Azure Cosmos DB.

diagnostics

Outils de diagnostic pour les opérations de service de base de données Azure Cosmos.

documents

Classes et enums pour les documents dans le service de base de données Azure Cosmos.

errors

Exceptions spécifiques au service dans le service de base de données Azure Cosmos.

.. avertissement : ce module est DÉCONSEILLÉ. Utilisez azure.cosmos.exceptions à la place.

exceptions

Exceptions spécifiques au service dans le service de base de données Azure Cosmos.

http_constants

Constantes HTTP dans le service de base de données Azure Cosmos.

offer

Créez des propriétés de débit dans le service d’API SQL Azure Cosmos DB.

partition_key

Créez des clés de partition dans le service d’API SQL Azure Cosmos DB.

permission

Créez des autorisations dans le service d’API SQL Azure Cosmos DB.

scripts

Créez, lisez, mettez à jour et supprimez et exécutez des scripts dans le service d’API SQL Azure Cosmos DB.

user

Créez, lisez, mettez à jour et supprimez des utilisateurs dans le service d’API SQL Azure Cosmos DB.

Classes

ConnectionRetryPolicy
ConsistencyLevel

Représente les niveaux de cohérence pris en charge pour les opérations du client Azure Cosmos.

Le consistencyLevel demandé doit correspondre ou être plus faible que celui provisionné pour le compte de base de données. Niveaux de cohérence.

Les niveaux de cohérence par ordre de force sont Strong, BoundedStaleness, Session, ConsistentPrefix et Eventual.

ContainerProxy

Interface permettant d’interagir avec un conteneur de base de données spécifique.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt la get_container_client méthode pour obtenir un conteneur existant ou la create_container méthode pour créer un conteneur.

Un conteneur dans une base de données d’API SQL Azure Cosmos DB est une collection de documents, chacun d’eux étant représenté sous la forme d’un élément.

CosmosClient

Représentation logique côté client d’un compte Azure Cosmos DB.

Utilisez ce client pour configurer et exécuter des demandes au service Azure Cosmos DB.

Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances.

L’initialisation de CosmosClient est une opération lourde : n’utilisez pas d’instances CosmosClient d’initialisation comme informations d’identification ou validations de connectivité réseau.

Instanciez un nouveau CosmosClient.

DataType

Spécifie le type de données des spécifications d’index.

DatabaseAccount

Compte de base de données.

Un DatabaseAccount est le conteneur pour les bases de données.

DatabaseProxy

Interface permettant d’interagir avec une base de données spécifique.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt la get_database_client méthode .

Une base de données contient un ou plusieurs conteneurs, chacun pouvant contenir des éléments, des procédures stockées, des déclencheurs et des fonctions définies par l’utilisateur.

Une base de données peut également avoir des utilisateurs associés, chacun étant configuré avec un ensemble d’autorisations pour accéder à certains conteneurs, procédures stockées, déclencheurs, fonctions définies par l’utilisateur ou éléments.

Une base de données d’API SQL Azure Cosmos DB possède les propriétés générées par le système suivantes. Ces propriétés sont en lecture seule :

  • _rid : ID de ressource.

  • _ts : date de la dernière mise à jour de la ressource. La valeur est un horodateur.

  • _self : URI adressable unique pour la ressource.

  • _etag : etag de ressource requis pour le contrôle d’accès concurrentiel optimiste.

  • _colls : chemin adressable de la ressource de collections.

  • _users : chemin adressable de la ressource users.

IndexKind

Spécifie le type d’index des spécifications d’index.

IndexingMode

Spécifie les modes d’indexation pris en charge.

PartitionKey

Clé utilisée pour partitionner un conteneur en partitions logiques.

Consultez https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey pour plus d’informations sur le choix des clés de partition.

Permission

Représente un objet Permission dans le service d’API SQL Azure Cosmos DB.

PermissionMode

Énumération spécifiant l’applicabilité d’une autorisation.

ProxyConfiguration

Configuration d’un proxy.

SSLConfiguration

Configuration des connexions SSL.

Consultez la rubrique https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification (éventuellement en anglais) pour plus d'informations.

ScriptsProxy

Interface permettant d’interagir avec les procédures stockées.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt l’attribut scripts .

ThroughputProperties

Représente les propriétés de débit dans un conteneur d’API SQL Azure Cosmos DB.

Pour lire et mettre à jour les propriétés de débit, utilisez les méthodes associées sur le <xref:Container>. Si vous configurez la mise à l’échelle automatique, auto_scale_max_throughput doit être défini et auto_scale_increment_percent pouvez également l’être conjointement. La valeur de offer_throughput ne sera pas autorisée à être définie conjointement avec les paramètres de mise à l’échelle automatique.

TriggerOperation

Spécifie les opérations sur lesquelles un déclencheur doit être exécuté.

TriggerType

Spécifie le type d’un déclencheur.

UserProxy

Interface permettant d’interagir avec un utilisateur spécifique.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt la get_user_client méthode .