CosmosClient class

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 szabályzattal

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

Konstruktorok

CosmosClient(CosmosClientOptions)	Létrehoz egy új CosmosClient-objektumot . A használható lehetőségekről további információt a CosmosClientOptionsban talál.
CosmosClient(string)	Létrehoz egy új CosmosClient-objektumot egy kapcsolati karakterlánc. Az adatbázis-kapcsolati karakterlánc az Azure Portalon találhatók

Tulajdonságok

databases	Új adatbázisok létrehozásához, vagy az összes adatbázis lekérdezéséhez/olvasásához használható. Egy adott, meglévő adatbázis azonosító alapján történő olvasására, cseréjére vagy törlésére használható .database(id) . 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ére szolgál & olvasásához. A meglévő ajánlatok olvasására vagy cseréjére használható .offer(id) .

Metódusok

database(string)	Egy 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. Az .read adatbázis adatainak lekéréséhez használja az 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, amikor egy másik folyamaton belül megsemmisíti a CosmosClientet.
getDatabaseAccount(RequestOptions)	Az aktuális DatabaseAccount adatainak lekérése (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. Az URL-cím tartalmazhat régió-utótagot (pl. "-eastus"), ha helyspecifikus végpontokat használunk.
getReadEndpoints()	Lekéri a jelenleg használt olvasási végpontot. Hibaelhárítási célokra hasznos. Az URL-cím tartalmazhat régió-utótagot (pl. "-eastus"), ha helyspecifikus végpontokat használunk.
getWriteEndpoint()	Lekéri a jelenleg használt írási végpont URL-címét. Hibaelhárítási célokra hasznos. Az URL-cím régió-utótagot (például "-eastus") tartalmazhat, ha helyspecifikus végpontokat használunk.
getWriteEndpoints()	Lekéri az ismert írási végpontokat. Hibaelhárítási célokra hasznos. Az URL-címek régió-utótagot (például "-eastus") tartalmazhatnak, ha helyspecifikus végpontokat használunk.
offer(string)	Egy meglévő ajánlat azonosító alapján történő olvasásához vagy frissítéséhez használatos.

Konstruktor adatai

CosmosClient(CosmosClientOptions)

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

new CosmosClient(options: CosmosClientOptions)

Paraméterek

options

CosmosClientOptions

táska lehetőségek; legalább végpont és hitelesítés konfigurálásának megkövetelése

CosmosClient(string)

Létrehoz egy új CosmosClient-objektumot egy kapcsolati karakterlánc. Az adatbázis-kapcsolati karakterlánc az Azure Portalon találhatók

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ó.

Egy adott, meglévő adatbázis azonosító alapján történő olvasására, cseréjére vagy törlésére használható .database(id) .

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ére szolgál & olvasásához.

A meglévő ajánlatok olvasására vagy cseréjére használható .offer(id) .

offers: Offers

Tulajdonság értéke

Offers

Metódus adatai

database(string)

Egy 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. Az .read adatbázis adatainak lekéréséhez használja az 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, amikor egy másik folyamaton belül megsemmisíti a CosmosClientet.

function dispose()

getDatabaseAccount(RequestOptions)

Az aktuális DatabaseAccount adatainak lekérése (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.

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

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.

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

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.

Az URL-cím régió-utótagot (például "-eastus") tartalmazhat, ha helyspecifikus végpontokat használunk.

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 régió-utótagot (például "-eastus") tartalmazhatnak, ha helyspecifikus végpontokat használunk.

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

Válaszok

Promise<readonly string[]>

offer(string)

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

function offer(id: string): Offer

Paraméterek

id

string

Az ajánlat azonosítója.

Válaszok

Offer