Database class
Meglévő adatbázis olvasására vagy törlésére szolgáló műveletek.
Lásd: Adatbázisok új adatbázisok létrehozásához és az összes adatbázis olvasásához/lekérdezéséhez; client.databases
használata.
Megjegyzés: ezek a műveletek rögzített költségvetéssel kapcsolatos hívásokat hajtanak végre.
Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással együtt alkonyatosan skálázhatók legyenek.
Például ne hívjon database.read()
minden egyes item.read()
hívás előtt, hogy meggyőződjön arról, hogy az adatbázis létezik; ezt egyszer kell elvégeznie az alkalmazás indításakor.
Konstruktorok
Database(Cosmos |
Egy új Database-példányt ad vissza. Megjegyzés: a szándék az, hogy ezt az objektumot CosmosClient keresztül |
Tulajdonságok
client | |
containers | Új tárolók létrehozásához vagy az összes tároló lekérdezéséhez/olvasásához használható. A példa Új tároló létrehozása
|
id | |
url | Az erőforrás hivatkozási URL-címét adja vissza. Az engedélyek csatolásához használatos. |
users | Új felhasználók létrehozásához vagy az összes felhasználó lekérdezéséhez/olvasásához használható. A |
Metódusok
container(string) | Egy adott, meglévő adatbázis azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál. Használja példa Tároló törlése
|
delete(Request |
Törölje a megadott adatbázist. |
read(Request |
Olvassa el az adott adatbázis definícióját. |
read |
Ajánlatot kap az adatbázisban. Ha nincs ilyen, akkor egy nem definiált OfferResponse értéket ad vissza. |
user(string) | Egy adott, meglévő felhasználó azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál. Az |
Konstruktor adatai
Database(CosmosClient, string, ClientContext)
Egy új Database-példányt ad vissza.
Megjegyzés: a szándék az, hogy ezt az objektumot CosmosClient keresztül client.database(id)
, nem pedig saját példányosítása.
new Database(client: CosmosClient, id: string, clientContext: ClientContext)
Paraméterek
- client
- CosmosClient
- id
-
string
- clientContext
-
ClientContext
Tulajdonság adatai
client
containers
Új tárolók létrehozásához vagy az összes tároló lekérdezéséhez/olvasásához használható.
A .database(id)
használatával beolvashat, lecserélhet vagy törölhet egy adott meglévő adatbázis- azonosító alapján.
példa
Új tároló létrehozása
const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
containers: Containers
Tulajdonság értéke
id
id: string
Tulajdonság értéke
string
url
Az erőforrás hivatkozási URL-címét adja vissza. Az engedélyek csatolásához használatos.
string url
Tulajdonság értéke
string
users
Új felhasználók létrehozásához vagy az összes felhasználó lekérdezéséhez/olvasásához használható.
A .user(id)
használatával beolvashat, lecserélhet vagy törölhet egy adott meglévő felhasználót, azonosító alapján.
users: Users
Tulajdonság értéke
Metódus adatai
container(string)
Egy adott, meglévő adatbázis azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.
Használja .containers
új tárolók létrehozását, vagy az összes tároló lekérdezését/olvasását.
példa
Tároló törlése
await client.database("<db id>").container("<container id>").delete();
function container(id: string): Container
Paraméterek
- id
-
string
Válaszok
delete(RequestOptions)
Törölje a megadott adatbázist.
function delete(options?: RequestOptions): Promise<DatabaseResponse>
Paraméterek
- options
- RequestOptions
Válaszok
Promise<DatabaseResponse>
read(RequestOptions)
Olvassa el az adott adatbázis definícióját.
function read(options?: RequestOptions): Promise<DatabaseResponse>
Paraméterek
- options
- RequestOptions
Válaszok
Promise<DatabaseResponse>
readOffer(RequestOptions)
Ajánlatot kap az adatbázisban. Ha nincs ilyen, akkor egy nem definiált OfferResponse értéket ad vissza.
function readOffer(options?: RequestOptions): Promise<OfferResponse>
Paraméterek
- options
- RequestOptions
Válaszok
Promise<OfferResponse>
user(string)
Egy adott, meglévő felhasználó azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.
Az .users
használata új felhasználók létrehozásához, vagy az összes felhasználó lekérdezéséhez/olvasásához.
function user(id: string): User
Paraméterek
- id
-
string