Aracılığıyla paylaş

CosmosClient class

Paket:
@azure/cosmos

Azure Cosmos DB veritabanı hesabının istemci tarafı mantıksal gösterimini sağlar. Bu istemci, Azure Cosmos DB veritabanı hizmetinde istekleri yapılandırmak ve yürütmek için kullanılır.

Örnek

İstemci örneği oluşturma ve yeni veritabanı oluşturma

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

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

Örnek

Özel Bağlantı İlkesi ile istemci örneği oluşturma

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,
  },
});

Örnek

AAD kimlik doğrulaması ve özel kapsam ile istemci örneği oluşturma

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
});

Oluşturucular

CosmosClient(CosmosClientOptions)

Yeni bir CosmosClient nesnesi oluşturur. Kullanabileceğiniz seçenekler hakkında daha fazla bilgi için bkz. CosmosClientOptions .
CosmosClient(string)

Bağlantı dizesinden yeni bir CosmosClient nesnesi oluşturur. Veritabanı bağlantı dizenizi Azure Portal'da bulabilirsiniz

Özellikler

databases

Yeni veritabanları oluşturmak veya tüm veritabanlarını sorgulamak/okumak için kullanılır.

Belirli bir var olan veritabanını kimliğe göre okumak, değiştirmek veya silmek için .database(id) kullanın.

Örnek

Yeni veritabanı oluşturma

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

Tüm teklifleri okumak & sorgulamak için kullanılır.

Mevcut teklifleri okumak veya değiştirmek için .offer(id) kullanın.

Yöntemler

database(string)

Var olan bir veritabanını kimlikle okumak, güncelleştirmek veya silmek ya da bu veritabanına ait kapsayıcılara erişmek için kullanılır.

Bu bir ağ çağrısı yapmaz. .read nesnesini aldıktan sonra veritabanı hakkında bilgi almak için kullanın.

Örnek

Mevcut bir veritabanından yeni kapsayıcı oluşturma

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>",
});

Örnek

Var olan bir veritabanını silme

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()

Arka plan uç noktası yenileyiciyi temizler. CosmosClient'i başka bir işlem içinde yok ederken client.dispose() kullanın.
getDatabaseAccount(RequestOptions)

Geçerli DatabaseAccount (desteklenen bölgeler dahil vb.) hakkında bilgi alın
getReadEndpoint()

Şu anda kullanılan okuma uç noktasını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.
getReadEndpoints()

Şu anda kullanılan okuma uç noktasını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.
getWriteEndpoint()

Şu anda kullanılan yazma uç noktası URL'sini alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.
getWriteEndpoints()

Bilinen yazma uç noktalarını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL'ler bir bölge soneki (ör. "-eastus") içerebilir.
offer(string)

Var olan bir teklifi kimlikle okumak veya güncelleştirmek için kullanılır.

Oluşturucu Ayrıntıları

CosmosClient(CosmosClientOptions)

Yeni bir CosmosClient nesnesi oluşturur. Kullanabileceğiniz seçenekler hakkında daha fazla bilgi için bkz. CosmosClientOptions .

new CosmosClient(options: CosmosClientOptions)

Parametreler

options
CosmosClientOptions

seçenekler çantası; en az uç nokta ve kimlik doğrulamasının yapılandırılmasını gerektir

CosmosClient(string)

Bağlantı dizesinden yeni bir CosmosClient nesnesi oluşturur. Veritabanı bağlantı dizenizi Azure Portal'da bulabilirsiniz

new CosmosClient(connectionString: string)

Parametreler

connectionString

string

Özellik Ayrıntıları

databases

Yeni veritabanları oluşturmak veya tüm veritabanlarını sorgulamak/okumak için kullanılır.

Belirli bir var olan veritabanını kimliğe göre okumak, değiştirmek veya silmek için .database(id) kullanın.

Örnek

Yeni veritabanı oluşturma

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

Özellik Değeri

Databases

offers

Tüm teklifleri okumak & sorgulamak için kullanılır.

Mevcut teklifleri okumak veya değiştirmek için .offer(id) kullanın.

offers: Offers

Özellik Değeri

Offers

Yöntem Ayrıntıları

database(string)

Var olan bir veritabanını kimlikle okumak, güncelleştirmek veya silmek ya da bu veritabanına ait kapsayıcılara erişmek için kullanılır.

Bu bir ağ çağrısı yapmaz. .read nesnesini aldıktan sonra veritabanı hakkında bilgi almak için kullanın.

Örnek

Mevcut bir veritabanından yeni kapsayıcı oluşturma

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>",
});

Örnek

Var olan bir veritabanını silme

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

Parametreler

id

string

Veritabanının kimliği.

Döndürülenler

Database

dispose()

Arka plan uç noktası yenileyiciyi temizler. CosmosClient'i başka bir işlem içinde yok ederken client.dispose() kullanın.

function dispose()

getDatabaseAccount(RequestOptions)

Geçerli DatabaseAccount (desteklenen bölgeler dahil vb.) hakkında bilgi alın

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

Parametreler

options
RequestOptions

Döndürülenler

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Şu anda kullanılan okuma uç noktasını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.

function getReadEndpoint(): Promise<string>

Döndürülenler

Promise<string>

getReadEndpoints()

Şu anda kullanılan okuma uç noktasını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.

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

Döndürülenler

Promise<readonly string[]>

getWriteEndpoint()

Şu anda kullanılan yazma uç noktası URL'sini alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL bir bölge soneki (ör. "-eastus") içerebilir.

function getWriteEndpoint(): Promise<string>

Döndürülenler

Promise<string>

getWriteEndpoints()

Bilinen yazma uç noktalarını alır. Sorun giderme amacıyla kullanışlıdır.

Konuma özgü uç noktaları kullanıyorsak URL'ler bir bölge soneki (ör. "-eastus") içerebilir.

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

Döndürülenler

Promise<readonly string[]>

offer(string)

Var olan bir teklifi kimlikle okumak veya güncelleştirmek için kullanılır.

function offer(id: string): Offer

Parametreler

id

string

Teklifin kimliği.

Döndürülenler

Offer