Databases class

Pacchetto:

@azure/cosmos

Operazioni per la creazione di nuovi database e la lettura/esecuzione di query su tutti i database

Vedere Database per la lettura o l'eliminazione di un database esistente; usare client.database(id).

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 databases.readAll() prima di ogni singola item.read() chiamata, per assicurarsi che il database esista. Eseguire questa operazione una volta all'avvio dell'applicazione.

Proprietà

client

Metodi

create(DatabaseRequest, RequestOptions)	Inviare una richiesta per la creazione di un database. Un database gestisce utenti, autorizzazioni e un set di contenitori. Ogni account del database Azure Cosmos DB è in grado di supportare più database denominati indipendenti, con il database che rappresenta il contenitore logico per i dati. Ogni database è costituito da uno o più contenitori, ognuno dei quali a sua volta contiene uno o più documenti. Poiché i database sono una risorsa amministrativa, la chiave master del servizio sarà necessaria per accedere e completare correttamente qualsiasi azione usando le API utente.
createIfNotExists(DatabaseRequest, RequestOptions)	Controllare se esiste un database e, in caso contrario, crearlo. In questo modo verrà eseguita un'operazione di lettura basata sull'ID in body, quindi, se non viene trovata, un'operazione di creazione. Un database gestisce utenti, autorizzazioni e un set di contenitori. Ogni account del database Azure Cosmos DB è in grado di supportare più database denominati indipendenti, con il database che rappresenta il contenitore logico per i dati. Ogni database è costituito da uno o più contenitori, ognuno dei quali a sua volta contiene uno o più documenti. Poiché i database sono una risorsa amministrativa, la chiave master del servizio sarà necessaria per accedere e completare correttamente qualsiasi azione usando le API utente.
query(string | SqlQuerySpec, FeedOptions)	Esegue query su tutti i database. Esempio Leggere tutti i database nella matrice. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
query<T>(string | SqlQuerySpec, FeedOptions)	Esegue query su tutti i database. Esempio Leggere tutti i database nella matrice. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
readAll(FeedOptions)	Legge tutti i database. Esempio Leggere tutti i database nella matrice. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

Dettagli proprietà

client

client: CosmosClient

Valore della proprietà

CosmosClient

Dettagli metodo

create(DatabaseRequest, RequestOptions)

Inviare una richiesta per la creazione di un database.

Un database gestisce utenti, autorizzazioni e un set di contenitori. Ogni account del database Azure Cosmos DB è in grado di supportare più database denominati indipendenti, con il database che rappresenta il contenitore logico per i dati.

Ogni database è costituito da uno o più contenitori, ognuno dei quali a sua volta contiene uno o più documenti. Poiché i database sono una risorsa amministrativa, la chiave master del servizio sarà necessaria per accedere e completare correttamente qualsiasi azione usando le API utente.

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametri

body

DatabaseRequest

DatabaseDefinition che rappresenta il database da creare.

options

RequestOptions

Usare per impostare opzioni come le dimensioni della pagina di risposta, i token di continuazione e così via.

Restituisce

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Controllare se esiste un database e, in caso contrario, crearlo. In questo modo verrà eseguita un'operazione di lettura basata sull'ID in body, quindi, se non viene trovata, un'operazione di creazione.

Un database gestisce utenti, autorizzazioni e un set di contenitori. Ogni account del database Azure Cosmos DB è in grado di supportare più database denominati indipendenti, con il database che rappresenta il contenitore logico per i dati.

Ogni database è costituito da uno o più contenitori, ognuno dei quali a sua volta contiene uno o più documenti. Poiché i database sono una risorsa amministrativa, la chiave master del servizio sarà necessaria per accedere e completare correttamente qualsiasi azione usando le API utente.

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parametri

body

DatabaseRequest

DatabaseDefinition che rappresenta il database da creare.

options

RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti i database.

Esempio

Leggere tutti i database nella matrice. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametri

query

string | SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec .

options

FeedOptions

Usare per impostare opzioni come le dimensioni della pagina di risposta, i token di continuazione e così via.

Restituisce

QueryIterator<any>

QueryIterator Consente di restituire tutti i database in una matrice o di eseguirne l'iterazione uno alla volta. *

query<T>(string | SqlQuerySpec, FeedOptions)

Esegue query su tutti i database.

Esempio

Leggere tutti i database nella matrice. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametri

query

string | SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec .

options

FeedOptions

Usare per impostare opzioni come le dimensioni della pagina di risposta, i token di continuazione e così via.

Restituisce

QueryIterator<T>

QueryIterator Consente di restituire tutti i database in una matrice o di eseguirne l'iterazione uno alla volta. *

readAll(FeedOptions)

Legge tutti i database.

Esempio

Leggere tutti i database nella matrice. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

Parametri

options

FeedOptions

Usare per impostare opzioni come le dimensioni della pagina di risposta, i token di continuazione e così via.

Restituisce

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Consente di restituire tutti i database in una matrice o di eseguirne l'iterazione uno alla volta. *