CosmosClient class

Pacchetto:

@azure/cosmos

Fornisce una rappresentazione logica lato client dell'account del database Azure Cosmos DB. Questo client viene usato per configurare ed eseguire richieste nel servizio di database Di Azure Cosmos DB.

Esempio

Creare un'istanza di un client e creare un nuovo database

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

Esempio

Creare un'istanza di un client con criteri di connessione personalizzati

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

Costruttori

CosmosClient(CosmosClientOptions)	Crea un nuovo oggetto CosmosClient . Per altre informazioni sulle opzioni che è possibile usare, vedere CosmosClientOptions .
CosmosClient(string)	Crea un nuovo oggetto CosmosClient da un stringa di connessione. Il database stringa di connessione è disponibile nel portale di Azure

Proprietà

databases	Usato per la creazione di nuovi database o l'esecuzione di query/lettura di tutti i database. Usare .database(id) per leggere, sostituire o eliminare un database specifico in base all'ID. Esempio Creare un nuovo database const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Usato per l'esecuzione di query & lettura di tutte le offerte. Usare .offer(id) per leggere o sostituire le offerte esistenti.

Metodi

database(string)	Usato per la lettura, l'aggiornamento o l'eliminazione di un database esistente in base all'ID o all'accesso ai contenitori appartenenti a tale database. Questo non effettua una chiamata di rete. Usare .read per ottenere informazioni sul database dopo aver ottenuto l'oggetto Database . Esempio Creare un nuovo contenitore fuori da un database esistente const container = client.database("<database id>").containers.create("<container id>"); Esempio Eliminare un database esistente await client.database("<id here>").delete();
dispose()	Cancella l'aggiornamento degli endpoint in background. Usare client.dispose() quando si elimina CosmosClient all'interno di un altro processo.
getDatabaseAccount(RequestOptions)	Ottenere informazioni sul database correnteAccount (incluse le aree supportate e così via)
getReadEndpoint()	Ottiene l'endpoint di lettura attualmente usato. Utile per la risoluzione dei problemi. L'URL può contenere un suffisso di area (ad esempio "-eastus") se si usano endpoint specifici della posizione.
getReadEndpoints()	Ottiene l'endpoint di lettura attualmente usato. Utile per la risoluzione dei problemi. L'URL può contenere un suffisso di area (ad esempio "-eastus") se si usano endpoint specifici della posizione.
getWriteEndpoint()	Ottiene l'URL dell'endpoint di scrittura attualmente utilizzato. Utile per la risoluzione dei problemi. L'URL può contenere un suffisso di area ( ad esempio "-eastus") se si usano endpoint specifici della posizione.
getWriteEndpoints()	Ottiene gli endpoint di scrittura noti. Utile per la risoluzione dei problemi. Gli URL possono contenere un suffisso di area ( ad esempio "-eastus") se si usano endpoint specifici della posizione.
offer(string)	Usato per la lettura o l'aggiornamento di un'offerta esistente in base all'ID.

Dettagli costruttore

CosmosClient(CosmosClientOptions)

Crea un nuovo oggetto CosmosClient . Per altre informazioni sulle opzioni che è possibile usare, vedere CosmosClientOptions .

new CosmosClient(options: CosmosClientOptions)

Parametri

options

CosmosClientOptions

borsa di opzioni; richiedere almeno l'endpoint e l'autenticazione da configurare

CosmosClient(string)

Crea un nuovo oggetto CosmosClient da un stringa di connessione. Il database stringa di connessione è disponibile nel portale di Azure

new CosmosClient(connectionString: string)

Parametri

connectionString

string

Dettagli proprietà

databases

Usato per la creazione di nuovi database o l'esecuzione di query/lettura di tutti i database.

Usare .database(id) per leggere, sostituire o eliminare un database specifico in base all'ID.

Esempio

Creare un nuovo database

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

Valore della proprietà

Databases

offers

Usato per l'esecuzione di query & lettura di tutte le offerte.

Usare .offer(id) per leggere o sostituire le offerte esistenti.

offers: Offers

Valore della proprietà

Offers

Dettagli metodo

database(string)

Usato per la lettura, l'aggiornamento o l'eliminazione di un database esistente in base all'ID o all'accesso ai contenitori appartenenti a tale database.

Questo non effettua una chiamata di rete. Usare .read per ottenere informazioni sul database dopo aver ottenuto l'oggetto Database .

Esempio

Creare un nuovo contenitore fuori da un database esistente

const container = client.database("<database id>").containers.create("<container id>");

Esempio

Eliminare un database esistente

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

function database(id: string): Database

Parametri

id

string

ID del database.

Restituisce

Database

dispose()

Cancella l'aggiornamento degli endpoint in background. Usare client.dispose() quando si elimina CosmosClient all'interno di un altro processo.

function dispose()

getDatabaseAccount(RequestOptions)

Ottenere informazioni sul database correnteAccount (incluse le aree supportate e così via)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Parametri

options

RequestOptions

Restituisce

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Ottiene l'endpoint di lettura attualmente usato. Utile per la risoluzione dei problemi.

L'URL può contenere un suffisso di area (ad esempio "-eastus") se si usano endpoint specifici della posizione.

function getReadEndpoint(): Promise<string>

Restituisce

Promise<string>

getReadEndpoints()

Ottiene l'endpoint di lettura attualmente usato. Utile per la risoluzione dei problemi.

L'URL può contenere un suffisso di area (ad esempio "-eastus") se si usano endpoint specifici della posizione.

function getReadEndpoints(): Promise<readonly string[]>

Restituisce

Promise<readonly string[]>

getWriteEndpoint()

Ottiene l'URL dell'endpoint di scrittura attualmente utilizzato. Utile per la risoluzione dei problemi.

L'URL può contenere un suffisso di area ( ad esempio "-eastus") se si usano endpoint specifici della posizione.

function getWriteEndpoint(): Promise<string>

Restituisce

Promise<string>

getWriteEndpoints()

Ottiene gli endpoint di scrittura noti. Utile per la risoluzione dei problemi.

Gli URL possono contenere un suffisso di area ( ad esempio "-eastus") se si usano endpoint specifici della posizione.

function getWriteEndpoints(): Promise<readonly string[]>

Restituisce

Promise<readonly string[]>

offer(string)

Usato per la lettura o l'aggiornamento di un'offerta esistente in base all'ID.

function offer(id: string): Offer

Parametri

id

string

ID dell'offerta.

Restituisce

Offer