Megosztás a következőn keresztül:

CosmosClient class

  • Referencia
Csomag:
@azure/cosmos

Az Azure Cosmos DB-adatbázisfiók ügyféloldali logikai ábrázolását biztosítja. Ez az ügyfél a kérések konfigurálására és végrehajtására szolgál az Azure Cosmos DB adatbázis-szolgáltatásban.

példa

Ügyfél példányosítása és új adatbázis létrehozása

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

példa

Ügyfél példányosítása egyéni kapcsolati házirenddel

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

Konstruktorok

CosmosClient(CosmosClientOptions)

Létrehoz egy új CosmosClient objektumot. A CosmosClientOptions további információt a használható lehetőségekről talál.
CosmosClient(string)

Létrehoz egy új CosmosClient objektumot egy kapcsolati sztringből. Az adatbázis kapcsolati sztringje az Azure Portalon található

Tulajdonságok

databases

Új adatbázisok létrehozásához, vagy az összes adatbázis 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ázist azonosító alapján.

példa

Új adatbázis létrehozása

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers

Az összes ajánlat lekérdezéséhez & használható.

A meglévő ajánlatok olvasásához vagy cseréjéhez használja a .offer(id).

Metódusok

database(string)

Meglévő adatbázis olvasására, frissítésére vagy törlésére szolgál az adatbázishoz tartozó tárolók azonosítójával vagy elérésével.

Ez nem indít hálózati hívást. A .read használatával adatokat kaphat az adatbázisról a Adatbázis objektum lekérése után.

példa

Új tároló létrehozása meglévő adatbázisból

const container = client.database("<database id>").containers.create("<container id>");

példa

Meglévő adatbázis törlése

await client.database("<id here>").delete();
dispose()

Törli a háttérvégpont-frissítőt. Használja a client.dispose() parancsot a CosmosClient egy másik folyamaton belüli elpusztításakor.
getDatabaseAccount(RequestOptions)

Az aktuális DatabaseAccount (beleértve a támogatott régiókat stb.)
getReadEndpoint()

Lekéri a jelenleg használt olvasási végpontot. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").
getReadEndpoints()

Lekéri a jelenleg használt olvasási végpontot. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").
getWriteEndpoint()

Lekéri a jelenleg használt írási végpont URL-címét. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").
getWriteEndpoints()

Lekéri az ismert írási végpontokat. Hibaelhárítási célokra hasznos.

Az URL-címek tartalmazhatnak régió-utótagot (pl. "-eastus"), ha helyspecifikus végpontokat használunk.
offer(string)

Egy meglévő ajánlat olvasásához vagy frissítéséhez használatos azonosító alapján.

Konstruktor adatai

CosmosClient(CosmosClientOptions)

Létrehoz egy új CosmosClient objektumot. A CosmosClientOptions további információt a használható lehetőségekről talál.

new CosmosClient(options: CosmosClientOptions)

Paraméterek

options
CosmosClientOptions

táska lehetőségek; legalább a végpont és a hitelesítés konfigurálását igényli

CosmosClient(string)

Létrehoz egy új CosmosClient objektumot egy kapcsolati sztringből. Az adatbázis kapcsolati sztringje az Azure Portalon található

new CosmosClient(connectionString: string)

Paraméterek

connectionString

string

Tulajdonság adatai

databases

Új adatbázisok létrehozásához, vagy az összes adatbázis 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ázist azonosító alapján.

példa

Új adatbázis létrehozása

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

Tulajdonság értéke

Databases

offers

Az összes ajánlat lekérdezéséhez & használható.

A meglévő ajánlatok olvasásához vagy cseréjéhez használja a .offer(id).

offers: Offers

Tulajdonság értéke

Offers

Metódus adatai

database(string)

Meglévő adatbázis olvasására, frissítésére vagy törlésére szolgál az adatbázishoz tartozó tárolók azonosítójával vagy elérésével.

Ez nem indít hálózati hívást. A .read használatával adatokat kaphat az adatbázisról a Adatbázis objektum lekérése után.

példa

Új tároló létrehozása meglévő adatbázisból

const container = client.database("<database id>").containers.create("<container id>");

példa

Meglévő adatbázis törlése

await client.database("<id here>").delete();

function database(id: string): Database

Paraméterek

id

string

Az adatbázis azonosítója.

Válaszok

Database

dispose()

Törli a háttérvégpont-frissítőt. Használja a client.dispose() parancsot a CosmosClient egy másik folyamaton belüli elpusztításakor.

function dispose()

getDatabaseAccount(RequestOptions)

Az aktuális DatabaseAccount (beleértve a támogatott régiókat stb.)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Paraméterek

options
RequestOptions

Válaszok

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Lekéri a jelenleg használt olvasási végpontot. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").

function getReadEndpoint(): Promise<string>

Válaszok

Promise<string>

getReadEndpoints()

Lekéri a jelenleg használt olvasási végpontot. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").

function getReadEndpoints(): Promise<readonly string[]>

Válaszok

Promise<readonly string[]>

getWriteEndpoint()

Lekéri a jelenleg használt írási végpont URL-címét. Hibaelhárítási célokra hasznos.

Ha helyspecifikus végpontokat használunk, az URL-cím tartalmazhat régió utótagot (pl. "-eastus").

function getWriteEndpoint(): Promise<string>

Válaszok

Promise<string>

getWriteEndpoints()

Lekéri az ismert írási végpontokat. Hibaelhárítási célokra hasznos.

Az URL-címek tartalmazhatnak régió-utótagot (pl. "-eastus"), ha helyspecifikus végpontokat használunk.

function getWriteEndpoints(): Promise<readonly string[]>

Válaszok

Promise<readonly string[]>

offer(string)

Egy meglévő ajánlat olvasásához vagy frissítéséhez használatos azonosító alapján.

function offer(id: string): Offer

Paraméterek

id

string

Az ajánlat azonosítója.

Válaszok

Offer