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

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

Beispiel

Instanziieren eines Clients mit benutzerdefinierter Verbindungsrichtlinie

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

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 einem Verbindungszeichenfolge. Ihre Datenbank Verbindungszeichenfolge 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 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)	Dient zum Lesen, Aktualisieren oder Löschen einer vorhandenen Datenbank nach ID oder zum Zugreifen auf Container, die zu dieser Datenbank gehören. Dadurch wird kein Netzwerkaufruf vorgenommen. Verwenden Sie .read , um Informationen zur Datenbank nach dem Abrufen des Database-Objekts abzurufen. Beispiel Erstellen eines neuen Containers aus einer vorhandenen Datenbank const container = client.database("<database id>").containers.create("<container id>"); Beispiel Löschen einer vorhandenen Datenbank await client.database("<id here>").delete();
dispose()	Löscht die Aktualisierung des Endpunkts im Hintergrund. Verwenden Sie client.dispose(), wenn Sie den CosmosClient in einem anderen Prozess 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 die Problembehandlung. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn standortspezifische Endpunkte verwendet werden.
getReadEndpoints()	Ruft den aktuell verwendeten Leseendpunkt ab. Nützlich für die Problembehandlung. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn standortspezifische Endpunkte verwendet werden.
getWriteEndpoint()	Ruft die aktuell verwendete Schreibendpunkt-URL ab. Nützlich für die Problembehandlung. Die URL kann ein Regionssuffix (z. B. "-eastus") enthalten, wenn standortspezifische Endpunkte verwendet werden.
getWriteEndpoints()	Ruft die bekannten Schreibendpunkte ab. Nützlich für die Problembehandlung. 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 .

new CosmosClient(options: CosmosClientOptions)

Parameter

options

CosmosClientOptions

Beutel mit Optionen; erfordern, dass mindestens Endpunkt und Authentifizierung konfiguriert werden müssen

CosmosClient(string)

Erstellt ein neues CosmosClient-Objekt aus einem Verbindungszeichenfolge. Ihre Datenbank Verbindungszeichenfolge finden Sie im Azure-Portal.

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

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

databases: Databases

Eigenschaftswert

Databases

offers

Wird zum Abfragen & Lesen aller Angebote verwendet.

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

offers: Offers

Eigenschaftswert

Offers

Details zur Methode

database(string)

Dient zum Lesen, Aktualisieren oder Löschen einer vorhandenen Datenbank nach ID oder zum Zugreifen auf Container, die zu dieser Datenbank gehören.

Dadurch wird kein Netzwerkaufruf vorgenommen. Verwenden Sie .read , um Informationen zur Datenbank nach dem Abrufen des Database-Objekts abzurufen.

Beispiel

Erstellen eines neuen Containers aus einer vorhandenen Datenbank

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

Beispiel

Löschen einer vorhandenen Datenbank

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

function database(id: string): Database

Parameter

id

string

Die ID der Datenbank.

Gibt zurück

Database

dispose()

Löscht die Aktualisierung des Endpunkts im Hintergrund. Verwenden Sie client.dispose(), wenn Sie den CosmosClient in einem anderen Prozess zerstören.

function dispose()

getDatabaseAccount(RequestOptions)

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

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 die Problembehandlung.

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

function getReadEndpoint(): Promise<string>

Gibt zurück

Promise<string>

getReadEndpoints()

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

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

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

Gibt zurück

Promise<readonly string[]>

getWriteEndpoint()

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

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

function getWriteEndpoint(): Promise<string>

Gibt zurück

Promise<string>

getWriteEndpoints()

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

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

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

Gibt zurück

Promise<readonly string[]>

offer(string)

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

function offer(id: string): Offer

Parameter

id

string

Die ID des Angebots.

Gibt zurück

Offer