CosmosClient class

Paket:

@azure/cosmos

Stellt eine clientseitige logische Darstellung des Azure Cosmos DB-Datenbankkontos bereit. Dieser Client wird verwendet, um Anforderungen im Azure Cosmos DB-Datenbankdienst zu konfigurieren und auszuführen.

Beispiel

Instanziieren eines Clients und Erstellen einer neuen Datenbank

TypeScript

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

Beispiel

Instanziieren eines Clients mit benutzerdefinierter Verbindungsrichtlinie

TypeScript

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

Konstruktoren

CosmosClient(CosmosClientOptions)	Erstellt ein neues CosmosClient- -Objekt. Weitere Informationen zu den optionen, die Sie verwenden können, finden Sie unter CosmosClientOptions-.
CosmosClient(string)	Erstellt ein neues CosmosClient- -Objekt aus einer Verbindungszeichenfolge. Ihre Datenbankverbindungszeichenfolge finden Sie im Azure-Portal.

Eigenschaften

databases	Wird zum Erstellen neuer Datenbanken oder zum Abfragen/Lesen aller Datenbanken verwendet. Verwenden Sie .database(id), um eine bestimmte vorhandene Datenbank anhand der ID zu lesen, zu ersetzen oder zu löschen. Beispiel Erstellen einer neuen Datenbank TypeScript const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Wird zum Abfragen & Lesen aller Angebote verwendet. Verwenden Sie .offer(id), um vorhandene Angebote zu lesen oder zu ersetzen.

Methoden

database(string)	Wird zum Lesen, Aktualisieren oder Löschen einer vorhandenen Datenbank anhand der ID oder des Zugriffs auf Container verwendet, die zu dieser Datenbank gehören. Dadurch wird kein Netzwerkanruf vorgenommen. Verwenden Sie .read, um Informationen zur Datenbank abzurufen, nachdem Sie das Database-Objekt abgerufen haben. Beispiel Erstellen eines neuen Containers aus einer vorhandenen Datenbank TypeScript const container = client.database("<database id>").containers.create("<container id>"); Beispiel Löschen einer vorhandenen Datenbank TypeScript await client.database("<id here>").delete();
dispose()	Löscht die Aktualisierung des Hintergrundendpunkts. Verwenden Sie "client.dispose()", wenn Sie den CosmosClient innerhalb eines anderen Prozesses zerstören.
getDatabaseAccount(RequestOptions)	Abrufen von Informationen zum aktuellen DatabaseAccount- (einschließlich der unterstützten Regionen usw.)
getReadEndpoint()	Ruft den aktuell verwendeten Leseendpunkt ab. Nützlich für Problembehandlungszwecke. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.
getReadEndpoints()	Ruft den aktuell verwendeten Leseendpunkt ab. Nützlich für Problembehandlungszwecke. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.
getWriteEndpoint()	Ruft die aktuell verwendete Schreibendpunkt-URL ab. Nützlich für Problembehandlungszwecke. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.
getWriteEndpoints()	Ruft die bekannten Schreibendpunkte ab. Nützlich für Problembehandlungszwecke. Die URLs können ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.
offer(string)	Wird zum Lesen oder Aktualisieren eines vorhandenen Angebots nach ID verwendet.

Details zum Konstruktor

CosmosClient(CosmosClientOptions)

Erstellt ein neues CosmosClient- -Objekt. Weitere Informationen zu den optionen, die Sie verwenden können, finden Sie unter CosmosClientOptions-.

TypeScript

new CosmosClient(options: CosmosClientOptions)

Parameter

options

CosmosClientOptions

Beutel mit Optionen; Mindestens Endpunkt und Authentifizierung müssen konfiguriert werden

CosmosClient(string)

Erstellt ein neues CosmosClient- -Objekt aus einer Verbindungszeichenfolge. Ihre Datenbankverbindungszeichenfolge finden Sie im Azure-Portal.

TypeScript

new CosmosClient(connectionString: string)

Parameter

connectionString

string

Details zur Eigenschaft

databases

Wird zum Erstellen neuer Datenbanken oder zum Abfragen/Lesen aller Datenbanken verwendet.

Verwenden Sie .database(id), um eine bestimmte vorhandene Datenbank anhand der ID zu lesen, zu ersetzen oder zu löschen.

Beispiel

Erstellen einer neuen Datenbank

TypeScript

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

TypeScript

databases: Databases

Eigenschaftswert

Databases

offers

Wird zum Abfragen & Lesen aller Angebote verwendet.

Verwenden Sie .offer(id), um vorhandene Angebote zu lesen oder zu ersetzen.

TypeScript

offers: Offers

Eigenschaftswert

Offers

Details zur Methode

database(string)

Wird zum Lesen, Aktualisieren oder Löschen einer vorhandenen Datenbank anhand der ID oder des Zugriffs auf Container verwendet, die zu dieser Datenbank gehören.

Dadurch wird kein Netzwerkanruf vorgenommen. Verwenden Sie .read, um Informationen zur Datenbank abzurufen, nachdem Sie das Database-Objekt abgerufen haben.

Beispiel

Erstellen eines neuen Containers aus einer vorhandenen Datenbank

TypeScript

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

Beispiel

Löschen einer vorhandenen Datenbank

TypeScript

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

TypeScript

function database(id: string): Database

Parameter

id

string

Die ID der Datenbank.

Gibt zurück

Database

dispose()

Löscht die Aktualisierung des Hintergrundendpunkts. Verwenden Sie "client.dispose()", wenn Sie den CosmosClient innerhalb eines anderen Prozesses zerstören.

TypeScript

function dispose()

getDatabaseAccount(RequestOptions)

Abrufen von Informationen zum aktuellen DatabaseAccount- (einschließlich der unterstützten Regionen usw.)

TypeScript

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

Parameter

options

RequestOptions

Gibt zurück

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Ruft den aktuell verwendeten Leseendpunkt ab. Nützlich für Problembehandlungszwecke.

Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.

TypeScript

function getReadEndpoint(): Promise<string>

Gibt zurück

Promise<string>

getReadEndpoints()

Ruft den aktuell verwendeten Leseendpunkt ab. Nützlich für Problembehandlungszwecke.

Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.

TypeScript

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

Gibt zurück

Promise<readonly string[]>

getWriteEndpoint()

Ruft die aktuell verwendete Schreibendpunkt-URL ab. Nützlich für Problembehandlungszwecke.

Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.

TypeScript

function getWriteEndpoint(): Promise<string>

Gibt zurück

Promise<string>

getWriteEndpoints()

Ruft die bekannten Schreibendpunkte ab. Nützlich für Problembehandlungszwecke.

Die URLs können ein Regionssuffix (z. B. "-eastus") enthalten, wenn wir standortspezifische Endpunkte verwenden.

TypeScript

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

Gibt zurück

Promise<readonly string[]>

offer(string)

Wird zum Lesen oder Aktualisieren eines vorhandenen Angebots nach ID verwendet.

TypeScript

function offer(id: string): Offer

Parameter

id

string

Die ID des Angebots.

Gibt zurück

Offer