1odbcinst.ini(5)              unixODBC manual pages             odbcinst.ini(5)
2
3
4

NAME

6       /etc/odbcinst.ini - unixODBC driver configuration file
7
8

DESCRIPTION

10       /etc/odbcinst.ini is a configuration file for unixODBC drivers.
11
12       The file can be updated by using the  odbcinst utility (recommended) or
13       edited by hand.
14
15

FILE FORMAT

17       The general .ini file format is:
18
19              [SectionName1]
20              key1 = value1
21              key2 = value2
22              ...
23
24              [SectionName2]
25              key1 = value1
26              key2 = value2
27              ...
28
29       Each ODBC driver has its own section and can be referred to by the name
30       of  that  section  in  files  such  as  odbc.ini.  Within each section,
31       unixODBC also recognises the following configuration keys:
32
33
34       Description
35              A text string briefly describing the driver.
36
37
38       Driver A filesystem path to the actual driver library.
39
40
41       Setup  A filesystem path to the driver setup library.
42
43
44       FileUsage
45              The section named [ODBC] configures global options. Keys  recog‐
46              nised in the [ODBC] section include:
47
48
49              Trace  Enable  ODBC driver trace output, which is written to the
50                     file path specified by TraceFile.
51
52                     Some ODBC drivers have their own trace  control  options.
53                     Unlike  the Trace option, these separate options are usu‐
54                     ally specified at the Data Source Name (DSN) level.
55
56                     Trace will be enabled if the corresponding value contains
57                     any case variant of "1", "y", "yes" or "on".
58
59
60              TraceFile
61                     Specifies  the  system path or path-pattern to which ODBC
62                     driver trace output will be written. This option  has  no
63                     effect unless Trace is enabled. The default file location
64                     for trace output is /tmp/sql.log.
65
66                     WARNING: Setting TraceFile to a path writable by multiple
67                     users  might  not  work correctly, as only the first user
68                     will be able to create and open the file.
69
70

TEMPLATE FILES

72       Many ODBC drivers come with .ini file templates, which can be installed
73       by using the odbcinst utility.
74
75       Template files use the same format as odbcinst.ini.
76
77

EXAMPLES

79       To  install the unixODBC PostgreSQL driver, the following configuration
80       can be entered into odbcinst.ini:
81
82              [PostgreSQL]
83              Description = PostgreSQL driver for GNU/Linux
84              Driver      = /usr/lib/psqlodbcw.so
85              Setup       = /usr/lib/libodbcpsqlS.so
86              FileUsage   = 1
87
88       Driver paths can vary, depending on your operating system  and  whether
89       your  distribution  is  multi-arch  enabled.  Some drivers also require
90       Driver64 and Setup64 entries.
91
92       The above section can be referenced in odbc.ini as follows:
93
94              Driver = PostgreSQL
95
96       The recommended way of adding the PostgreSQL driver to your  system  is
97       by creating a template file containing:
98
99              [PostgreSQL]
100              Description = PostgreSQL driver for GNU/Linux
101              Driver      = /usr/lib/psqlodbcw.so
102              Setup       = /usr/lib/libodbcpsqlS.so
103
104       and calling odbcinst as follows:
105
106              # odbcinst -i -d -f template.ini
107
108

SEE ALSO

110       unixODBC(7), odbcinst(1), odbc.ini(5)
111
112       "The unixODBC Administrator Manual (HTML)"
113
114

AUTHORS

116       The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and
117       Nick Gorham <nick@lurcher.org>.
118
119       For a full list of contributors, refer to the AUTHORS file.
120
121

123       unixODBC is licensed under the GNU Lesser General Public  License.  For
124       details about the license, see the COPYING file.
125
126
127
128version 2.3.11                  Tue 12 Jan 2021                odbcinst.ini(5)
Impressum