Database class
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.
Konstruktor
Database(Cosmos |
Mengembalikan instans Database baru. Catatan: tujuannya adalah untuk mendapatkan objek ini dari CosmosClient melalui |
Properti
client | |
containers | Digunakan untuk membuat kontainer baru, atau mengkueri/membaca semua kontainer. Gunakan Contoh Membuat kontainer baru
|
id | |
url | Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan dalam Izin. |
users | Digunakan untuk membuat pengguna baru, atau mengkueri/membaca semua pengguna. Gunakan |
Metode
container(string) | Digunakan untuk membaca, mengganti, atau menghapus Database tertentu yang sudah ada menurut id. Gunakan Contoh Menghapus kontainer
|
delete(Request |
Hapus Database yang diberikan. |
read(Request |
Baca definisi Database yang diberikan. |
read |
Mendapatkan penawaran pada database. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi. |
user(string) | Digunakan untuk membaca, mengganti, atau menghapus Pengguna tertentu yang sudah ada berdasarkan id. Gunakan |
Detail Konstruktor
Database(CosmosClient, string, ClientContext)
Mengembalikan instans Database baru.
Catatan: tujuannya adalah untuk mendapatkan objek ini dari CosmosClient melalui client.database(id)
, bukan untuk membuat instans sendiri.
new Database(client: CosmosClient, id: string, clientContext: ClientContext)
Parameter
- client
- CosmosClient
- id
-
string
- clientContext
-
ClientContext
Detail Properti
client
containers
Digunakan untuk membuat kontainer baru, atau mengkueri/membaca semua kontainer.
Gunakan .database(id)
untuk membaca, mengganti, atau menghapus Database tertentu yang sudah ada menurut id.
Contoh
Membuat kontainer baru
const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
containers: Containers
Nilai Properti
id
id: string
Nilai Properti
string
url
Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan dalam Izin.
string url
Nilai Properti
string
users
Digunakan untuk membuat pengguna baru, atau mengkueri/membaca semua pengguna.
Gunakan .user(id)
untuk membaca, mengganti, atau menghapus Pengguna tertentu yang sudah ada berdasarkan id.
users: Users
Nilai Properti
Detail Metode
container(string)
Digunakan untuk membaca, mengganti, atau menghapus Database tertentu yang sudah ada menurut id.
Gunakan .containers
membuat kontainer baru, atau mengkueri/membaca semua kontainer.
Contoh
Menghapus kontainer
await client.database("<db id>").container("<container id>").delete();
function container(id: string): Container
Parameter
- id
-
string
Mengembalikan
delete(RequestOptions)
Hapus Database yang diberikan.
function delete(options?: RequestOptions): Promise<DatabaseResponse>
Parameter
- options
- RequestOptions
Mengembalikan
Promise<DatabaseResponse>
read(RequestOptions)
Baca definisi Database yang diberikan.
function read(options?: RequestOptions): Promise<DatabaseResponse>
Parameter
- options
- RequestOptions
Mengembalikan
Promise<DatabaseResponse>
readOffer(RequestOptions)
Mendapatkan penawaran pada database. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi.
function readOffer(options?: RequestOptions): Promise<OfferResponse>
Parameter
- options
- RequestOptions
Mengembalikan
Promise<OfferResponse>