Databases class
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 sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda.
Misalnya, jangan panggil databases.readAll()
sebelum setiap item.read()
panggilan, untuk memastikan database ada; lakukan ini sekali pada memulai aplikasi.
Properti
client |
Metode
create(Database |
Kirim permintaan untuk membuat database. Database mengelola pengguna, izin, dan sekumpulan kontainer. Setiap Akun Database Azure Cosmos DB dapat mendukung beberapa database bernama independen, dengan database menjadi kontainer logis untuk data. Setiap Database terdiri dari satu atau beberapa kontainer, yang masing-masing berisi satu atau beberapa dokumen. Karena database adalah sumber daya administratif, Kunci Master Layanan akan diperlukan untuk mengakses dan berhasil menyelesaikan tindakan apa pun menggunakan API Pengguna. |
create |
Periksa apakah database ada, dan jika tidak, buatlah.
Ini akan membuat operasi baca berdasarkan id di Database mengelola pengguna, izin, dan sekumpulan kontainer. Setiap Akun Database Azure Cosmos DB dapat mendukung beberapa database bernama independen, dengan database menjadi kontainer logis untuk data. Setiap Database terdiri dari satu atau beberapa kontainer, yang masing-masing berisi satu atau beberapa dokumen. Karena database adalah sumber daya administratif, Kunci Master Layanan akan diperlukan untuk mengakses dan berhasil menyelesaikan tindakan apa pun menggunakan API Pengguna. |
query(string | Sql |
Mengkueri semua database. Contoh Baca semua database ke array.
* |
query<T>(string | Sql |
Mengkueri semua database. Contoh Baca semua database ke array.
* |
read |
Membaca semua database. Contoh Baca semua database ke array.
* |
Detail Properti
client
Detail Metode
create(DatabaseRequest, RequestOptions)
Kirim permintaan untuk membuat database.
Database mengelola pengguna, izin, dan sekumpulan kontainer. Setiap Akun Database Azure Cosmos DB dapat mendukung beberapa database bernama independen, dengan database menjadi kontainer logis untuk data.
Setiap Database terdiri dari satu atau beberapa kontainer, yang masing-masing berisi satu atau beberapa dokumen. Karena database adalah sumber daya administratif, Kunci Master Layanan akan diperlukan untuk mengakses dan berhasil menyelesaikan tindakan apa pun menggunakan API Pengguna.
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parameter
- body
- DatabaseRequest
DatabaseDefinition yang mewakili Database yang akan dibuat.
- options
- RequestOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
Periksa apakah database ada, dan jika tidak, buatlah.
Ini akan membuat operasi baca berdasarkan id di body
, maka jika tidak ditemukan, operasi buat.
Database mengelola pengguna, izin, dan sekumpulan kontainer. Setiap Akun Database Azure Cosmos DB dapat mendukung beberapa database bernama independen, dengan database menjadi kontainer logis untuk data.
Setiap Database terdiri dari satu atau beberapa kontainer, yang masing-masing berisi satu atau beberapa dokumen. Karena database adalah sumber daya administratif, Kunci Master Layanan akan diperlukan untuk mengakses dan berhasil menyelesaikan tindakan apa pun menggunakan API Pengguna.
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parameter
- body
- DatabaseRequest
DatabaseDefinition yang mewakili Database yang akan dibuat.
- options
- RequestOptions
Opsi tambahan untuk permintaan
Mengembalikan
Promise<DatabaseResponse>
query(string | SqlQuerySpec, FeedOptions)
Mengkueri semua database.
Contoh
Baca semua database ke array.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
Parameter
- query
-
string | 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 semua database dalam array atau mengulanginya satu per satu. *
query<T>(string | SqlQuerySpec, FeedOptions)
Mengkueri semua database.
Contoh
Baca semua database ke array.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
Parameter
- query
-
string | 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 semua database dalam array atau mengulanginya satu per satu. *
readAll(FeedOptions)
Membaca semua database.
Contoh
Baca semua database ke array.
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>
Parameter
- options
- FeedOptions
Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.
Mengembalikan
QueryIterator Memungkinkan Anda mengembalikan semua database dalam array atau mengulanginya satu per satu. *