Databases class
Vorgänge zum Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken
Siehe Datenbank zum Lesen oder Löschen einer vorhandenen Datenbank; verwenden Sie client.database(id).
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 databases.readAll() auf, um sicherzustellen, dass die Datenbank vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.
Eigenschaften
| client |
Methoden
| create(Database |
Senden Sie eine Anforderung zum Erstellen einer Datenbank. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Gruppe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jedes wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine administrative Ressource handelt, ist der Dienstmasterschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und sie erfolgreich abzuschließen. |
| create |
Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls nicht.
Dadurch wird ein Lesevorgang basierend auf der ID im Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Gruppe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jedes wiederum ein oder mehrere Dokumente enthält. Da Datenbanken eine administrative Ressource sind, ist der Dienstmasterschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und sie erfolgreich abzuschließen. |
| query(string | Sql |
Fragt alle Datenbanken ab. Beispiel Alle Datenbanken in Array lesen.
* |
| query<T>(string | Sql |
Fragt alle Datenbanken ab. Beispiel Alle Datenbanken in Array lesen.
* |
| read |
Liest alle Datenbanken. Beispiel Alle Datenbanken in Array lesen.
* |
Details zur Eigenschaft
client
Details zur Methode
create(DatabaseRequest, RequestOptions)
Senden Sie eine Anforderung zum Erstellen einer Datenbank.
Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Gruppe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist.
Jede Datenbank besteht aus einem oder mehreren Containern, von denen jedes wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine administrative Ressource handelt, ist der Dienstmasterschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und sie erfolgreich abzuschließen.
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>Parameter
- body
- DatabaseRequest
Die DatabaseDefinition-, die den zu erstellenden Datenbank- darstellt.
- options
- RequestOptions
Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.
Gibt zurück
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls nicht.
Dadurch wird ein Lesevorgang basierend auf der ID im bodyerstellt, und wenn er nicht gefunden wird, wird ein Erstellungsvorgang ausgeführt.
Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Gruppe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist.
Jede Datenbank besteht aus einem oder mehreren Containern, von denen jedes wiederum ein oder mehrere Dokumente enthält. Da Datenbanken eine administrative Ressource sind, ist der Dienstmasterschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und sie erfolgreich abzuschließen.
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>Parameter
- body
- DatabaseRequest
Die DatabaseDefinition-, die den zu erstellenden Datenbank- darstellt.
- options
- RequestOptions
Zusätzliche Optionen für die Anforderung
Gibt zurück
Promise<DatabaseResponse>
query(string | SqlQuerySpec, FeedOptions)
Fragt alle Datenbanken ab.
Beispiel
Alle Datenbanken in Array lesen.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>Parameter
- query
-
string | SqlQuerySpec
Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.
- options
- FeedOptions
Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator<any>
QueryIterator- Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *
query<T>(string | SqlQuerySpec, FeedOptions)
Fragt alle Datenbanken ab.
Beispiel
Alle Datenbanken in Array lesen.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>Parameter
- query
-
string | SqlQuerySpec
Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.
- options
- FeedOptions
Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator- Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *
readAll(FeedOptions)
Liest alle Datenbanken.
Beispiel
Alle Datenbanken in Array lesen.
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>Parameter
- options
- FeedOptions
Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator- Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *