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.
Property | Description |
ApiKey | The API Key used to identify the user to IBM Cloud. |
CloudObjectStorageCRN | The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud. |
SqlQueryCRN | The CRN which uniquely identifies your SQL Query instance in IBM Cloud. |
Property | Description |
Bucket | The name of the bucket in IBM Cloud that you will be connecting to. |
ResultLocationURI | A COSURI (e.g. cos://region/bucket) where job files will be stored. |
Region | The geographic location of the bucket you're connecting to. |
Property | Description |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The 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://. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This 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. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Property | Description |
CleanQueryResults | CleanQueryResults specifies whether query cache files should be deleted once the connection is closed. |
MaxRows | Limits 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. |
Other | These hidden properties are used only in specific use cases. |
PollingInterval | Specifies the amount of time in seconds that the provider should wait between the job status requests. |
QueryCachingLevel | Sets the level of caching for executed queries. |
QueryTolerance | Specifies the amount of time in seconds queries cache for if QueryCachingLevel is set to local or cloud. |
Readonly | You can use this property to enforce read-only access to IBM Cloud SQL Query from the provider. |
StoreResultsAs | Specifies the data type of the generated results file after a job has been completed. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |