CosmosClient Klasse

Paket:

com.azure.cosmos

Maven-Artefakt:

com.azure:azure-cosmos:4.63.3

• java.lang.Object
• • com.azure.cosmos.CosmosClient

Implementiert

Verschließbar

public final class CosmosClient
implements Closeable

Stellt eine clientseitige logische Darstellung des Azure Cosmos DB-Diensts bereit. Aufrufe von CosmosClient-APIs werden für den Abschluss blockiert.

CosmosClient ist threadsicher. Es wird empfohlen, eine einzelne instance von CosmosClient pro Lebensdauer der Anwendung beizubehalten, was eine effiziente Verbindungsverwaltung und -leistung ermöglicht. Die CosmosClient-Initialisierung ist ein umfangreicher Vorgang. Verwenden Sie keine CosmosClient-Initialisierungsinstanzen als Anmeldeinformationen oder Netzwerkkonnektivitätsüberprüfungen.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
void	close() Schließen Sie diese CosmosClient instance.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties) Erstellt eine Cosmos-Datenbank.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Erstellt eine Datenbank.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Erstellt eine Cosmos-Datenbank.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Erstellt eine Cosmos-Datenbank.
CosmosDatabaseResponse	createDatabase(String id) Erstellt eine Cosmos-Datenbank.
CosmosDatabaseResponse	createDatabase(String id, ThroughputProperties throughputProperties) Erstellt eine Cosmos-Datenbank.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id) Erstellen Sie eine Cosmos-Datenbank, wenn sie noch nicht im Dienst vorhanden ist.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Erstellen Sie eine Cosmos-Datenbank, wenn sie noch nicht im Dienst vorhanden ist.
GlobalThroughputControlConfigBuilder	createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Erstellen Sie den Konfigurations-Generator für globale Durchsatzsteuerungen, der zum Erstellen GlobalThroughputControlConfigvon verwendet wird.
CosmosDatabase	getDatabase(String id) Ruft die Cosmos-Datenbank instance ab, ohne einen Dienstaufruf durchzuführen.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Abfragen einer Cosmos-Datenbank.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Abfragen einer Cosmos-Datenbank.
CosmosPagedIterable<CosmosDatabaseProperties>	readAllDatabases() Liest alle Cosmos-Datenbanken.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

close

public void close()

Schließen Sie diese CosmosClient instance.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)

Erstellt eine Cosmos-Datenbank.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parameter:

databaseProperties - CosmosDatabaseProperties die Datenbankeigenschaften.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Erstellt eine Datenbank.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parameter:

databaseProperties - CosmosDatabaseProperties die Datenbankeigenschaften.

options - die Anforderungsoptionen.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Erstellt eine Cosmos-Datenbank.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parameter:

databaseProperties - CosmosDatabaseProperties die Datenbankeigenschaften.

throughputProperties - die Durchsatzeigenschaften.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)

Erstellt eine Cosmos-Datenbank.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parameter:

databaseProperties - CosmosDatabaseProperties die Datenbankeigenschaften.

throughputProperties - die Durchsatzeigenschaften.

options - CosmosDatabaseRequestOptions die Anforderungsoptionen.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabase

public CosmosDatabaseResponse createDatabase(String id)

Erstellt eine Cosmos-Datenbank.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parameter:

id - die ID der Datenbank.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabase

public CosmosDatabaseResponse createDatabase(String id, ThroughputProperties throughputProperties)

Erstellt eine Cosmos-Datenbank.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parameter:

id - die ID der Datenbank.

throughputProperties - die Durchsatzeigenschaften.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)

Erstellen Sie eine Cosmos-Datenbank, wenn sie noch nicht im Dienst vorhanden ist.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabaseIfNotExists(databaseProperties);

Parameter:

id - die ID der Datenbank.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Erstellen Sie eine Cosmos-Datenbank, wenn sie noch nicht im Dienst vorhanden ist.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabaseIfNotExists(databaseName, throughputProperties);

Die throughputProperties werden nur verwendet, wenn die angegebene Datenbank nicht vorhanden ist und daher eine neue Datenbank mit "throughputProperties" erstellt wird.

Parameter:

id - die ID der Datenbank.

throughputProperties - die throughputProperties.

Gibt zurück:

die CosmosDatabaseResponse mit der erstellten Datenbank.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Erstellen Sie den Konfigurations-Generator für globale Durchsatzsteuerungen, der zum Erstellen GlobalThroughputControlConfigvon verwendet wird.

Parameter:

databaseId - Die Datenbank-ID des Steuerelementcontainers.

containerId - Die Container-ID des Steuerelementcontainers.

Gibt zurück:

einen GlobalThroughputControlConfigBuilder

getDatabase

public CosmosDatabase getDatabase(String id)

Ruft die Cosmos-Datenbank instance ab, ohne einen Dienstaufruf durchzuführen.

Parameter:

id - die ID der Datenbank.

Gibt zurück:

CosmosDatabase die cosmos-Synchronisierungsdatenbank.

queryDatabases

public CosmosPagedIterable queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Abfragen einer Cosmos-Datenbank.

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

Parameter:

querySpec - SqlQuerySpec die Abfragespezifikation.

options - die Abfrageanforderungsoptionen.

Gibt zurück:

für CosmosPagedIterable<T> die Feedantwort mit den abgerufenen Datenbanken.

queryDatabases

public CosmosPagedIterable queryDatabases(String query, CosmosQueryRequestOptions options)

Abfragen einer Cosmos-Datenbank.

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

Parameter:

query - die Abfrage.

options - CosmosQueryRequestOptionsdie Feedoptionen.

Gibt zurück:

für CosmosPagedIterable<T> die Feedantwort mit den abgerufenen Datenbanken.

readAllDatabases

public CosmosPagedIterable readAllDatabases()

Liest alle Cosmos-Datenbanken.

CosmosPagedIterable<CosmosDatabaseProperties> cosmosDatabaseProperties =
     cosmosClient.readAllDatabases();
 cosmosDatabaseProperties.forEach(databaseProperties -> {
     System.out.println(databaseProperties);
 });

Gibt zurück:

für CosmosPagedIterable<T> die Feedantwort mit den Lesedatenbanken.