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 Establishing a Connection.
| Property | Description |
| AuthScheme | The authentication scheme used. Accepted entries are Basic, OAuth and ClientJWT. |
| User | The user name of the CData Connect Account. |
| Password | The Password of the CData Connect Account. |
| Property | Description |
| CallbackURL | The URL users return to after authenticating to CData Connect via OAuth. |
| Property | Description |
| ClientJWTCert | The JWT Certificate store. |
| ClientJWTCertType | The type of key store containing the JWT Certificate. |
| ClientJWTCertPassword | The password for the Client JWT certificate. |
| ClientJWTIssuer | A string representing the OEM’s account id. |
| ClientJWTSubject | A string representing the OEM’s customer’s account id. |
| ClientJWTValidityTime | How long the JWT should remain valid, in seconds. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheConnection | The connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance, in seconds, for stale data in the specified cache database. |
| Offline | Get the data from the specified cache database instead of live CData Connect data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| ConnectClient | The name of the client connecting to Connect Cloud. Optional. |
| DefaultCatalog | The default catalog. |
| DefaultSchema | The default schema. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| MaxRowsTimeout | Specify the the max timeout of every batch in the Steam mode, the default value is 30 seconds;. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| QueryPassthrough | This option passes the query to the CData Connect server as is. |
| StreamMaxRows | Specify the the row size of every batch in the Steam mode, the default value is 5000;. |
| Timeout | The query timeout. |
| URL | The URL of the CData Connect on-premise Server. |
| UseStreamMode | Specify whether or not use the Stream mode when executing queries, it's enabled by default. |
| Workspace | Specify the workspace to connect with. |