Database class

Paket:

@azure/cosmos

Vorgänge zum Lesen oder Löschen einer vorhandenen Datenbank.

Weitere Informationen finden Sie Databases unter Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken. Verwenden Sie client.databases.

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe sublinear mit Ihrer Anwendung skaliert werden. Rufen database.read() Sie beispielsweise nicht vor jedem einzelnen item.read() Aufruf auf, um sicherzustellen, dass die Datenbank vorhanden ist. Führen Sie dies einmal beim Starten der Anwendung aus.

Konstruktoren

Database(CosmosClient, string, ClientContext)

Gibt eine neue Database-Instanz zurück. Hinweis: Die Absicht besteht darin, dieses Objekt über CosmosClientclient.database(id)zu erhalten, nicht um es selbst zu instanziieren.

Eigenschaften

client
containers	Wird zum Erstellen neuer Container oder zum Abfragen/Lesen aller Container verwendet. Verwenden Sie .database(id) zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen Database by-ID. Beispiel Erstellen eines neuen Containers const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.
users	Wird zum Erstellen neuer Benutzer oder zum Abfragen/Lesen aller Benutzer verwendet. Verwenden Sie .user(id) zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen User by-ID.

Methoden

container(string)	Wird zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen Database id verwendet. Verwenden Sie .containers das Erstellen neuer Container oder das Abfragen/Lesen aller Container. Beispiel Löschen eines Containers await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Löschen Sie die angegebene Datenbank.
read(RequestOptions)	Lesen Sie die Definition der angegebenen Datenbank.
readOffer(RequestOptions)	Ruft das Angebot für die Datenbank ab. Wenn keine vorhanden ist, gibt ein OfferResponse mit undefined zurück.
user(string)	Wird zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen User id verwendet. Verwenden Sie .users zum Erstellen neuer Benutzer oder zum Abfragen/Lesen aller Benutzer.

Details zum Konstruktor

Database(CosmosClient, string, ClientContext)

Gibt eine neue Database-Instanz zurück. Hinweis: Die Absicht besteht darin, dieses Objekt über CosmosClientclient.database(id)zu erhalten, nicht um es selbst zu instanziieren.

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

Parameter

client

CosmosClient

id

string

clientContext

ClientContext

Details zur Eigenschaft

client

client: CosmosClient

Eigenschaftswert

CosmosClient

containers

Wird zum Erstellen neuer Container oder zum Abfragen/Lesen aller Container verwendet. Verwenden Sie .database(id) zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen Database by-ID.

Beispiel

Erstellen eines neuen Containers

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

containers: Containers

Eigenschaftswert

Containers

id

id: string

Eigenschaftswert

string

url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

string url

Eigenschaftswert

string

users

Wird zum Erstellen neuer Benutzer oder zum Abfragen/Lesen aller Benutzer verwendet. Verwenden Sie .user(id) zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen User by-ID.

users: Users

Eigenschaftswert

Users

Details zur Methode

container(string)

Wird zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen Database id verwendet. Verwenden Sie .containers das Erstellen neuer Container oder das Abfragen/Lesen aller Container.

Beispiel

Löschen eines Containers

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

function container(id: string): Container

Parameter

id

string

Gibt zurück

Container

delete(RequestOptions)

Löschen Sie die angegebene Datenbank.

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

Parameter

options

RequestOptions

Gibt zurück

Promise<DatabaseResponse>

read(RequestOptions)

Lesen Sie die Definition der angegebenen Datenbank.

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

Parameter

options

RequestOptions

Gibt zurück

Promise<DatabaseResponse>

readOffer(RequestOptions)

Ruft das Angebot für die Datenbank ab. Wenn keine vorhanden ist, gibt ein OfferResponse mit undefined zurück.

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

Parameter

options

RequestOptions

Gibt zurück

Promise<OfferResponse>

user(string)

Wird zum Lesen, Ersetzen oder Löschen einer bestimmten vorhandenen User id verwendet. Verwenden Sie .users zum Erstellen neuer Benutzer oder zum Abfragen/Lesen aller Benutzer.

function user(id: string): User

Parameter

id

string

Gibt zurück

User