TDV Adapter for IBM Cloud SQL Query

Build 21.0.8137

Connection String Options

The connection string 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 string for this provider. Click the links for further details.

For more information on establishing a connection, see Basic Tab.

Authentication


PropertyDescription
ApiKeyThe API Key used to identify the user to IBM Cloud.
CloudObjectStorageCRNThe CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud.
SqlQueryCRNThe CRN which uniquely identifies your SQL Query instance in IBM Cloud.

Connection


PropertyDescription
BucketThe name of the bucket in IBM Cloud that you will be connecting to.
ResultLocationURIA COSURI (e.g. cos://region/bucket) where job files will be stored.
RegionThe geographic location of the bucket you're connecting to.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis 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.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.

Miscellaneous


PropertyDescription
CleanQueryResultsCleanQueryResults specifies whether query cache files should be deleted once the connection is closed.
MaxRowsLimits 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.
OtherThese hidden properties are used only in specific use cases.
PollingIntervalSpecifies the amount of time in seconds that the provider should wait between the job status requests.
QueryCachingLevelSets the level of caching for executed queries.
QueryToleranceSpecifies the amount of time in seconds queries cache for if QueryCachingLevel is set to local or cloud.
ReadonlyYou can use this property to enforce read-only access to IBM Cloud SQL Query from the provider.
StoreResultsAsSpecifies the data type of the generated results file after a job has been completed.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137