Container class
Operasi untuk membaca, mengganti, atau menghapus kontainer tertentu yang ada menurut 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 sih sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda.
Misalnya, jangan memanggil container(id).read() sebelum setiap panggilan item.read(), untuk memastikan kontainer ada; lakukan ini setelah aplikasi dimulai.
Properti
| conflicts | Operasi untuk membaca dan mengkueri konflik untuk kontainer yang diberikan. Untuk membaca atau menghapus konflik tertentu, gunakan |
| database | |
| id | |
| items | Operasi untuk membuat item baru, dan membaca/mengkueri semua item Untuk membaca, mengganti, atau menghapus item yang ada, gunakan Contoh Membuat item baru |
| scripts | Semua operasi untuk Prosedur Tersimpan, Pemicu, dan Fungsi yang Ditentukan Pengguna |
| url | Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin. |
Metode
| conflict(string, Partition |
Digunakan untuk membaca, mengganti, atau menghapus Konflik tertentu yang ada menurut id. Gunakan |
| delete(Request |
Menghapus kontainer |
| delete |
Menghapus semua dokumen milik kontainer untuk nilai kunci partisi yang disediakan |
| get |
|
| get |
Mendapatkan definisi kunci partisi terlebih dahulu dengan melihat ke cache jika tidak dengan membaca koleksi. |
| get |
|
| item(string, Partition |
Digunakan untuk membaca, mengganti, atau menghapus Item tertentu yang sudah ada menurut id. Gunakan Contoh Mengganti item |
| read(Request |
Membaca definisi kontainer |
| read |
Mendapatkan penawaran pada kontainer. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi. |
| read |
|
| replace(Container |
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 conflictsNilai Properti
database
id
id: stringNilai Properti
string
items
Operasi untuk membuat item baru, dan membaca/mengkueri semua item
Untuk membaca, mengganti, atau menghapus item yang ada, gunakan .item(id).
Contoh
Membuat item baru
const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
Items itemsNilai Properti
scripts
Semua operasi untuk Prosedur Tersimpan, Pemicu, dan Fungsi yang Ditentukan Pengguna
Scripts scriptsNilai Properti
url
Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.
string urlNilai 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): ConflictParameter
- id
-
string
Id Konflik.
- partitionKey
- PartitionKey
Mengembalikan
delete(RequestOptions)
Menghapus kontainer
function delete(options?: RequestOptions): Promise<ContainerResponse>Parameter
- options
- RequestOptions
Mengembalikan
Promise<ContainerResponse>
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)
Menghapus 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 tempat changefeed 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 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): ItemParameter
- id
-
string
Id Item.
- partitionKeyValue
- PartitionKey
Nilai kunci partisi Item
Mengembalikan
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>