Database class

Paket:

@azure/cosmos

Åtgärder för att läsa eller ta bort en befintlig databas.

Se Databaser för att skapa nya databaser och läsa/köra frågor mot alla databaser. använd client.databases.

Obs! Alla dessa åtgärder anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte database.read() före varje enskilt item.read()-anrop för att säkerställa att databasen finns. gör detta en gång när programmet startas.

Konstruktorer

Database(CosmosClient, string, ClientContext)

Returnerar en ny Database-instans. Obs! Avsikten är att hämta objektet från CosmosClient via client.database(id), inte att instansiera det själv.

Egenskaper

client
containers	Används för att skapa nya containrar eller fråga/läsa alla containrar. Använd .database(id) för att läsa, ersätta eller ta bort en specifik befintlig Database med ID. Exempel Skapa en ny container const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.
users	Används för att skapa nya användare eller fråga/läsa alla användare. Använd .user(id) för att läsa, ersätta eller ta bort en specifik befintlig användare med ID.

Metoder

container(string)	Används för att läsa, ersätta eller ta bort en specifik befintlig Database med ID. Använd .containers att skapa nya containrar eller fråga/läsa alla containrar. Exempel Ta bort en container await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Ta bort den angivna databasen.
read(RequestOptions)	Läs definitionen av den angivna databasen.
readOffer(RequestOptions)	Hämtar erbjudande om databas. Om ingen finns returnerar ett OfferResponse med odefinierat.
user(string)	Används för att läsa, ersätta eller ta bort en specifik befintlig användare med ID. Använd .users för att skapa nya användare eller fråga/läsa alla användare.

Konstruktorinformation

Database(CosmosClient, string, ClientContext)

Returnerar en ny Database-instans.

Obs! Avsikten är att hämta objektet från CosmosClient via client.database(id), inte att instansiera det själv.

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

Parametrar

client

CosmosClient

id

string

clientContext

ClientContext

Egenskapsinformation

client

client: CosmosClient

Egenskapsvärde

CosmosClient

containers

Används för att skapa nya containrar eller fråga/läsa alla containrar.

Använd .database(id) för att läsa, ersätta eller ta bort en specifik befintlig Database med ID.

Exempel

Skapa en ny container

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

containers: Containers

Egenskapsvärde

Containers

id

id: string

Egenskapsvärde

string

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

users

Används för att skapa nya användare eller fråga/läsa alla användare.

Använd .user(id) för att läsa, ersätta eller ta bort en specifik befintlig användare med ID.

users: Users

Egenskapsvärde

Users

Metodinformation

container(string)

Används för att läsa, ersätta eller ta bort en specifik befintlig Database med ID.

Använd .containers att skapa nya containrar eller fråga/läsa alla containrar.

Exempel

Ta bort en container

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

function container(id: string): Container

Parametrar

id

string

Returer

Container

delete(RequestOptions)

Ta bort den angivna databasen.

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

Parametrar

options

RequestOptions

Returer

Promise<DatabaseResponse>

read(RequestOptions)

Läs definitionen av den angivna databasen.

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

Parametrar

options

RequestOptions

Returer

Promise<DatabaseResponse>

readOffer(RequestOptions)

Hämtar erbjudande om databas. Om ingen finns returnerar ett OfferResponse med odefinierat.

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

Parametrar

options

RequestOptions

Returer

Promise<OfferResponse>

user(string)

Används för att läsa, ersätta eller ta bort en specifik befintlig användare med ID.

Använd .users för att skapa nya användare eller fråga/läsa alla användare.

function user(id: string): User

Parametrar

id

string

Returer

User