Debian Codegraph @

README

raw
1 DBD::ODBC -- DBD module interfacing the ODBC databases.
2
3 $Id$
4
5 DBD::ODBC is Copyright (C) 1994,1995,1996,1997,1998 Tim Bunce
6 portions Copyright (C) 1997,1998,1999,2000,2001,2002 Jeff Urlwin
7 portions Copyright (C) 1997 Thomas K. Wenrich
8 portions Copyright (C) 2007,2008,2009,2010,2012 Martin J. Evans
9
10 LICENSE INFORMATION:
11
12 This module is free software; you can redistribute it and/or modify
13 it under the same terms as Perl 5.10.0. For more details, see the
14 full text of the licenses at
15 <http://www.perlfoundation.org/artistic_license_1_0>, and
16 <http://www.gnu.org/licenses/gpl-2.0.html>.
17
18 Files with different licenses or copyright holders:
19
20 ConvertUTF.c:
21 Copyright (C) 2001-2004, Unicode, Inc.
22 see ConvertUTF8.c for the license.
23
24 This program is distributed in the hope that it will be useful, but
25 it is provided “as is” and without any express or implied
26 warranties.
27
28 PLEASE READ THE ENTIRE README FILE CAREFULLY
29
30 *BEFORE* BUILDING, TESTING AND INSTALLING this you will need to:
31
32 Build, test and install Perl 5 (as per DBI specifications/compatibility)
33 It is very important to TEST it and INSTALL it.
34
35 Build, test and install the DBI module (at least DBI 1.609).
36 It is very important to TEST it and INSTALL it.
37
38 Remember to *read* the DBD::ODBC.pm POD documentation and the
39 DBD::ODBC::Changes.pm POD documentation.
40
41 BUILDING:
42
43 set-up these environment variables:
44 DBI_DSN The dbi data source, e.g. 'dbi:ODBC:YOUR_DSN_HERE'
45 DBI_USER The username to use to connect to the database
46 DBI_PASS The username to use to connect to the database
47 ODBCHOME (Unix only) The dir your driver manager is installed in
48 or specify this via -o argument to Makefile.PL
49
50 If you want UNICODE support on non-Windows platforms specify -u
51 switch to Makefile.PL. If you don't want UNICODE support on Windows
52 specify the -nou switch to Makefile.PL. On non-Windows platforms all
53 UNICODE features will work correctly with the unixODBC driver
54 manager.
55
56 If the Makefile.PL finds iODBC and you would prefer to build with
57 unixODBC you can use the -x switch to favor unixODBC. This only
58 happens in rare case where you have binary packages of both
59 installed but you can only have development packages on one
60 installed and DBD::ODBC locates iODBC first. This quite often
61 happens on Ubuntu and other Debian based Linux systems where an
62 incomplete iODBC is often installed.
63
64 perl Makefile.PL
65 make (or nmake/dmake, if VC++ on Win32)
66 make test (or nmake/dmake, if VC++ on Win32)
67
68 TESTING
69
70 make test
71 make test TEST_VERBOSE=1 (if any of the t/* tests fail)
72 make install (if the tests look okay)
73
74 Note that the tests currently all pass when using the Microsoft SQL
75 server driver up to SQL Server 2008 and many other ODBC drivers on
76 Windows and UNIX (too numerous to mention here).
77
78 To run an individual test use:
79
80 prove -vb t/test.t
81
82 If the tests from t/09bind.t fail, that is an indication of lack of
83 ODBC Level 2 functionality. This does not (necessarily) mean that
84 your installation is broken. It does indicate that your ODBC driver
85 does not support certain level 2 calls (see below). All other tests
86 should pass, however, since I've tested with a limited number of
87 ODBC drivers, I could have something wrong in the test. Please
88 notify me if you have an incompatibility in the other tests. (For
89 example, some Paradox ODBC drivers *could* fail, if they don't
90 support long file names, since in Paradox file names are
91 tableName.db.). Please let me know about any incompatibilities you
92 encounter. I will say, though, that I may not be able to reproduce
93 or fix problems without some help, since I can't possibly install
94 all the known ODBC drivers. Please try to "solve" the problem, in
95 addition to discovering it.
96
97 If any of the tests fail and you are using SQL Server and Windows drivers,
98 ensure you updated to MDAC 2.7 or later.
99
100 NOTES on ODBC Drivers and Compatibility with DBD-ODBC
101
102 This version utilizes at least one "Level 2" ODBC call
103 (SQLDescribeParam). This *will* affect compatibility with specific
104 ODBC drivers. If the driver is not level 2 (or does not support the
105 level 2 function(s) required), then full compatibility will not be
106 available. The best thing to do is build DBD::ODBC against an ODBC
107 driver manager like unixODBC (http://www.unixodbc.org) as it will
108 resolve many incompatibilities between ODBC versions for you.
109
110 IF YOU HAVE PROBLEMS:
111
112 Do not hand edit the generated Makefile unless you are completely sure
113 you understand the implications! Always try to make changes via the
114 Makefile.PL command line and/or editing the Makefile.PL.
115
116 You should not need to make any changes. If you do *please* let me
117 know so that I can try to make it automatic in a later release.
118
119 This software is supported via the dbi-users mailing list. For more
120 information and to keep informed about progress you can join the
121 mailing list via http://dbi.perl.org (if you are unable to use the web
122 you can subscribe by sending a message to
123 [email protected].
124
125 Please post details of any problems (or changes you needed to make) to
126 [email protected]. But note...
127
128 ** IT IS IMPORTANT TO INCLUDE THE FOLLOWING INFORMATION:
129
130 1. A complete log of a all steps of the build, e.g.:
131
132 perl Makefile.PL (do a make realclean first)
133 make
134 make test
135 make test TEST_VERBOSE=1 (if any tests fail)
136
137 2. Full details of which software you are using, including:
138
139 Perl version (the output of perl -V)
140 ODBC Driver and version
141 ODBC Driver manager used and version
142
143 It is important to check that you are using the latest version before
144 posting. If you're not then I'm *very* likely to simply say "upgrade to
145 the latest". You would do yourself a favour by upgrading beforehand.
146
147 Please remember that I'm _very_ busy. Try to help yourself first,
148 then try to help me help you by following these guidelines carefully.
149
150 Regards,
151 Tim, Jeff and Martin.
152
153 ===============================================================================
154 Other info:
155
156 DBI 'home page': http://dbi.perl.org
157
158 perldoc DBI
159 perldoc DBD::ODBC (which will include the DBD::ODBC FAQ list)
160 perldoc DBD::ODBC::Changes
161 perldoc DBD::ODBC::FAQ
162
163 Win32 ODBC drivers:
164 http://www.microsoft.com/support/products/backoffice/odbc/
165 Follow "Microsoft ODBC Desktop Database Drivers 3.5 For 32-Bit Programs"
166 and "ODBC Drivers for Win95 Applications".
167 For Access use version "Access ODBC driver 3.40.2111 27/03/96" or later.
168
169 Also, see the examples in the tests and the mytest directory. They *do* show
170 some of the things you can do with the special DBD::ODBC functions.
171
172 End.