Container class

Paket:

@azure/cosmos

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.

Properti

conflicts	Operasi untuk membaca dan mengkueri konflik untuk kontainer yang diberikan. Untuk membaca atau menghapus konflik tertentu, gunakan .conflict(id).
database
id
items	Operasi untuk membuat item baru, dan membaca/mengkueri semua item Untuk membaca, mengganti, atau menghapus item yang sudah ada, gunakan .item(id). Contoh Membuat item baru const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Semua operasi untuk Prosedur Tersimpan, Pemicu, dan Fungsi yang Ditentukan Pengguna
url	Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan dalam Izin.

Metode

conflict(string, PartitionKey)	Digunakan untuk membaca, mengganti, atau menghapus Konflik tertentu yang ada menurut id. Gunakan .conflicts untuk membuat konflik baru, atau mengkueri/membaca semua konflik.
delete(RequestOptions)	Menghapus kontainer
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Hapus semua dokumen milik kontainer untuk nilai kunci partisi yang disediakan
getFeedRanges()
getPartitionKeyDefinition()	Mendapatkan definisi kunci partisi terlebih dahulu dengan melihat ke dalam cache jika tidak dengan membaca koleksi.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Digunakan untuk membaca, mengganti, atau menghapus Item tertentu yang sudah ada menurut id. Gunakan .items untuk membuat item baru, atau mengkueri/membaca semua item. Contoh Mengganti item const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Membaca definisi kontainer
readOffer(RequestOptions)	Mendapatkan penawaran pada kontainer. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Mengganti definisi kontainer

Detail Properti

conflicts

Operasi untuk membaca dan mengkueri konflik untuk kontainer yang diberikan.

Untuk membaca atau menghapus konflik tertentu, gunakan .conflict(id).

Conflicts conflicts

Nilai Properti

Conflicts

database

database: Database

Nilai Properti

Database

id

id: string

Nilai Properti

string

items

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

Untuk membaca, mengganti, atau menghapus item yang sudah ada, gunakan .item(id).

Contoh

Membuat item baru

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

Nilai Properti

Items

scripts

Semua operasi untuk Prosedur Tersimpan, Pemicu, dan Fungsi yang Ditentukan Pengguna

Scripts scripts

Nilai Properti

Scripts

url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan dalam Izin.

string url

Nilai Properti

string

Detail Metode

conflict(string, PartitionKey)

Digunakan untuk membaca, mengganti, atau menghapus Konflik tertentu yang ada menurut id.

Gunakan .conflicts untuk membuat konflik baru, atau mengkueri/membaca semua konflik.

function conflict(id: string, partitionKey?: PartitionKey): Conflict

Parameter

id

string

Id Konflik.

partitionKey

PartitionKey

Mengembalikan

Conflict

delete(RequestOptions)

Menghapus kontainer

function delete(options?: RequestOptions): Promise<ContainerResponse>

Parameter

options

RequestOptions

Mengembalikan

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Hapus semua dokumen milik kontainer untuk nilai kunci partisi yang disediakan

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

Parameter

partitionKey

PartitionKey

Nilai kunci partisi item yang akan dihapus

options

RequestOptions

Mengembalikan

Promise<ContainerResponse>

getFeedRanges()

function getFeedRanges(): Promise<readonly FeedRange[]>

Mengembalikan

Promise<readonly FeedRange[]>

semua rentang umpan yang umpan perubahannya dapat diambil.

getPartitionKeyDefinition()

Peringatan

API ini sudah tidak digunakan lagi.

This method has been renamed to readPartitionKeyDefinition.

Mendapatkan definisi kunci partisi terlebih dahulu dengan melihat ke dalam cache jika tidak dengan membaca koleksi.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

Mengembalikan

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

Parameter

query

string | SqlQuerySpec

Mengembalikan

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Digunakan untuk membaca, mengganti, atau menghapus Item tertentu yang sudah ada menurut id.

Gunakan .items untuk membuat item baru, atau mengkueri/membaca semua item.

Contoh

Mengganti item const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

Parameter

id

string

Id Item.

partitionKeyValue

PartitionKey

Nilai kunci partisi Item

Mengembalikan

Item

read(RequestOptions)

Membaca definisi kontainer

function read(options?: RequestOptions): Promise<ContainerResponse>

Parameter

options

RequestOptions

Mengembalikan

Promise<ContainerResponse>

readOffer(RequestOptions)

Mendapatkan penawaran pada kontainer. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parameter

options

RequestOptions

Mengembalikan

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

Parameter

feedOptions

FeedOptions

Mengembalikan

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Mengganti definisi kontainer

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

Parameter

body

ContainerDefinition

options

RequestOptions

Mengembalikan

Promise<ContainerResponse>