Bagikan melalui

Database class

  • Referensi
Paket:
@azure/cosmos

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 sih sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil database.read() sebelum setiap panggilan item.read(), untuk memastikan database ada; lakukan ini setelah aplikasi dimulai.

Konstruktor

Database(CosmosClient, string, ClientContext)

Mengembalikan instans Database baru.

Catatan: niatnya adalah untuk mendapatkan objek ini dari CosmosClient melalui client.database(id), bukan untuk membuat instans sendiri.

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>"});
id
url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.
users

Digunakan untuk membuat pengguna baru, atau mengkueri/membaca semua pengguna.

Gunakan .user(id) untuk membaca, mengganti, atau menghapus pengguna tertentu yang sudah ada menurut id.

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();
delete(RequestOptions)

Hapus Database yang diberikan.
read(RequestOptions)

Baca definisi Database yang diberikan.
readOffer(RequestOptions)

Mendapatkan penawaran pada database. Jika tidak ada, mengembalikan OfferResponse dengan tidak terdefinisi.
user(string)

Digunakan untuk membaca, mengganti, atau menghapus Pengguna tertentu yang ada berdasarkan id.

Gunakan .users untuk membuat pengguna baru, atau mengkueri/membaca semua pengguna.

Detail Konstruktor

Database(CosmosClient, string, ClientContext)

Mengembalikan instans Database baru.

Catatan: niatnya 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 

client: CosmosClient

Nilai Properti

CosmosClient

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

Containers

id 

id: string

Nilai Properti

string

url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di 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 menurut id.

users: Users

Nilai Properti

Users

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

Container

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>

user(string)

Digunakan untuk membaca, mengganti, atau menghapus Pengguna tertentu yang ada berdasarkan id.

Gunakan .users untuk membuat pengguna baru, atau mengkueri/membaca semua pengguna.

function user(id: string): User

Parameter

id

string

Mengembalikan

User