CosmosAsyncClient Clase

Paquete:

com.azure.cosmos

Artefacto Maven:

com.azure:azure-cosmos:4.62.0

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

Implementaciones

Se puede cerrar

public final class CosmosAsyncClient
implements Closeable

Proporciona una representación lógica del lado cliente del servicio Azure Cosmos DB. Este cliente asincrónico se usa para configurar y ejecutar solicitudes en el servicio.

CosmosAsyncClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosAsyncClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. La inicialización de CosmosAsyncClient es una operación intensiva: no use las instancias de CosmosAsyncClient 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 CosmosAsyncClient instancia y limpie los recursos.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabase(String id) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabase(String id, ThroughputProperties throughputProperties) Crea una base de datos.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties) CREE una base de datos si aún no existe en el servicio.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id) Cree una base de datos si aún no existe en el servicio.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Cree una base de datos 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.
CosmosAsyncDatabase	getDatabase(String id) Obtiene un objeto de base de datos sin realizar una llamada de servicio.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consulta de bases de datos.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Consulta de bases de datos.
CosmosPagedFlux<CosmosDatabaseProperties>	readAllDatabases() Lee todas las bases de datos.

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 CosmosAsyncClient instancia y limpie los recursos.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties)

Crea una base de datos. Después de la suscripción, se realizará la operación. Cuando Mono se complete correctamente, contendrá una única respuesta de recursos con la base de datos creada. En caso de error, se producirá un Mono error.

Parámetros:

databaseProperties - CosmosDatabaseProperties.

Devoluciones:

que Mono contiene la respuesta de base de datos de Cosmos única con la base de datos creada o un error.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Crea una base de datos. Después de la suscripción, se realizará la operación. Cuando Mono se complete correctamente, contendrá una única respuesta de recursos con la base de datos creada. En caso de error, se producirá un Mono error.

Parámetros:

databaseProperties - CosmosDatabaseProperties.

options - CosmosDatabaseRequestOptions.

Devoluciones:

que Mono contiene la respuesta de base de datos de Cosmos única con la base de datos creada o un error.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Crea una base de datos. Después de la suscripción, se realizará la operación. Cuando Mono se complete correctamente, contendrá una única respuesta de recursos con la base de datos creada. En caso de error, se producirá un Mono error.

Parámetros:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - las propiedades de rendimiento de la base de datos.

Devoluciones:

que Mono contiene la respuesta de base de datos de Cosmos única con la base de datos creada o un error.

createDatabase

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

Crea una base de datos. Después de la suscripción, se realizará la operación. Cuando Mono se complete correctamente, contendrá una única respuesta de recursos con la base de datos creada. En caso de error, se producirá un Mono error.

Parámetros:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - las propiedades de rendimiento de la base de datos.

options - CosmosDatabaseRequestOptions.

Devoluciones:

que Mono contiene la respuesta de base de datos de Cosmos única con la base de datos creada o un error.

createDatabase

public Mono createDatabase(String id)

Crea una base de datos. Después de la suscripción, se realizará la operación. Cuando Mono se complete correctamente, contendrá una única respuesta de recursos con la base de datos creada. En caso de error, se producirá un Mono error.

Parámetros:

id - id de la base de datos.

Devoluciones:

que Mono contiene la respuesta de base de datos de Cosmos única con la base de datos creada o un error.

createDatabase

public Mono createDatabase(String id, ThroughputProperties throughputProperties)

Crea una base de datos.

Parámetros:

id - el identificador.

throughputProperties - la propiedad throughputProperties.

Devoluciones:

mono.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

CREE una base de datos si aún no existe en el servicio. Cuando Mono se complete correctamente, contendrá una única respuesta de base de datos cosmos con la base de datos creada o existente.

Parámetros:

databaseProperties - CosmosDatabaseProperties.

Devoluciones:

que Mono contiene la respuesta de la base de datos de Cosmos con la base de datos creada o existente o un error.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id)

Cree una base de datos si aún no existe en el servicio. Cuando Mono se complete correctamente, contendrá una única respuesta de base de datos cosmos con la base de datos creada o existente.

Parámetros:

id - el identificador de la base de datos.

Devoluciones:

que Mono contiene la respuesta de la base de datos de Cosmos con la base de datos creada o existente o un error.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Cree una base de datos si aún no existe en el servicio. La propiedad throughputProperties solo se usará si la base de datos especificada no existe y, para ello, se creará una nueva base de datos con throughputProperties. Cuando Mono se complete correctamente, contendrá una única respuesta de base de datos cosmos con la base de datos creada o existente.

Parámetros:

id - el identificador.

throughputProperties - la propiedad throughputProperties.

Devoluciones:

mono.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Cree el 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 CosmosAsyncDatabase getDatabase(String id)

Obtiene un objeto de base de datos sin realizar una llamada de servicio.

Parámetros:

id - nombre de la base de datos.

Devoluciones:

CosmosAsyncDatabase.

queryDatabases

public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consulta de bases de datos. Después de la suscripción, se realizará la operación. CosmosPagedFlux<T> Contendrá una o varias respuestas de fuente de las bases de datos de lectura. En caso de error, se producirá un CosmosPagedFlux<T> error.

Parámetros:

querySpec - especificación de consulta SQL.

options - las opciones de fuente.

Devoluciones:

que CosmosPagedFlux<T> contiene una o varias páginas de respuesta de fuente de bases de datos de lectura o un error.

queryDatabases

public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)

Consulta de bases de datos. Después de la suscripción, se realizará la operación. CosmosPagedFlux<T> Contendrá una o varias respuestas de fuente de las bases de datos de lectura. En caso de error, se producirá un CosmosPagedFlux<T> error.

Parámetros:

query - la consulta.

options - las opciones de fuente.

Devoluciones:

que CosmosPagedFlux<T> contiene una o varias páginas de respuesta de fuente de bases de datos de lectura o un error.

readAllDatabases

public CosmosPagedFlux readAllDatabases()

Lee todas las bases de datos. Después de la suscripción, se realizará la operación. CosmosPagedFlux<T> Contendrá una o varias respuestas de fuente de las bases de datos de lectura. En caso de error, se producirá un CosmosPagedFlux<T> error.

Devoluciones:

que CosmosPagedFlux<T> contiene una o varias páginas de respuesta de fuente de bases de datos de lectura o un error.