Connection String Options
The following is the full list of the options you can configure in the connection string for this provider.
| A password used to authenticate to a proxy-based firewall. |
| The TCP port for a proxy-based firewall. |
| The name or IP address of a proxy-based firewall. |
| The protocol used by a proxy-based firewall. |
| The user name to use to authenticate with a proxy-based firewall. |
| A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| 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. |
Max Threads | Specifies the number of concurrent requests. Only used when UseJobs is true. |
| These hidden properties are used only in specific use cases. |
| The number of results to return per page of data retrieved from the Splunk server. |
| The password of the user. |
| The authentication type to use to authenticate to the ProxyServer proxy. |
| 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. |
| A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
| A password to be used to authenticate to the ProxyServer proxy. |
| The TCP port the ProxyServer proxy is running on. |
| The hostname or IP address of a proxy to route HTTP traffic through. |
| The SSL type to use when connecting to the ProxyServer proxy. |
| A user name to be used to authenticate to the ProxyServer proxy. |
| You can use this property to enforce read-only access to Splunk from the provider. |
| Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan. |
| The certificate to be accepted from the server when connecting using TLS/SSL. |
| The value in seconds until the timeout error is thrown, canceling the operation. |
| Determines how to determine the data type of columns. |
| The URL to your Splunk endpoint. |
Use Client Side Paging | Whether or not the CData ADO.NET Provider for Splunk should use client side paging. This setting is only applied when UseJobs=true. |
Use Jobs | Specifies whether to use the jobs endpoint instead of the export endpoint. If set to true, the maximum number of returned rows is configured Splunk's limit.conf file. |
| The name of a user. |
Firewall Password
A password used to authenticate to a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
Firewall Port
The TCP port for a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
Firewall Server
The name or IP address of a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the adapter uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
Firewall Type
The protocol used by a proxy-based firewall.
Data Type
string
Default Value
"NONE"
Remarks
This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy. Note that by default, the adapter connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the adapter opens a connection to Splunk and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the adapter sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the adapter sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Firewall User
The user name to use to authenticate with a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
"%APPDATA%\\CData\\Splunk Data Provider\\Schema"
Remarks
The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Splunk Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
Max Rows
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.
Data Type
string
Default Value
"-1"
Remarks
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.
Max Threads
Specifies the number of concurrent requests. Only used when UseJobs is true.
Data Type
string
Default Value
"10"
Remarks
This property allows you to issue multiple requests simultaneously, thereby improving performance.
Other
These hidden properties are used only in specific use cases.
Data Type
string
Default Value
""
Remarks
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Page Size
The number of results to return per page of data retrieved from the Splunk server.
Data Type
string
Default Value
"1000"
Remarks
The number of results to return per page of data retrieved from the Splunk server.
Password
The password of the user.
Data Type
string
Default Value
""
Remarks
Together with User, this field is used to authenticate against the Splunk server.
Proxy Auth Scheme
The authentication type to use to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
"BASIC"
Remarks
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
• BASIC: The adapter performs HTTP BASIC authentication.
• DIGEST: The adapter performs HTTP DIGEST authentication.
• NEGOTIATE: The adapter retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The adapter does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see
Firewall Type.
Proxy Auto Detect
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.
Data Type
bool
Default Value
true
Remarks
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
• A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
• In the case that the JVM properties don't exist, a search from
• java.home/lib/net.properties is performed.
• In the case that java.net.useSystemProxies is set to True, a search from
• the SystemProxy is performed.
• In Windows only, an attempt is made to retrieve these properties from the
• Internet Options in the registry.
To connect to an HTTP proxy, see
Proxy Server. For other proxies, such as SOCKS or tunneling, see
Firewall Type.
Proxy Exceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
Data Type
string
Default Value
""
Remarks
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the adapter uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
Proxy Password
A password to be used to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
""
Remarks
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see
Firewall Type.
By default, the adapter uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
Proxy Port
The TCP port the ProxyServer proxy is running on.
Data Type
string
Default Value
"80"
Remarks
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in
ProxyServer. For other proxy types, see
Firewall Type.
Proxy Server
The hostname or IP address of a proxy to route HTTP traffic through.
Data Type
string
Default Value
""
Remarks
The hostname or IP address of a proxy to route HTTP traffic through. The adapter can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see
Firewall Type.
By default, the adapter uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
Proxy SSL Type
The SSL type to use when connecting to the ProxyServer proxy.
Data Type
string
Default Value
"AUTO"
Remarks
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the adapter will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Proxy User
A user name to be used to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
""
Remarks
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain
domain\user
Readonly
You can use this property to enforce read-only access to Splunk from the provider.
Data Type
bool
Default Value
false
Remarks
If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
Row Scan Depth
Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Data Type
string
Default Value
"50"
Remarks
Determines the number of rows used to determine the column data types.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
SSL Server Cert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type
string
Default Value
"60"
Remarks
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the adapter throws an exception.
Type Detection Scheme
Determines how to determine the data type of columns.
Data Type
string
Default Value
"RowScan"
Remarks
None | Setting TypeDetectionScheme to None will return all columns as the string type. |
RowScan | Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned. |
URL
The URL to your Splunk endpoint.
Data Type
string
Default Value
""
Remarks
The URL to your Splunk endpoint; for example, https://yoursitename.splunk.com:8089.
Use Client Side Paging
Whether or not the CData ADO.NET Provider for Splunk should use client side paging. This setting is only applied when UseJobs=true.
Data Type
bool
Default Value
true
Remarks
Setting this value to false will cause only a single thread to be used to execute this operation instead of attempting to use multiple threads to improve performance.
Use Jobs
Specifies whether to use the jobs endpoint instead of the export endpoint. If set to true, the maximum number of returned rows is configured Splunk's limit.conf file.
Data Type
bool
Default Value
false
Remarks
Whether to use the jobs endpoint instead of the export endpoint.
User
The name of a user.
Data Type
string
Default Value
""
Remarks
Together with Password, this field is used to authenticate against the Splunk server.