CosmosClient class

Paquet:

@azure/cosmos

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 de

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 de

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

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

Constructeurs

CosmosClient(CosmosClientOptions)	Crée un objet CosmosClient. Consultez CosmosClientOptions pour plus d’informations sur les options que vous pouvez utiliser.
CosmosClient(string)	Crée un objet CosmosClient à partir d’une chaîne de connexion. Votre chaîne de connexion de base de données est disponible dans le portail Azure

Propriétés

databases	Utilisé pour créer de nouvelles bases de données, ou interroger/lire toutes les bases de données. Utilisez .database(id) pour lire, remplacer ou supprimer une base de données existante spécifique par ID. exemple de Créer une base de données const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Utilisé pour interroger & lecture de toutes les offres. Utilisez .offer(id) pour lire ou remplacer des offres existantes.

Méthodes

database(string)	Utilisé pour lire, mettre à jour ou supprimer une base de données existante par ID ou accès aux conteneurs appartenant à cette base de données. Cela n’effectue pas d’appel réseau. Utilisez .read pour obtenir des informations sur la base de données après avoir obtenu l’objet Database. exemple de Créer un conteneur hors d’une base de données existante const container = client.database("<database id>").containers.create("<container id>"); exemple de Supprimer une base de données existante await client.database("<id here>").delete();
dispose()	Efface l’actualisation du point de terminaison en arrière-plan. Utilisez client.dispose() lors de la destruction du CosmosClient dans un autre processus.
getDatabaseAccount(RequestOptions)	Obtenez des informations sur le DatabaseAccount actuel (y compris les régions prises en charge, etc.)
getReadEndpoint()	Obtient le point de terminaison de lecture actuellement utilisé. Utile à des fins de résolution des problèmes. L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.
getReadEndpoints()	Obtient le point de terminaison de lecture actuellement utilisé. Utile à des fins de résolution des problèmes. L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.
getWriteEndpoint()	Obtient l’URL de point de terminaison d’écriture actuellement utilisée. Utile à des fins de résolution des problèmes. L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.
getWriteEndpoints()	Obtient les points de terminaison d’écriture connus. Utile à des fins de résolution des problèmes. Les URL peuvent contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.
offer(string)	Utilisé pour la lecture ou la mise à jour d’une offre existante par ID.

Détails du constructeur

CosmosClient(CosmosClientOptions)

Crée un objet CosmosClient. Consultez CosmosClientOptions pour plus d’informations sur les options que vous pouvez utiliser.

new CosmosClient(options: CosmosClientOptions)

Paramètres

options

CosmosClientOptions

sac d’options ; exiger au moins un point de terminaison et une authentification à configurer

CosmosClient(string)

Crée un objet CosmosClient à partir d’une chaîne de connexion. Votre chaîne de connexion de base de données est disponible dans le portail Azure

new CosmosClient(connectionString: string)

Paramètres

connectionString

string

Détails de la propriété

databases

Utilisé pour créer de nouvelles bases de données, ou interroger/lire toutes les bases de données.

Utilisez .database(id) pour lire, remplacer ou supprimer une base de données existante spécifique par ID.

exemple de

Créer une base de données

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

Valeur de propriété

Databases

offers

Utilisé pour interroger & lecture de toutes les offres.

Utilisez .offer(id) pour lire ou remplacer des offres existantes.

offers: Offers

Valeur de propriété

Offers

Détails de la méthode

database(string)

Utilisé pour lire, mettre à jour ou supprimer une base de données existante par ID ou accès aux conteneurs appartenant à cette base de données.

Cela n’effectue pas d’appel réseau. Utilisez .read pour obtenir des informations sur la base de données après avoir obtenu l’objet Database.

exemple de

Créer un conteneur hors d’une base de données existante

const container = client.database("<database id>").containers.create("<container id>");

exemple de

Supprimer une base de données existante

await client.database("<id here>").delete();

function database(id: string): Database

Paramètres

id

string

ID de la base de données.

Retours

Database

dispose()

Efface l’actualisation du point de terminaison en arrière-plan. Utilisez client.dispose() lors de la destruction du CosmosClient dans un autre processus.

function dispose()

getDatabaseAccount(RequestOptions)

Obtenez des informations sur le DatabaseAccount actuel (y compris les régions prises en charge, etc.)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Paramètres

options

RequestOptions

Retours

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Obtient le point de terminaison de lecture actuellement utilisé. Utile à des fins de résolution des problèmes.

L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.

function getReadEndpoint(): Promise<string>

Retours

Promise<string>

getReadEndpoints()

Obtient le point de terminaison de lecture actuellement utilisé. Utile à des fins de résolution des problèmes.

L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.

function getReadEndpoints(): Promise<readonly string[]>

Retours

Promise<readonly string[]>

getWriteEndpoint()

Obtient l’URL de point de terminaison d’écriture actuellement utilisée. Utile à des fins de résolution des problèmes.

L’URL peut contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.

function getWriteEndpoint(): Promise<string>

Retours

Promise<string>

getWriteEndpoints()

Obtient les points de terminaison d’écriture connus. Utile à des fins de résolution des problèmes.

Les URL peuvent contenir un suffixe de région (par exemple, « -eastus ») si nous utilisons des points de terminaison spécifiques à l’emplacement.

function getWriteEndpoints(): Promise<readonly string[]>

Retours

Promise<readonly string[]>

offer(string)

Utilisé pour la lecture ou la mise à jour d’une offre existante par ID.

function offer(id: string): Offer

Paramètres

id

string

ID de l’offre.

Retours

Offer