Cmdlets for IBM Cloud SQL Query

Build 20.0.7654

Parameters (Connect-IBMCloudSQLQuery Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Parameter Required Description
ApiKey    The API Key used to identify the user to IBM Cloud. 
AutoCache    Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . 
Bucket    The name of the bucket in IBM Cloud that you will be connecting to. 
CacheConnection    The 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. 
CacheLocation    Specifies the path to the cache when caching to a file. 
CacheMetadata    This property determines whether or not to cache the table metadata to a file store. 
CacheProvider    The name of the provider to be used to cache data. 
CacheTolerance    The tolerance for stale data in the cache specified in seconds when using AutoCache . 
CleanQueryResults    CleanQueryResults specifies whether query cache files should be deleted once the connection is closed. 
CloudObjectStorageCRN    The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud. 
FirewallPassword    A password used to authenticate to a proxy-based firewall. 
FirewallPort    The TCP port for a proxy-based firewall. 
FirewallServer    The name or IP address of a proxy-based firewall. 
FirewallType    The protocol used by a proxy-based firewall. 
FirewallUser    The user name to use to authenticate with a proxy-based firewall. 
InitiateOAuth    Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. 
Location    A path to the directory that contains the schema files defining tables, views, and stored procedures. 
Logfile    A filepath which designates the name and location of the log file. 
LogModules    Core modules to be included in the log file. 
MaxLogFileCount    A 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. 
MaxLogFileSize    A 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. 
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. 
OAuthAccessToken  True  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://. 
Offline    Use offline mode to get the data from the cache instead of the live source. 
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. 
ProxyAuthScheme    The authentication type to use to authenticate to the ProxyServer proxy. 
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. 
ProxyExceptions    A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . 
ProxyPassword    A password to be used to authenticate to the ProxyServer proxy. 
ProxyPort    The TCP port the ProxyServer proxy is running on. 
ProxyServer    The hostname or IP address of a proxy to route HTTP traffic through. 
ProxySSLType    The SSL type to use when connecting to the ProxyServer proxy. 
ProxyUser    A user name to be used to authenticate to the ProxyServer proxy. 
PseudoColumns    This property indicates whether or not to include pseudo columns as columns to the table. 
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. 
Region    The geographic location of the bucket you're connecting to. 
ResultLocationURI    A COSURI (e.g. cos://region/bucket) where job files will be stored. 
RTK    The runtime key used for licensing. 
SqlQueryCRN    The CRN which uniquely identifies your SQL Query instance in IBM Cloud. 
SSLServerCert    The certificate to be accepted from the server when connecting using TLS/SSL. 
StoreResultsAs    Specifies the data type of the generated results file after a job has been completed. 
Tables    This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. 
Timeout    The value in seconds until the timeout error is thrown, canceling the operation. 
Verbosity    The verbosity level that determines the amount of detail included in the log file. 
Views    Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. 

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