Environment Variables¶

Naming Convention¶

To set an mds_global.ini setting via an environment variable, prefix the setting name with btr2sql_:

btr2sql_<SETTING_NAME>

For example, the mds_global.ini setting TRACE_ON becomes the environment variable btr2sql_TRACE_ON.

How It Works¶

When the driver starts, it checks for environment variables in addition to the mds_global.ini file. Environment variables sit below the mds_global.ini in the precedence order — meaning an mds_global.ini setting will override an environment variable if both are present.

Enabling and Disabling on the Fly¶

Environment variables are especially handy for ad-hoc debugging. You can set them in your terminal session immediately before running your application, and they disappear when the session ends.

Windows Command Prompt (cmd)

set btr2sql_TRACE_ON=c:\trace\sql_btr.tra
set btr2sql_TRACE_LEVEL=-3
myapp.exe
rem Trace is active for this run only.
rem Close the terminal or unset the variables to stop tracing:
set btr2sql_TRACE_ON=
set btr2sql_TRACE_LEVEL=

Windows PowerShell

$env:btr2sql_TRACE_ON = "c:\trace\sql_btr.tra"
$env:btr2sql_TRACE_LEVEL = "-3"
.\myapp.exe
# Remove when done:
Remove-Item Env:btr2sql_TRACE_ON
Remove-Item Env:btr2sql_TRACE_LEVEL

Supported Environment Variables¶

Every mds_global.ini setting listed below can be used as an environment variable by adding the btr2sql_ prefix. Click any setting name for full documentation.

Trace Settings

Locking Settings

Performance Settings

Connection Settings

Data Handling Settings

Security and Control Settings

Language and Localization Settings

Version Settings

File and Path Settings

Cache Settings

Debug Settings