Parâmetros avançados de conexão
As seções a seguir descrevem os parâmetros avançados de conexão para o driver JDBC 3.x.
Tópicos
Parâmetros da criptografia de resultados
Observe os seguintes pontos:
-
A chave do AWS KMS deve ser especificada quando
EncryptionOptionéSSE_KMSouCSE_KMS. -
A chave do AWS KMS não pode ser especificada quando a
EncryptionOptionnão está especificada ou quando aEncryptionOptionéSSE_S3.
Opção de criptografia
O tipo de criptografia a ser usado nos resultados de consultas quando eles são armazenados no Amazon S3. Para obter mais informações sobre as opções de criptografia, consulte EncryptionConfiguration na Amazon Athena API Reference.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão | Possíveis valores |
|---|---|---|---|---|
| EncryptionOption | S3OutputEncOption (obsoleto) | Opcional | nenhuma | SSE_S3, SSE_KMS, CSE_KMS |
Chave do KMS
O ARN ou ID da chave do KMS, se SSE_KMS ou CSE_KMS for escolhido como a opção de criptografia. Para obter mais informações, consulte EncryptionConfiguration na Amazon Athena API Reference.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| KmsKey | S3OutputEncKMSKey (obsoleto) | Opcional | nenhuma |
Parâmetros de busca de resultados
Buscador de resultados
O buscador que será usado para baixar resultados das consultas.
O buscador de resultados padrão, auto, baixa os resultados das consultas diretamente do Amazon S3 sem usar as APIs do Athena. Quando não é possível fazer o download direto do S3, como nos casos em que os resultados da consulta estão criptografados com a opção CSE_KMS, o Athena automaticamente usa a API GetQueryResultsStream como alternativa.
O uso do buscador auto é recomendado na maioria das situações. Se suas políticas do IAM ou as políticas para o bucket do S3 usarem a condição s3:CalledVia com a finalidade de limitar o acesso às solicitações de objetos do S3 provenientes do Athena, o buscador auto tentará primeiro fazer o download dos resultados do S3 e, em seguida, recorrerá à API GetQueryResultsStream. Nessa situação, é possível configurar o ResultFetcher para GetQueryResultsStream, evitando uma chamada de API adicional.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão | Possíveis valores |
|---|---|---|---|---|
| ResultFetcher | nenhuma | Opcional | auto | auto, S3, GetQueryResults e GetQueryResultsStream |
Tamanho da busca
O valor desse parâmetro é usado como o mínimo para buffers internos e como tamanho das páginas de destino ao buscar resultados. O valor 0 (zero) significa que o driver deve usar seus próprios padrões conforme descrito abaixo. O valor máximo é 1.000.000.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| FetchSize | RowsToFetchPerBlock (obsoleto) | Opcional | 0 |
-
O buscador
GetQueryResultssempre usará um tamanho de página de 1.000, que é o valor máximo permitido para a chamada de API. Quando o tamanho da busca é maior do de 1.000, várias chamadas sucessivas de API são feitas para preencher o buffer acima do mínimo. -
O buscador
GetQueryResultsStreamusa o tamanho de busca configurado como o tamanho de página, ou 10.000 por padrão. -
O buscador
S3usa o tamanho de busca configurado como o tamanho de página, ou 10.000 por padrão.
Parâmetros de configuração do resultado
Expected bucket owner (Proprietário esperado do bucket)
O ID da conta do proprietário esperado do bucket do S3. Se o ID da conta que você fornecer não corresponder ao proprietário real do bucket, a solicitação falhará. Para obter mais informações sobre como verificar o proprietário do bucket do S3, consulte Verificar a propriedade do bucket.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ExpectedBucketOwner | nenhuma | Opcional | nenhuma |
Opção ACL
Indica que uma ACL predefinida do Amazon S3 deve ser configurada para controlar o proprietário dos resultados da consulta armazenados. Para mais informações sobre AclOption, consulte AclConfiguration.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão | Possíveis valores |
|---|---|---|---|---|
| AclOption | nenhuma | Opcional | nenhuma | BUCKET_OWNER_FULL_CONTROL |
Parâmetros de reutilização dos resultados da consulta
Habilitar a reutilização de resultados
Especifica se os resultados anteriores para a mesma consulta poderão reutilizados quando uma consulta for executada. Para obter informações sobre a reutilização de resultados de consulta, consulte ResultReuseByAgeConfiguration.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| EnableResultReuseByAge | nenhuma | Opcional | FALSE |
Idade máxima para reutilização dos resultados
Especifica, em minutos, a idade máxima do resultado de uma consulta anterior que o Athena deve considerar para reutilização. Para obter informações sobre a idade máxima para reutilização de resultados, consulte ResultReuseByAgeConfiguration.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| MaxResultReuseAgeInMinutes | nenhuma | Opcional | 60 |
Parâmetros de sondagem da execução de uma consulta
Intervalo mínimo para a sondagem da execução de uma consulta
O tempo mínimo, em milissegundos, a ser aguardado antes de sondar o Athena sobre o status da execução de uma consulta.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| MinQueryExecutionPollingIntervalMillis | MinQueryExecutionPollingInterval (obsoleto) | Opcional | 100 |
Intervalo máximo para sondagem da execução de uma consulta
O tempo máximo, em milissegundos, a ser aguardado antes de sondar o Athena sobre o status da execução de uma consulta.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| MaxQueryExecutionPollingIntervalMillis | MaxQueryExecutionPollingInterval (obsoleto) | Opcional | 5000 |
Multiplicador do intervalo de sondagem da execução de uma consulta
O fator de aumento do período de sondagem. Por padrão, a sondagem começa com o valor de MinQueryExecutionPollingIntervalMillis e dobra a cada sondagem até atingir o valor de MaxQueryExecutionPollingIntervalMillis.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| QueryExecutionPollingIntervalMultiplier | nenhuma | Opcional | 2 |
Parâmetros de substituição de endpoint
Substituição do endpoint do Athena
O endpoint que o driver usará para fazer chamadas de API para o Athena.
Observe os seguintes pontos:
-
Se os protocolos
https://ouhttp://não forem especificados na URL fornecida, o driver inserirá o prefixohttps://. -
Se esse parâmetro não for especificado, o driver usará um endpoint padrão.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| AthenaEndpoint | EndpointOverride (obsoleto) | Opcional | nenhuma |
Substituição de endpoint de serviço de streaming do Athena
O endpoint que o driver usará para baixar os resultados das consultas quando usar o serviço de streaming do Athena. O serviço de streaming do Athena está disponível na porta 444.
Observe os seguintes pontos:
-
Se os protocolos
https://ouhttp://não forem especificados na URL fornecida, o driver inserirá o prefixohttps://. -
Se uma porta não for especificada na URL fornecida, o driver inserirá a porta 444 do serviço de streaming.
-
Se o parâmetro
AthenaStreamingEndpointnão for especificado, o driver usará a substituição doAthenaEndpoint. Se nem oAthenaStreamingEndpointnem a substituição doAthenaEndpointforem especificados, o driver usará um endpoint de streaming padrão.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| AthenaStreamingEndpoint | StreamingEndpointOverride (obsoleto) | Opcional | nenhuma |
Substituição de endpoint do LakeFormation
O endpoint que o driver usará para o serviço Lake Formation quando usar a API AssumeDecorateRoleWithSAML do AWS Lake Formation para recuperar credenciais temporárias. Se esse parâmetro não for especificado, o driver usará um endpoint padrão do Lake Formation.
Observe os seguintes pontos:
-
Se os protocolos
https://ouhttp://não forem especificados na URL fornecida, o driver inserirá o prefixohttps://.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| LakeFormationEndpoint |
LfEndpointOverride (obsoleto) |
Opcional | nenhuma |
Substituição de endpoint do S3
O endpoint que o driver usará para baixar os resultados das consultas quando usar o buscador do Amazon S3. Se esse parâmetro não for especificado, o driver usará um endpoint padrão do Amazon S3.
Observe os seguintes pontos:
-
Se os protocolos
https://ouhttp://não forem especificados na URL fornecida, o driver inserirá o prefixohttps://.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| S3Endpoint | Nenhum | Opcional | nenhuma |
Substituição de endpoint do STS
O endpoint que o driver usará para o serviço AWS STS quando usar a API AssumeRoleWithSAML do AWS STS para recuperar as credenciais temporárias. Se esse parâmetro não for especificado, o driver usará um endpoint padrão do AWS STS.
Observe os seguintes pontos:
-
Se os protocolos
https://ouhttp://não forem especificados na URL fornecida, o driver inserirá o prefixohttps://.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| StsEndpoint | StsEndpointOverride(obsoleto) | Opcional | nenhuma |
Substituição de endpoint OIDC de SSO
O endpoint que o driver usará ao utilizar ClientConfiguration.endpointOverride para substituir o endpoint HTTP padrão para o cliente SSO OIDC. Para obter mais informações, consulte ClientConfiguration.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| SSOOIDCEndpointOverride | Opcional | nenhuma |
Substituição do endpoint de SSO Admin
O endpoint que o driver usará ao utilizar ClientConfiguration.endpointOverride para substituir o endpoint HTTP padrão para o cliente de SSO Admin. Para obter mais informações, consulte ClientConfiguration.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| SSOAdminEndpointOverride | Opcional | nenhuma |
Parâmetros de configuração de proxy
Host do proxy
A URL do host proxy. Use esse parâmetro se você precisar que as solicitações do Athena passem por um proxy.
nota
Certifique-se de incluir o protocolo https:// ou http:// no início da URL do ProxyHost.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyHost | nenhuma | Opcional | nenhuma |
Porta do proxy
A porta a ser usada no host proxy. Use esse parâmetro se você precisar que as solicitações do Athena passem por um proxy.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyPort | nenhuma | Opcional | nenhuma |
Nome de usuário do proxy
O nome de usuário para autenticação no servidor proxy. Use esse parâmetro se você precisar que as solicitações do Athena passem por um proxy.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyUsername | ProxyUID (obsoleto) | Opcional | nenhuma |
Senha do proxy
A senha para a autenticação no servidor proxy. Use esse parâmetro se você precisar que as solicitações do Athena passem por um proxy.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyPassword | ProxyPWD (obsoleto) | Opcional | nenhuma |
Hosts isentos de proxy
Um conjunto dos nomes de host aos quais o driver se conecta sem usar um proxy quando o uso de proxy está habilitado (ou seja, quando os parâmetros de conexão ProxyHost e ProxyPort estão definidos). Os hosts devem ser separados pelo caractere barra vertical (|) (por exemplo, host1.com|host2.com).
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyExemptHosts | NonProxyHost | Opcional | nenhuma |
Proxy habilitado para provedores de identidades
Especifica se um proxy deverá ser usado quando o driver se conectar a um provedor de identidades.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ProxyEnabledForIdP | UseProxyForIdP | Opcional | FALSE |
Parâmetros de registro em log
Esta seção descreve os parâmetros relacionados a registro em log.
Nível de log
Especifica o nível para o registro em log do driver. Nada é registrado em log, a menos que o parâmetro LogPath também esteja definido.
nota
Recomendamos definir somente o parâmetro LogPath, a menos que você tenha requisitos especiais. Definir somente o parâmetro LogPath habilita o registro em log e usa o nível de log padrão TRACE. O nível do registro em log TRACE fornece o registro em log mais detalhado.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão | Possíveis valores |
|---|---|---|---|---|
| LogLevel | nenhuma | Opcional | TRACE | OFF, ERROR, WARN, INFO, DEBUG, TRACE |
Caminho do log.
O caminho para um diretório no computador que executa o driver no qual os logs do driver serão armazenados. Um arquivo de log com um nome exclusivo será criado no diretório especificado. Se definido, habilita o registro em log do driver.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| LogPath | nenhuma | Opcional | nenhuma |
Nome da aplicação
O nome da aplicação que usa o driver. Se um valor for especificado para esse parâmetro, esse valor será incluído na string de agente do usuário das chamadas de API que o driver fizer para o Athena.
nota
Você também pode definir o nome da aplicação chamando setApplicationName no objeto DataSource.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ApplicationName | nenhuma | Opcional | nenhuma |
Teste de conexão
Se definido como TRUE, o driver executa um teste de conexão toda vez que uma conexão JDBC é criada, mesmo que uma consulta não seja executada na conexão.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| ConnectionTest | nenhuma | Opcional | VERDADEIRO |
nota
Um teste de conexão envia uma consulta SELECT 1 ao Athena para verificar se a conexão foi configurada corretamente. Isso significa que dois arquivos serão armazenados no Amazon S3 (o conjunto de resultados e os metadados), e tarifas adicionais podem ser aplicadas de acordo com a política de preços do Amazon Athena
Número de novas tentativas
O número máximo de vezes que o driver deve reenviar uma solicitação recuperável para o Athena.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
| NumRetries | MaxErrorRetry (obsoleto) | Opcional | nenhuma |
Tempo limite de rede
O tempo limite de rede controla a quantidade de tempo que o driver espera para que uma conexão de rede seja estabelecida. Isso inclui o tempo necessário para enviar solicitações de API. Em raras circunstâncias, pode ser útil alterar o tempo limite da rede. Por exemplo, você pode querer aumentar o tempo limite para pausas longas na coleta de resíduos. Definir este parâmetro de conexão é equivalente a usar o método setNetworkTimeout em um objeto Connection.
| Nome do parâmetro | Alias | Tipo de parâmetro | Valor padrão |
|---|---|---|---|
|
NetworkTimeoutMillis |
nenhuma | Opcional | nenhuma |