Database class
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.
Constructeurs
Database(Cosmos |
Retourne une nouvelle instance Database. Remarque : l’intention est d’obtenir cet objet à partir de CosmosClient via |
Propriétés
client | |
containers | Utilisé pour créer de nouveaux conteneurs, ou interroger/lire tous les conteneurs. Utilisez exemple de Créer un conteneur
|
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 |
Méthodes
container(string) | Utilisé pour lire, remplacer ou supprimer une base de données existante par ID. Utilisez exemple de Supprimer un conteneur
|
delete(Request |
Supprimez la base de données donnée. |
read(Request |
Lisez la définition de la base de données donnée. |
read |
Obtient l’offre sur la base de données. S’il n’en existe aucun, retourne un OfferResponse avec undefined. |
user(string) | Utilisé pour lire, remplacer ou supprimer un utilisateur existant par ID. Utilisez |
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
containers
Utilisé pour créer de nouveaux conteneurs, ou interroger/lire tous les conteneurs.
Utilisez .database(id)
pour lire, remplacer ou supprimer une base de données existante par ID.
exemple de
Créer un conteneur
const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
containers: Containers
Valeur de propriété
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 utilisateur spécifique par ID.
users: Users
Valeur de propriété
Détails de la méthode
container(string)
Utilisé pour lire, remplacer ou supprimer une base de données existante par ID.
Utilisez .containers
la création de nouveaux conteneurs ou l’interrogation/lecture de tous les conteneurs.
exemple de
Supprimer un conteneur
await client.database("<db id>").container("<container id>").delete();
function container(id: string): Container
Paramètres
- id
-
string
Retours
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’en existe aucun, retourne un OfferResponse avec undefined.
function readOffer(options?: RequestOptions): Promise<OfferResponse>
Paramètres
- options
- RequestOptions
Retours
Promise<OfferResponse>