CosmosClient class

Pakiet:

@azure/cosmos

Zapewnia logiczną reprezentację konta bazy danych usługi Azure Cosmos DB po stronie klienta. Ten klient służy do konfigurowania i wykonywania żądań w usłudze bazy danych Azure Cosmos DB.

Przykład

Tworzenie wystąpienia klienta i tworzenie nowej bazy danych

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

Przykład

Tworzenie wystąpienia klienta przy użyciu niestandardowych zasad połączenia

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

Konstruktory

CosmosClient(CosmosClientOptions)	Tworzy nowy obiekt CosmosClient . Aby uzyskać więcej informacji na temat opcji, których można użyć, zobacz CosmosClientOptions .
CosmosClient(string)	Tworzy nowy obiekt CosmosClient na podstawie parametry połączenia. Parametry połączenia bazy danych można znaleźć w witrynie Azure Portal

Właściwości

databases	Służy do tworzenia nowych baz danych lub wykonywania zapytań/odczytywania wszystkich baz danych. Służy .database(id) do odczytywania, zastępowania lub usuwania określonej, istniejącej bazy danych według identyfikatora. Przykład Tworzenie nowej bazy danych const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Służy do wykonywania zapytań & odczytywania wszystkich ofert. Użyj .offer(id) polecenia , aby odczytać lub zastąpić istniejące oferty.

Metody

database(string)	Służy do odczytywania, aktualizowania lub usuwania istniejącej bazy danych za pomocą identyfikatora lub uzyskiwania dostępu do kontenerów należących do tej bazy danych. Nie powoduje to wywołania sieciowego. Użyj polecenia .read , aby uzyskać informacje o bazie danych po pobraniu obiektu Database . Przykład Tworzenie nowego kontenera poza istniejącą bazą danych const container = client.database("<database id>").containers.create("<container id>"); Przykład Usuwanie istniejącej bazy danych await client.database("<id here>").delete();
dispose()	Czyści odświeżanie punktu końcowego w tle. Użyj metody client.dispose() podczas niszczenia obiektu CosmosClient w ramach innego procesu.
getDatabaseAccount(RequestOptions)	Uzyskaj informacje o bieżącym elemencie DatabaseAccount (w tym o obsługiwanych regionach itp.)
getReadEndpoint()	Pobiera aktualnie używany punkt końcowy odczytu. Przydatne do rozwiązywania problemów. Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.
getReadEndpoints()	Pobiera aktualnie używany punkt końcowy odczytu. Przydatne do rozwiązywania problemów. Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.
getWriteEndpoint()	Pobiera aktualnie używany adres URL punktu końcowego zapisu. Przydatne do rozwiązywania problemów. Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.
getWriteEndpoints()	Pobiera znane punkty końcowe zapisu. Przydatne do rozwiązywania problemów. Adresy URL mogą zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.
offer(string)	Służy do odczytywania lub aktualizowania istniejącej oferty według identyfikatora.

Szczegóły konstruktora

CosmosClient(CosmosClientOptions)

Tworzy nowy obiekt CosmosClient . Aby uzyskać więcej informacji na temat opcji, których można użyć, zobacz CosmosClientOptions .

new CosmosClient(options: CosmosClientOptions)

Parametry

options

CosmosClientOptions

torba z opcjami; wymaga skonfigurowania co najmniej punktu końcowego i uwierzytelniania

CosmosClient(string)

Tworzy nowy obiekt CosmosClient na podstawie parametry połączenia. Parametry połączenia bazy danych można znaleźć w witrynie Azure Portal

new CosmosClient(connectionString: string)

Parametry

connectionString

string

Szczegóły właściwości

databases

Służy do tworzenia nowych baz danych lub wykonywania zapytań/odczytywania wszystkich baz danych.

Służy .database(id) do odczytywania, zastępowania lub usuwania określonej, istniejącej bazy danych według identyfikatora.

Przykład

Tworzenie nowej bazy danych

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

databases: Databases

Wartość właściwości

Databases

offers

Służy do wykonywania zapytań & odczytywania wszystkich ofert.

Użyj .offer(id) polecenia , aby odczytać lub zastąpić istniejące oferty.

offers: Offers

Wartość właściwości

Offers

Szczegóły metody

database(string)

Służy do odczytywania, aktualizowania lub usuwania istniejącej bazy danych za pomocą identyfikatora lub uzyskiwania dostępu do kontenerów należących do tej bazy danych.

Nie powoduje to wywołania sieciowego. Użyj polecenia .read , aby uzyskać informacje o bazie danych po pobraniu obiektu Database .

Przykład

Tworzenie nowego kontenera poza istniejącą bazą danych

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

Przykład

Usuwanie istniejącej bazy danych

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

function database(id: string): Database

Parametry

id

string

Identyfikator bazy danych.

Zwraca

Database

dispose()

Czyści odświeżanie punktu końcowego w tle. Użyj metody client.dispose() podczas niszczenia obiektu CosmosClient w ramach innego procesu.

function dispose()

getDatabaseAccount(RequestOptions)

Uzyskaj informacje o bieżącym elemencie DatabaseAccount (w tym o obsługiwanych regionach itp.)

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

Parametry

options

RequestOptions

Zwraca

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Pobiera aktualnie używany punkt końcowy odczytu. Przydatne do rozwiązywania problemów.

Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.

function getReadEndpoint(): Promise<string>

Zwraca

Promise<string>

getReadEndpoints()

Pobiera aktualnie używany punkt końcowy odczytu. Przydatne do rozwiązywania problemów.

Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.

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

Zwraca

Promise<readonly string[]>

getWriteEndpoint()

Pobiera aktualnie używany adres URL punktu końcowego zapisu. Przydatne do rozwiązywania problemów.

Adres URL może zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.

function getWriteEndpoint(): Promise<string>

Zwraca

Promise<string>

getWriteEndpoints()

Pobiera znane punkty końcowe zapisu. Przydatne do rozwiązywania problemów.

Adresy URL mogą zawierać sufiks regionu (np. "-eastus"), jeśli używamy określonych punktów końcowych lokalizacji.

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

Zwraca

Promise<readonly string[]>

offer(string)

Służy do odczytywania lub aktualizowania istniejącej oferty według identyfikatora.

function offer(id: string): Offer

Parametry

id

string

Identyfikator oferty.

Zwraca

Offer