Database class
Operazioni per la lettura o l'eliminazione di un database esistente.
Vedere Database 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 scalano in modo secondario con l'applicazione.
Ad esempio, non chiamare database.read()
prima di ogni singola chiamata item.read()
, per assicurarsi che il database esista; eseguire questa operazione una volta all'avvio dell'applicazione.
Costruttori
Database(Cosmos |
Restituisce una nuova istanza di database. Nota: l'intenzione è ottenere questo oggetto da CosmosClient tramite |
Proprietà
client | |
containers | Usato per la creazione di nuovi contenitori o l'esecuzione di query o la lettura di tutti i contenitori. Usare esempio di Creare un nuovo contenitore
|
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 |
Metodi
container(string) | Consente di leggere, sostituire o eliminare un database specifico per ID. Usare esempio di Eliminare un contenitore
|
delete(Request |
Eliminare il database specificato. |
read(Request |
Leggere la definizione del database specificato. |
read |
Ottiene l'offerta nel database. Se non esiste alcun valore, restituisce un oggetto OfferResponse senza definizione. |
user(string) | Usato per leggere, sostituire o eliminare un utente specifico in base all'ID. Usare |
Dettagli costruttore
Database(CosmosClient, string, ClientContext)
Restituisce una nuova istanza di database.
Nota: l'intenzione è ottenere questo oggetto da CosmosClient tramite client.database(id)
, non per crearne un'istanza manualmente.
new Database(client: CosmosClient, id: string, clientContext: ClientContext)
Parametri
- client
- CosmosClient
- id
-
string
- clientContext
-
ClientContext
Dettagli proprietà
client
containers
Usato per la creazione di nuovi contenitori o l'esecuzione di query o la lettura di tutti i contenitori.
Usare .database(id)
per leggere, sostituire o eliminare un database esistente in base all'ID.
esempio di
Creare un nuovo contenitore
const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
containers: Containers
Valore della proprietà
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 utente esistente in base all'ID.
users: Users
Valore della proprietà
Dettagli metodo
container(string)
Consente di leggere, sostituire o eliminare un database specifico per ID.
Usare .containers
creare nuovi contenitori o eseguire query/leggere tutti i contenitori.
esempio di
Eliminare un contenitore
await client.database("<db id>").container("<container id>").delete();
function container(id: string): Container
Parametri
- id
-
string
Restituisce
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 alcun valore, restituisce un oggetto OfferResponse senza definizione.
function readOffer(options?: RequestOptions): Promise<OfferResponse>
Parametri
- options
- RequestOptions
Restituisce
Promise<OfferResponse>
user(string)
Usato per leggere, sostituire o eliminare un utente specifico in base all'ID.
Usare .users
per creare nuovi utenti o eseguire query/leggere tutti gli utenti.
function user(id: string): User
Parametri
- id
-
string