Advanced connection parameters

The following sections describe the advanced connection parameters for the JDBC 3.x driver.

Result encryption parameters

Note the following points:

Encryption option

The type of encryption to be used for query results as they are stored in Amazon S3. For information about query result encryption, see EncryptionConfiguration in the Amazon Athena API Reference.

KMS Key

The KMS key ARN or ID, if SSE_KMS or CSE_KMS is chosen as the encryption option. For more information, see EncryptionConfiguration in the Amazon Athena API Reference.

Result fetching parameters

Result fetcher

The fetcher that will be used to download query results.

The available fetchers are identical in that they all return results from Amazon S3, but differ in terms of performance and implementation. The default result fetcher, S3, downloads query results directly from Amazon S3 without using the Athena APIs. This is the fastest option in most cases, but the S3 option is not available if 1) your query results are encrypted with CSE_KMS or 2) if the policy that allows the user access to query results only allows calls from Athena using s3:CalledVia. The ResultFetcher=GetQueryResultsStream option uses the result set streaming API and is the equivalent of the UseResultsetStreaming = 1 setting in the JDBC 2.x driver.

Fetch size

The value of this parameter is used as the minimum for internal buffers and as the target page size when fetching results. The value 0 (zero) means that the driver should use its defaults as described below. The maximum value is 1,000,000.

Query result reuse parameters

Enable result reuse

Specifies whether previous results for the same query can be reused when a query is run. For information about query result reuse, see ResultReuseByAgeConfiguration.

Result reuse max age

The maximum age, in minutes, of a previous query result that Athena should consider for reuse. For information about result reuse max age, see ResultReuseByAgeConfiguration.

Query execution polling parameters

Minimum query execution polling interval

The minimum time, in milliseconds, to wait before polling Athena for the query execution status.

Maximum query execution polling interval

The maximum time, in milliseconds, to wait before polling Athena for the query execution status.

Query execution polling interval multiplier

The factor for increasing the polling period. By default, polling will begin with the value for MinQueryExecutionPollingIntervalMillis and double with each poll until it reaches the value for MaxQueryExecutionPollingIntervalMillis.

Endpoint override parameters

Athena endpoint override

The endpoint that the driver will use to make API calls to Athena.

Note the following points:

Athena streaming service endpoint override

The endpoint that the driver will use to download query results when it uses the Athena streaming service. The Athena streaming service is available on port 444.

Note the following points:

LakeFormation endpoint override

The endpoint that the driver will use for the Lake Formation service when using the AWS Lake Formation AssumeDecoratedRoleWithSAML API to retrieve temporary credentials. If this parameter is not specified, the driver uses a default Lake Formation endpoint.

Note the following points:

S3 endpoint override

The endpoint that the driver will use to download query results when it uses the Amazon S3 fetcher. If this parameter is not specified, the driver uses a default Amazon S3 endpoint.

Note the following points:

STS endpoint override

The endpoint that the driver will use for the AWS STS service when using the AWS STS AssumeRoleWithSAML API to retrieve temporary credentials. If this parameter is not specified, the driver uses a default AWS STS endpoint.

Note the following points:

Proxy configuration parameters

Proxy host

The URL of the proxy host. Use this parameter if you require Athena requests to go through a proxy.

Proxy port

The port to be used on the proxy host. Use this parameter if you require Athena requests to go through a proxy.

Proxy username

The username to authenticate on the proxy server. Use this parameter if you require Athena requests to go through a proxy.

Proxy password

The password to authenticate on the proxy server. Use this parameter if you require Athena requests to go through a proxy.

Proxy-exempt hosts

A set of host names that the driver connects to without using a proxy when proxying is enabled (that is, when the ProxyHost and ProxyPort connection parameters are set). The hosts should be separated by the pipe (|) character (for example, host1.com|host2.com).

Proxy enabled for identity providers

Specifies whether a proxy should be used when the driver connects to an identity provider.

Logging parameters

This section describes parameters related to logging.

Log level

Specifies the level for the driver logging. Nothing is logged unless the LogPath parameter is also set.

Log path

The path to a directory on the computer that runs the driver where driver logs will be stored. A log file with a unique name will be created within the specified directory. If set, enables driver logging.

Application name

The name of the application that uses the driver. If a value for this parameter is specified, the value is included in the user agent string of the API calls that the driver makes to Athena.

Connection test

If set to TRUE, the driver performs a connection test each time a JDBC connection is created, even if a query is not executed on the connection.

Number of retries

The maximum number of times the driver should resend a retriable request to Athena.

Network timeout

The network timeout controls the amount of time that the driver waits for a network connection to be established. This includes the time it takes to send API requests. In rare circumstances, it may be useful to change the network timeout. For example, you might want to increase the timeout for long garbage collection pauses. Setting this connection parameter is equivalent to using the setNetworkTimeout method on a Connection object.