Databases class

Pakiet:

@azure/cosmos

Operacje tworzenia nowych baz danych i odczytywania/wykonywania zapytań względem wszystkich baz danych

Zobacz Baza danych do odczytu lub usuwania istniejącej bazy danych; użyj polecenia client.database(id).

Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinijnie w aplikacji. Na przykład nie należy wywoływać przed każdym item.read() wywołaniemdatabases.readAll(), aby upewnić się, że baza danych istnieje; zrób to raz na uruchomieniu aplikacji.

Właściwości

client

Metody

create(DatabaseRequest, RequestOptions)	Wyślij żądanie utworzenia bazy danych. Baza danych zarządza użytkownikami, uprawnieniami i zestawem kontenerów. Każde konto bazy danych usługi Azure Cosmos DB może obsługiwać wiele niezależnych nazwanych baz danych, a baza danych jest logicznym kontenerem danych. Każda baza danych składa się z co najmniej jednego kontenera, z których każdy z kolei zawiera co najmniej jeden dokument. Ponieważ bazy danych są zasobem administracyjnym, klucz główny usługi będzie wymagany w celu uzyskania dostępu do wszystkich akcji i pomyślnego ukończenia każdej akcji przy użyciu interfejsów API użytkownika.
createIfNotExists(DatabaseRequest, RequestOptions)	Sprawdź, czy baza danych istnieje i czy nie istnieje, utwórz ją. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w elemecie body, a jeśli nie zostanie znalezione, operacja tworzenia. Baza danych zarządza użytkownikami, uprawnieniami i zestawem kontenerów. Każde konto bazy danych usługi Azure Cosmos DB może obsługiwać wiele niezależnych nazwanych baz danych, a baza danych jest logicznym kontenerem danych. Każda baza danych składa się z co najmniej jednego kontenera, z których każdy z kolei zawiera co najmniej jeden dokument. Ponieważ bazy danych są zasobem administracyjnym, klucz główny usługi będzie wymagany w celu uzyskania dostępu i pomyślnego ukończenia dowolnej akcji przy użyciu interfejsów API użytkownika.
query(string | SqlQuerySpec, FeedOptions)	Wykonuje zapytania dotyczące wszystkich baz danych. Przykład Odczytaj wszystkie bazy danych do tablicy. * 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(); *
query<T>(string | SqlQuerySpec, FeedOptions)	Wykonuje zapytania dotyczące wszystkich baz danych. Przykład Odczytaj wszystkie bazy danych do tablicy. * 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(); *
readAll(FeedOptions)	Odczytuje wszystkie bazy danych. Przykład Odczytaj wszystkie bazy danych do tablicy. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

Szczegóły właściwości

client

client: CosmosClient

Wartość właściwości

CosmosClient

Szczegóły metody

create(DatabaseRequest, RequestOptions)

Wyślij żądanie utworzenia bazy danych.

Baza danych zarządza użytkownikami, uprawnieniami i zestawem kontenerów. Każde konto bazy danych usługi Azure Cosmos DB może obsługiwać wiele niezależnych nazwanych baz danych, a baza danych jest logicznym kontenerem danych.

Każda baza danych składa się z co najmniej jednego kontenera, z których każdy z kolei zawiera co najmniej jeden dokument. Ponieważ bazy danych są zasobem administracyjnym, klucz główny usługi będzie wymagany w celu uzyskania dostępu do wszystkich akcji i pomyślnego ukończenia każdej akcji przy użyciu interfejsów API użytkownika.

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametry

body

DatabaseRequest

Baza danychDefinition reprezentująca bazę danych do utworzenia.

options

RequestOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Sprawdź, czy baza danych istnieje i czy nie istnieje, utwórz ją. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w elemecie body, a jeśli nie zostanie znalezione, operacja tworzenia.

Baza danych zarządza użytkownikami, uprawnieniami i zestawem kontenerów. Każde konto bazy danych usługi Azure Cosmos DB może obsługiwać wiele niezależnych nazwanych baz danych, a baza danych jest logicznym kontenerem danych.

Każda baza danych składa się z co najmniej jednego kontenera, z których każdy z kolei zawiera co najmniej jeden dokument. Ponieważ bazy danych są zasobem administracyjnym, klucz główny usługi będzie wymagany w celu uzyskania dostępu i pomyślnego ukończenia dowolnej akcji przy użyciu interfejsów API użytkownika.

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametry

body

DatabaseRequest

Baza danychDefinition reprezentująca bazę danych do utworzenia.

options

RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich baz danych.

Przykład

Odczytaj wszystkie bazy danych do tablicy. * 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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań dotyczących konfiguracji dla operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec .

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<any>

QueryIterator Umożliwia zwracanie wszystkich baz danych w tablicy lub iterowanie ich pojedynczo. *

query<T>(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich baz danych.

Przykład

Odczytaj wszystkie bazy danych do tablicy. * 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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań dotyczących konfiguracji dla operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec .

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<T>

QueryIterator Umożliwia zwracanie wszystkich baz danych w tablicy lub iterowanie ich pojedynczo. *

readAll(FeedOptions)

Odczytuje wszystkie bazy danych.

Przykład

Odczytaj wszystkie bazy danych do tablicy. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

Parametry

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Umożliwia zwracanie wszystkich baz danych w tablicy lub iterowanie ich pojedynczo. *