Guia para programadores do Azure Cosmos DB

O Azure Spring Data para Azure Cosmos DB fornece suporte ao Spring Data para o Azure Cosmos DB para NoSQL. O Azure Cosmos DB é um serviço de banco de dados distribuído globalmente que permite que os desenvolvedores trabalhem com dados usando várias APIs padrão, como SQL, MongoDB, Cassandra, Graph e Table.

Este guia irá guiá-lo pelos conceitos do Azure Spring Data Azure Cosmos DB SDK, recursos suportados, solução de problemas e problemas conhecidos. Para obter mais informações sobre os conceitos e exemplos de código abaixo, consulte o Leiame do SDK do Spring Data for Azure Cosmos DB.

Política de suporte de versão

Suporte à versão Spring Boot

Este projeto suporta várias versões do Spring Boot. Para obter mais informações, consulte Política de suporte do Spring Boot. Os usuários do Maven podem herdar do spring-boot-starter-parent projeto para obter uma seção de gerenciamento de dependência para permitir que o Spring gerencie as versões das dependências. Para obter mais informações, consulte Suporte à versão do Spring Boot.

Suporte à versão Spring Data

Este projeto suporta diferentes versões spring-data-commons. Para obter mais informações, consulte Suporte à versão do Spring Data.

Qual versão do Azure Spring Data Azure Cosmos DB usar

Azure Spring Data A biblioteca do Azure Cosmos DB suporta várias versões do Spring Boot / Spring Cloud. Para obter mais informações sobre qual versão do Azure Spring Data Azure Cosmos DB usar com a versão Spring Boot / Spring Cloud, consulte Qual versão do Azure Spring Data para Azure Cosmos DB devo usar?.

Começar

Inclua o pacote

Se você estiver usando o Maven, adicione a seguinte dependência.

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

Pré-requisitos

• Java Development Kit (JDK), versão 8 ou superior.
• Uma conta ativa do Azure. Se não tiver uma, pode inscrever-se numa conta gratuita. Como alternativa, você pode usar o emulador do Azure Cosmos DB para desenvolvimento e teste. Como o certificado https do emulador é autoassinado, você precisa importar seu certificado para o armazenamento de certificados confiável java, explicado aqui
• (Opcional) SLF4J é uma fachada de registro.
• (Opcional) A vinculação SLF4J é usada para associar uma estrutura de log específica ao SLF4J.
• (Opcional) Maven

SLF4J só é necessário se você planeja usar logging, também baixar uma ligação SLF4J, que irá vincular a API SLF4J com a implementação de log de sua escolha. Para obter mais informações, veja o Manual do utilizador do SLF4J.

Instalar e personalizar a classe de configuração

Para configurar a classe de configuração, você precisa estender AbstractCosmosConfigurationo . Para obter mais informações, consulte Setup Configuration Class.

Você pode personalizar o uso subjacente CosmosAsyncClient pelo SDK do Azure Spring Data Azure Cosmos DB fornecendo DirectConnectionConfig ou GatewayConnectionConfig ambos e fornecendo-os ao CosmosClientBuilder. Para obter um exemplo completo, visite a seção de configuração de personalização.

Configuração da entidade

Você pode definir uma entidade simples como item no Azure Cosmos DB. Você pode definir entidades adicionando a @Container anotação e especificando propriedades relacionadas ao contêiner. Para obter mais informações, consulte Definir uma entidade.

A anotação de contêiner suporta a especificação do nome do contêiner, unidades de solicitação (RUs), tempo de vida, criação de contêineres com taxa de transferência de dimensionamento automático, suporte a chave de partição aninhada e outras propriedades de contêiner.

Configuração do repositório

Azure Spring Data O Azure Cosmos DB suporta ReactiveCrudRepository (APIs assíncronas) e CrudRepository (APIs de sincronização), que fornecem a seguinte funcionalidade CRUD básica:

• save
• encontrarTodos
• findOne por ID
• excluirTodos
• excluir por ID
• excluir entidade

Você pode estender CosmosRepository (para suporte de API de sincronização) ou ReactiveCosmosRepository (para suporte de API assíncrona) para configurar repositórios de dados Spring para seu aplicativo. Para obter mais informações, consulte Criar repositórios.

Azure Spring Data O Azure Cosmos DB dá suporte à especificação de consultas anotadas nos repositórios usando @Queryo . Para obter mais informações, consulte QueryAnnotation : Usando consultas anotadas em repositórios.

Anotações de dados do Spring

Anotação de @Id de dados do Spring

Há várias maneiras de mapear um campo na classe de domínio para id. Para obter mais informações, consulte a seção Código de anotação de ID de dados de primavera.

Geração automática de ID

Azure Spring Data O Azure Cosmos DB dá suporte à geração automática de IDs usando a @GeneratedValue anotação. Para obter mais informações, consulte a seção Geração automática de ID.

Expressão SpEL e nome do contêiner personalizado

Por padrão, o nome do contêiner será o nome da classe de domínio do usuário. Para personalizar, adicione a @Container(containerName="myCustomContainerName") anotação à classe de domínio. Para obter mais informações, consulte a seção Expressão SpEL e nome do contêiner personalizado.

Política de indexação personalizada

Por padrão, IndexingPolicy será definido pelo serviço do Azure. Para personalizar, adicione a anotação @CosmosIndexingPolicy à classe de domínio. Para obter mais informações, consulte a seção Política de indexação.

Política chave única

Azure Spring Data O Azure Cosmos DB dá suporte à configuração UniqueKeyPolicy no contêiner adicionando a anotação @CosmosUniqueKeyPolicy à classe de domínio. Para obter mais informações, consulte a seção política de chave exclusiva.

Partição do Azure Cosmos DB

Azure-spring-data-cosmos suporta partições do Azure Cosmos DB.

Para especificar um campo da classe de domínio como um campo de chave de partição, basta anotá-lo com @PartitionKey.

Ao executar a operação CRUD, especifique o valor da partição.

Para obter mais informações, consulte a seção de teste aqui.

Bloqueio otimista

Azure-spring-data-cosmos suporta bloqueio otimista para contêineres específicos, o que significa que os upserts/exclusões por item falharão com uma exceção caso o item seja modificado por outro processo entretanto. Para obter mais informações, consulte a seção bloqueio otimista.

Consulta personalizada do Spring Data, paginável e de classificação

Azure-spring-data-cosmos suporta consultas personalizadas do Spring Data, por exemplo, uma operação de localização como findByAFieldAndBField. Ele também suporta Spring Data Pageable, Slice e Sort. Para obter mais informações, consulte a seção consulta, paginável e classificação.

Usando o SDK Java do Azure Cosmos DB por meio do Spring Data Cosmos

Azure-spring-data-cosmos suporta o uso do Azure Cosmos DB Java SDK. Os usuários podem obter CosmosClient ou CosmosAsyncClient fazer bean e ApplicationContext executar quaisquer operações suportadas pelo SDK Java do Azure Cosmos DB. Para obter mais informações, consulte a seção Usando o Azure Cosmos Client através do Spring Data Cosmos.

Spring Data REST

Azure-spring-data-cosmossuporta Spring Data REST. Para obter mais informações, consulte a seção Azure Spring Data Azure Cosmos DB REST API.

Auditoria

Azure-spring-data-cosmos Suporta campos de auditoria em entidades de banco de dados usando anotações padrão de dados de mola. Para obter mais informações, consulte a seção Auditoria do Spring Data Azure Cosmos DB.

Configuração de vários bancos de dados

Azure-spring-data-cosmos Suporta configuração de vários bancos de dados, incluindo "várias contas de banco de dados" e "conta única, com vários bancos de dados". Para obter um trecho de código completo, consulte a seção de configuração de vários bancos de dados.

Resolução de Problemas

Geral

Se você encontrar algum bug, registre um problema aqui.

Para sugerir um novo recurso ou alterações que possam ser feitas, registre um problema da mesma forma que faria para um bug.

Habilitar o log do cliente

Azure-spring-data-cosmos usa SLF4j como a fachada de log que suporta o login em estruturas de log populares, como log4j e logback. Para obter mais informações, consulte a seção habilitar log do cliente.

Exemplos

Para obter um projeto de exemplo completo, consulte o projeto de exemplo.

Contas de várias bases de dados

Para obter um projeto de exemplo completo, consulte o projeto de exemplo de vários bancos de dados.

Conta única com várias bases de dados

Para obter um projeto de exemplo completo, consulte o projeto de exemplo Conta única com vários bancos de dados.

Próximos passos

• Leia mais sobre os dados de primavera do Azure Azure Cosmos DB.
• Leia mais sobre o Serviço Azure Cosmos DB
• Veja os exemplos do Azure Spring Data do Azure Cosmos DB
• Veja o exemplo do Spring MVC com o Azure Cosmos DB

Contribuição

Este projeto acolhe contribuições e sugestões. A maioria das contribuições exige que você concorde com um Contrato de Licença de Colaborador (CLA) declarando que você tem o direito de, e realmente concede, os direitos de usar sua contribuição.

Quando você envia uma solicitação pull, um CLA-bot determinará automaticamente se você precisa fornecer um CLA e decorar o PR adequadamente (por exemplo, rótulo, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios usando nosso CLA.

Este projeto adotou o Código de Conduta Open Source da Microsoft. Para obter mais informações, consulte as Perguntas frequentes sobre o Código de Conduta ou entre em contato opencode@microsoft.com com quaisquer outras perguntas ou comentários.