odbcinst.ini(5) unixODBC manual pages odbcinst.ini(5)
NAME
/etc/odbcinst.ini - unixODBC driver configuration file
DESCRIPTION
/etc/odbcinst.ini is a configuration file for unixODBC drivers.
The file can be updated by using the odbcinst utility (recommended) or
edited by hand.
FILE FORMAT
The general .ini file format is:
[SectionName1]
key1 = value1
key2 = value2
...
[SectionName2]
key1 = value1
key2 = value2
...
Each ODBC driver has its own section and can be referred to by the name
of that section in files such as odbc.ini. Within each section, unixODBC
also recognises the following configuration keys:
Description
A text string briefly describing the driver.
Driver A filesystem path to the actual driver library.
Setup A filesystem path to the driver setup library.
FileUsage
The section named [ODBC] configures global options. Keys
recognised in the [ODBC] section include:
Trace Enable ODBC driver trace output, which is written to the
file path specified by TraceFile.
Some ODBC drivers have their own trace control options.
Unlike the Trace option, these separate options are usually
specified at the Data Source Name (DSN) level.
Trace will be enabled if the corresponding value contains
any case variant of "1", "y", "yes" or "on".
TraceFile
Specifies the system path or path-pattern to which ODBC
driver trace output will be written. This option has no
effect unless Trace is enabled. The default file location
for trace output is /tmp/sql.log.
WARNING: Setting TraceFile to a path writable by multiple
users might not work correctly, as only the first user will
be able to create and open the file.
TEMPLATE FILES
Many ODBC drivers come with .ini file templates, which can be installed
by using the odbcinst utility.
Template files use the same format as odbcinst.ini.
EXAMPLES
To install the unixODBC PostgreSQL driver, the following configuration
can be entered into odbcinst.ini:
[PostgreSQL]
Description = PostgreSQL driver for GNU/Linux
Driver = /usr/lib/psqlodbcw.so
Setup = /usr/lib/libodbcpsqlS.so
FileUsage = 1
Driver paths can vary, depending on your operating system and whether
your distribution is multi-arch enabled. Some drivers also require
Driver64 and Setup64 entries.
The above section can be referenced in odbc.ini as follows:
Driver = PostgreSQL
The recommended way of adding the PostgreSQL driver to your system is by
creating a template file containing:
[PostgreSQL]
Description = PostgreSQL driver for GNU/Linux
Driver = /usr/lib/psqlodbcw.so
Setup = /usr/lib/libodbcpsqlS.so
and calling odbcinst as follows:
# odbcinst -i -d -f template.ini
SEE ALSO
unixODBC(7), odbcinst(1), odbc.ini(5)
"The unixODBC Administrator Manual (HTML)"
AUTHORS
The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and
Nick Gorham <nick@lurcher.org>.
For a full list of contributors, refer to the AUTHORS file.
COPYRIGHT
unixODBC is licensed under the GNU Lesser General Public License. For
details about the license, see the COPYING file.
version 2.3.11 Tue 12 Jan 2021 odbcinst.ini(5)
unixODBC 2.3.11 - Generated Sat May 20 10:56:10 CDT 2023