ODBC Driver for Amazon Athena

Build 20.0.7654

Connection Properties

The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.

For more information on establishing a connection, see Getting Started.
Auth SchemeThe scheme used for authentication. Accepted entries are: Auto, , AwsRootKeys , AwsIAMRoles , AwsEC2Roles , AwsMFA , AwsOKTA, AwsADFS , AwsCredentialsFile.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
AWS Access KeyYour AWS account access key. This value is accessible from your AWS security credentials page.
AWS Credentials FileThe path to the AWS Credentials File to be used for authentication.
AWS Credentials File ProfileThe name of the profile to be used from the supplied AWSCredentialsFile.
AWS External IdA unique identifier that might be required when you assume a role in another account.
AWS Principal ArnThe ARN of the SAML Identity provider in your AWS account.
AWS RegionThe hosting region for your Amazon Web Services.
AWS Role ARNThe Amazon Resource Name of the role to use when authenticating.
AWS Secret KeyYour AWS account secret key. This value is accessible from your AWS security credentials page.
AWS Session TokenYour AWS session token.
Cache ConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ProviderThe name of the provider to be used to cache data.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Clean Query ResultsAmazon Athena produces cache files with every query, in the folder specified in S3StagingDirectory . CleanQueryResults specifies whether these files should be deleted once the connection is closed.
DatabaseThe name of the Athena database.
Default DomainThis property is used for the Oracle Database Gateway for ODBC.
Enable Foreign Key DetectionWhether to detect the foreign keys in ODBC.
Encryption KeySpecifies the encryption key when encrypting results stored in S3.
Encryption TypeSpecifies the encryption option for query results in Athena.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Include Dual TableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
Include Table TypesIf set to true, the provider will query for the types of individual tables.
Limit Key SizeThe maximum length of a primary key column.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Map To IntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
Map To Long VarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
Map To WVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
Maximum Column SizeThe maximum column size.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Metadata Discovery MethodAPI to use to retrieve the metadata for Amazon Athena.
MFA Serial NumberThe serial number of the MFA device if one is being used.
MFA TokenThe temporary token available from your MFA device.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
Page SizeThe number of results to return per page of data retrieved from Amazon Athena.
Polling IntervalThis determines the polling interval in milliseconds to check whether the result is ready to be retrieved.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
Query Caching LevelModifies the usage of query results stored in S3StagingDirectory . Cached queries will not be scanned again by Amazon Athena until the amount of seconds specified in QueryTolerance has passed.
Query PassthroughWhether or not the provider will pass the query to Amazon Athena as-is.
Query TimeoutThe timeout in seconds for requests issued by the provider to download large result sets.
Query ToleranceSpecifies the amount of time in seconds queries cache for if QueryCachingLevel is not set to None.
RTKThe runtime key used for licensing.
S3 Staging DirectorySpecifies the location Amazon Athena will use to store the results of a query.
Simple Upload LimitThis setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request.
Skip Header Line CountSpecifies the number of header rows to skip for SELECT queries.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
SSO PropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Temporary Token DurationThe amount of time (in seconds) a temporary token will last.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Upper Case IdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
WorkgroupWork group of the executed queries.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654