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

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

Örnek

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

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});

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)	bir bağlantı dizesi yeni bir CosmosClient nesnesi oluşturur. Veritabanı bağlantı dizesi Azure Portal'da bulunabilir

Özellikler

databases	Yeni veritabanları oluşturmak veya tüm veritabanlarını sorgulamak/okumak için kullanılır. Var olan belirli bir veritabanını kimliğe göre okumak, değiştirmek veya silmek için kullanın .database(id) . Örnek Yeni veritabanı oluşturma const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Tüm teklifleri sorgulamak & okumak için kullanılır. Mevcut teklifleri okumak veya değiştirmek için kullanın .offer(id) .

Yöntemler

database(string)	Var olan bir veritabanını kimlikle okumak, güncelleştirmek veya silmek veya bu veritabanına ait kapsayıcılara erişmek için kullanılır. Bu bir ağ çağrısı yapmaz. Veritabanı nesnesini aldıktan sonra veritabanı hakkında bilgi almak için kullanın.read. Örnek Mevcut veritabanından yeni kapsayıcı oluşturma const container = client.database("<database id>").containers.create("<container id>"); Örnek Mevcut veritabanını silme await client.database("<id here>").delete();
dispose()	Arka plan uç noktası yenileyiciyi temizler. CosmosClient'i başka bir işlemde yok ederken client.dispose() kullanın.
getDatabaseAccount(RequestOptions)	Geçerli DatabaseAccount hakkında bilgi alın (desteklenen bölgeler dahil vb.)
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 ("-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ı gerektirme

CosmosClient(string)

bir bağlantı dizesi yeni bir CosmosClient nesnesi oluşturur. Veritabanı bağlantı dizesi Azure Portal'da bulunabilir

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.

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

Örnek

Yeni veritabanı oluşturma

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

databases: Databases

Özellik Değeri

Databases

offers

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

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

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 veya bu veritabanına ait kapsayıcılara erişmek için kullanılır.

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

Örnek

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

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

Örnek

Mevcut veritabanını silme

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şlemde yok ederken client.dispose() kullanın.

function dispose()

getDatabaseAccount(RequestOptions)

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

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