CosmosClient class
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 van
Een client instantiëren en een nieuwe database maken
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
voorbeeld van
Een client instantiëren met aangepast verbindingsbeleid
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
Constructors
Cosmos |
Hiermee maakt u een nieuw CosmosClient--object. Zie CosmosClientOptions- voor meer informatie over welke opties u kunt gebruiken. |
Cosmos |
Hiermee maakt u een nieuw CosmosClient--object op basis van een verbindingsreeks. Uw databaseverbindingsreeks vindt u in Azure Portal |
Eigenschappen
databases | Wordt gebruikt voor het maken van nieuwe databases of het opvragen/lezen van alle databases. Gebruik voorbeeld van Een nieuwe database maken
|
offers | Wordt gebruikt voor het opvragen van & het lezen van alle aanbiedingen. Gebruik |
Methoden
database(string) | Wordt gebruikt voor het lezen, bijwerken of verwijderen van een bestaande database door id of toegang te krijgen tot containers die behoren tot die database. Dit doet geen netwerkoproep. Gebruik voorbeeld van Een nieuwe container maken op basis van een bestaande database
voorbeeld van Een bestaande database verwijderen
|
dispose() | Hiermee wist u de vernieuwing van het achtergrondeindpunt. Gebruik client.dispose() bij het vernietigen van de CosmosClient binnen een ander proces. |
get |
Informatie ophalen over de huidige DatabaseAccount- (inclusief welke regio's worden ondersteund, enzovoort) |
get |
Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken. |
get |
Hiermee haalt u het momenteel gebruikte leeseindpunt op. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken. |
get |
Hiermee haalt u de url van het schrijfeindpunt op die momenteel wordt gebruikt. Handig voor het oplossen van problemen. De URL kan een regioachtervoegsel (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken. |
get |
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
zak met opties; vereisen dat ten minste eindpunt en verificatie worden geconfigureerd
CosmosClient(string)
Hiermee maakt u een nieuw CosmosClient--object op basis van een verbindingsreeks. Uw databaseverbindingsreeks 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 op id te lezen, te vervangen of te verwijderen.
voorbeeld van
Een nieuwe database maken
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databases
Waarde van eigenschap
offers
Wordt gebruikt voor het opvragen van & het lezen van alle aanbiedingen.
Gebruik .offer(id)
om bestaande aanbiedingen te lezen of te vervangen.
offers: Offers
Waarde van eigenschap
Methodedetails
database(string)
Wordt gebruikt voor het lezen, bijwerken of verwijderen van een bestaande database door id of toegang te krijgen tot containers die behoren tot die database.
Dit doet geen netwerkoproep. Gebruik .read
om informatie over de database op te halen nadat u het Database-object hebt opgehaald.
voorbeeld van
Een nieuwe container maken op basis van een bestaande database
const container = client.database("<database id>").containers.create("<container id>");
voorbeeld van
Een bestaande database verwijderen
await client.database("<id here>").delete();
function database(id: string): Database
Parameters
- id
-
string
De id van de database.
Retouren
dispose()
Hiermee wist u de vernieuwing van het achtergrondeindpunt. Gebruik client.dispose() bij het vernietigen van de CosmosClient binnen een ander proces.
function dispose()
getDatabaseAccount(RequestOptions)
Informatie ophalen over de 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 (bijvoorbeeld '-eastus') bevatten 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 (bijvoorbeeld '-eastus') bevatten als we locatiespecifieke eindpunten gebruiken.
function getReadEndpoints(): Promise<readonly string[]>
Retouren
Promise<readonly string[]>
getWriteEndpoint()
Hiermee haalt u de url van het schrijfeindpunt op die momenteel wordt gebruikt. 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.