CosmosDatabase Klasse

Paket:

com.azure.cosmos

Maven-Artefakt:

com.azure:azure-cosmos:4.59.0

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

public class CosmosDatabase

Ausführen von Lese- und Löschdatenbanken, Aktualisieren des Datenbankdurchsatzes und Ausführen von Vorgängen für untergeordnete Ressourcen auf synchrone Weise

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties) Erstellt einen Cosmos-Container.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Erstellt einen Cosmos-Container, während zusätzliche Anforderungsoptionen übergeben werden.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Erstellt einen Cosmos-Container mit benutzerdefinierter Durchsatzeinstellung.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options) Erstellt einen Cosmos-Container.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath) Erstellen Sie einen Cosmos-Container.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Erstellen Sie einen Cosmos-Container.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties) Erstellen Sie einen Container, wenn einer, der der ID im Eigenschaftenobjekt entspricht, nicht vorhanden ist.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Erstellt einen Cosmos-Container, wenn einer, der der ID im Eigenschaftenobjekt entspricht, nicht vorhanden ist.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath) Erstellt einen Cosmos-Container, wenn einer, der der ID entspricht, nicht vorhanden ist.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Erstellt einen Cosmos-Container, wenn einer, der der ID entspricht, nicht vorhanden ist.
CosmosUserResponse	createUser(CosmosUserProperties userProperties) Erstellen eines Cosmos-Benutzers.
CosmosDatabaseResponse	delete() Löscht die aktuelle Cosmos-Datenbank.
CosmosDatabaseResponse	delete(CosmosDatabaseRequestOptions options) Löschen Sie die aktuelle Cosmos-Datenbank, während Sie zusätzliche Anforderungsoptionen angeben.
CosmosClientEncryptionKey	getClientEncryptionKey(String id) Ruft ein Cosmos-Clientverschlüsselungsschlüsselobjektab, ohne einen Dienstaufruf zu tätigen
CosmosContainer	getContainer(String id) Ruft einen Cosmos-Container instance ab, ohne einen Dienstaufruf zu tätigen.
String	getId() Rufen Sie die ID der Cosmos-Datenbank ab.
CosmosUser	getUser(String id) Ruft einen Cosmos-Benutzer instance ab, ohne einen Dienstaufruf zu tätigen.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec) Abfragen von Containern in der aktuellen Datenbank.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Abfragen von Containern in der aktuellen Datenbank.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query) Abfragen von Containern in der aktuellen Datenbank.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query, CosmosQueryRequestOptions options) Abfragecontainer-Iterator.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec) Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query) Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query, CosmosQueryRequestOptions options) Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.
CosmosDatabaseResponse	read() Liest die aktuelle Cosmos-Datenbank.
CosmosDatabaseResponse	read(CosmosDatabaseRequestOptions options) Liest die aktuelle Cosmos-Datenbank, während zusätzliche Anforderungsoptionen angegeben werden.
CosmosPagedIterable<CosmosClientEncryptionKeyProperties>	readAllClientEncryptionKeys() Liest alle Cosmos-Clientverschlüsselungsschlüssel in einer Datenbank.
CosmosPagedIterable<CosmosContainerProperties>	readAllContainers() Lesen Sie alle Container in der aktuellen Datenbank.
CosmosPagedIterable<CosmosUserProperties>	readAllUsers() Lesen Sie alle Cosmos-Benutzer für die aktuelle Datenbank.
ThroughputResponse	readThroughput() Ruft den Durchsatz der aktuellen Datenbank ab.
ThroughputResponse	replaceThroughput(ThroughputProperties throughputProperties) Legt den Durchsatz der aktuellen Datenbank fest.
CosmosUserResponse	upsertUser(CosmosUserProperties userProperties) Upsert einen Cosmos-Benutzer.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties)

Erstellt einen Cosmos-Container.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(containerProperties);
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

containerProperties - der CosmosContainerProperties.

Returns:

die CosmosContainerResponse mit dem erstellten Container.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)

Erstellt einen Cosmos-Container, während zusätzliche Anforderungsoptionen übergeben werden.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(containerProperties);
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

containerProperties - der CosmosContainerProperties.

options - der CosmosContainerProperties.

Returns:

die CosmosContainerResponse mit dem erstellten Container.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Erstellt einen Cosmos-Container mit benutzerdefinierter Durchsatzeinstellung.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerProperties,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

containerProperties - der CosmosContainerProperties.

throughputProperties - die Durchsatzeigenschaften.

Returns:

die CosmosContainerResponse mit dem erstellten Container.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)

Erstellt einen Cosmos-Container.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerProperties,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

containerProperties - die Containereigenschaften.

throughputProperties - die Durchsatzeigenschaften.

options - die Optionen.

Returns:

die Cosmos-Containerantwort.

createContainer

public CosmosContainerResponse createContainer(String id, String partitionKeyPath)

Erstellen Sie einen Cosmos-Container.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerId,
         partitionKeyPath,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

id - die Container-ID.

partitionKeyPath - der Pfad des Partitionsschlüssels.

Returns:

die Cosmos-Containerantwort.

createContainer

public CosmosContainerResponse createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)

Erstellen Sie einen Cosmos-Container.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerId,
         partitionKeyPath,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parameters:

id - die ID.

partitionKeyPath - der Pfad des Partitionsschlüssels.

throughputProperties - die Durchsatzeigenschaften.

Returns:

die Cosmos-Containerantwort.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties)

Erstellen Sie einen Container, wenn einer, der der ID im Eigenschaftenobjekt entspricht, nicht vorhanden ist.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(containerProperties);

Parameters:

containerProperties - die Containereigenschaften.

Returns:

die Cosmos-Containerantwort.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Erstellt einen Cosmos-Container, wenn einer, der der ID im Eigenschaftenobjekt entspricht, nicht vorhanden ist.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerProperties,
     throughputProperties
 );

Die Durchsatzeigenschaften werden nur verwendet, wenn der angegebene Container nicht vorhanden ist und daher ein neuer Container erstellt wird.

Parameters:

containerProperties - die Containereigenschaften.

throughputProperties - die Durchsatzeigenschaften für den Container.

Returns:

die Cosmos-Containerantwort.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id, String partitionKeyPath)

Erstellt einen Cosmos-Container, wenn einer, der der ID entspricht, nicht vorhanden ist.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerId,
     partitionKeyPath,
     throughputProperties
 );

Parameters:

id - die ID.

partitionKeyPath - der Pfad des Partitionsschlüssels.

Returns:

die Cosmos-Containerantwort.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)

Erstellt einen Cosmos-Container, wenn einer, der der ID entspricht, nicht vorhanden ist.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerId,
     partitionKeyPath,
     throughputProperties
 );

Die Durchsatzeigenschaften werden nur verwendet, wenn der angegebene Container nicht vorhanden ist und daher ein neuer Container erstellt wird.

Parameters:

id - die ID.

partitionKeyPath - der Pfad des Partitionsschlüssels.

throughputProperties - die Durchsatzeigenschaften für den Container.

Returns:

die Cosmos-Containerantwort.

createUser

public CosmosUserResponse createUser(CosmosUserProperties userProperties)

Erstellen eines Cosmos-Benutzers.

CosmosUserProperties userProperties = new CosmosUserProperties();
 userProperties.setId(userId);
 cosmosDatabase.createUser(userProperties);

Parameters:

userProperties - die Einstellungen.

Returns:

die Cosmos-Benutzerantwort.

delete

public CosmosDatabaseResponse delete()

Löscht die aktuelle Cosmos-Datenbank.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse deleteResponse = cosmosDatabase.delete();

Returns:

der CosmosDatabaseResponse.

delete

public CosmosDatabaseResponse delete(CosmosDatabaseRequestOptions options)

Löschen Sie die aktuelle Cosmos-Datenbank, während Sie zusätzliche Anforderungsoptionen angeben.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse deleteResponse = cosmosDatabase.delete();

Parameters:

options - die CosmosDatabaseRequestOptions Anforderungsoptionen.

Returns:

der CosmosDatabaseResponse.

getClientEncryptionKey

public CosmosClientEncryptionKey getClientEncryptionKey(String id)

Ruft ein CosmosClientEncryptionKey-Objekt ab, ohne einen Dienstaufruf auszuführen

Parameters:

id - id des clientsEncryptionKey

Returns:

Cosmos ClientEncryptionKey

getContainer

public CosmosContainer getContainer(String id)

Ruft einen Cosmos-Container instance ab, ohne einen Dienstaufruf zu tätigen.

Um das tatsächliche Objekt abzurufen, muss zuerst ein Lesevorgang ausgeführt werden.

Parameters:

id - id des Containers.

Returns:

Cosmos Container.

getId

public String getId()

Rufen Sie die ID der Cosmos-Datenbank ab.

Returns:

die ID der Datenbank.

getUser

public CosmosUser getUser(String id)

Ruft einen Cosmos-Benutzer instance ab, ohne einen Dienstaufruf zu tätigen.

Um das tatsächliche Objekt abzurufen, muss zuerst ein Lesevorgang ausgeführt werden.

Parameters:

id - die ID.

Returns:

der Benutzer.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec)

Abfragen von Containern in der aktuellen Datenbank.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parameters:

querySpec - die Abfragespezifikation.

Returns:

der CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Abfragen von Containern in der aktuellen Datenbank.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parameters:

querySpec - die Abfragespezifikation.

options - die Optionen.

Returns:

der CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query)

Abfragen von Containern in der aktuellen Datenbank.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parameters:

query - die Abfrage.

Returns:

der CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query, CosmosQueryRequestOptions options)

Abfragecontainer-Iterator.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parameters:

query - die Abfrage.

options - die Optionen.

Returns:

der CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec)

Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parameters:

querySpec - die Abfragespezifikation.

Returns:

der CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parameters:

querySpec - die Abfragespezifikation.

options - die Optionen.

Returns:

der CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query)

Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parameters:

query - die Abfrage.

Returns:

der CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query, CosmosQueryRequestOptions options)

Fragen Sie alle Cosmos-Benutzer nach der aktuellen Datenbank ab.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parameters:

query - die Abfrage.

options - die Optionen.

Returns:

der CosmosPagedIterable<T>.

read

public CosmosDatabaseResponse read()

Liest die aktuelle Cosmos-Datenbank. Ruft die Details und Eigenschaften einer Datenbank basierend auf ihrem eindeutigen Bezeichner ab.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse readResponse = cosmosDatabase.read();

Returns:

der CosmosDatabaseResponse.

read

public CosmosDatabaseResponse read(CosmosDatabaseRequestOptions options)

Liest die aktuelle Cosmos-Datenbank, während zusätzliche Anforderungsoptionen angegeben werden. Ruft die Details und Eigenschaften einer Datenbank basierend auf ihrem eindeutigen Bezeichner ab.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse readResponse = cosmosDatabase.read();

Parameters:

options - die CosmosDatabaseRequestOptions Anforderungsoptionen.

Returns:

das CosmosDatabaseResponse

readAllClientEncryptionKeys

public CosmosPagedIterable readAllClientEncryptionKeys()

Liest alle Cosmos-Clientverschlüsselungsschlüssel in einer Datenbank.

CosmosPagedIterable<CosmosClientEncryptionKeyProperties> clientEncryptionKeys =
     cosmosDatabase.readAllClientEncryptionKeys();
 clientEncryptionKeys.forEach(encryptionKeyProperties ->
     System.out.println(clientEncryptionKeys)
 );

Returns:

a CosmosPagedIterable<T>.

readAllContainers

public CosmosPagedIterable readAllContainers()

Lesen Sie alle Container in der aktuellen Datenbank.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.readAllContainers();
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Returns:

der CosmosPagedIterable<T>.

readAllUsers

public CosmosPagedIterable readAllUsers()

Lesen Sie alle Cosmos-Benutzer für die aktuelle Datenbank.

CosmosPagedIterable<CosmosUserProperties> cosmosUserProperties = cosmosDatabase.readAllUsers();
 cosmosUserProperties.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Returns:

der CosmosPagedIterable<T>.

readThroughput

public ThroughputResponse readThroughput()

Ruft den Durchsatz der aktuellen Datenbank ab.

ThroughputResponse throughputResponse = cosmosDatabase.readThroughput();
 System.out.println(throughputResponse);

Returns:

die Durchsatzantwort.

replaceThroughput

public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)

Legt den Durchsatz der aktuellen Datenbank fest.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);

 ThroughputResponse throughputResponse = cosmosDatabase.replaceThroughput(throughputProperties);
 System.out.println(throughputResponse);

Parameters:

throughputProperties - die Durchsatzeigenschaften.

Returns:

die Durchsatzantwort.

upsertUser

public CosmosUserResponse upsertUser(CosmosUserProperties userProperties)

Upsert einen Cosmos-Benutzer.

CosmosUserProperties userProperties = new CosmosUserProperties();
 userProperties.setId(userId);
 cosmosDatabase.upsertUser(userProperties);

Parameters:

userProperties - die Einstellungen.

Returns:

die Cosmos-Benutzerantwort.