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 connecting, see Establishing a Connection.
Authentication
| Property | Description |
|---|---|
| Host | The name of the server running TDV Server. |
| Port | The port of the TDV server. |
| Domain | The TDV domain to which the DataSource belongs. |
| DataSource | The name of the TDV data source. |
| User | The username provided for authentication with TDV Server. |
| Password | The user's password. |
| Encrypt | Specifies whether to encrypt the connection using SSL. |
| SSO | The single-sign-on (SSO) type to use to authenticate. |
| UserTokens | Authentication values that can be packaged for delivery. |
Kerberos
| Property | Description |
|---|---|
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user with. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| UsePlatformKerberosAPI | This setting determines if the platform's Kerberos API is used. |
SSL
| Property | Description |
|---|---|
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertPassword | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertType | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Logging
| Property | Description |
|---|---|
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| Connection String Options | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
Schema
| Property | Description |
|---|---|
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Miscellaneous
| Property | Description |
|---|---|
| Alternate Security Credentials | Uses the URL to set an alternate security credentials value for client authorization when using TDV with a client restricted license. |
| BatchSize | The maximum size of each batch operation to submit. |
| CaseSensitive | Specifies case sensitivity in the request values. |
| Catalog | The name of the catalog to use. |
| CommitFailure | Specifies the behavior if a commit fails. |
| CommitInterrupt | Specifies the behavior if a commit is interrupted. |
| Compensate | The correcting behavior. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectTimeout | The time-out for initial connection, in seconds. |
| DefaultCatalog | The default catalog for a specified connection. |
| DefaultSchema | The default schema for a specified connection. |
| DelegateOauth2flowToServer | Specify whether to delegate the OAuth flow to the TDV server. |
| EnableFlood | Values are true or false. Default value is true. If true, the server will constantly send data, filling the network buffer.Useful for larger result sets. |
| EnableReconnectOnError | Attempt to reconnect to TDV if the connection was lost during the lifetime of the provider. |
| FetchBytes | The maximum number of rows to fetch for a batch based on batch size, in bytes. |
| FetchRows | Maximum number of rows to fetch for a batch. |
| IgnoreTrailingSpaces | Specifies whether to ignore trailing spaces at the end of values. |
| Locale | Value that defines the user's language and country. |
| 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. |
| NoMetadata | Blocks return of result-set metadata during query execution. |
| OptimizationPrepare | Specifies whether to optimize prepare requests sent to TDV. |
| Other | These hidden properties are used only in specific use cases. |
| ParamMode | Controls the behavior of OUT parameters for stored procedures. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| QueryPassthrough | This option passes the query to the TDV server as is. |
| Readonly | You can use this property to enforce read-only access to TDV from the provider. |
| RegisterOutputCursors | Specifies how to handle output cursors. |
| RequestTimeout | The time-out for query commands and other requests, in seconds. |
| SessionTimeout | Server session inactivity timeout, in seconds. |
| SessionToken | Uses the URL to set a session token value for client authorization when using TDV with a client restricted license. |
| StripDuplicates | Values are true or false. Default value is true. If true, the server will detect duplicate CHAR/VARCHAR columns in subsequent rows, and will not re-transmit the data across the wire. |
| StripTrailingZeros | Determines whether decimal result values are to be returned with trailing zeroes removed. |
| TraceFolder | The absolute directory to save the trace file. |
| TraceLevel | The level of information to log. |
| UseConnectionPooling | This property enables connection pooling. |
| ValidateRemoteCert | Values are true or false. Default value is false. If true, the client will validate the server's cert. |
| ValidateRemoteHostname | Values are true or false. Default value is false. If true, the client will validate the server's hostname. |
Other
| Property | Description |
|---|---|
| EnableFastExec | Specifies whether to enable fast execution of queries. |
Host
The name of the server running TDV Server.
Data Type
string
Default Value
""
Remarks
This property should be set to the name or network address of the computer running TDV Server.
Port
The port of the TDV server.
Data Type
int
Default Value
9401
Remarks
Set this to the base (plaintext) client port configured on the server.
When Encrypt is enabled, the provider will adjust the port accordingly.
Domain
The TDV domain to which the DataSource belongs.
Data Type
string
Default Value
""
Remarks
The TDV domain to which the DataSource belongs.
Typically the domain is 'composite' for installations with locally defined users.
DataSource
The name of the TDV data source.
Data Type
string
Default Value
""
Remarks
Data source refers to the TDV database name published in the Data Services node.
User
The username provided for authentication with TDV Server.
Data Type
string
Default Value
""
Remarks
The username provided for authentication with TDV Server.
Password
The user's password.
Data Type
string
Default Value
""
Remarks
The password provided for authentication with the TDV Server.
Encrypt
Specifies whether to encrypt the connection using SSL.
Data Type
bool
Default Value
false
Remarks
When set to true, automatically passes messages to the SSL port for processing with the TDV SSL Certificate.
SSO
The single-sign-on (SSO) type to use to authenticate.
Possible Values
Disable, Kerberos, NTLM
Data Type
string
Default Value
"Disable"
Remarks
The single-sign-on (SSO) type to use to authenticate. Valid values are: Disable, Kerberos, and NTLM.
Valid on Windows platform only.
Default is "Disable" which forces the client to provide a user and password to authenticate.
UserTokens
Authentication values that can be packaged for delivery.
Data Type
string
Default Value
""
Remarks
Authentication values that can be packaged for delivery.
The URL can pass the user_tokens property to the server at the init command, in the form: " user_tokens=(" NAME "=" VALUE ( "," NAME "=" VALUE )* " )"
KerberosKDC
The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
Data Type
string
Default Value
""
Remarks
The Kerberos properties are used when using Windows Authentication. The provider will request session tickets and temporary session keys from the Kerberos Key Distribution Center (KDC) service. The Kerberos Key Distribution Center (KDC) service is conventionally colocated with the domain controller. If Kerberos KDC is not specified the provider will attempt to detect these properties automatically from the following locations:
-
Java System Properties: Kerberos settings can be configured in Java using the config file krb5.conf, or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The provider will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
-
Domain Name and Host: The provider will infer the Kerberos Realm and Kerberos KDC from the configured domain name and host as a last resort.
Note: Windows authentication is supported in JRE 1.6 and above only.
KerberosRealm
The Kerberos Realm used to authenticate the user with.
Data Type
string
Default Value
""
Remarks
The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is based on the domain name. If Kerberos Realm is not specified the provider will attempt to detect these properties automatically from the following locations:
-
Java System Properties: Kerberos settings can be configured in Java using a config file (krb5.conf) or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The provider will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
-
Domain Name and Host: The provider will infer the Kerberos Realm and Kerberos KDC from the user-configured domain name and host as a last resort. This might work in some Windows environments.
Note: Kerberos-based authentication is supported in JRE 1.6 and above only.
KerberosSPN
The Service Principal Name for the Kerberos Domain Controller.
Data Type
string
Default Value
""
Remarks
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, set the Service Principal Name here.
UsePlatformKerberosAPI
This setting determines if the platform's Kerberos API is used.
Data Type
bool
Default Value
false
Remarks
This setting determines if the platform's Kerberos API is used. By default no platform APIs are relied on to perform Kerberos authentication. Use of the platform API may be enabled by setting this to True. The default value is False.
Note: This functionality is only available on Windows.
SSLClientCert
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
Data Type
string
Default Value
""
Remarks
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
The type of key store containing the TLS/SSL client certificate.
Possible Values
USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB
Data Type
string
Default Value
"USER"
Remarks
This property can take one of the following values:
| USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword
The password for the TLS/SSL client certificate.
Data Type
string
Default Value
""
Remarks
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSLClientCertSubject
The subject of the TLS/SSL client certificate.
Data Type
string
Default Value
"*"
Remarks
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
| Field | Meaning |
|---|---|
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
SSLServerCert
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.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Logfile
A path to the log file.
Data Type
string
Default Value
""
Remarks
Once this property is set, the provider will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property. Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Data Type
string
Default Value
"1"
Remarks
The verbosity level determines the amount of detail that the provider reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
LogModules
Core modules to be included in the log file.
Data Type
string
Default Value
""
Remarks
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
Data Type
string
Default Value
"100MB"
Remarks
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead. Adjust the maximum number of logfiles generated with MaxLogFileCount.
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.
Data Type
string
Default Value
""
Remarks
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. The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
"%APPDATA%\\TIBCO\\Composite Data Provider\\Schema"
Remarks
The path to a directory which contains the schema files for the provider (.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%\\TIBCO\\Composite Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
|---|---|
| Windows | The value of the APPDATA environment variable |
| Mac | ~/.config |
| Linux | ~/.config |
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the provider.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the provider.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Alternate Security Credentials
Uses the URL to set an alternate security credentials value for client authorization when using TDV with a client restricted license.
Data Type
string
Default Value
""
Remarks
Uses the URL to set an alternate security credentials value for client authorization when using TDV with a client restricted license.
BatchSize
The maximum size of each batch operation to submit.
Data Type
int
Default Value
0
Remarks
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
CaseSensitive
Specifies case sensitivity in the request values.
Data Type
bool
Default Value
false
Remarks
Specifies case sensitivity in the request values. By default (false), requests are not case-sensitive.
Catalog
The name of the catalog to use.
Data Type
string
Default Value
""
Remarks
This field allows you to limit the Catalog to the one explicitly specified. If not set, the provider will retrieve the available catalogs from the TDV server.
CommitFailure
Specifies the behavior if a commit fails.
Possible Values
none, rollback, bestEffort
Data Type
string
Default Value
"none"
Remarks
Specifies the behavior if a commit fails. Possible values are: rollback or bestEffort.
CommitInterrupt
Specifies the behavior if a commit is interrupted.
Possible Values
none, ignore, log, fail
Data Type
string
Default Value
"none"
Remarks
Specifies the behavior if a commit is interrupted. Possible values are: ignore, log, fail.
Compensate
The correcting behavior.
Data Type
string
Default Value
"disabled"
Remarks
The correcting behavior, possible values are: disabled or enabled.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Data Type
int
Default Value
"0"
Remarks
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
ConnectTimeout
The time-out for initial connection, in seconds.
Data Type
int
Default Value
30
Remarks
The time-out for initial connection, in seconds. Use 0 (zero) for infinite time-out.
DefaultCatalog
The default catalog for a specified connection.
Data Type
string
Default Value
""
Remarks
The default catalog for a specified connection.
DefaultSchema
The default schema for a specified connection.
Data Type
string
Default Value
""
Remarks
The default schema for a specified connection.
DelegateOauth2flowToServer
Specify whether to delegate the OAuth flow to the TDV server.
Data Type
bool
Default Value
false
Remarks
Specify whether to delegate the OAuth flow to the TDV server.
EnableFlood
Values are true or false. Default value is true. If true, the server will constantly send data, filling the network buffer.Useful for larger result sets.
Data Type
bool
Default Value
true
Remarks
Values are true or false. Default value is true. If true, the server will constantly send data, filling the network buffer.Useful for larger result sets.
EnableReconnectOnError
Attempt to reconnect to TDV if the connection was lost during the lifetime of the provider.
Data Type
bool
Default Value
false
Remarks
Attempt to reconnect to TDV if the connection was lost during the lifetime of the provider. This property can be useful to Enable for long-lived connections, in a case where the TCP connection to the server is lost, such as during a restart of the TDV Server, where errors such as 'Action impossible while not connected' or 'Connection to the server has been forcibly closed.' would otherwise be encountered.
FetchBytes
The maximum number of rows to fetch for a batch based on batch size, in bytes.
Data Type
int
Default Value
131072
Remarks
The maximum number of rows to fetch for a batch based on batch size, in bytes.
Setting FetchBytes to a very large number can cause an Out Of Memory error in the server. The value set for FetchBytes affects the memory used on the client and the TDV server, so the value should be set based on the heap size configured.
FetchRows
Maximum number of rows to fetch for a batch.
Data Type
int
Default Value
500
Remarks
Maximum number of rows to fetch for a batch. Set to 0 (zero) to return an unlimited number of rows.
IgnoreTrailingSpaces
Specifies whether to ignore trailing spaces at the end of values.
Data Type
bool
Default Value
false
Remarks
Specifies whether to ignore trailing spaces at the end of values.
Locale
Value that defines the user's language and country.
Data Type
string
Default Value
""
Remarks
Value that defines the user's language and country.
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.
Data Type
int
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.
NoMetadata
Blocks return of result-set metadata during query execution.
Data Type
bool
Default Value
false
Remarks
Blocks return of result-set metadata during query execution.
OptimizationPrepare
Specifies whether to optimize prepare requests sent to TDV.
Data Type
bool
Default Value
true
Remarks
When set to "True" (default), the provider will submit the query in a single request to TDV.
When set to "False", the provider will submit an initial prepare request to TDV.
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. |
ParamMode
Controls the behavior of OUT parameters for stored procedures.
Possible Values
normal, return, omit, omitCursors
Data Type
string
Default Value
"normal"
Remarks
Controls the behavior of OUT parameters for stored procedures.
Valid values are:
| normal | Report OUT parameters in procedure metadata as OUT parameters. |
| return | Report OUT parameters as return values. |
| omit | Omit OUT parameters from metadata. |
| omitCursors | Omit output cursors from metadata. |
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
Data Type
int
Default Value
60
Remarks
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
PoolMaxSize
The maximum connections in the pool.
Data Type
int
Default Value
100
Remarks
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
PoolMinSize
The minimum number of connections in the pool.
Data Type
int
Default Value
1
Remarks
The minimum number of connections in the pool. The default is 1.
PoolWaitTime
The max seconds to wait for an available connection.
Data Type
int
Default Value
60
Remarks
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
QueryPassthrough
This option passes the query to the TDV server as is.
Data Type
bool
Default Value
false
Remarks
When this is set, queries are passed through directly to TDV.
Readonly
You can use this property to enforce read-only access to TDV from the provider.
Data Type
bool
Default Value
false
Remarks
If this property is set to true, the provider will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
RegisterOutputCursors
Specifies how to handle output cursors.
Data Type
bool
Default Value
false
Remarks
Specifies how to handle output cursors.
Valid values are:
| true | Bind or register output cursors as output parameters. |
| false | Do not bind or register output cursors as output parameters; instead, use SQLMoreResults or Statement.getMoreResults() to access the cursors. |
RequestTimeout
The time-out for query commands and other requests, in seconds.
Data Type
int
Default Value
0
Remarks
The time-out for query commands and other requests, in seconds.
SessionTimeout
Session inactivity time-out, in seconds.
Data Type
int
Default Value
0
Remarks
Server session inactivity timeout, in seconds. Set to 0 (zero) for infinite time-out.
This value is submitted to the server when a session is initiated and the server controls the session timeout.
SessionToken
Uses the URL to set a session token value for client authorization when using TDV with a client restricted license.
Data Type
string
Default Value
""
Remarks
Uses the URL to set a session token value for client authorization when using TDV with a client restricted license.
StripDuplicates
Values are true or false. Default value is true. If true, the server will detect duplicate CHAR/VARCHAR columns in subsequent rows, and will not re-transmit the data across the wire.
Data Type
bool
Default Value
true
Remarks
Values are true or false. Default value is true. If true, the server will detect duplicate CHAR/VARCHAR columns in subsequent rows, and will not re-transmit the data across the wire.
The provider will submit this option to the server to identify how the response data will be returned by the server. When true, the server will strip duplicate values to decrease the size of the response data, thus increasing performance. This option does not affect result output.
StripTrailingZeros
Determines whether decimal result values are to be returned with trailing zeroes removed.
Data Type
bool
Default Value
false
Remarks
Determines whether decimal result values are to be returned with trailing zeroes removed.
TraceFolder
The absolute directory to save the trace file.
Data Type
string
Default Value
""
Remarks
The absolute directory to save the trace file.
TraceLevel
The level of information to log.
Possible Values
off, fatal, error, warn, info, debug, all
Data Type
string
Default Value
"error"
Remarks
The level of information to log. Valid values are: off, fatal, error (default), warn, info, debug, and all.
UseConnectionPooling
This property enables connection pooling.
Data Type
bool
Default Value
false
Remarks
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
ValidateRemoteCert
Values are true or false. Default value is false. If true, the client will validate the server's cert.
Data Type
bool
Default Value
false
Remarks
Values are true or false. Default value is false. If true, the client will validate the server's cert.
ValidateRemoteHostname
Values are true or false. Default value is false. If true, the client will validate the server's hostname.
Data Type
bool
Default Value
false
Remarks
Values are true or false. Default value is false. If true, the client will validate the server's hostname.
EnableFastExec
Specifies whether to enable fast execution of queries.
Data Type
bool
Default Value
false
Remarks
Values are true or false (default).
Results are processed and returned immediately (instead of round trip) when a query is submitted, potentially improving performance of low latency queries.