CosmosClient class

Pakket:

@azure/cosmos

Biedt een logische weergave aan de clientzijde van het Azure Cosmos DB-databaseaccount. Deze client wordt gebruikt voor het configureren en uitvoeren van aanvragen in de Azure Cosmos DB-databaseservice.

Voorbeeld

Een client instantiëren en een nieuwe database maken

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

Voorbeeld

Een client instantiëren met aangepast verbindingsbeleid

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});

Constructors

CosmosClient(CosmosClientOptions)	Hiermee maakt u een nieuw CosmosClient-object . Zie CosmosClientOptions voor meer informatie over welke opties u kunt gebruiken.
CosmosClient(string)	Hiermee maakt u een nieuw CosmosClient-object op basis van een verbindingsreeks. Uw database-verbindingsreeks vindt u in Azure Portal

Eigenschappen

databases	Wordt gebruikt voor het maken van nieuwe databases of het opvragen/lezen van alle databases. Gebruik .database(id) om een specifieke, bestaande database te lezen, te vervangen of te verwijderen op id. Voorbeeld Een nieuwe database maken const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Wordt gebruikt voor het uitvoeren van query's & het lezen van alle aanbiedingen. Gebruik .offer(id) om bestaande aanbiedingen te lezen of te vervangen.

Methoden

database(string)	Wordt gebruikt voor het lezen, bijwerken of verwijderen van een bestaande database op basis van id of voor toegang tot containers die deel uitmaken van die database. Hiermee wordt geen netwerkoproep tot gevolg. Gebruik .read om informatie over de database op te halen nadat u het databaseobject hebt opgehaald. Voorbeeld Een nieuwe container maken van een bestaande database const container = client.database("<database id>").containers.create("<container id>"); Voorbeeld Een bestaande database verwijderen await client.database("<id here>").delete();
dispose()	Hiermee wist u het vernieuwen van eindpunten op de achtergrond. Gebruik client.dispose() bij het vernietigen van de CosmosClient binnen een ander proces.
getDatabaseAccount(RequestOptions)	Informatie ophalen over het huidige DatabaseAccount (inclusief welke regio's worden ondersteund, enzovoort)
getReadEndpoint()	Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel bevatten (bijvoorbeeld '-eastus') als we locatiespecifieke eindpunten gebruiken.
getReadEndpoints()	Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel bevatten (bijvoorbeeld '-eastus') als we locatiespecifieke eindpunten gebruiken.
getWriteEndpoint()	Hiermee haalt u de url van het huidige schrijfeindpunt op. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken.
getWriteEndpoints()	Hiermee haalt u de bekende schrijfeindpunten op. Handig voor het oplossen van problemen. De URL's kunnen een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken.
offer(string)	Wordt gebruikt voor het lezen of bijwerken van een bestaande aanbieding op id.

Constructordetails

CosmosClient(CosmosClientOptions)

Hiermee maakt u een nieuw CosmosClient-object . Zie CosmosClientOptions voor meer informatie over welke opties u kunt gebruiken.

new CosmosClient(options: CosmosClientOptions)

Parameters

options

CosmosClientOptions

tas met opties; vereisen dat ten minste eindpunt en verificatie zijn geconfigureerd

CosmosClient(string)

Hiermee maakt u een nieuw CosmosClient-object op basis van een verbindingsreeks. Uw database-verbindingsreeks vindt u in Azure Portal

new CosmosClient(connectionString: string)

Parameters

connectionString

string

Eigenschapdetails

databases

Wordt gebruikt voor het maken van nieuwe databases of het opvragen/lezen van alle databases.

Gebruik .database(id) om een specifieke, bestaande database te lezen, te vervangen of te verwijderen op id.

Voorbeeld

Een nieuwe database maken

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

databases: Databases

Waarde van eigenschap

Databases

offers

Wordt gebruikt voor het uitvoeren van query's & het lezen van alle aanbiedingen.

Gebruik .offer(id) om bestaande aanbiedingen te lezen of te vervangen.

offers: Offers

Waarde van eigenschap

Offers

Methodedetails

database(string)

Wordt gebruikt voor het lezen, bijwerken of verwijderen van een bestaande database op basis van id of voor toegang tot containers die deel uitmaken van die database.

Hiermee wordt geen netwerkoproep tot gevolg. Gebruik .read om informatie over de database op te halen nadat u het databaseobject hebt opgehaald.

Voorbeeld

Een nieuwe container maken van een bestaande database

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

Voorbeeld

Een bestaande database verwijderen

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

function database(id: string): Database

Parameters

id

string

De id van de database.

Retouren

Database

dispose()

Hiermee wist u het vernieuwen van eindpunten op de achtergrond. Gebruik client.dispose() bij het vernietigen van de CosmosClient binnen een ander proces.

function dispose()

getDatabaseAccount(RequestOptions)

Informatie ophalen over het huidige DatabaseAccount (inclusief welke regio's worden ondersteund, enzovoort)

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

Parameters

options

RequestOptions

Retouren

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen.

De URL kan een regioachtervoegsel bevatten (bijvoorbeeld '-eastus') als we locatiespecifieke eindpunten gebruiken.

function getReadEndpoint(): Promise<string>

Retouren

Promise<string>

getReadEndpoints()

Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen.

De URL kan een regioachtervoegsel bevatten (bijvoorbeeld '-eastus') als we locatiespecifieke eindpunten gebruiken.

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

Retouren

Promise<readonly string[]>

getWriteEndpoint()

Hiermee haalt u de url van het huidige schrijfeindpunt op. Handig voor het oplossen van problemen.

De URL kan een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken.

function getWriteEndpoint(): Promise<string>

Retouren

Promise<string>

getWriteEndpoints()

Hiermee haalt u de bekende schrijfeindpunten op. Handig voor het oplossen van problemen.

De URL's kunnen een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken.

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

Retouren

Promise<readonly string[]>

offer(string)

Wordt gebruikt voor het lezen of bijwerken van een bestaande aanbieding op id.

function offer(id: string): Offer

Parameters

id

string

De id van de aanbieding.

Retouren

Offer