Database class

Balíček:

@azure/cosmos

Operace čtení nebo odstranění existující databáze

Viz Databases vytváření nových databází a čtení/dotazování všech databází. Použijte client.databases.

Poznámka: Všechny tyto operace můžou volat pevný rozpočet. Systém byste měli navrhnout tak, aby se tato volání škálovat podřádně s vaší aplikací. Například nevolejte database.read() před každým voláním item.read() , abyste zajistili, že databáze existuje. Uděláte to jednou při spuštění aplikace.

Konstruktory

Database(CosmosClient, string, ClientContext)

Vrátí novou Database instanci. Poznámka: Záměrem je získat tento objekt přes CosmosClientclient.database(id), nikoli vytvořit instanci sami.

Vlastnosti

client
containers	Používá se k vytváření nových kontejnerů nebo dotazování nebo čtení všech kontejnerů. Slouží .database(id) ke čtení, nahrazení nebo odstranění konkrétního existujícího Database pomocí ID. Příklad Vytvoření nového kontejneru const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Vrátí odkazovou adresu URL prostředku. Používá se pro propojení v oprávněních.
users	Používá se k vytváření nových uživatelů nebo dotazování/čtení všech uživatelů. Slouží .user(id) ke čtení, nahrazení nebo odstranění konkrétního existujícího User pomocí ID.

Metody

container(string)	Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího Database pomocí ID. Použijte .containers vytváření nových kontejnerů nebo dotazování nebo čtení všech kontejnerů. Příklad Odstranění kontejneru await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Odstraňte danou databázi.
read(RequestOptions)	Přečtěte si definici dané databáze.
readOffer(RequestOptions)	Získá nabídku pro databázi. Pokud žádná neexistuje, vrátí hodnotu OfferResponse s nedefinovanou.
user(string)	Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího User pomocí ID. Slouží .users k vytváření nových uživatelů nebo dotazování nebo čtení všech uživatelů.

Podrobnosti konstruktoru

Database(CosmosClient, string, ClientContext)

Vrátí novou Database instanci. Poznámka: Záměrem je získat tento objekt přes CosmosClientclient.database(id), nikoli vytvořit instanci sami.

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

Parametry

client

CosmosClient

id

string

clientContext

ClientContext

Podrobnosti vlastnosti

client

client: CosmosClient

Hodnota vlastnosti

CosmosClient

containers

Používá se k vytváření nových kontejnerů nebo dotazování nebo čtení všech kontejnerů. Slouží .database(id) ke čtení, nahrazení nebo odstranění konkrétního existujícího Database pomocí ID.

Příklad

Vytvoření nového kontejneru

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

containers: Containers

Hodnota vlastnosti

Containers

id

id: string

Hodnota vlastnosti

string

url

Vrátí odkazovou adresu URL prostředku. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

users

Používá se k vytváření nových uživatelů nebo dotazování/čtení všech uživatelů. Slouží .user(id) ke čtení, nahrazení nebo odstranění konkrétního existujícího User pomocí ID.

users: Users

Hodnota vlastnosti

Users

Podrobnosti metody

container(string)

Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího Database pomocí ID. Použijte .containers vytváření nových kontejnerů nebo dotazování nebo čtení všech kontejnerů.

Příklad

Odstranění kontejneru

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

function container(id: string): Container

Parametry

id

string

Návraty

Container

delete(RequestOptions)

Odstraňte danou databázi.

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

Parametry

options

RequestOptions

Návraty

Promise<DatabaseResponse>

read(RequestOptions)

Přečtěte si definici dané databáze.

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

Parametry

options

RequestOptions

Návraty

Promise<DatabaseResponse>

readOffer(RequestOptions)

Získá nabídku pro databázi. Pokud žádná neexistuje, vrátí hodnotu OfferResponse s nedefinovanou.

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

Parametry

options

RequestOptions

Návraty

Promise<OfferResponse>

user(string)

Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího User pomocí ID. Slouží .users k vytváření nových uživatelů nebo dotazování nebo čtení všech uživatelů.

function user(id: string): User

Parametry

id

string

Návraty

User