MSQL driver specific resources
Resource names are case sensitive. If you use a spelling checker, ensure that the resource names are not changed.
| msql_array_fetch / MSQL_ARRAY_FETCH | |
|---|---|
| Driver resource | msql_array_fetch |
| Environment variable | MSQL_ARRAY_FETCH |
| Client/Server resource | Set for server only |
| Type | Boolean |
| Default | 1 (enabled) |
| Description | This environment variable is used to enable or disable the array fetch interface. The valid values are 0 and 1. When set to 0, the array fetch interface is disabled. When set to 1, it is enabled. For more information, see table_load_array_size and Array interface. |
| msql_array_insert / MSQL_ARRAY_INSERT | |
|---|---|
| Driver resource | msql_array_insert |
| Environment variable | MSQL_ARRAY_INSERT |
| Client/Server resource | Set for server only |
| Type | Boolean |
| Default | 1 (enabled) |
| Description | This environment variable is used to enable
or disable the array insert interface. The valid values are 0 and 1. When set
to 0, the array insert interface is disabled. When set to 1, it is enabled.
Note that this option can be disabled by the driver, even if this resource is
enabled. For example, no array insert is done in these situations:
For information, see Array interface. |
| msql_dsn / MSQL_DSN | |
|---|---|
| Driver resource | msql_dsn |
| Environment variable | MSQL_DSN |
| Client/Server resource | Set for server only |
| Type | String |
| Default | None |
| Description | Allows specification of a data source name
to be used by the driver for communication with SQL Server. This resource has
priority over
msql_obdc_driver resource.
|
| MSQL_DUMP_MESG | |
|---|---|
| Driver resource | — |
| Environment variable | MSQL_DUMP_MESG |
| Client/Server resource | Set for server only |
| Type | String |
| Default | Not set |
| Description | This environment variable allows to override the destination of messages. By default, messages such as fatal SQL statements are written to the Event Viewer. This variable overrides this behavior. The value must be an absolute path to the file name where error messages must be written. |
| msql_execution_plan_type / MSQL_EXECUTION_PLAN_TYPE | |
|---|---|
| Driver resource | msql_execution_plan_type |
| Environment variable | MSQL_EXECUTION_PLAN_TYPE |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 1 |
| Description | This value determines the type of plan information
retrieved. Possible values are:
Plans are written to the DBSLOG file when DBSLOG level was set to log plans See DBSLOG resource for more details. |
| msql_execution_plan_max_buffer_size / MSQL_EXECUTION_PLAN_MAX_BUFFER_SIZE | |
|---|---|
| Driver resource | msql_execution_plan_max_buffer_size |
| Environment variable | MSQL_EXECUTION_PLAN_MAX_BUFFER_SIZE |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 1048576 |
| Description | Defines the size in bytes for the buffer that is used for columns in the result set of the SQL server execution plan where of the width is not (yet) known. This variable is only meaningful when DBSLOG level is set to capture execution plans. If the size of the buffer is too small, then correct truncation happens on the involved column when printed in the DBSLOG file. Increase the value when correct truncation happens. This usually happens for complex select statements when retrieving XML based execution plans. |
| msql_join_hint / MSQL_JOIN_HINT | |
|---|---|
| Driver resource | msql_join_hint |
| Environment variable | MSQL_JOIN_HINT |
| Client/Server resource | Set for server only |
| Type | String |
| Default | NONE |
| Description | This variable allows the driver to send a
join hint to SQL Server, which enforces a join strategy between two tables.
Multiple join types in the same FROM clause of a query are not supported. Caution: In general, do not use join hints. Using this
setting without correct understanding can cause severe performance problems.
The possible values and their descriptions are shown in these rows:
|
| msql_lock_timeout / MSQL_LOCK_TIMEOUT | |
|---|---|
| Driver resource | msql_lock_timeout |
| Environment variable | MSQL_LOCK_TIMEOUT |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 10 |
| Description | Determines the time-out value, in seconds, for queries that are blocked by locks in the database server. The default is 10 which means “wait for 10 seconds for the lock to be released before giving up”. When set to -1, the driver waits indefinitely for the locks to be released and when set to 0, the driver does not wait. |
| msql_log_warnings / MSQL_LOG_WARNINGS | |
|---|---|
| Driver resource | msql_log_warnings |
| Environment variable | MSQL_LOG_WARNINGS |
| Client/Server resource | Set for server only |
| Type | Boolean |
| Default | 0 (disabled) |
| Description | This variable enables or disables the logging of warning messages. The warnings are logged to the %BSE%\LOG\msql.log.mesg or to the file specified by MSQL_DUMP_MESG environment variable. The valid values are 0 and 1. When 0 is set, logging is disabled and when 1 is set, logging is enabled. |
| msql_max_arrsz / MSQL_MAX_ARRSZ | |
|---|---|
| Driver resource | msql_max_arrsz |
| Environment variable | MSQL_MAX_ARRSZ |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 5 |
| Description | If msql_array_insert is enabled, this variable defines the maximum
number of rows that are inserted at once into the RDBMS. If msql_array_fetch is enabled, this variable defines
the maximum number of rows that are fetched at once from the RDBMS. For more
information about the array interface, see Array interface. |
| msql_network_packetsize / MSQL_NETWORK_PACKETSIZE | |
|---|---|
| Driver resource | msql_network_packetsize |
| Environment variable | MSQL_NETWORK_PACKETSIZE |
| Client/Server resource | Set for server only |
| Type | Unsigned integer |
| Default | 0 (using Microsoft SQL server’s default) |
| Description | Use this variable to configure the network packet size. Changing the network packet size can affect performance. For more information, check Microsoft SQL documentation about network packet size. |
| msql_no_index_hint / MSQL_NO_INDEX_HINT | |
|---|---|
| Driver resource | no_index_hint |
| Environment variable | MSQL_NO_INDEX_HINT |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 1 (as of portingset 9.1b) |
| Description | This variable is used to enable or disable index hints for some SQL statements. Changing the default value can affect performance. |
| msql_odbc_driver / MSQL_ODBC_DRIVER | |
|---|---|
| Driver resource | msql_odbc_driver |
| Environment variable | MSQL_ODBC_DRIVER |
| Client/Server resource | Set for server only |
| Type | String |
| Default | NONE (empty string) |
| Description | This variable shows which ODBC driver must be used. If this variable is not set, the driver checks which ODBC drivers are available on the local system. It is required to install the SQL Server Client software, to avoid errors. |
| msql_odbc_perf_stat / MSQL_ODBC_PERF_STAT | |
|---|---|
| Driver resource | msql_odbc_perf_stat |
| Environment variable | MSQL_ODBC_PERF_STAT |
| Client/Server resource | Set for server only |
| Type | Boolean |
| Default | 0 (disabled) |
| Description | This variable is used to enable or disable
ODBC’s performance data logging. The data includes these values:
The valid values are 0 and 1. Logging is disabled when set to 0. When set to 1, the performance data is logged to the odbcP<process id>.log file at %BSE%\LOG. |
| msql_opt_rows / MSQL_OPT_ROWS | |
|---|---|
| Driver resource | msql_opt_rows |
| Environment variable | MSQL_OPT_ROWS |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | The same value as the msql_max_arrsz default. |
| Description | With this option you can specify SQL Server
to retrieve the first n rows fast. This allows SQL Server to optimize the fetch
request. Based on this value, a suitable communication buffer size is
determined to improve performance. This variable can have a value of n, whose
possible values and their descriptions are given in these rows:
|
| msql_odbc_custom_parameters / MSQL_ODBC_CUSTOM_PARAMETERS | |
|---|---|
| Driver resource | msql_odbc_custom_parameters |
| Environment variable | MSQL_ODBC_CUSTOM_PARAMETERS |
| Client/Server resource | Set for server only |
| Type | String |
| Default | Not set |
| Description |
Note: This variable can be used to add connection string
keywords with Microsoft ODBC driver for SQL Server. Using this parameter is
at your own risk. A connection keyword can change the behavior of SQL server
database and result in errors. We do not provide support on issues caused by
the use of these parameters.
|
| MSQLPROF | |
|---|---|
| Driver resource | — |
| Environment variable | MSQLPROF |
| Client/Server resource | Set for server only |
| Type | Floating point |
| Default | Not set |
| Description | When a value is specified in this variable, any statement that takes more than the number of seconds that are specified is logged. The maximum precision that can be specified is 0.01 seconds. This variable is used to determine which table actions are the most time consuming. |
| msql_retained_cursors / MSQL_RETAINED_CURSORS | |
|---|---|
| Driver resource | msql_retained_cursors |
| Environment variable | MSQL_RETAINED_CURSORS |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | 20 |
| Description | This resource sets the number of inactive
(breaked) cursors that must be retained in the list for reuse. These cursors
can be reused and, therefore, save prepare/bind overhead. The cursors must also
have more resources such as memory than if they were closed and released.
See Cursor management . |
| msql_serverhost / MSQL_SERVERHOST | |
|---|---|
| Driver resource | msql_serverhost |
| Environment variable | MSQL_SERVERHOST |
| Client/Server resource | Set for server only |
| Type | String |
| Default | None |
| Description | Allows specification of a host name for the driver to locate the SQL Server instance to be used. |
| MSQLSTAT | |
|---|---|
| Driver resource | — |
| Environment variable | MSQLSTAT |
| Client/Server resource | Set for server only |
| Type | Integer |
| Default | Not set |
| Description | This variable allows database driver statistics to be reported. If it is set to a value n greater than 0, statistics are logged every n seconds when the driver is active. If it is set to 0, a statistics report is generated when the driver terminates. |