Azure Cosmos DB for NoSQL: ejemplos de Spring Data Azure Cosmos DB v5

  • Artículo

SE APLICA A: NoSQL

Importante

Estas notas corresponden a la versión 5 de Spring Data Azure Cosmos DB. Puede encontrar las notas de la versión 3 aquí y de la versión 2 aquí.

Spring Data Azure Cosmos DB solo admite la API para NoSQL.

Consulte estos artículos para obtener información sobre Spring Data en otras API de Azure Cosmos DB:

Importante

Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.

Puede probar gratis Azure Cosmos DB sin una suscripción de Azure, de forma gratuita y sin compromiso. Como alternativa, puede crear una cuenta de nivel gratis de Azure Cosmos DB, con las primeras 1000 RU/s y 25 GB de almacenamiento de forma gratuita. También puede usar el emulador de Azure Cosmos DB con un identificador URI https://localhost:8081. Para obtener la clave que se va a usar con el emulador, consulte Autenticación de solicitudes.

En el repositorio de GitHub azure-cosmos-java-sql-api-samples se incluyen las aplicaciones de ejemplo más recientes que realizan operaciones CRUD y otras operaciones comunes en recursos de Azure Cosmos DB. Este artículo ofrece:

  • Vínculos a las tareas de cada uno de los archivos de proyecto de ejemplo de Spring Data Azure Cosmos DB.
  • Vínculos al contenido de referencia de la API relacionada.

Requisitos previos

Necesita lo siguiente para poder ejecutar esta aplicación de ejemplo:

  • Java Development Kit 8
  • Spring Data Azure Cosmos DB v5

También puede usar Maven para obtener los archivos binarios más recientes del SDK de Spring Data Azure Cosmos DB v3 para usarlos en el proyecto. Maven se encarga de agregar automáticamente las dependencias necesarias. En caso contrario, puede descargar directamente las dependencias que se enumeran en el archivo pom.xml y agregarlas a la ruta de acceso de la compilación.

<dependency>
	<groupId>com.azure</groupId>
	<artifactId>azure-spring-data-cosmos</artifactId>
	<version>LATEST</version>
</dependency>

Ejecutar las aplicaciones de ejemplo

Clone el repositorio de ejemplo:

$ git clone https://github.com/Azure-Samples/azure-spring-boot-samples

$ cd cosmos/azure-spring-data-cosmos/spring3-samples/cosmos-quickstart-samples

Puede ejecutar los ejemplos mediante un IDE (Eclipse, IntelliJ o VS Code) o bien desde la línea de comandos mediante Maven.

En application.properties, estas variables de entorno deben estar establecidas

cosmos.uri=${ACCOUNT_HOST}
cosmos.key=${ACCOUNT_KEY}
cosmos.secondaryKey=${SECONDARY_ACCOUNT_KEY}

dynamic.collection.name=spel-property-collection
# Populate query metrics
cosmos.queryMetricsEnabled=true

con el fin de dar a los ejemplos acceso de lectura y escritura a su cuenta, sus bases de datos y sus contenedores.

El IDE puede proporcionar la capacidad de ejecutar el código de ejemplo de Spring Data. De lo contrario, puede usar el siguiente comando de terminal para ejecutar el ejemplo:

mvn spring-boot:run

Ejemplos de CRUD de documentos

El archivo samples muestra cómo realizar las siguientes tareas. Para obtener información sobre los documentos de Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.

Tarea Referencia de API
Creación de un documento CosmosRepository.save
Leer un documento por identificador CosmosRepository.derivedQueryMethod
Eliminar todos los documentos CosmosRepository.deleteAll

Ejemplos de métodos de consulta derivados

El archivo samples muestra cómo realizar las siguientes tareas. Para obtener información sobre las consultas de Azure Cosmos DB antes de ejecutar los ejemplos siguientes, es posible que le resulte útil leer el artículo Derived Query Methods in Spring (Métodos de consulta derivados en Spring) de Baeldung.

| Consulta de documentos | CosmosRepository.derivedQueryMethod |

Ejemplos de consultas personalizadas

El archivo samples muestra cómo realizar las siguientes tareas con la gramática de consultas SQL. Para más información sobre la referencia de consultas SQL en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte los ejemplos de consultas SQL para Azure Cosmos DB.

Tarea Referencia de API
Consulta de todos los documentos Anotación @Query
Consulta de igualdad mediante == Anotación @Query
Consulta de desigualdad mediante != y NOT Anotación @Query
Consulta mediante operadores de intervalo como >, <, >=, <= Anotación @Query
Consulta con operadores de intervalo en cadenas Anotación @Query
Consulta con ORDER BY Anotación @Query
Query with DISTINCT Anotación @Query
Consulta con funciones de agregado Anotación @Query
Uso de subdocumentos Anotación @Query
Consulta con Joins dentro de documentos Anotación @Query
Consulta con operadores de cadena, matemáticos y de matriz Anotación @Query

Pasos siguientes

¿Intenta planear la capacidad de una migración a Azure Cosmos DB? Para ello, puede usar información sobre el clúster de bases de datos existente.