Azure CosmosDB

Saiba mais sobre o conector Azure CosmosDB e como usá-lo na Digibee Integration Platform.

O Azure CosmosDB realiza leituras e gravações de registros no banco de dados CosmosDB na plataforma em nuvem Azure.

Aba General

Parâmetro	Descrição	Valor padrão	Tipo de dado
Dynamic Account	Quando ativo, o conector usará a conta dinamicamente. Caso contrário, ele usará a conta de forma estática.	False	Boolean
Account Name (DB)	O nome da conta dinâmica usada para conectar o conector ao banco de dados CosmosDB. Esta conta deve ter sido previamente configurada em um conector Store Account no pipeline para que este processo tenha efeito. Está disponível apenas se o parâmetro Dynamic Account estiver ativo.	N/A	String
Account	A conta utilizada pelo conector. Está disponível apenas se o parâmetro Dynamic Account estiver inativo.	N/A	String
Database Endpoint (DB)	O endpoint do banco de dados Azure Cosmos ao qual o conector irá se conectar.	N/A	String
Fail On Error	Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade "success".	False	Boolean

Aba Optional

Parâmetro	Descrição	Valor padrão	Tipo de dado
Database Name (DB)	O nome do banco de dados Cosmos ao qual o conector deve se conectar. Se você estiver produzindo dados e o parâmetro Create Database If Not Exists estiver ativo, o conector criará automaticamente um banco de dados Cosmos.	N/A	String
Container Name (DB)	O nome do contêiner Cosmos ao qual o conector deve se conectar. Se você estiver produzindo dados e o parâmetro Create Container If Not Exists estiver ativo, o conector criará automaticamente um contêiner Cosmos.	N/A	String
Client Telemetry Enabled	Define a flag para habilitar a telemetria do cliente, que coleta estatísticas sobre agregação de operações do banco de dados e informações do sistema, como CPU/memória em intervalos regulares, e as envia ao Cosmos Monitoring Service, o que é útil para a resolução de problemas. Este parâmetro está inativo por padrão, indicando que é um recurso opcional; nenhuma telemetria é coletada por padrão.	False	Boolean
Connection Sharing Across Clients Enabled	Permite que vários Clientes Cosmos compartilhem conexões. O parâmetro está inativo por padrão. Quando há várias instâncias do Cliente Cosmos no mesmo JVM interagindo com várias contas Cosmos, ativar essa opção permite o compartilhamento de conexões no modo Direct, se possível, entre as instâncias do Cliente Cosmos. Observe que ao configurar essa opção, a configuração de conexão (ex.: Socket Timeout Config, Idle Timeout Config) do primeiro cliente instanciado será usada para todas as outras instâncias de cliente.	False	Boolean
Consistency Level	Define os níveis de consistência suportados para operações de cliente Azure Cosmos DB no serviço Azure Cosmos DB. O ConsistencyLevel solicitado deve corresponder ou ser mais fraco do que o fornecido para a conta do banco de dados. Os níveis de consistência em ordem de força são: Strong, Bounded Staleness, Session e Eventual. Mais detalhes podem ser encontrados na documentação sobre os níveis de consistência.	N/A	String
Container Partition Key Path (DB)	Define o caminho da chave de partição do contêiner.	N/A	String
Content Response On Write Enabled	Define o valor booleano para retornar apenas os cabeçalhos e o código de status na resposta do Cosmos DB em caso de operações de Create, Update e Delete no CosmosItem. Ele é ativado por padrão no Consumer, pois o ChangeFeed no consumidor requer essa flag e, portanto, não deve ser substituído. No Producer, é recomendável desativá-lo, pois reduz a sobrecarga de rede.	True	Boolean
Create Container If Not Exists	Determina se o conector deve criar automaticamente o contêiner Cosmos caso ele não exista no banco de dados Cosmos.	False	Boolean
Create Database If Not Exists	Determina se o conector deve criar automaticamente o banco de dados Cosmos caso ele não exista na conta Cosmos.	False	Boolean
Multiple Write Regions Enabled	Define a flag para permitir gravações em qualquer região para contas de banco de dados geo-replicadas no serviço Azure Cosmos DB. Se este parâmetro estiver ativo, o SDK direcionará as operações de gravação para as regiões graváveis disponíveis da conta de banco de dados geo-replicada. As regiões graváveis são ordenadas de acordo com o parâmetro Preferred Regions. Ativar este parâmetro não terá efeito até que EnableMultipleWriteRegions no DatabaseAccount também esteja definido como true. Este parâmetro é ativado por padrão, indicando que as gravações são direcionadas às regiões graváveis disponíveis da conta de banco de dados geo-replicada.	True	Boolean
Preferred Regions (DB)	Define as regiões preferenciais separadas por vírgulas para contas de banco de dados geo-replicadas. Por exemplo, East US como a região preferida. Se EnableEndpointDiscovery for true e PreferredRegions não estiver vazio, o SDK usará preferencialmente as regiões no contêiner na ordem em que foram especificadas para realizar operações.	N/A	String
Read Requests Fallback Enabled	Define se será permitido que leituras sejam feitas em várias regiões configuradas em uma conta do serviço Azure Cosmos DB. Este parâmetro está ativo por padrão. Se esta propriedade não for definida, o valor padrão para todos os Níveis de Consistência, exceto Bounded Staleness, é true. O valor padrão para Bounded Staleness é false. 1. endpointDiscoveryEnabled é true. 2. A conta do Azure Cosmos DB tem mais de uma região.	True	Boolean
Item Id (DB)	Define o itemId se for necessário para operações como exclusão ou substituição.	N/A	String
Item Partition Key (DB)	Define a chave de partição. Representa um valor de chave de partição no serviço de banco de dados Azure Cosmos DB. Uma chave de partição identifica a partição em que o item é armazenado.	N/A	String
Operation	A operação do CosmosDB que pode ser usada com este conector no producer.	List Databases	String
Query (DB)	Uma consulta SQL a ser executada para um recurso específico. Saiba mais sobre a Cosmos SQL API.	N/A	String

Aba Documentation

Parâmetro	Descrição	Valor padrão	Tipo de dado
Documentation	Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.	N/A	String