CosmosClient class

Paket:

@azure/cosmos

Menyediakan representasi logis sisi klien dari akun database Azure Cosmos DB. Klien ini digunakan untuk mengonfigurasi dan menjalankan permintaan di layanan database Azure Cosmos DB.

Contoh

Membuat instans klien dan membuat database baru

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

Contoh

Membuat instans klien dengan Kebijakan Koneksi kustom

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

Konstruktor

CosmosClient(CosmosClientOptions)	Membuat objek CosmosClient baru. Lihat CosmosClientOptions untuk detail selengkapnya tentang opsi apa yang dapat Anda gunakan.
CosmosClient(string)	Membuat objek CosmosClient baru dari string koneksi. Database Anda string koneksi dapat ditemukan di Portal Microsoft Azure

Properti

databases	Digunakan untuk membuat database baru, atau mengkueri/membaca semua database. Gunakan .database(id) untuk membaca, mengganti, atau menghapus database tertentu yang sudah ada menurut id. Contoh Buat database baru const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Digunakan untuk mengkueri & membaca semua penawaran. Gunakan .offer(id) untuk membaca, atau mengganti penawaran yang ada.

Metode

database(string)	Digunakan untuk membaca, memperbarui, atau menghapus database yang ada dengan id atau mengakses kontainer milik database tersebut. Ini tidak melakukan panggilan jaringan. Gunakan .read untuk mendapatkan info tentang database setelah mendapatkan objek Database . Contoh Membuat kontainer baru dari database yang sudah ada const container = client.database("<database id>").containers.create("<container id>"); Contoh Menghapus database yang sudah ada await client.database("<id here>").delete();
dispose()	Menghapus penyegaran titik akhir latar belakang. Gunakan client.dispose() saat menghancurkan CosmosClient dalam proses lain.
getDatabaseAccount(RequestOptions)	Dapatkan informasi tentang DatabaseAccount saat ini (termasuk wilayah mana yang didukung, dll.)
getReadEndpoint()	Mendapatkan titik akhir baca yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah. Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.
getReadEndpoints()	Mendapatkan titik akhir baca yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah. Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.
getWriteEndpoint()	Mendapatkan url titik akhir tulis yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah. Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.
getWriteEndpoints()	Mendapatkan titik akhir tulis yang diketahui. Berguna untuk tujuan pemecahan masalah. Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.
offer(string)	Digunakan untuk membaca, atau memperbarui penawaran yang ada berdasarkan id.

Detail Konstruktor

CosmosClient(CosmosClientOptions)

Membuat objek CosmosClient baru. Lihat CosmosClientOptions untuk detail selengkapnya tentang opsi apa yang dapat Anda gunakan.

new CosmosClient(options: CosmosClientOptions)

Parameter

options

CosmosClientOptions

kantong pilihan; memerlukan setidaknya titik akhir dan autentikasi untuk dikonfigurasi

CosmosClient(string)

Membuat objek CosmosClient baru dari string koneksi. Database Anda string koneksi dapat ditemukan di Portal Microsoft Azure

new CosmosClient(connectionString: string)

Parameter

connectionString

string

Detail Properti

databases

Digunakan untuk membuat database baru, atau mengkueri/membaca semua database.

Gunakan .database(id) untuk membaca, mengganti, atau menghapus database tertentu yang sudah ada menurut id.

Contoh

Buat database baru

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

databases: Databases

Nilai Properti

Databases

offers

Digunakan untuk mengkueri & membaca semua penawaran.

Gunakan .offer(id) untuk membaca, atau mengganti penawaran yang ada.

offers: Offers

Nilai Properti

Offers

Detail Metode

database(string)

Digunakan untuk membaca, memperbarui, atau menghapus database yang ada dengan id atau mengakses kontainer milik database tersebut.

Ini tidak melakukan panggilan jaringan. Gunakan .read untuk mendapatkan info tentang database setelah mendapatkan objek Database .

Contoh

Membuat kontainer baru dari database yang sudah ada

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

Contoh

Menghapus database yang sudah ada

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

function database(id: string): Database

Parameter

id

string

Id database.

Mengembalikan

Database

dispose()

Menghapus penyegaran titik akhir latar belakang. Gunakan client.dispose() saat menghancurkan CosmosClient dalam proses lain.

function dispose()

getDatabaseAccount(RequestOptions)

Dapatkan informasi tentang DatabaseAccount saat ini (termasuk wilayah mana yang didukung, dll.)

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

Parameter

options

RequestOptions

Mengembalikan

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Mendapatkan titik akhir baca yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah.

Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.

function getReadEndpoint(): Promise<string>

Mengembalikan

Promise<string>

getReadEndpoints()

Mendapatkan titik akhir baca yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah.

Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.

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

Mengembalikan

Promise<readonly string[]>

getWriteEndpoint()

Mendapatkan url titik akhir tulis yang saat ini digunakan. Berguna untuk tujuan pemecahan masalah.

Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.

function getWriteEndpoint(): Promise<string>

Mengembalikan

Promise<string>

getWriteEndpoints()

Mendapatkan titik akhir tulis yang diketahui. Berguna untuk tujuan pemecahan masalah.

Url mungkin berisi akhiran wilayah (misalnya "-eastus") jika kita menggunakan titik akhir spesifik lokasi.

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

Mengembalikan

Promise<readonly string[]>

offer(string)

Digunakan untuk membaca, atau memperbarui penawaran yang ada berdasarkan id.

function offer(id: string): Offer

Parameter

id

string

Id penawaran.

Mengembalikan

Offer