Sdílet prostřednictvím

CosmosClient class

Balíček:
@azure/cosmos

Poskytuje logickou reprezentaci účtu databáze Azure Cosmos DB na straně klienta. Tento klient se používá ke konfiguraci a spouštění požadavků v databázové službě Azure Cosmos DB.

příklad

Vytvoření instance klienta a vytvoření nové databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

příklad

Vytvoření instance klienta pomocí vlastních zásad připojení

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({
  endpoint,
  key,
  connectionPolicy: {
    requestTimeout: 10000,
  },
});

příklad

Vytvoření instance klienta s ověřováním AAD a vlastním oborem

import { DefaultAzureCredential } from "@azure/identity";
import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const aadCredentials = new DefaultAzureCredential();
const client = new CosmosClient({
  endpoint,
  aadCredentials,
  aadScope: "https://cosmos.azure.com/.default", // Optional custom scope
});

Konstruktory

CosmosClient(CosmosClientOptions)

Vytvoří nový objekt CosmosClient. Další podrobnosti o možnostech, které můžete použít, najdete v tématu CosmosClientOptions.
CosmosClient(string)

Vytvoří nový objekt CosmosClient z připojovacího řetězce. Připojovací řetězec databáze najdete na webu Azure Portal.

Vlastnosti

databases

Používá se k vytváření nových databází nebo dotazování/čtení všech databází.

Pomocí .database(id) můžete číst, nahrazovat nebo odstraňovat konkrétní existující databázi podle ID.

příklad

Vytvoření nové databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: databaseDefinition, database } = await client.databases.create({
  id: "<name here>",
});
offers

Používá se k dotazování & čtení všech nabídek.

Ke čtení nebo nahrazení existujících nabídek použijte .offer(id).

Metody

database(string)

Používá se ke čtení, aktualizaci nebo odstraňování existující databáze pomocí ID nebo přístupu ke kontejnerům patřícím do této databáze.

Tím se nevyvolá síťové volání. Pomocí .read můžete získat informace o databázi po získání objektu databáze.

příklad

Vytvoření nového kontejneru z existující databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const container = client.database("<database id>").containers.create({
  id: "<name here>",
});

příklad

Odstranění existující databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
await client.database("<id here>").delete();
dispose()

Vymaže obnovovací prvek koncového bodu na pozadí. Při zničení CosmosClient v rámci jiného procesu použijte client.dispose().
getDatabaseAccount(RequestOptions)

Získejte informace o aktuálním DatabaseAccount (včetně podporovaných oblastí atd.).
getReadEndpoint()

Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").
getReadEndpoints()

Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").
getWriteEndpoint()

Získá aktuálně použitou adresu URL koncového bodu zápisu. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").
getWriteEndpoints()

Získá známé koncové body zápisu. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, můžou adresy URL obsahovat příponu oblasti (např. -eastus).
offer(string)

Používá se ke čtení nebo aktualizaci existující nabídky podle ID.

Podrobnosti konstruktoru

CosmosClient(CosmosClientOptions)

Vytvoří nový objekt CosmosClient. Další podrobnosti o možnostech, které můžete použít, najdete v tématu CosmosClientOptions.

new CosmosClient(options: CosmosClientOptions)

Parametry

options
CosmosClientOptions

taška s možnostmi; vyžadování konfigurace aspoň koncového bodu a ověřování

CosmosClient(string)

Vytvoří nový objekt CosmosClient z připojovacího řetězce. Připojovací řetězec databáze najdete na webu Azure Portal.

new CosmosClient(connectionString: string)

Parametry

connectionString

string

Podrobnosti vlastnosti

databases

Používá se k vytváření nových databází nebo dotazování/čtení všech databází.

Pomocí .database(id) můžete číst, nahrazovat nebo odstraňovat konkrétní existující databázi podle ID.

příklad

Vytvoření nové databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: databaseDefinition, database } = await client.databases.create({
  id: "<name here>",
});

databases: Databases

Hodnota vlastnosti

Databases

offers

Používá se k dotazování & čtení všech nabídek.

Ke čtení nebo nahrazení existujících nabídek použijte .offer(id).

offers: Offers

Hodnota vlastnosti

Offers

Podrobnosti metody

database(string)

Používá se ke čtení, aktualizaci nebo odstraňování existující databáze pomocí ID nebo přístupu ke kontejnerům patřícím do této databáze.

Tím se nevyvolá síťové volání. Pomocí .read můžete získat informace o databázi po získání objektu databáze.

příklad

Vytvoření nového kontejneru z existující databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const container = client.database("<database id>").containers.create({
  id: "<name here>",
});

příklad

Odstranění existující databáze

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
await client.database("<id here>").delete();

function database(id: string): Database

Parametry

id

string

ID databáze.

Návraty

Database

dispose()

Vymaže obnovovací prvek koncového bodu na pozadí. Při zničení CosmosClient v rámci jiného procesu použijte client.dispose().

function dispose()

getDatabaseAccount(RequestOptions)

Získejte informace o aktuálním DatabaseAccount (včetně podporovaných oblastí atd.).

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

Parametry

options
RequestOptions

Návraty

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").

function getReadEndpoint(): Promise<string>

Návraty

Promise<string>

getReadEndpoints()

Získá aktuálně používaný koncový bod pro čtení. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").

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

Návraty

Promise<readonly string[]>

getWriteEndpoint()

Získá aktuálně použitou adresu URL koncového bodu zápisu. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, může adresa URL obsahovat příponu oblasti (např. "-eastus").

function getWriteEndpoint(): Promise<string>

Návraty

Promise<string>

getWriteEndpoints()

Získá známé koncové body zápisu. Užitečné pro účely řešení potíží.

Pokud používáme koncové body specifické pro umístění, můžou adresy URL obsahovat příponu oblasti (např. -eastus).

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

Návraty

Promise<readonly string[]>

offer(string)

Používá se ke čtení nebo aktualizaci existující nabídky podle ID.

function offer(id: string): Offer

Parametry

id

string

ID nabídky.

Návraty

Offer