CosmosClient class
Tillhandahåller en logisk representation på klientsidan av Azure Cosmos DB-databaskontot. Den här klienten används för att konfigurera och köra begäranden i Azure Cosmos DB-databastjänsten.
Exempel
Instansiera en klient och skapa en ny databas
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
Exempel
Instansiera en klient med anpassad anslutningsprincip
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
Konstruktorer
Cosmos |
Skapar ett nytt CosmosClient- objekt. Mer information om vilka alternativ du kan använda finns i CosmosClientOptions. |
Cosmos |
Skapar ett nytt CosmosClient- objekt från en anslutningssträng. Databasanslutningssträngen finns i Azure-portalen |
Egenskaper
databases | Används för att skapa nya databaser eller fråga/läsa alla databaser. Använd Exempel Skapa en ny databas
|
offers | Används för att fråga & läsa alla erbjudanden. Använd |
Metoder
database(string) | Används för att läsa, uppdatera eller ta bort en befintlig databas genom ID eller åtkomst till containrar som tillhör den databasen. Detta gör inte ett nätverksanrop. Använd Exempel Skapa en ny container utanför en befintlig databas
Exempel Ta bort en befintlig databas
|
dispose() | Rensar bakgrundsslutpunktsuppdatering. Använd client.dispose() när du förstör CosmosClient i en annan process. |
get |
Hämta information om den aktuella DatabaseAccount- (inklusive vilka regioner som stöds osv.) |
get |
Hämtar den lässlutpunkt som används för tillfället. Användbart för felsökning. URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter. |
get |
Hämtar den lässlutpunkt som används för tillfället. Användbart för felsökning. URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter. |
get |
Hämtar den för tillfället använda url:en för skrivslutpunkten. Användbart för felsökning. URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter. |
get |
Hämtar kända skrivslutpunkter. Användbart för felsökning. URL:erna kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter. |
offer(string) | Används för att läsa eller uppdatera ett befintligt erbjudande efter ID. |
Konstruktorinformation
CosmosClient(CosmosClientOptions)
Skapar ett nytt CosmosClient- objekt. Mer information om vilka alternativ du kan använda finns i CosmosClientOptions.
new CosmosClient(options: CosmosClientOptions)
Parametrar
- options
- CosmosClientOptions
påse med alternativ; kräver att minst slutpunkt och autentisering konfigureras
CosmosClient(string)
Skapar ett nytt CosmosClient- objekt från en anslutningssträng. Databasanslutningssträngen finns i Azure-portalen
new CosmosClient(connectionString: string)
Parametrar
- connectionString
-
string
Egenskapsinformation
databases
Används för att skapa nya databaser eller fråga/läsa alla databaser.
Använd .database(id)
för att läsa, ersätta eller ta bort en specifik befintlig databas med ID.
Exempel
Skapa en ny databas
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databases
Egenskapsvärde
offers
Används för att fråga & läsa alla erbjudanden.
Använd .offer(id)
för att läsa eller ersätta befintliga erbjudanden.
offers: Offers
Egenskapsvärde
Metodinformation
database(string)
Används för att läsa, uppdatera eller ta bort en befintlig databas genom ID eller åtkomst till containrar som tillhör den databasen.
Detta gör inte ett nätverksanrop. Använd .read
för att hämta information om databasen när du har hämtat objektet Database.
Exempel
Skapa en ny container utanför en befintlig databas
const container = client.database("<database id>").containers.create("<container id>");
Exempel
Ta bort en befintlig databas
await client.database("<id here>").delete();
function database(id: string): Database
Parametrar
- id
-
string
ID:t för databasen.
Returer
dispose()
Rensar bakgrundsslutpunktsuppdatering. Använd client.dispose() när du förstör CosmosClient i en annan process.
function dispose()
getDatabaseAccount(RequestOptions)
Hämta information om den aktuella DatabaseAccount- (inklusive vilka regioner som stöds osv.)
function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>
Parametrar
- options
- RequestOptions
Returer
Promise<ResourceResponse<DatabaseAccount>>
getReadEndpoint()
Hämtar den lässlutpunkt som används för tillfället. Användbart för felsökning.
URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter.
function getReadEndpoint(): Promise<string>
Returer
Promise<string>
getReadEndpoints()
Hämtar den lässlutpunkt som används för tillfället. Användbart för felsökning.
URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter.
function getReadEndpoints(): Promise<readonly string[]>
Returer
Promise<readonly string[]>
getWriteEndpoint()
Hämtar den för tillfället använda url:en för skrivslutpunkten. Användbart för felsökning.
URL:en kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter.
function getWriteEndpoint(): Promise<string>
Returer
Promise<string>
getWriteEndpoints()
Hämtar kända skrivslutpunkter. Användbart för felsökning.
URL:erna kan innehålla ett regionssuffix (t.ex. "-eastus") om vi använder platsspecifika slutpunkter.
function getWriteEndpoints(): Promise<readonly string[]>
Returer
Promise<readonly string[]>
offer(string)
Används för att läsa eller uppdatera ett befintligt erbjudande efter ID.
function offer(id: string): Offer
Parametrar
- id
-
string
ID:t för erbjudandet.