1odbcinst.ini(5) unixODBC manual pages odbcinst.ini(5)
2
3
4
6 /etc/odbcinst.ini - An unixODBC drivers configuration
7
8
10 /etc/odbcinst.ini is a text configuration file for unixODBC drivers. It
11 can be edited by hand, but the recommended way to update this file is
12 to use the odbcinst(1) utility.
13
14
16 The general .ini file format is:
17
18 [SectionName1]
19 key1 = value1
20 key2 = value2
21 ...
22
23 [SectionName2]
24 key1 = value1
25 key2 = value2
26 ...
27
28 Each ODBC driver has its own section and can be referred to by the name
29 of its section. Configuration keys recognised in driver sections by
30 unixODBC itself are:
31
32
33 Description
34 A text string briefly describing the driver.
35
36
37 Driver A filesystem path to the actual driver library.
38
39
40 Setup A filesystem path to the driver setup library.
41
42
43 FileUsage
44
45 The section named [ODBC] configures global options. Keys recogā
46 nised in the [ODBC] section include:
47
48
49 Trace
50
51 Enable ODBC driver trace output, which is written to the path
52 specified by TraceFile.
53
54 Note that some drivers have their own separate trace control
55 options. Unlike the Trace option these are usually specified at
56 the DSN level.
57
58 Values recognised as enabled are any case variation of "1", "y",
59 "yes" or "on".
60
61
62 TraceFile
63
64 Path or path-pattern to write the ODBC trace file to. Has no
65 effect unless Trace is enabled. Default /tmp/sql.log.
66
67 WARNING: setting TraceFile to a path writeable by multiple users
68 may not work correctly as only the first user will be able to
69 create and open the file.
70
71
72 TEMPLATE FILES
73 The recommended way to manage the drivers is using the odbcinst(1)
74 utility. You can install the drivers by supplying it with template
75 file, which has the same format as this file.
76
77
79 An example of the actual PostgreSQL driver:
80
81 [PostgreSQL]
82 Description = PostgreSQL driver for GNU/Linux
83 Driver = /usr/lib/psqlodbcw.so
84 Setup = /usr/lib/libodbcpsqlS.so
85 FileUsage = 1
86
87 Note that driver paths may vary, and some drivers require Driver64 and
88 Setup64 entries too.
89
90 By specifying the driver like that, you can then reference it in the
91 odbc.ini(5) as follows:
92
93 Driver = PostgreSQL
94
95 The recommended way to add that driver is by creating a template file
96 containing:
97
98 [PostgreSQL]
99 Description = PostgreSQL driver for GNU/Linux
100 Driver = /usr/lib/psqlodbcw.so
101 Setup = /usr/lib/libodbcpsqlS.so
102
103 and call the odbcinst(1):
104
105 # odbcinst -i -d -f template.ini
106
107
109 unixODBC(7), odbcinst(1), odbc.ini(5)
110
111 The unixODBC Administrator Manual (HTML)
112
113
115 The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and
116 Nick Gorham <nick@lurcher.org>. For the full list of contributors see
117 the AUTHORS file.
118
119
121 unixODBC is licensed under the GNU Lesser General Public License. For
122 details about the license, see the COPYING file.
123
124
125
126version 2.3.6 Thu 27 Jun 2013 odbcinst.ini(5)