Database class

  • Référence
Paquet:
@azure/cosmos

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

Consultez Databases pour créer des 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 de manière à ce que ces appels soient mis à l’échelle de manière subligne avec votre application. Par exemple, n’appelez database.read() pas avant chaque item.read() appel, pour vous assurer que la base de données existe ; effectuez cette opération une fois au démarrage de l’application.

Constructeurs

Database(CosmosClient, string, ClientContext)

Retourne une nouvelle instance Database. Remarque : l’intention est d’obtenir cet objet à partir de CosmosClient via client.database(id), et non de l’instancier vous-même.

Propriétés

client
containers

Utilisé pour créer de nouveaux conteneurs ou interroger/lire tous les conteneurs. Utilisez .database(id) pour lire, remplacer ou supprimer un spécifique existant Database par id.

Exemple

Créer un conteneur

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.
users

Utilisé pour créer de nouveaux utilisateurs ou interroger/lire tous les utilisateurs. Utilisez .user(id) pour lire, remplacer ou supprimer un spécifique existant User par id.

Méthodes

container(string)

Utilisé pour lire, remplacer ou supprimer un objet spécifique existant Database par id. Utilisez .containers la création de nouveaux conteneurs ou l’interrogation/lecture de tous les conteneurs.

Exemple

Supprimer un conteneur

await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)

Supprimez la base de données donnée.
read(RequestOptions)

Lisez la définition de la base de données donnée.
readOffer(RequestOptions)

Obtient l’offre sur la base de données. S’il n’existe aucun élément, retourne une valeur OfferResponse dont la valeur n’est pas définie.
user(string)

Utilisé pour lire, remplacer ou supprimer un spécifique existant User par id. Utilisez .users pour créer de nouveaux utilisateurs ou interroger/lire tous les utilisateurs.

Détails du constructeur

Database(CosmosClient, string, ClientContext)

Retourne une nouvelle instance Database. Remarque : l’intention est d’obtenir cet objet à partir de CosmosClient via client.database(id), et non de l’instancier vous-même.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Paramètres

client
CosmosClient
id

string

clientContext

ClientContext

Détails de la propriété

client 

client: CosmosClient

Valeur de propriété

CosmosClient

containers

Utilisé pour créer de nouveaux conteneurs ou interroger/lire tous les conteneurs. Utilisez .database(id) pour lire, remplacer ou supprimer un spécifique existant Database par id.

Exemple

Créer un conteneur

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

Valeur de propriété

Containers

id 

id: string

Valeur de propriété

string

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

users

Utilisé pour créer de nouveaux utilisateurs ou interroger/lire tous les utilisateurs. Utilisez .user(id) pour lire, remplacer ou supprimer un spécifique existant User par id.

users: Users

Valeur de propriété

Users

Détails de la méthode

container(string)

Utilisé pour lire, remplacer ou supprimer un objet spécifique existant Database par id. Utilisez .containers la création de nouveaux conteneurs ou l’interrogation/lecture de tous les conteneurs.

Exemple

Supprimer un conteneur

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

function container(id: string): Container

Paramètres

id

string

Retours

Container

delete(RequestOptions)

Supprimez la base de données donnée.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Paramètres

options
RequestOptions

Retours

Promise<DatabaseResponse>

read(RequestOptions)

Lisez la définition de la base de données donnée.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Paramètres

options
RequestOptions

Retours

Promise<DatabaseResponse>

readOffer(RequestOptions)

Obtient l’offre sur la base de données. S’il n’existe aucun élément, retourne une valeur OfferResponse dont la valeur n’est pas définie.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Paramètres

options
RequestOptions

Retours

Promise<OfferResponse>

user(string)

Utilisé pour lire, remplacer ou supprimer un spécifique existant User par id. Utilisez .users pour créer de nouveaux utilisateurs ou interroger/lire tous les utilisateurs.

function user(id: string): User

Paramètres

id

string

Retours

User