Stream DB V3

Descubra mais sobre o componente Stream DB V3 e saiba como utilizá-lo na Digibee Integration Platform.

O Stream DB V3 permite estabelecer uma conexão com um serviço que suporta o protocolo JDBC (Java Database Connectivity) e executar instruções SQL (Structured Query Language). Para consultar quais os bancos de dados suportados por esse componente, leia a documentação Bancos de dados suportados.

Diferentemente do componente DB V1, o Stream DB foi desenvolvido para realizar execução em lotes, ou seja, cada retorno (linha resultante ou row) da instrução SQL executada é tratada individualmente através de um subpipeline, podendo conter seu próprio fluxo de processamento. Leia o artigo Subpipelines para saber mais.

Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Aba General

Parâmetro	Descrição	Valor padrão	Tipo de dado
Account Type	Define o tipo de Conta a ser utilizada pelo componente. As opções são: Basic, AWS V4 e Kerberos.	Basic	String
Account	Conta a ser utilizada pelo componente para se conectar. Contas suportadas: Basic e Kerberos.	N/A	String
Fail On Error	Se a opção estiver ativada, a execução do pipeline com erro será interrompida. Do contrário, a execução do pipeline continua, mas o resultado irá mostrar um valor falso para a propriedade "success".	False	Booleano

Aba Operation

Parâmetro	Descrição	Valor padrão	Tipo de dado
Database URL	URL (Uniform Resource Locator) para estabelecer conexão ao servidor de banco de dados com suporte ao protocolo JDBC. Este parâmetro aceita Double Braces.	jdbc:mysql://35.223.175.97/db-training	String
SQL Statement (DB)	Instrução SQL a ser executada.	select * from clientes LIMIT 2	String
Column Name	Caso haja um erro no processamento do subpipeline onProcess, o valor associado à coluna definida neste campo será adicionado à mensagem de erro, em um novo campo chamado "processedId" e que poderá ser manipulado pelo subpipeline onException.	codigo	String
Parallel Execution Of Each Iteration	Quando ativada, essa opção faz com que cada uma das passagens pelo subpipeline seja feita em paralelo, reduzindo o tempo de execução total. No entanto, não há qualquer garantia de que os itens sejam executados na ordem retornada pelo banco de dados.	False	Booleano
Blob As File	Se ativada, a opção faz com que os campos do tipo blob sejam armazenados no contexto do pipeline como arquivo; do contrário, os campos são armazenados como textos normais (strings) e codificados em base64.	False	Booleano
Clob As File	A opção faz com que os campos do tipo clob sejam armazenados no contexto do pipeline como arquivo; do contrário, os campos são armazenados como textos normais (strings).	False	Booleano
Charset	Essa opção é exibida apenas quando a opção Clob As File for ativada. Esse parâmetro permite configurar o encoding de arquivos clob.	UTF-8	String
Custom Connection Properties	Propriedades de conexão específicas definidas pelo usuário.	N/A	String

Aba Advanced Settings

Parâmetro	Descrição	Valor padrão	Tipo de dado
Pool Size By Actual Consumers	Se a opção estiver habilitada, o número de conexões agrupadas é igual ao número de consumidores configurados na implantação do pipeline. Se a opção estiver desativada, o tamanho do pool será determinado pelo tamanho da implantação do pipeline, independentemente do número de consumidores.	False	Booleano
Exclusive DB Pool	Se a opção estiver habilitada, um novo pool não compartilhado sempre é criado para uso exclusivo desse conector. Se a opção estiver desativada, um pool poderá ser compartilhado entre os componentes se a URL, credenciais e propriedades específicas de conexão forem as mesmas. Importante: propriedades específicas de conexão precisam ser declaradas na mesma ordem entre outros conectores para que o pool seja compartilhado, caso contrário será considerada como uma configuração diferente e um novo pool será criado.	False	Booleano
Custom Pool	Se a opção for habilitada, a configuração base do pool de conexões será feita baseada nos parâmetros Connection Maximum Lifetime, Minimum Idle Connections e Idle Connection Timeout. Se a opção for desabilitada, o pool será configurado com base no parâmetro Keep Connection. Importante: essa é uma funcionalidade avançada e deve ser usada com cautela. Confira abaixo a seção dedicada para o tópico Pool de Conexões.	False	Booleano
Connection Maximum Lifetime	Define o tempo de vida máximo de uma conexão no pool de conexões. Uma conexão em uso nunca será encerrada. Ela será removida apenas quando for fechada. O valor mínimo permitido é 30000 milissegundos (30 segundos). Se um valor menor for informado, será usado o valor padrão de 1800000 milissegundos (30 minutos). Esta opção está disponível apenas se o parâmetro Custom Pool estiver habilitado.	N/A	Integer
Minimum Idle Connections	Define o número mínimo de conexões idle a serem mantidas no pool. O valor máximo permitido é baseado no tamanho do deployment, ou seja, 10, 20 ou 40. Se um valor maior for informado, o máximo para o tamanho do deployment será usado. Esta opção está disponível apenas se o parâmetro Custom Pool estiver habilitado.	N/A	Integer
Idle Connection Timeout	Define o máximo de tempo no qual uma conexão pode ser mantida idle no pool. Para essa opção ter efeito: Seu valor deve ser inferior ao definido em Connection Maximum Lifetime. O valor configurado em Minimum Idle Connections deve ser inferior ao tamanho do pool (definido através de Pool Size By Actual Consumers). Esta opção está disponível apenas se o parâmetro Custom Pool estiver habilitado.	N/A	Integer
Keep Connection	Se a opção for habilitada, o pool de conexões sempre manterá um número mínimo de conexões abertas prontas para uso. Após 30 minutos, essas conexões serão renovadas. O número mínimo de conexões abertas é definido baseado no parâmetro Pool Size By Actual Consumers. Se a opção for desabilitada, o pool será criado vazio e conexões serão criadas sob demanda, sendo mantidas no pool por não mais que 5 minutos. Neste caso, as conexões não são renovadas. Esta opção está disponível apenas se o parâmetro Custom Pool estiver desabilitado.	True	Booleano
Output Column From Label	Para alguns bancos de dados, se seu Select usar um alias, você deve habilitar este sinalizador para que o nome da coluna seja exibido exatamente como o alias.	False	Booleano
Connection Test Query	SQL statement a ser usado antes de cada conexão ser estabelecida. Este é um parâmetro opcional e deve ser usado com bancos de dados que não fornecem informações confiáveis sobre o status da conexão.	N/A	String
Raw SQL Statement (DB)	Se a opção estiver ativada, o parâmetro SQL Statement permite o uso de queries dinâmicas através de declarações Double Braces. Ao utilizar essa funcionalidade, você deve garantir que o pipeline possua mecanismos de segurança contra instruções SQL indesejadas (SQL Injection). Veja mais sobre esse parâmetro na seção abaixo.	False	Booleano

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

Em casos onde um banco de dados Apache Hive é usado, os dados de Updatecount podem estar indisponíveis devido a uma característica do sistema. Essa informação estará disponível apenas se o controle do updated row count estiver habilitado no servidor Apache Hive. Para mais informações sobre suporte Apache Hive para a Digibee Integration Platform, leia o artigo Banco de dados suportados.

Informações adicionais sobre parâmetros

Column Name

Veja o seguinte exemplo sobre a mensagem de erro em Column Name:

{
  "timestamp": 1600797662733,
  "error": "Error message",
  "code": 500,
  "processedId": "2"
}

Blob As File

Se Blob As File estiver ativado, os campos do tipo blob são armazenados como no exemplo a seguir:

// "Blob As File" true
{
  "id": 12,
  "blob": "d3X8YK.file",
}

Do contrário, os campos do tipo blob são armazenados como mostrado abaixo:

// "Blob As File" false
{
  "id": 12,
  "blob": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAeSURBVDhPY1Da6EMSYiBJNVDxqAZiQmw0lAZHKAEAaskfEED3lr0AAAAASUVORK5CYII="
}

Clob As File

Se Clob As File estiver ativado, os campos do tipo clob são armazenados como no exemplo a seguir:

// "Clob As File" true
{
  "id": 15,
  "clob": "f7X9AS.file",
}

Do contrário, os campos do tipo clob são armazenados como mostrado abaixo:

// "Clob As File" false
{
  "id": 15,
  "clob": "AAAAABBBBBCCCC”
}

Raw SQL Statement

Para trazer mais flexibilidade ao utilizar o Stream DB V3, podemos ativar a opção Raw SQL Statement, configurar previamente uma query e referenciá-la via Double Braces no parâmetro SQL Statement da seguinte maneira:

Query definida previamente via Template Transformer

Ativação do Raw SQL Statement

Query referenciada no parâmetro SQL Statement

Importante: como boa prática, recomendamos fortemente que ao ativar a opção Raw SQL Statement, as queries sejam definidas previamente através do componente Template Transformer. O uso do Template Transformer permite validar parâmetros através da tecnologia FreeMarker e também a declaração de parâmetros via Double Braces. Estes parâmetros não são resolvidos pelo Template Transformer e sim pelo componente Stream DB V3, que por padrão configura e valida os parâmetros da instrução SQL previamente (PreparedStatement). Ao aplicar essas medidas de segurança, você diminui os riscos de ataques do tipo SQL Injection.

Na imagem abaixo, temos à esquerda um exemplo do uso recomendado do componente (com o Double Braces na cláusula WHERE, no destaque verde); e à direita um exemplo do uso não recomendado (com o FreeMarker na cláusula WHERE, no destaque vermelho) que pode trazer riscos à segurança do pipeline:

Tecnologia

Autenticação via Kerberos

Para realizar autenticação a um banco de dados via Kerberos é necessário:

• informar uma conta (account) do tipo KERBEROS;

• configurar um Kerberos principal;

• configurar uma keytab (que deve ser a base64 do próprio arquivo keytab gerado).

Fluxo de Mensagens

Estrutura de mensagem disponível no subpipeline onProcess

Uma vez que a instrução SQL é executada, o subpipeline será disparado recebendo o resultado da execução por meio de uma mensagem na seguinte estrutura:

{  
    "coluna1": "dado1",   
    "coluna2": "dado2",  
    "coluna3": "dado3"
}

Saída com erro

{   
    "code": error_code,   
    "error": mensagem de erro,   
    "processId": the_id_column_value
}

Saída

Após a execução do componente, é retornada uma mensagem na seguinte estrutura:

{   
    "total": 0,   
    "success": 0,   
    "failed": 0
}

• total: número total de linhas processadas.

• success: número total de linhas processadas com sucesso.

• failed: número total de linhas cujo processamento falhou.

Importante: para detectar se uma linha foi processada corretamente, cada subpipeline onProcess deve responder com { "success": true } a cada elemento processado.

O Stream DB V3 realiza processamento em lote. Consulte o artigo Processamento em lote para saber mais sobre este conceito.

Pool de conexão

Por padrão, utilizamos um pool com tamanho baseado nas configurações do pipeline implantado. Caso seja um pipeline Small, então o tamanho do pool será de 10; para o Medium, será de 20; e para o Large, de 40.

É possível gerenciar o tamanho do pool também na hora da implantação. Para isso, será necessário habilitar o parâmetro Pool Size By Actual Consumers no componente. Com isso, será utilizado o que for configurado manualmente na tela de implantação.

No exemplo da figura abaixo, foi configurado um pipeline Small com 5 consumers. Se você quiser que o pool dos componentes de banco de dados (DB V2 e Stream DB V3) utilize esse tamanho, é necessário habilitar o parâmetro Pool Size By Actual Consumers em todos os componentes existentes.

Tenha atenção redobrada ao configurar o tamanho do pool manualmente para que não ocorra nenhum deadlock em chamadas concorrentes ao mesmo banco.

O nosso pool é compartilhado entre os componentes de banco de dados que acessam o mesmo banco de dados dentro do pipeline. Caso seja necessário um pool exclusivo para um determinado componente, habilite o parâmetro Exclusive DB Pool.

Customizando o Pool de Conexões

Por padrão, o conector definirá como as conexões são gerenciadas no pool com base no parâmetro Keep Connection. Esta configuração visa facilitar a configuração do pool de conexões para cenários em que, por exemplo, alta disponibilidade é necessária ou o oposto disso.

Se habilitado, as conexões são mantidas abertas no pool o tempo todo e são renovadas após 30 minutos. Isso pode ser usado para cenários de alta disponibilidade reduzindo custo de abrir novas conexões frequentemente.

No entanto, se tivermos o cenário oposto onde as conexões são necessárias em intervalos de tempo mais espaçados, você pode desativar o parâmetro para configurar o pool sem conexões abertas previamente e abri-las apenas quando for realmente necessário. Após a conexão ser utilizada, ela será mantida no pool por no máximo 5 minutos e não será renovada.

Embora isso signifique que você não precisa se preocupar com a configuração do pool de conexões, esta opção padrão pode não ser a melhor para alguns casos.

Para ter mais flexibilidade na configuração do pool, você pode ativar a opção Custom Pool. Esta opção ignora a configuração padrão e torna possível definir uma configuração customizada.

Nesse caso, precisamos definir os três parâmetros abaixo (que são definidos implicitamente na configuração padrão):

• Connection Maximum Lifetime

• Minimum Idle Connections

• Idle Connection Timeout

Configurar um pool de conexões pode ser uma tarefa difícil, pois se espera um conhecimento mais aprofundado sobre o tema. Quando aplicado no contexto da Digibee Integration Platform, você deve considerar as variáveis que podem afetar o desempenho do pool.

Coisas como o tamanho do deployment e suas réplicas, acessar os mesmos bancos de dados usando credenciais e propriedades distintas nos conectores de banco de dados dentro dos mesmos e diferentes pipelines e a opção exclusiva de pool de banco de dados nos conectores de banco de dados impactam diretamente em como o pool de conexões deve ser configurado.

Com base em tudo mencionado acima, é altamente recomendável habilitar a opção Custom Pool se tiver conhecimento sobre o tema e se for realmente necessário.

O conector usa o framework HikariCP para gerenciar os pools de conexão. Informações adicionais sobre o tema podem ser encontradas em sua documentação oficial.