Database class

Pakiet:

@azure/cosmos

Operacje odczytu lub usuwania istniejącej bazy danych.

Zobacz Databases na potrzeby tworzenia nowych baz danych oraz odczytywania/wykonywania zapytań dotyczących wszystkich baz danych; użyj client.databases.

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 podlinearnie z aplikacją. Na przykład nie należy wywoływać database.read() przed każdym wywołaniem item.read(), aby upewnić się, że baza danych istnieje; zrób to raz podczas uruchamiania aplikacji.

Konstruktory

Database(CosmosClient, string, ClientContext)

Zwraca nowe wystąpienie usługi Database. Uwaga: celem jest pobranie tego obiektu z CosmosClient za pośrednictwem client.database(id), a nie utworzenia wystąpienia go samodzielnie.

Właściwości

client
containers	Służy do tworzenia nowych kontenerów lub wykonywania zapytań/odczytywania wszystkich kontenerów. Użyj .database(id), aby odczytywać, zastępować lub usuwać określony istniejący Database według identyfikatora. Przykład Tworzenie nowego kontenera const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.
users	Służy do tworzenia nowych użytkowników lub wykonywania zapytań/odczytywania wszystkich użytkowników. Użyj .user(id) do odczytywania, zastępowania lub usuwania określonego istniejącego użytkownika według identyfikatora.

Metody

container(string)	Służy do odczytywania, zastępowania lub usuwania określonego istniejącego Database według identyfikatora. Użyj .containers tworzenia nowych kontenerów lub wykonywania zapytań/odczytywania wszystkich kontenerów. Przykład Usuwanie kontenera await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Usuń daną bazę danych.
read(RequestOptions)	Przeczytaj definicję danej bazy danych.
readOffer(RequestOptions)	Pobiera ofertę w bazie danych. Jeśli żadna z nich nie istnieje, zwraca element OfferResponse z niezdefiniowanym.
user(string)	Służy do odczytywania, zastępowania lub usuwania określonego, istniejącego użytkownika według identyfikatora. Użyj .users do tworzenia nowych użytkowników lub wykonywania zapytań/odczytywania wszystkich użytkowników.

Szczegóły konstruktora

Database(CosmosClient, string, ClientContext)

Zwraca nowe wystąpienie usługi Database.

Uwaga: celem jest pobranie tego obiektu z CosmosClient za pośrednictwem client.database(id), a nie utworzenia wystąpienia go samodzielnie.

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

Parametry

client

CosmosClient

id

string

clientContext

ClientContext

Szczegóły właściwości

client

client: CosmosClient

Wartość właściwości

CosmosClient

containers

Służy do tworzenia nowych kontenerów lub wykonywania zapytań/odczytywania wszystkich kontenerów.

Użyj .database(id), aby odczytywać, zastępować lub usuwać określony istniejący Database według identyfikatora.

Przykład

Tworzenie nowego kontenera

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

containers: Containers

Wartość właściwości

Containers

id

id: string

Wartość właściwości

string

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

string url

Wartość właściwości

string

users

Służy do tworzenia nowych użytkowników lub wykonywania zapytań/odczytywania wszystkich użytkowników.

Użyj .user(id) do odczytywania, zastępowania lub usuwania określonego istniejącego użytkownika według identyfikatora.

users: Users

Wartość właściwości

Users

Szczegóły metody

container(string)

Służy do odczytywania, zastępowania lub usuwania określonego istniejącego Database według identyfikatora.

Użyj .containers tworzenia nowych kontenerów lub wykonywania zapytań/odczytywania wszystkich kontenerów.

Przykład

Usuwanie kontenera

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

function container(id: string): Container

Parametry

id

string

Zwraca

Container

delete(RequestOptions)

Usuń daną bazę danych.

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

Parametry

options

RequestOptions

Zwraca

Promise<DatabaseResponse>

read(RequestOptions)

Przeczytaj definicję danej bazy danych.

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

Parametry

options

RequestOptions

Zwraca

Promise<DatabaseResponse>

readOffer(RequestOptions)

Pobiera ofertę w bazie danych. Jeśli żadna z nich nie istnieje, zwraca element OfferResponse z niezdefiniowanym.

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

Parametry

options

RequestOptions

Zwraca

Promise<OfferResponse>

user(string)

Służy do odczytywania, zastępowania lub usuwania określonego, istniejącego użytkownika według identyfikatora.

Użyj .users do tworzenia nowych użytkowników lub wykonywania zapytań/odczytywania wszystkich użytkowników.

function user(id: string): User

Parametry

id

string

Zwraca

User