Database class

Pacchetto:

@azure/cosmos

Operazioni per la lettura o l'eliminazione di un database esistente.

Vedere Databases per la creazione di nuovi database e la lettura/esecuzione di query su tutti i database. Usare client.databases.

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate vengano ridimensionate in modo secondario con l'applicazione. Ad esempio, non chiamare database.read() prima di ogni singola item.read() chiamata, per assicurarsi che il database esista. Eseguire questa operazione una volta all'avvio dell'applicazione.

Costruttori

Database(CosmosClient, string, ClientContext)

Restituisce una nuova istanza di Database. Nota: l'intenzione è quella di ottenere questo oggetto da CosmosClient tramite client.database(id), non di crearne un'istanza autonomamente.

Proprietà

client
containers	Usato per la creazione di nuovi contenitori o l'esecuzione di query/lettura di tutti i contenitori. Usare .database(id) per leggere, sostituire o eliminare uno specifico, esistente Database in base all'ID. Esempio Crea un nuovo contenitore const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.
users	Usato per la creazione di nuovi utenti o l'esecuzione di query/lettura di tutti gli utenti. Usare .user(id) per leggere, sostituire o eliminare uno specifico, esistente User in base all'ID.

Metodi

container(string)	Utilizzato per leggere, sostituire o eliminare uno specifico, esistente Database in base all'ID. Utilizzare .containers la creazione di nuovi contenitori o l'esecuzione di query/lettura di tutti i contenitori. Esempio Eliminare un contenitore await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Eliminare il database specificato.
read(RequestOptions)	Leggere la definizione del database specificato.
readOffer(RequestOptions)	Ottiene l'offerta nel database. Se non esiste, restituisce un oggetto OfferResponse con non definito.
user(string)	Utilizzato per leggere, sostituire o eliminare uno specifico, esistente User in base all'ID. Utilizzare .users per la creazione di nuovi utenti o l'esecuzione di query o la lettura di tutti gli utenti.

Dettagli costruttore

Database(CosmosClient, string, ClientContext)

Restituisce una nuova istanza di Database. Nota: l'intenzione è quella di ottenere questo oggetto da CosmosClient tramite client.database(id), non di crearne un'istanza autonomamente.

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

Parametri

client

CosmosClient

id

string

clientContext

ClientContext

Dettagli proprietà

client

client: CosmosClient

Valore della proprietà

CosmosClient

containers

Usato per la creazione di nuovi contenitori o l'esecuzione di query/lettura di tutti i contenitori. Usare .database(id) per leggere, sostituire o eliminare uno specifico, esistente Database in base all'ID.

Esempio

Crea un nuovo contenitore

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

containers: Containers

Valore della proprietà

Containers

id

id: string

Valore della proprietà

string

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

users

Usato per la creazione di nuovi utenti o l'esecuzione di query/lettura di tutti gli utenti. Usare .user(id) per leggere, sostituire o eliminare uno specifico, esistente User in base all'ID.

users: Users

Valore della proprietà

Users

Dettagli metodo

container(string)

Utilizzato per leggere, sostituire o eliminare uno specifico, esistente Database in base all'ID. Utilizzare .containers la creazione di nuovi contenitori o l'esecuzione di query/lettura di tutti i contenitori.

Esempio

Eliminare un contenitore

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

function container(id: string): Container

Parametri

id

string

Restituisce

Container

delete(RequestOptions)

Eliminare il database specificato.

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

Parametri

options

RequestOptions

Restituisce

Promise<DatabaseResponse>

read(RequestOptions)

Leggere la definizione del database specificato.

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

Parametri

options

RequestOptions

Restituisce

Promise<DatabaseResponse>

readOffer(RequestOptions)

Ottiene l'offerta nel database. Se non esiste, restituisce un oggetto OfferResponse con non definito.

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

Parametri

options

RequestOptions

Restituisce

Promise<OfferResponse>

user(string)

Utilizzato per leggere, sostituire o eliminare uno specifico, esistente User in base all'ID. Utilizzare .users per la creazione di nuovi utenti o l'esecuzione di query o la lettura di tutti gli utenti.

function user(id: string): User

Parametri

id

string

Restituisce

User