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

NAME

6       /etc/odbc.ini,  $HOME/.odbc.ini  -  unixODBC  data source configuration
7       files
8
9

DESCRIPTION

11       /etc/odbc.ini is a system-wide configuration file for ODBC Data  Source
12       Names (DSNs).
13
14       $HOME/.odbc.ini  is  a  user-specific  configuration file for ODBC Data
15       Source Names (DSNs).
16
17       Paths to both configuration files can be overridden by  unixODBC  build
18       options.  Call  odbcinst -j to determine the default configuration file
19       paths on your system.
20
21

NOTES

23   Templates
24       Many ODBC drivers come with .ini file templates. Using odbcinst to  in‐
25       stall these templates is recommended.
26
27
28   FILE FORMAT
29       odbc.ini  follows the pesudo-standard ini file syntax convention of one
30       or more [section headings], each followed by zero or more key  =  value
31       attributes.
32
33
34       [ODBC Data Sources] section
35
36           This  mandatory section lists each data source name (DSN) as a key.
37           The associated values serve as comments. Each entry must be matched
38           by an ini file [section] describing the data source.
39
40
41       Data Source Name [section]
42
43           Each  data source is identified by a [section header], which is the
44           DSN name used by applications. Each DSN definition section may con‐
45           tain values for the keys:
46
47
48           • Driver (REQUIRED)
49                   The  name  of  the ODBC driver to use for the DSN. The name
50                   must exactly match the [section name] of the driver defini‐
51                   tion stored in odbcinst.ini (and listed by odbcinst -q -d).
52
53
54           • Description
55                   Human-readable data source description.
56
57
58           • Database
59                   Database name or identifier. The meaning is driver-specific
60                   and can specify a file path, Unix socket path,  an  identi‐
61                   fier relative to a server name, etc.
62
63
64           • Servername
65                   Server  name.  The meaning is driver-specific but generally
66                   specifies a DNS name, IP network address or driver-specific
67                   discovery identifier.
68
69       For  a  full  list of supported parameters, refer to the HTML-formatted
70       "Administrator Manual" shipped with  unixODBC,  the  documentation  for
71       your ODBC driver and any data-source templates supplied by your driver.
72
73

EXAMPLES

75       An  example  odbc.ini configuration file is shown in the "Administrator
76       Manual" shipped with unixODBC.
77
78

SEE ALSO

80       unixODBC(7), odbcinst(1), isql(1), iusql(1), odbcinst.ini(5)
81
82       "The unixODBC Administrator Manual (HTML)"
83
84

AUTHORS

86       The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and
87       Nick Gorham <nick@lurcher.org>.
88
89       For a full list of contributors, refer to the AUTHORS file.
90
91

93       unixODBC  is  licensed under the GNU Lesser General Public License. For
94       details about the license, see the COPYING file.
95
96
97
98version 2.3.11                  Sun 10 Jan 2021                    odbc.ini(5)
Impressum