Database class

Paket:

@azure/cosmos

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

Siehe Datenbanken zum 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 mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht database.read() 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 von CosmosClient über client.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), um ein bestimmtes, vorhandenes Datenbank- nach ID zu lesen, zu ersetzen oder zu löschen. 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), um eine bestimmte, vorhandene Benutzer- nach ID zu lesen, zu ersetzen oder zu löschen.

Methoden

container(string)	Wird verwendet, um eine bestimmte, vorhandene Datenbank nach ID zu lesen, zu ersetzen oder zu löschen. 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 Angebot für Datenbank ab. Wenn keine vorhanden ist, wird ein OfferResponse mit undefiniert zurückgegeben.
user(string)	Wird verwendet, um eine bestimmte, vorhandene Benutzer- nach ID zu lesen, zu ersetzen oder zu löschen. 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 von CosmosClient über client.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), um ein bestimmtes, vorhandenes Datenbank- nach ID zu lesen, zu ersetzen oder zu löschen.

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), um eine bestimmte, vorhandene Benutzer- nach ID zu lesen, zu ersetzen oder zu löschen.

users: Users

Eigenschaftswert

Users

Details zur Methode

container(string)

Wird verwendet, um eine bestimmte, vorhandene Datenbank nach ID zu lesen, zu ersetzen oder zu löschen.

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 Angebot für Datenbank ab. Wenn keine vorhanden ist, wird ein OfferResponse mit undefiniert zurückgegeben.

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

Parameter

options

RequestOptions

Gibt zurück

Promise<OfferResponse>

user(string)

Wird verwendet, um eine bestimmte, vorhandene Benutzer- nach ID zu lesen, zu ersetzen oder zu löschen.

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