Containers class
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 sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda.
Misalnya, jangan panggil containers.readAll() sebelum setiap item.read() panggilan, untuk memastikan kontainer ada; lakukan ini sekali pada start up aplikasi.
Konstruktor
| Containers(Database, Client |
Properti
| database |
Metode
| create(Container |
Membuat kontainer. Kontainer adalah kontainer logis bernama untuk item. Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON. Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama. Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya. |
| create |
Memeriksa apakah Kontainer ada, dan, jika tidak, membuatnya.
Ini akan membuat operasi baca berdasarkan id di Kontainer adalah kontainer logis bernama untuk item. Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON. Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama. Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya. |
| query(Sql |
Mengkueri semua kontainer. Contoh Baca semua kontainer untuk array.
* |
| query<T>(Sql |
Mengkueri semua kontainer. Contoh Baca semua kontainer untuk array.
* |
| read |
Membaca semua kontainer. Contoh Baca semua kontainer untuk array.
* |
Detail Konstruktor
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)Parameter
- database
- Database
- clientContext
-
ClientContext
Detail Properti
database
Detail Metode
create(ContainerRequest, RequestOptions)
Membuat kontainer.
Kontainer adalah kontainer logis bernama untuk item.
Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.
Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.
Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parameter
- body
- ContainerRequest
Mewakili isi kontainer.
- options
- RequestOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
Memeriksa apakah Kontainer ada, dan, jika tidak, membuatnya.
Ini akan membuat operasi baca berdasarkan id di body, maka jika tidak ditemukan, operasi buat.
Anda harus mengonfirmasi bahwa output cocok dengan isi yang Anda lewati untuk properti non-default (yaitu kebijakan pengindeksan/dll.)
Kontainer adalah kontainer logis bernama untuk item.
Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.
Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.
Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parameter
- body
- ContainerRequest
Mewakili isi kontainer.
- options
- RequestOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
Mengkueri semua kontainer.
Contoh
Baca semua kontainer untuk array.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>Parameter
- query
- SqlQuerySpec
Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.
- options
- FeedOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
QueryIterator<any>
QueryIterator Memungkinkan Anda mengembalikan kontainer tertentu dalam array atau mengulanginya satu per satu. *
query<T>(SqlQuerySpec, FeedOptions)
Mengkueri semua kontainer.
Contoh
Baca semua kontainer untuk array.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>Parameter
- query
- SqlQuerySpec
Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.
- options
- FeedOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
QueryIterator Memungkinkan Anda mengembalikan kontainer tertentu dalam array atau mengulanginya satu per satu. *
readAll(FeedOptions)
Membaca semua kontainer.
Contoh
Baca semua kontainer untuk array.
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>Parameter
- options
- FeedOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
QueryIterator Memungkinkan Anda mengembalikan semua kontainer dalam array atau mengulanginya satu per satu. *