Databases class
Vorgänge zum Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken
Informationen zum Lesen oder Löschen einer vorhandenen Datenbank finden Sie unter Datenbank . Verwenden Sie client.database(id).
Hinweis: Alle diese Vorgänge führen Aufrufe mit einem festen Budget aus.
Sie sollten Ihr System so entwerfen, dass diese Aufrufe sublinear mit Ihrer Anwendung skaliert werden.
Rufen databases.readAll() Sie beispielsweise nicht vor jedem einzelnen item.read() Aufruf auf, um sicherzustellen, dass die Datenbank vorhanden ist. Führen Sie dies einmal beim Anwendungsstart 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 jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen. |
| create |
Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls dies nicht der Fall ist.
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 jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen. |
| query(string | Sql |
Fragt alle Datenbanken ab. Beispiel Lesen sie alle Datenbanken, um ein Array zu erstellen.
* |
| query<T>(string | Sql |
Fragt alle Datenbanken ab. Beispiel Lesen sie alle Datenbanken, um ein Array zu erstellen.
* |
| read |
Liest alle Datenbanken. Beispiel Lesen sie alle Datenbanken, um ein Array zu erstellen.
* |
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 jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>Parameter
- body
- DatabaseRequest
Die DatabaseDefinition , die die zu erstellende Datenbank darstellt.
- options
- RequestOptions
Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.
Gibt zurück
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls dies nicht der Fall ist.
Dadurch wird ein Lesevorgang basierend auf der ID im bodyerstellt, wenn er nicht gefunden wird.
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 jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>Parameter
- body
- DatabaseRequest
Die DatabaseDefinition , die die zu erstellende 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
Lesen sie alle Datenbanken, um ein Array zu erstellen.
* 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
Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator<any>
QueryIterator Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder sie einzeln zu durchlaufen. *
query<T>(string | SqlQuerySpec, FeedOptions)
Fragt alle Datenbanken ab.
Beispiel
Lesen sie alle Datenbanken, um ein Array zu erstellen.
* 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
Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder sie einzeln zu durchlaufen. *
readAll(FeedOptions)
Liest alle Datenbanken.
Beispiel
Lesen sie alle Datenbanken, um ein Array zu erstellen.
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>Parameter
- options
- FeedOptions
Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.
Gibt zurück
QueryIterator Ermöglicht es Ihnen, alle Datenbanken in einem Array zurückzugeben oder sie einzeln zu durchlaufen. *