SharedOptions interface

Paket:

@azure/cosmos

Opsi yang dapat ditentukan untuk permintaan yang dikeluarkan ke server Azure Cosmos DB.=

Properti

abortSignal	abortSignal untuk meneruskan ke semua permintaan jaringan yang mendasar yang dibuat oleh panggilan metode ini. Lihat https://developer.mozilla.org/en-US/docs/Web/API/AbortController Contoh Membatalkan permintaan baca 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 { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const controller = new AbortController(); const results = container.items.query("SELECT * from c", { abortSignal: controller.signal, });
bypassIntegratedCache	Mengatur apakah cache terintegrasi harus dilewati atau diaktifkan untuk permintaan di layanan Azure CosmosDB. Nilai defaultnya adalah false. Secara default, cache terintegrasi diaktifkan
consistencyLevel	Tingkat konsistensi yang diperlukan oleh klien.
disableRUPerMinuteUsage	DisableRUPerMinuteUsage digunakan untuk mengaktifkan/menonaktifkan kapasitas Unit Permintaan(RU)/menit untuk melayani permintaan jika RU/detik yang disediakan reguler habis.
excludedLocations	Tidak termasuk satu atau beberapa wilayah Azure untuk operasi. Opsi ini hanya diterapkan ketika enableEndPointDiscovery diatur ke true.
initialHeaders	(Kasus penggunaan tingkat lanjut) Header awal untuk memulai saat mengirim permintaan ke Cosmos
maxIntegratedCacheStalenessInMs	Mengatur nilai keusangan yang terkait dengan permintaan dalam layanan Azure CosmosDB. Untuk permintaan di mana <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> atau <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, respons dari cache terintegrasi dijamin tidak lebih dari nilai yang ditunjukkan oleh maxIntegratedCacheStaleness ini. Ketika tingkat konsistensi tidak diatur, properti ini diabaikan. Nilai default adalah null Cache Staleness didukung dalam granularitas milidetik. Apa pun yang lebih kecil dari milidetik akan diabaikan.
priorityLevel	Tingkat Prioritas (Rendah/Tinggi) untuk setiap permintaan. Permintaan berprioritas rendah selalu dibatasi sebelum permintaan prioritas tinggi. Nilai default adalah null. Secara default semua permintaan berprioritas tinggi
sessionToken	Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen.
throughputBucket	Bucket Throughput untuk permintaan. Nilai default adalah null. Dalam hal ini, permintaan dapat menggunakan 100% throughput partisi. Untuk informasi selengkapnya, kunjungi [Bucketing throughput Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Detail Properti

abortSignal

abortSignal untuk meneruskan ke semua permintaan jaringan yang mendasar yang dibuat oleh panggilan metode ini. Lihat https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Contoh

Membatalkan permintaan baca

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 { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Nilai Properti

AbortSignal

bypassIntegratedCache

Mengatur apakah cache terintegrasi harus dilewati atau diaktifkan untuk permintaan di layanan Azure CosmosDB.

Nilai defaultnya adalah false. Secara default, cache terintegrasi diaktifkan

bypassIntegratedCache?: boolean

Nilai Properti

boolean

consistencyLevel

Tingkat konsistensi yang diperlukan oleh klien.

consistencyLevel?: string

Nilai Properti

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage digunakan untuk mengaktifkan/menonaktifkan kapasitas Unit Permintaan(RU)/menit untuk melayani permintaan jika RU/detik yang disediakan reguler habis.

disableRUPerMinuteUsage?: boolean

Nilai Properti

boolean

excludedLocations

Tidak termasuk satu atau beberapa wilayah Azure untuk operasi.

Opsi ini hanya diterapkan ketika enableEndPointDiscovery diatur ke true.

excludedLocations?: string[]

Nilai Properti

string[]

initialHeaders

(Kasus penggunaan tingkat lanjut) Header awal untuk memulai saat mengirim permintaan ke Cosmos

initialHeaders?: CosmosHeaders

Nilai Properti

CosmosHeaders

maxIntegratedCacheStalenessInMs

Mengatur nilai keusangan yang terkait dengan permintaan dalam layanan Azure CosmosDB. Untuk permintaan di mana <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> atau <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, respons dari cache terintegrasi dijamin tidak lebih dari nilai yang ditunjukkan oleh maxIntegratedCacheStaleness ini. Ketika tingkat konsistensi tidak diatur, properti ini diabaikan.

Nilai default adalah null

Cache Staleness didukung dalam granularitas milidetik. Apa pun yang lebih kecil dari milidetik akan diabaikan.

maxIntegratedCacheStalenessInMs?: number

Nilai Properti

number

priorityLevel

Tingkat Prioritas (Rendah/Tinggi) untuk setiap permintaan. Permintaan berprioritas rendah selalu dibatasi sebelum permintaan prioritas tinggi.

Nilai default adalah null. Secara default semua permintaan berprioritas tinggi

priorityLevel?: PriorityLevel

Nilai Properti

PriorityLevel

sessionToken

Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen.

sessionToken?: string

Nilai Properti

string

throughputBucket

Bucket Throughput untuk permintaan.

Nilai default adalah null. Dalam hal ini, permintaan dapat menggunakan 100% throughput partisi.

Untuk informasi selengkapnya, kunjungi [Bucketing throughput Cosmos DB](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Nilai Properti

number