---
description: >-
  Saiba mais sobre o conector AWS Athena e como usá-lo na Digibee Integration
  Platform.
---

# AWS Athena

{% hint style="info" %}
O conteúdo desta documentação está em revisão e pode ser alterado. Agradecemos sua compreensão enquanto trabalhamos para melhorá-la.
{% endhint %}

**AWS Athena** acessa o serviço AWS Athena usando a versão 2.x do AWS SDK.

## **Parâmetros**

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por [expressões Double Braces](../../double-braces/overview) estão marcados com `(DB)`.

### **Aba General**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>Quando ativo, o conector usará a conta dinamicamente. Caso contrário, usará a conta de forma estática.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>O nome da conta dinâmica usada pelo conector. Esta conta deve ter sido previamente configurada em um conector <a href="../tools/store-account"><strong>Store Account</strong></a> no pipeline para que este processo tenha efeito. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver ativo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>A conta usada pelo conector. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver inativo.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Label</strong> <code>(DB)</code></td><td>Nome lógico.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>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 <code>"success"</code>.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Optional**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Database</strong> <code>(DB)</code></td><td>O banco de dados Athena a ser utilizado.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Delay</strong></td><td>Milissegundos antes da próxima verificação do status de execução da consulta.</td><td>2000</td><td>Integer</td></tr><tr><td><strong>Encryption Option</strong></td><td>O tipo de criptografia a ser usado ao armazenar os resultados da consulta no S3.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Include Trace</strong></td><td>Inclui informações úteis de rastreamento no início das consultas como um comentário SQL (prefixado com –).</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Initial Delay</strong></td><td>Milissegundos antes da primeira verificação do status de execução da consulta.</td><td>1000</td><td>Integer</td></tr><tr><td><strong>Kms Key</strong> <code>(DB)</code></td><td>Para SSE-KMS e CSE-KMS, esta é a ARN ou ID da chave KMS.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Max Attempts</strong></td><td>Número máximo de tentativas para executar uma consulta. Defina como 1 para desativar tentativas adicionais.</td><td>1</td><td>Integer</td></tr><tr><td><strong>Max Results</strong></td><td>Número máximo de resultados a serem retornados para a operação especificada (se suportado pelo endpoint da API Athena). Se não definido, será usado o padrão da API Athena para a operação.</td><td>N/A</td><td>Integer</td></tr><tr><td><strong>Next Token</strong> <code>(DB)</code></td><td>Token de paginação a ser usado caso a resposta da solicitação anterior tenha sido truncada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Operation</strong></td><td>A função da API Athena a ser chamada.</td><td>Start Query Execution</td><td>String</td></tr><tr><td><strong>Output Location</strong> <code>(DB)</code></td><td>A localização no Amazon S3 onde os resultados da consulta são armazenados, como s3://caminho/para/bucket/. Certifique-se de que este valor termine com uma barra (‘/’).</td><td>N/A</td><td>String</td></tr><tr><td><strong>Output Type</strong></td><td>Como os resultados da consulta devem ser retornados. Uma das opções: Stream List (padrão - retorna um GetQueryResultsIterable que pode paginar todos os resultados), Select List (retorna no máximo 1.000 linhas por vez, além de um valor NextToken como cabeçalho, que pode ser usado para paginação manual dos resultados), S3 Pointer (retorna um caminho S3 apontando para os resultados).</td><td>Stream List</td><td>String</td></tr><tr><td><strong>Query Execution Id</strong> <code>(DB)</code></td><td>O ID exclusivo que identifica a execução da consulta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Query String</strong> <code>(DB)</code></td><td>A consulta SQL a ser executada. Exceto para consultas simples, prefira configurar isso como o corpo do Exchange ou como um cabeçalho usando Athena2Constants.QUERY_STRING para evitar problemas com codificação de URL.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Region</strong> <code>(DB)</code></td><td>A região onde o cliente Athena precisa operar. Ao usar este parâmetro, a configuração esperará o nome da região em letras minúsculas (por exemplo, ap-east-1). Será necessário usar o nome Region.EU_WEST_1.id().</td><td>N/A</td><td>String</td></tr><tr><td><strong>Reset Wait Timeout On Retry</strong></td><td>Reinicia a contagem regressiva do waitTimeout em caso de nova tentativa de consulta. Se definido como true, o tempo máximo potencial de espera por consultas será igual a waitTimeout x maxAttempts.</td><td>True</td><td>Boolean</td></tr><tr><td><strong>Retry</strong></td><td>Lista opcional, separada por vírgulas, de tipos de erro para os quais a consulta deve ser repetida. Use <strong>Retryable</strong> para repetir todas as condições de falha repetíveis (por exemplo, erros genéricos e recursos esgotados), <strong>Generic</strong> para repetir falhas do tipo ‘GENERIC_INTERNAL_ERROR’, <strong>Exhausted</strong> para repetir consultas que esgotaram os limites de recursos, <strong>Always</strong> para sempre repetir independentemente da condição de falha, ou <strong>Never</strong> ou null para nunca repetir (padrão).</td><td>Never</td><td>String</td></tr><tr><td><strong>Wait Timeout</strong></td><td>Tempo máximo de espera opcional em milissegundos para aguardar a conclusão bem-sucedida de uma consulta.</td><td>0</td><td>Integer</td></tr><tr><td><strong>Work Group</strong> <code>(DB)</code></td><td>O grupo de trabalho a ser usado para executar a consulta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Client Request Token</strong> <code>(DB)</code></td><td>Uma string exclusiva para garantir que as consultas emitidas sejam idempotentes. É improvável que você precise definir isso.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Aba Headers**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Query Execution Id</strong> <code>(DB)</code></td><td>O ID exclusivo que identifica a execução da consulta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Query Execution State</strong></td><td>O estado da execução da consulta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Delay</strong></td><td>Milissegundos antes da próxima verificação do status de execução da consulta.</td><td>N/A</td><td>Integer</td></tr><tr><td><strong>Reset Wait Timeout On Retry</strong></td><td>Reinicia a contagem regressiva do waitTimeout em caso de nova tentativa de consulta. Se definido como true, o tempo máximo potencial de espera por consultas será igual a waitTimeout x maxAttempts.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Start Query Execution Attempts</strong></td><td>Número total de tentativas feitas para executar a consulta. Será maior que 1 se a consulta for repetida.</td><td>0</td><td>Integer</td></tr><tr><td><strong>Start Query Execution Elapsed Millis</strong></td><td>Tempo total em milissegundos gasto no startQueryExecution (principalmente relevante ao aguardar a conclusão da consulta dentro de startQueryExecution).</td><td>0</td><td>Integer</td></tr></tbody></table>

### **Aba Documentation**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.</td><td>N/A</td><td>String</td></tr></tbody></table>
