RequestOptions interface
Opsi yang dapat ditentukan untuk permintaan yang dikeluarkan ke server Azure Cosmos DB.=
- Memperluas
Properti
access |
Kondisi yang Terkait dengan permintaan. |
consistency |
Tingkat konsistensi yang diperlukan oleh klien. |
disable |
Menonaktifkan pembuatan id otomatis (akan menyebabkan pembuatan gagal jika id tidak ada pada definisi) |
disable |
DisableRUPerMinuteUsage digunakan untuk mengaktifkan/menonaktifkan kapasitas Unit Permintaan(RU)/menit untuk melayani permintaan jika RU/detik yang disediakan reguler habis. |
enable |
Mengaktifkan atau menonaktifkan pengelogan dalam prosedur tersimpan JavaScript. |
indexing |
Menentukan arahan pengindeksan (indeks, jangan indeks .. dll). |
offer |
Throughput penawaran yang disediakan untuk kontainer dalam pengukuran Requests-per-Unit. |
offer |
Jenis penawaran saat membuat kontainer dokumen. Opsi ini hanya valid saat membuat kontainer dokumen. |
populate |
Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen. |
post |
Menunjukkan apa pemicu postingan yang akan dipanggil setelah operasi. |
pre |
Menunjukkan apa pemicu sebelumnya yang akan dipanggil sebelum operasi. |
resource |
Waktu kedaluwarsa (dalam detik) untuk token sumber daya yang terkait dengan izin (hanya berlaku untuk permintaan izin). |
url |
(Kasus penggunaan tingkat lanjut) Url yang akan disambungkan. |
Properti yang Diwariskan
abort |
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
|
bypass |
Mengatur apakah cache terintegrasi harus dilewati atau diaktifkan untuk permintaan di layanan Azure CosmosDB. Nilai defaultnya adalah false. Secara default, cache terintegrasi diaktifkan |
initial |
(Kasus penggunaan tingkat lanjut) Header awal untuk memulai saat mengirim permintaan ke Cosmos |
max |
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. |
priority |
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 |
session |
Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen. |
Detail Properti
accessCondition
Kondisi yang Terkait dengan permintaan.
accessCondition?: { condition: string, type: string }
Nilai Properti
{ condition: string, type: string }
consistencyLevel
Tingkat konsistensi yang diperlukan oleh klien.
consistencyLevel?: string
Nilai Properti
string
disableAutomaticIdGeneration
Menonaktifkan pembuatan id otomatis (akan menyebabkan pembuatan gagal jika id tidak ada pada definisi)
disableAutomaticIdGeneration?: boolean
Nilai Properti
boolean
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
enableScriptLogging
Mengaktifkan atau menonaktifkan pengelogan dalam prosedur tersimpan JavaScript.
enableScriptLogging?: boolean
Nilai Properti
boolean
indexingDirective
Menentukan arahan pengindeksan (indeks, jangan indeks .. dll).
indexingDirective?: string
Nilai Properti
string
offerThroughput
Throughput penawaran yang disediakan untuk kontainer dalam pengukuran Requests-per-Unit.
offerThroughput?: number
Nilai Properti
number
offerType
Jenis penawaran saat membuat kontainer dokumen.
Opsi ini hanya valid saat membuat kontainer dokumen.
offerType?: string
Nilai Properti
string
populateQuotaInfo
Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen.
populateQuotaInfo?: boolean
Nilai Properti
boolean
postTriggerInclude
Menunjukkan apa pemicu postingan yang akan dipanggil setelah operasi.
postTriggerInclude?: string | string[]
Nilai Properti
string | string[]
preTriggerInclude
Menunjukkan apa pemicu sebelumnya yang akan dipanggil sebelum operasi.
preTriggerInclude?: string | string[]
Nilai Properti
string | string[]
resourceTokenExpirySeconds
Waktu kedaluwarsa (dalam detik) untuk token sumber daya yang terkait dengan izin (hanya berlaku untuk permintaan izin).
resourceTokenExpirySeconds?: number
Nilai Properti
number
urlConnection
(Kasus penggunaan tingkat lanjut) Url yang akan disambungkan.
urlConnection?: string
Nilai Properti
string
Detail Properti yang Diwariskan
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
const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
abortSignal?: AbortSignal
Nilai Properti
AbortSignal
Diwariskan DariSharedOptions.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
Diwariskan DariSharedOptions.bypassIntegratedCache
initialHeaders
(Kasus penggunaan tingkat lanjut) Header awal untuk memulai saat mengirim permintaan ke Cosmos
initialHeaders?: CosmosHeaders
Nilai Properti
Diwariskan DariSharedOptions.initialHeaders
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
Diwarisi DariSharedOptions.maxIntegratedCacheStalenessInMs
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
Diwariskan DariSharedOptions.priorityLevel
sessionToken
Mengaktifkan/menonaktifkan mendapatkan statistik terkait kuota kontainer dokumen untuk permintaan baca kontainer dokumen.
sessionToken?: string
Nilai Properti
string
Diwariskan DariSharedOptions.sessionToken