Partager via

@azure/cosmos package

  • Référence

Classes

AbortError

Cette erreur est levée lorsqu’une opération asynchrone a été abandonnée. Vérifiez cette erreur en testant l'name que la propriété name de l’erreur correspond à "AbortError".

Exemple

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
ChangeFeedIterator

Fournit un itérateur pour le flux de modification.

Utilisez Items.changeFeed() pour obtenir une instance de l’itérateur.
ChangeFeedIteratorResponse

Page de réponse unique du flux de modification Azure Cosmos DB
ChangeFeedPolicy

Représente la configuration de la stratégie de flux de modification pour un conteneur dans le service Azure Cosmos DB.
ChangeFeedResponse

Page de réponse unique du flux de modification Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Classe de base pour l’emplacement de démarrage d’un ChangeFeedIterator.
ClientSideMetrics
Conflict

Permet de lire ou de supprimer un conflit donné par ID.

Consultez conflits pour interroger ou lire tous les conflits.
ConflictResponse
Conflicts

Permet d’interroger ou de lire tous les conflits.

Consultez conflit pour lire ou supprimer un conflit donné par ID.
Container

Opérations de lecture, de remplacement ou de suppression d’un conteneur spécifique existant par ID.

Consultez conteneurs pour créer de nouveaux conteneurs et lire/interroger tous les conteneurs ; utilisez .containers.

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système afin que ces appels soient mis à l’échelle sous-linéairement avec votre application. Par exemple, n’appelez pas container(id).read() avant chaque appel de item.read() unique, pour vous assurer que le conteneur existe ; effectuez cette opération une fois sur le démarrage de l’application.
ContainerResponse

Objet Response pour les opérations de conteneur
Containers

Opérations de création de nouveaux conteneurs et lecture/interrogation de tous les conteneurs

Consultez conteneur pour la lecture, le remplacement ou la suppression d’un conteneur existant ; utilisez .container(id).

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système afin que ces appels soient mis à l’échelle sous-linéairement avec votre application. Par exemple, n’appelez pas containers.readAll() avant chaque appel de item.read() unique, pour vous assurer que le conteneur existe ; effectuez cette opération une fois sur le démarrage de l’application.
CosmosClient

Fournit une représentation logique côté client du compte de base de données Azure Cosmos DB. Ce client est utilisé pour configurer et exécuter des requêtes dans le service de base de données Azure Cosmos DB.

Exemple

Instancier un client et créer une base de données

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

Exemple

Instancier un client avec une stratégie de connexion personnalisée

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});
CosmosDiagnostics
  • Il s’agit d’un type de diagnostic Cosmos qui contient les informations de diagnostic collectées pendant les opérations du client. Ie. Item.read(), Container.create(). Il a trois membres -
  1. clientSideRequestStatistics membre contient des informations de diagnostic agrégées, notamment :
  • recherches de métadonnées. Ici, toutes les demandes de serveur, en dehors de la ressource finale prévue sont considérées comme des appels de métadonnées. Par exemple, pour item.read(id), si le client effectue un appel de serveur pour découvrir les points de terminaison, il serait considéré comme un appel de métadonnées.
  • Tentatives
  • points de terminaison contactés.
  • statistiques de la charge utile de la requête, de la réponse.
  • gatewayStatistics : informations correspondant à l’opération principale. Par exemple, pendant Item.read(), le client peut effectuer de nombreuses opérations, c’est-à-dire la recherche de métadonnées, etc. mais gatewayStatistics représente les informations de diagnostic pour l’opération de lecture réelle.
  1. diagnosticNode : arborescence semblable à une structure qui capture des informations de diagnostic détaillées. Par défaut, il est désactivé et est destiné à être utilisé uniquement pour le débogage sur des environnements non de production. Le type de détails capturés dans diagnosticNode est contrôlé par CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info : valeur par défaut. Dans ce niveau, seuls clientSideRequestStatistics sont capturés. Est destiné aux environnements de production.
  • CosmosDbDiagnosticLevel.debug - Captures diagnosticNode et clientConfig. Aucune charge utile de requête et de réponse n’est capturée. N’est pas destiné à être utilisé dans l’environnement de production.
  • CosmosDbDiagnosticLevel.debug-unsafe : en plus des données capturées dans CosmosDbDiagnosticLevel.debug, capture également les charges utiles de requête et de réponse. N’est pas destiné à être utilisé dans l’environnement de production.
  1. clientConfig : capture des informations relatives à la façon dont le client a été configuré lors de l’initialisation.
Database

Opérations de lecture ou de suppression d’une base de données existante.

Consultez bases de données pour créer de nouvelles bases de données et lire/interroger toutes les bases de données ; utilisez client.databases.

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système afin que ces appels soient mis à l’échelle sous-linéairement avec votre application. Par exemple, n’appelez pas database.read() avant chaque appel de item.read() unique, pour vous assurer que la base de données existe ; effectuez cette opération une fois sur le démarrage de l’application.
DatabaseAccount

Représente un DatabaseAccount dans le service de base de données Azure Cosmos DB.
DatabaseResponse

Objet Response pour les opérations de base de données
Databases

Opérations de création de bases de données et lecture/interrogation de toutes les bases de données

Consultez base de données pour lire ou supprimer une base de données existante ; utilisez client.database(id).

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système afin que ces appels soient mis à l’échelle sous-linéairement avec votre application. Par exemple, n’appelez pas databases.readAll() avant chaque appel de item.read() unique, pour vous assurer que la base de données existe ; effectuez cette opération une fois sur le démarrage de l’application.
ErrorResponse
FeedRange

Spécifie une plage de flux pour le flux de modification.
FeedResponse
Item

Permet d’effectuer des opérations sur un élément spécifique.

Consultez éléments pour les opérations sur tous les éléments ; voir container.items.
ItemResponse
Items

Opérations de création d’éléments et lecture/interrogation de tous les éléments

Consultez d’élément pour la lecture, le remplacement ou la suppression d’un conteneur existant ; utilisez .item(id).
Offer

Permet de lire ou de remplacer une offre existante par ID.

Consultez offres pour interroger ou lire toutes les offres.
OfferResponse
Offers

Permet d’interroger ou de lire toutes les offres.

Consultez d’offre pour lire ou remplacer un d’offre existant par ID.
PartitionKeyBuilder

Classe Builder pour la génération de PartitionKey.
Permission

Permet de lire, remplacer ou supprimer un autorisation donné par ID.

Consultez autorisations pour créer, upsert, interroger ou lire toutes les autorisations.
PermissionResponse
Permissions

Permet de créer, remplacer, interroger et lire toutes les autorisations.

Consultez d’autorisation pour lire, remplacer ou supprimer une autorisation spécifique par ID.
QueryIterator

Représente un objet QueryIterator, une implémentation de flux ou de réponse de requête qui permet une traversée et une itération sur la réponse dans le service de base de données Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Opérations de lecture, de remplacement, de suppression ou d’exécution d’une procédure stockée existante spécifique par ID.

Pour que les opérations créent, lisent toutes ou interrogent des procédures stockées,
StoredProcedureResponse
StoredProcedures

Opérations de création, d’upserting ou de lecture/interrogation de toutes les procédures stockées.

Pour que les opérations de lecture, de remplacement, de suppression ou d’exécution d’une procédure stockée spécifique, existante par ID, voir container.storedProcedure().
TimeoutError
Trigger

Opérations de lecture, de remplacement ou de suppression d’un déclencheur .

Utilisez container.triggers pour créer, upsert, interroger ou lire tout.
TriggerResponse
Triggers

Opérations de création, upsert, requête et lecture de tous les déclencheurs.

Utilisez pour lire, remplacer ou supprimer undéclencheur .
User

Utilisé pour lire, remplacer et supprimer des utilisateurs.

En outre, vous pouvez accéder aux autorisations d’un utilisateur donné via user.permission et user.permissions.

Consultez Utilisateurs pour créer, upsert, interroger ou lire tout.
UserDefinedFunction

Utilisé pour lire, remplacer ou supprimer une fonction définie par id.

Consultez UserDefinedFunction pour créer, upsert, interroger, lire toutes les fonctions définies par l’utilisateur.
UserDefinedFunctionResponse
UserDefinedFunctions

Utilisé pour créer, upsert, interroger ou lire toutes les fonctions définies par l’utilisateur.

Consultez UserDefinedFunction pour lire, remplacer ou supprimer une fonction définie par l’utilisateur donnée par ID.
UserResponse
Users

Utilisé pour créer, upsert, interroger et lire tous les utilisateurs.

Consultez 'utilisateur pour lire, remplacer ou supprimer un utilisateur spécifique par ID.

Interfaces

@azure/cosmos.Index
Agent
BulkOptions

Objet Options utilisé pour modifier l’exécution en bloc. continueOnError (valeur par défaut : false) : poursuit l’exécution en bloc lorsqu’une opération échoue ** REMARQUE QUE LA valeur PAR DÉFAUT EST TRUE DANS la version 4.0 RELEASE
ChangeFeedIteratorOptions

Spécifie les options du flux de modification

Si aucune de ces options n’est définie, elle commence à lire les modifications à partir de maintenant pour l’ensemble du conteneur.
ChangeFeedOptions

Spécifie les options du flux de modification

Certaines de ces options contrôlent où et quand commencer la lecture à partir du flux de modification. L’ordre de priorité est le suivant :

  • continuation
  • startTime
  • startFromBeginning

Si aucune de ces options n’est définie, elle commence à lire les modifications de la première ChangeFeedIterator.fetchNext() appel.
ChangeFeedPullModelIterator

Utilisez Items.getChangeFeedIterator() pour retourner un itérateur qui peut itérer sur toutes les modifications d’une clé de partition, d’une plage de flux ou d’un conteneur entier.
CompositePath

Représente un chemin composite dans la stratégie d’indexation.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

Représente la configuration de la stratégie de résolution des conflits pour spécifier comment résoudre les conflits au cas où les écritures à partir de différentes régions entraînent des conflits sur les documents de la collection dans le service Azure Cosmos DB.
ConnectionPolicy

Représente la stratégie de connexion associée à un CosmosClient dans le service de base de données Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Représente une arborescence telle que la structure, pour capturer les informations de diagnostic.
ErrorBody
FailedRequestAttemptDiagnostic

Ce type capture les informations de diagnostic relatives à une requête ayant échoué à l’API serveur.
FeedOptions

Options de flux et méthodes de requête.
FullTextIndex

Représente un index de texte intégral dans la stratégie d’indexation.
FullTextPath

Représente un chemin de texte intégral à indexer dans le service Azure Cosmos DB.
FullTextPolicy

Représente une stratégie de texte intégral pour une collection dans le service Azure Cosmos DB.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Les éléments dans Cosmos DB sont simplement des objets JSON. La plupart des opérations Item permettent à vous de fournir votre propre type qui étend la très simple ItemDefinition.

Vous ne pouvez pas utiliser de clés réservées. Vous pouvez voir la liste des clés réservées dans <xref:ItemBody>
JSONArray
JSONObject
Location

Utilisé pour spécifier les emplacements disponibles, la lecture est l’index 1 et l’écriture est l’index 0.
MetadataLookUpDiagnostic

Ce type contient des informations de diagnostic concernant une demande de métadonnées unique au serveur.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=
Resource
RetryOptions

Représente la stratégie de nouvelle tentative assocée avec des requêtes limitées dans le service de base de données Azure Cosmos DB.
SharedOptions

Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=
SpatialIndex
SqlParameter

Représente un paramètre dans une requête SQL paramétrable, spécifiée dans SqlQuerySpec
SqlQuerySpec

Représente une requête SQL dans le service Azure Cosmos DB.

Les requêtes avec entrées doivent être paramétrées pour se protéger contre l’injection SQL.

Exemple

Requête SQL paramétrée

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

Interface pour une clé unique passée dans le cadre de UniqueKeyPolicy
UniqueKeyPolicy

Interface permettant de définir des clés uniques lors de la création d’un conteneur
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

Représente un incorporation vectorielle. Une incorporation de vecteurs est utilisée pour définir un champ vectoriel dans les documents.
VectorEmbeddingPolicy

Représente la configuration de stratégie pour les incorporations vectorielles dans le service Azure Cosmos DB.
VectorIndex

Représente un index vectoriel dans le service Azure Cosmos DB. Un index vectoriel est utilisé pour indexer des champs vectoriels dans les documents.

Alias de type

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Ce type contient des informations relatives à l’initialisation de CosmosClient
ClientSideRequestStatistics

Il s’agit d’un type de collection pour toutes les informations de diagnostic côté client.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Ce type contient des informations de diagnostic concernant toutes les requêtes de métadonnées adressées au serveur pendant une opération cliente CosmosDB.
NonePartitionKeyType

L’objet retourné représente une valeur de clé de partition qui permet de créer et d’accéder aux éléments sans valeur pour la clé de partition
NullPartitionKeyType

L’objet retourné représente une valeur de clé de partition qui permet de créer et d’accéder aux éléments avec une valeur Null pour la clé de partition.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey d’un conteneur.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Valeur de clé de partition primitive.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Ce type capture les informations de diagnostic relatives aux nouvelles tentatives lors d’une opération cliente CosmosDB.
TokenProvider
UpsertOperation

Énumérations

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

Détermine le comportement de connexion du CosmosClient. Notez que nous prenons uniquement en charge le mode passerelle.
ConsistencyLevel

Représente les niveaux de cohérence pris en charge pour les opérations du client Azure Cosmos DB.
La valeur ConsistencyLevel demandée doit correspondre ou être plus faible que celle configurée pour le compte de base de données. Niveaux de cohérence.

Les niveaux de cohérence par ordre de force sont Forts, BoundedStaleness, Session, Préfixe cohérent et Final.

Consultez https://aka.ms/cosmos-consistency pour obtenir une documentation plus détaillée sur les niveaux de cohérence.
CosmosDbDiagnosticLevel

Niveau de diagnostic Cosmos DB
DataType

Définit un type de données cible d’une spécification de chemin d’index dans le service Azure Cosmos DB.
GeospatialType
IndexKind

Spécifie les types d’index pris en charge.
IndexingMode

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

Il s’agit de l’énumération pour le type de recherche de métadonnées possible.
PartitionKeyDefinitionVersion

Version de la définition partitionKey
PartitionKeyKind

Type de PartitionKey, c’est-à-dire hachage, MultiHash
PermissionMode

Énumération pour les valeurs du mode d’autorisation.
PriorityLevel

Représente le niveau de priorité associé à chaque demande de client Azure Cosmos DB.
Les requêtes de faible priorité sont toujours limitées avant toutes les demandes de priorité élevée.

Par défaut, toutes les requêtes sont considérées comme des requêtes de priorité élevée.

Consultez https://aka.ms/CosmosDB/PriorityBasedExecution pour obtenir une documentation plus détaillée sur la limitation basée sur la priorité.
SpatialType
TriggerOperation

Énumération pour les valeurs d’opération de déclencheur. spécifie les opérations sur lesquelles un déclencheur doit être exécuté.
TriggerType

Énumération pour les valeurs de type de déclencheur. Spécifie le type du déclencheur.
UserDefinedFunctionType

Énumération pour les valeurs de type udf. Spécifie les types de fonctions définies par l’utilisateur.
VectorEmbeddingDataType

Représente le type de données du vecteur.
VectorEmbeddingDistanceFunction

Représente la fonction de distance à utiliser pour le calcul de distance entre les vecteurs.
VectorIndexType

Représente le type d’index du vecteur.

Functions

createAuthorizationSasToken(string, SasTokenProperties)

L’interne expérimental génère uniquement la charge utile représentant la configuration d’autorisation pour le jeton sas.

Informations relatives à la fonction

createAuthorizationSasToken(string, SasTokenProperties)

L’interne expérimental génère uniquement la charge utile représentant la configuration d’autorisation pour le jeton sas.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Paramètres

masterKey

string

sasTokenProperties
SasTokenProperties

Retours

Promise<string>