CosmosClient Clase

Paquete:

com.azure.cosmos

Artefacto Maven:

com.azure:azure-cosmos:4.63.3

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

Implementaciones

Se puede cerrar

public final class CosmosClient
implements Closeable

Proporciona una representación lógica del lado cliente del servicio Azure Cosmos DB. Las llamadas a la API de CosmosClient se bloquean para su finalización.

CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. La inicialización de CosmosClient es una operación intensiva: no use instancias de CosmosClient de inicialización como credenciales ni validaciones de conectividad de red.

Resumen del método

Modificador y tipo	Método y descripción
void	close() Cierre esta CosmosClient instancia.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties) Crea una base de datos de Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Crea una base de datos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Crea una base de datos de Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Crea una base de datos de Cosmos.
CosmosDatabaseResponse	createDatabase(String id) Crea una base de datos de Cosmos.
CosmosDatabaseResponse	createDatabase(String id, ThroughputProperties throughputProperties) Crea una base de datos de Cosmos.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id) Cree una base de datos de Cosmos si aún no existe en el servicio.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Cree una base de datos de Cosmos si aún no existe en el servicio.
GlobalThroughputControlConfigBuilder	createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Cree un generador de configuraciones de control de rendimiento global que se usará para compilar GlobalThroughputControlConfig.
CosmosDatabase	getDatabase(String id) Obtiene la instancia de base de datos de Cosmos sin realizar una llamada de servicio.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consulta de una base de datos de Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Consulta de una base de datos de Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	readAllDatabases() Lee todas las bases de datos de Cosmos.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del método

close

public void close()

Cierre esta CosmosClient instancia.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)

Crea una base de datos de Cosmos.

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

Parámetros:

databaseProperties - CosmosDatabaseProperties las propiedades de la base de datos.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Crea una base de datos.

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

Parámetros:

databaseProperties - CosmosDatabaseProperties las propiedades de la base de datos.

options - las opciones de solicitud.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Crea una base de datos de Cosmos.

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

Parámetros:

databaseProperties - CosmosDatabaseProperties las propiedades de la base de datos.

throughputProperties - las propiedades de rendimiento.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabase

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

Crea una base de datos de Cosmos.

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

Parámetros:

databaseProperties - CosmosDatabaseProperties las propiedades de la base de datos.

throughputProperties - las propiedades de rendimiento.

options - CosmosDatabaseRequestOptions las opciones de solicitud.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabase

public CosmosDatabaseResponse createDatabase(String id)

Crea una base de datos de Cosmos.

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

Parámetros:

id - el identificador de la base de datos.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabase

public CosmosDatabaseResponse createDatabase(String id, ThroughputProperties throughputProperties)

Crea una base de datos de Cosmos.

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

Parámetros:

id - el identificador de la base de datos.

throughputProperties - las propiedades de rendimiento.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)

Cree una base de datos de Cosmos si aún no existe en el servicio.

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

Parámetros:

id - el identificador de la base de datos.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Cree una base de datos de Cosmos si aún no existe en el servicio.

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

Las propiedades de rendimiento solo se usarán si la base de datos especificada no existe y, para ello, se creará una nueva base de datos con throughputProperties.

Parámetros:

id - el identificador de la base de datos.

throughputProperties - las propiedades de rendimiento.

Devoluciones:

con CosmosDatabaseResponse la base de datos creada.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Cree un generador de configuraciones de control de rendimiento global que se usará para compilar GlobalThroughputControlConfig.

Parámetros:

databaseId - Identificador de base de datos del contenedor de control.

containerId - Identificador de contenedor del contenedor de control.

Devoluciones:

Un objeto GlobalThroughputControlConfigBuilder.

getDatabase

public CosmosDatabase getDatabase(String id)

Obtiene la instancia de base de datos de Cosmos sin realizar una llamada de servicio.

Parámetros:

id - el identificador de la base de datos.

Devoluciones:

CosmosDatabase la base de datos de sincronización de Cosmos.

queryDatabases

public CosmosPagedIterable queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consulta de una base de datos de Cosmos.

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

Parámetros:

querySpec - SqlQuerySpec especificación de consulta.

options - las opciones de solicitud de consulta.

Devoluciones:

para la CosmosPagedIterable<T> respuesta de fuente con las bases de datos obtenidas.

queryDatabases

public CosmosPagedIterable queryDatabases(String query, CosmosQueryRequestOptions options)

Consulta de una base de datos de Cosmos.

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

Parámetros:

query - la consulta.

options - CosmosQueryRequestOptionslas opciones de fuente.

Devoluciones:

para la CosmosPagedIterable<T> respuesta de fuente con las bases de datos obtenidas.

readAllDatabases

public CosmosPagedIterable readAllDatabases()

Lee todas las bases de datos de Cosmos.

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

Devoluciones:

para la CosmosPagedIterable<T> respuesta de fuente con las bases de datos de lectura.