Share via

@azure/cosmos package

  • Referensi

Kelas

AbortError

Kesalahan ini dilemparkan ketika operasi asinkron telah dibatalkan. Periksa kesalahan ini dengan menguji name bahwa properti nama kesalahan cocok "AbortError"dengan .

Contoh

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
ChangeFeedIterator

Menyediakan iterator untuk umpan perubahan.

Gunakan Items.changeFeed() untuk mendapatkan instans iterator.
ChangeFeedIteratorResponse

Satu halaman respons dari Umpan Perubahan Azure Cosmos DB
ChangeFeedResponse

Satu halaman respons dari Umpan Perubahan Azure Cosmos DB
ChangeFeedStartFrom

Kelas dasar tempat memulai ChangeFeedIterator.
ClientSideMetrics
Conflict

Gunakan untuk membaca atau menghapus Konflik oleh id yang diberikan.

Lihat Konflik untuk mengkueri atau membaca semua konflik.
ConflictResponse
Conflicts

Gunakan untuk mengkueri atau membaca semua konflik.

Lihat Konflik untuk membaca atau menghapus Konflik yang diberikan menurut id.
Container

Operasi untuk membaca, mengganti, atau menghapus kontainer tertentu yang ada berdasarkan id.

Lihat Kontainer untuk membuat kontainer baru, dan membaca/mengkueri semua kontainer; gunakan .containers.

Catatan: semua operasi ini melakukan panggilan terhadap anggaran tetap. Anda harus merancang sistem Anda s sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil container(id).read() sebelum setiap item.read() panggilan, untuk memastikan kontainer ada; lakukan ini sekali pada saat aplikasi dimulai.
ContainerResponse

Objek respons untuk operasi Kontainer
Containers

Operasi untuk membuat kontainer baru, dan membaca/mengkueri semua kontainer

Lihat Kontainer untuk membaca, mengganti, atau menghapus kontainer yang ada; gunakan .container(id).

Catatan: semua operasi ini melakukan panggilan terhadap anggaran tetap. Anda harus merancang sistem Anda s sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil containers.readAll() sebelum setiap item.read() panggilan, untuk memastikan kontainer ada; lakukan ini sekali pada saat aplikasi dimulai.
CosmosClient

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
});
CosmosDiagnostics
  • Ini adalah jenis Diagnostik Cosmos yang menyimpan informasi diagnostik yang dikumpulkan selama operasi klien. Ie. Item.read(), Container.create(). Ini memiliki tiga anggota -
  1. clientSideRequestStatistics anggota berisi informasi diagnostik agregat, termasuk -
  • pencarian metadata. Di sini semua permintaan server, selain dari sumber daya akhir yang dimaksudkan dianggap sebagai panggilan metadata. yaitu untuk item.read(id), jika klien melakukan panggilan server untuk menemukan titik akhir, itu akan dianggap sebagai panggilan metadata.
  • retries
  • titik akhir dihubungi.
  • permintaan, statistik payload respons.
  • gatewayStatistics - Informasi yang sesuai dengan operasi utama. Misalnya selama Item.read(), klien mungkin melakukan banyak operasi yaitu pencarian metadata dll, tetapi gatewayStatistics mewakili informasi diagnostik untuk operasi baca aktual.
  1. diagnosticNode - Adalah pohon seperti struktur yang menangkap informasi diagnostik terperinci. Secara default dinonaktifkan, dan dimaksudkan untuk digunakan hanya untuk penelusuran kesalahan pada lingkungan non produksi. Jenis detail yang diambil dalam diagnosticNode dikendalikan oleh CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info - Adalah nilai default. Dalam tingkat ini hanya clientSideRequestStatistics yang ditangkap. Dimaksudkan untuk lingkungan produksi.
  • CosmosDbDiagnosticLevel.debug - Menangkap diagnosticNode dan clientConfig. Tidak ada payload permintaan dan respons yang ditangkap. Tidak dimaksudkan untuk digunakan di lingkungan produksi.
  • CosmosDbDiagnosticLevel.debug-unsafe - Selain data yang diambil di CosmosDbDiagnosticLevel.debug, juga menangkap payload permintaan dan respons. Tidak dimaksudkan untuk digunakan di lingkungan produksi.
  1. clientConfig - Menangkap informasi yang terkait dengan bagaimana klien dikonfigurasi selama inisialisasi.
Database

Operasi untuk membaca atau menghapus database yang sudah ada.

Lihat Database untuk membuat database baru, dan membaca/mengkueri semua database; gunakan client.databases.

Catatan: semua operasi ini melakukan panggilan terhadap anggaran tetap. Anda harus merancang sistem Anda s sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil database.read() sebelum setiap item.read() panggilan, untuk memastikan database ada; lakukan ini sekali pada saat aplikasi dimulai.
DatabaseAccount

Mewakili DatabaseAccount di layanan database Azure Cosmos DB.
DatabaseResponse

Objek respons untuk operasi Database
Databases

Operasi untuk membuat database baru, dan membaca/mengkueri semua database

Lihat Database untuk membaca atau menghapus database yang sudah ada; gunakan client.database(id).

Catatan: semua operasi ini melakukan panggilan terhadap anggaran tetap. Anda harus merancang sistem Anda s sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil databases.readAll() sebelum setiap item.read() panggilan, untuk memastikan database ada; lakukan ini sekali pada saat aplikasi dimulai.
ErrorResponse
FeedRange

Menentukan rentang umpan untuk umpan perubahan.
FeedResponse
Item

Digunakan untuk melakukan operasi pada item tertentu.

Lihat Item untuk operasi pada semua item; lihat container.items.
ItemResponse
Items

Operasi untuk membuat item baru, dan membaca/mengkueri semua item

Lihat Item untuk membaca, mengganti, atau menghapus kontainer yang sudah ada; gunakan .item(id).
Offer

Gunakan untuk membaca atau mengganti Penawaran yang ada dengan id.

Lihat Penawaran untuk mengkueri atau membaca semua penawaran.
OfferResponse
Offers

Gunakan untuk mengkueri atau membaca semua Penawaran.

Lihat Penawaran untuk membaca atau mengganti Penawaran yang ada berdasarkan id.
PartitionKeyBuilder

Kelas penyusun untuk membangun PartitionKey.
Permission

Gunakan untuk membaca, mengganti, atau menghapus Izin yang diberikan menurut id.

Lihat Izin untuk membuat, melakukan upsert, mengkueri, atau membaca semua Izin.
PermissionResponse
Permissions

Gunakan untuk membuat, mengganti, mengkueri, dan membaca semua Izin.

Lihat Izin untuk membaca, mengganti, atau menghapus izin tertentu menurut id.
QueryIterator

Mewakili Objek QueryIterator, implementasi umpan atau respons kueri yang memungkinkan traversal dan iterasi atas respons di layanan database Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Operasi untuk membaca, mengganti, menghapus, atau menjalankan prosedur tersimpan tertentu yang ada berdasarkan id.

Agar operasi membuat, membaca semua, atau mengkueri Prosedur Tersimpan,
StoredProcedureResponse
StoredProcedures

Operasi untuk membuat, meningkatkan, atau membaca/mengkueri semua Prosedur Tersimpan.

Agar operasi membaca, mengganti, menghapus, atau menjalankan prosedur tersimpan tertentu yang sudah ada menurut id, lihat container.storedProcedure().
TimeoutError
Trigger

Operasi untuk membaca, mengganti, atau menghapus Pemicu.

Gunakan container.triggers untuk membuat, melakukan upsert, mengkueri, atau membaca semua.
TriggerResponse
Triggers

Operasi untuk membuat, melakukan upsert, mengkueri, dan membaca semua pemicu.

Gunakan container.triggers untuk membaca, mengganti, atau menghapus Pemicu.
User

Digunakan untuk membaca, mengganti, dan menghapus Pengguna.

Selain itu, Anda dapat mengakses izin untuk pengguna tertentu melalui user.permission dan user.permissions.

Lihat Pengguna untuk membuat, melakukan upsert, mengkueri, atau membaca semua.
UserDefinedFunction

Digunakan untuk membaca, mengganti, atau menghapus Fungsi Definied Pengguna tertentu berdasarkan id.

Lihat UserDefinedFunction untuk membuat, upsert, kueri, membaca semua Fungsi yang Ditentukan Pengguna.
UserDefinedFunctionResponse
UserDefinedFunctions

Digunakan untuk membuat, melakukan upsert, mengkueri, atau membaca semua Fungsi yang Ditentukan Pengguna.

Lihat UserDefinedFunction untuk membaca, mengganti, atau menghapus Fungsi yang Ditentukan Pengguna tertentu menurut id.
UserResponse
Users

Digunakan untuk membuat, melakukan upsert, mengkueri, dan membaca semua pengguna.

Lihat Pengguna untuk membaca, mengganti, atau menghapus Pengguna tertentu menurut id.

Antarmuka

@azure/cosmos.Index
Agent
BulkOptions

Objek opsi yang digunakan untuk mengubah eksekusi massal. continueOnError (Nilai default: false) - Melanjutkan eksekusi massal ketika operasi gagal ** PERHATIKAN INI AKAN DEFAULT KE TRUE DALAM RILIS 4.0
ChangeFeedIteratorOptions

Menentukan opsi untuk umpan perubahan

Jika tidak ada opsi tersebut yang diatur, opsi tersebut akan mulai membaca perubahan dari sekarang untuk seluruh kontainer.
ChangeFeedOptions

Menentukan opsi untuk umpan perubahan

Beberapa opsi ini mengontrol di mana dan kapan harus mulai membaca dari umpan perubahan. Urutan prioritas adalah:

  • Kelanjutan
  • startTime
  • startFromBeginning

Jika tidak ada opsi tersebut yang diatur, opsi tersebut akan mulai membaca perubahan dari panggilan pertama ChangeFeedIterator.fetchNext() .
ChangeFeedPullModelIterator

Gunakan Items.getChangeFeedIterator() untuk mengembalikan iterator yang dapat mengulangi semua perubahan untuk kunci partisi, rentang umpan, atau seluruh kontainer.
ConflictDefinition
ConflictResolutionPolicy

Mewakili konfigurasi kebijakan resolusi konflik untuk menentukan cara mengatasi konflik jika menulis dari berbagai wilayah mengakibatkan konflik pada dokumen dalam koleksi di layanan Azure Cosmos DB.
ConnectionPolicy

Mewakili kebijakan Koneksi yang terkait dengan CosmosClient dalam layanan database Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Mewakili pohon seperti struktur, untuk menangkap informasi diagnostik.
ErrorBody
FailedRequestAttemptDiagnostic

Jenis ini menangkap informasi diagnostik mengenai permintaan yang gagal ke api server.
FeedOptions

Opsi umpan dan metode kueri.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Item di Cosmos DB hanyalah objek JSON. Sebagian besar operasi Item memungkinkan Anda untuk menyediakan jenis Anda sendiri yang memperluas ItemDefinition yang sangat sederhana.

Anda tidak dapat menggunakan kunci yang dipesan. Anda dapat melihat daftar kunci yang dipesan di <xref:ItemBody>
JSONArray
JSONObject
Location

Digunakan untuk menentukan lokasi yang tersedia, baca adalah indeks 1 dan tulis adalah indeks 0.
MetadataLookUpDiagnostic

Jenis ini berisi informasi diagnostik mengenai satu permintaan metadata ke server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

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

Mewakili kebijakan Coba Lagi yang dialokasikan dengan permintaan yang dibatasi dalam layanan database Azure Cosmos DB.
SharedOptions

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

Mewakili parameter dalam kueri SQL Berparameter, yang ditentukan dalam SqlQuerySpec
SqlQuerySpec

Mewakili kueri SQL di layanan Azure Cosmos DB.

Kueri dengan input harus diparameterkan untuk melindungi dari injeksi SQL.

Contoh

Kueri SQL Berparameter

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

Antarmuka untuk satu kunci unik yang diteruskan sebagai bagian dari UniqueKeyPolicy
UniqueKeyPolicy

Antarmuka untuk mengatur kunci unik pada pembuatan kontainer
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Alias Jenis

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Jenis ini menyimpan informasi yang terkait dengan inisialisasi CosmosClient
ClientSideRequestStatistics

Ini adalah jenis koleksi untuk semua informasi diagnostik sisi klien.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Jenis ini berisi informasi diagnostik mengenai semua permintaan metadata ke server selama operasi klien CosmosDB.
NonePartitionKeyType

Objek yang dikembalikan mewakili nilai kunci partisi yang memungkinkan pembuatan dan akses item tanpa nilai untuk kunci partisi
NullPartitionKeyType

Objek yang dikembalikan mewakili nilai kunci partisi yang memungkinkan pembuatan dan akses item dengan nilai null untuk kunci partisi.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey dari kontainer.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Nilai Kunci Partisi primitif.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Jenis ini menangkap informasi diagnostik mengenai upaya percobaan ulang selama operasi klien CosmosDB.
TokenProvider
UpsertOperation

Enum

ConflictResolutionMode
ConnectionMode

Menentukan perilaku koneksi CosmosClient. Catatan, saat ini kami hanya mendukung Mode Gateway.
ConsistencyLevel

Mewakili tingkat konsistensi yang didukung untuk operasi klien Azure Cosmos DB.
ConsistencyLevel yang diminta harus cocok atau lebih lemah dari yang disediakan untuk akun database. Tingkat konsistensi.

Tingkat konsistensi berdasarkan urutan kekuatan adalah Kuat, BoundedStaleness, Sesi, Awalan Konsisten, dan Akhirnya.

Lihat https://aka.ms/cosmos-consistency untuk dokumentasi yang lebih rinci tentang Tingkat Konsistensi.
CosmosDbDiagnosticLevel

Tingkat Diagnostik Cosmos DB
DataType

Menentukan jenis data target dari spesifikasi jalur indeks di layanan Azure Cosmos DB.
GeospatialType
IndexKind

Menentukan jenis Indeks yang didukung.
IndexingMode

Menentukan mode pengindeksan yang didukung.
MetadataLookUpType

Ini enum untuk jenis pencarian Metadata yang mungkin.
PartitionKeyDefinitionVersion

Versi Definisi PartitionKey
PartitionKeyKind

Jenis PartitionKey yaitu Hash, MultiHash
PermissionMode

Enum untuk nilai mode izin.
PriorityLevel

Mewakili Tingkat Prioritas yang terkait dengan setiap permintaan klien Azure Cosmos DB.
Permintaan Prioritas rendah selalu dibatasi sebelum permintaan Prioritas tinggi.

Secara default semua permintaan dianggap sebagai Permintaan prioritas tinggi.

Lihat https://aka.ms/CosmosDB/PriorityBasedExecution untuk dokumentasi lebih rinci tentang pembatasan berbasis Prioritas.
SpatialType
TriggerOperation

Enum untuk nilai operasi pemicu. menentukan operasi tempat pemicu harus dijalankan.
TriggerType

Enum untuk nilai jenis pemicu. Menentukan jenis pemicu.
UserDefinedFunctionType

Enum untuk nilai jenis udf. Menentukan jenis fungsi yang ditentukan pengguna.

Fungsi

createAuthorizationSasToken(string, SasTokenProperties)

Internal eksperimental hanya Menghasilkan payload yang mewakili konfigurasi izin untuk token sas.

Detail Fungsi

createAuthorizationSasToken(string, SasTokenProperties)

Internal eksperimental hanya Menghasilkan payload yang mewakili konfigurasi izin untuk token sas.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Parameter

masterKey

string

sasTokenProperties
SasTokenProperties

Mengembalikan

Promise<string>