Sdílet prostřednictvím

Database class

  • Reference
Balíček:
@azure/cosmos

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

Viz Databáze pro vytváření nových databází a čtení a dotazování všech databází; použít client.databases.

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte database.read() před každým voláním item.read(), aby se zajistilo, že databáze existuje; proveďte to jednou při spuštění aplikace.

Konstruktory

Database(CosmosClient, string, ClientContext)

Vrátí novou instanci Database.

Poznámka: Záměrem je získat tento objekt z CosmosClient prostřednictvím client.database(id), ne vytvořit instanci sami.

Vlastnosti

client
containers

Slouží k vytváření nových kontejnerů nebo dotazování/čtení všech kontejnerů.

Pomocí .database(id) můžete číst, nahrazovat nebo odstraňovat konkrétní existující databáze podle 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í adresu URL odkazu na prostředek. 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ů.

Pomocí .user(id) můžete přečíst, nahradit nebo odstranit konkrétní existující uživatele podle ID.

Metody

container(string)

Slouží ke čtení, nahrazení nebo odstranění konkrétní existující databáze databáze podle ID.

Použijte .containers vytváření nových kontejnerů nebo dotazování/č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í offerResponse s nedefinovaným.
user(string)

Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího uživatele podle ID.

Pomocí .users můžete vytvářet nové uživatele nebo dotazovat nebo číst všechny uživatele.

Podrobnosti konstruktoru

Database(CosmosClient, string, ClientContext)

Vrátí novou instanci Database.

Poznámka: Záměrem je získat tento objekt z CosmosClient prostřednictvím client.database(id), ne 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

Slouží k vytváření nových kontejnerů nebo dotazování/čtení všech kontejnerů.

Pomocí .database(id) můžete číst, nahrazovat nebo odstraňovat konkrétní existující databáze podle 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í adresu URL odkazu na prostředek. 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ů.

Pomocí .user(id) můžete přečíst, nahradit nebo odstranit konkrétní existující uživatele podle ID.

users: Users

Hodnota vlastnosti

Users

Podrobnosti metody

container(string)

Slouží ke čtení, nahrazení nebo odstranění konkrétní existující databáze databáze podle ID.

Použijte .containers vytváření nových kontejnerů nebo dotazování/č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í offerResponse s nedefinovaným.

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 uživatele podle ID.

Pomocí .users můžete vytvářet nové uživatele nebo dotazovat nebo číst všechny uživatele.

function user(id: string): User

Parametry

id

string

Návraty

User