Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
|
Property |
Description |
|
AlternateSecurityCredentials |
Uses the URL to set an alternate security credentials value for client authorization when using TDV with a client restricted license. |
|
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. |
|
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. |
AlternateSecurityCredentials
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.
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.
Possible Values
disabled, enabled
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.
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
Server session inactivity timeout, 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.