| 1 |
|
| 2 |
libdbi - Database Independent Abstraction Layer for C |
| 3 |
Copyright (C) 2001-2013, David Parker, Mark Tobenkin, Markus Hoenicka. |
| 4 |
http://libdbi.sourceforge.net |
| 5 |
|
| 6 |
|
| 7 |
INTRODUCTION: |
| 8 |
------------- |
| 9 |
|
| 10 |
libdbi implements a database-independent abstraction layer in C, similar to the |
| 11 |
DBI/DBD layer in Perl. Writing one generic set of code, programmers can |
| 12 |
leverage the power of multiple databases and multiple simultaneous database |
| 13 |
connections by using this framework. |
| 14 |
|
| 15 |
The plugin architecture allows for new database drivers to be easily added by a |
| 16 |
third party with flexbile licensing. See the libdbi-drivers project |
| 17 |
(http://libdbi-drivers.sourceforge.net) for the drivers officially |
| 18 |
supported by libdbi. |
| 19 |
|
| 20 |
*** The libdbi sources do not contain any drivers *** |
| 21 |
|
| 22 |
The framework and the drivers have to use the same internal API |
| 23 |
version. Starting from libdbi version 0.8.0, the major version number |
| 24 |
(in this case 0.8) denotes the API version. Any libdbi release 0.8.x |
| 25 |
will work with any libdbi-drivers release 0.8.x. 'x' will be |
| 26 |
incremented independently and denotes bugfix or upgrade releases that |
| 27 |
do not change the internal API. |
| 28 |
|
| 29 |
|
| 30 |
INSTALLATION: |
| 31 |
------------- |
| 32 |
|
| 33 |
Perform the regular ./configure, make, make install. See INSTALL for the |
| 34 |
generic details of each step. See ./configure --help for more libdbi |
| 35 |
configuration options. |
| 36 |
|
| 37 |
If you are building libdbi on Win32, see README.win32. |
| 38 |
If you are building libdbi on OSX, see README.osx. |
| 39 |
|
| 40 |
|
| 41 |
FEATURES: |
| 42 |
--------- |
| 43 |
|
| 44 |
* Database-level abstraction: |
| 45 |
Your programs don't need to deal with the arbitrary interfaces and oddities |
| 46 |
of each database library. libdbi handles all the details for you, you just |
| 47 |
tell it what you want the database to do. |
| 48 |
|
| 49 |
* Modularity: |
| 50 |
Since database code written with libdbi is not tied to one specific database |
| 51 |
server, you can effortlessly switch databases or give your users the option |
| 52 |
to specify their own database settings. |
| 53 |
|
| 54 |
* Clean interface: |
| 55 |
With ample documentation describing libdbi and its well thought out |
| 56 |
object-oriented design, programming with libdbi should be less painful than |
| 57 |
programming with native database libraries. And you only need to learn it |
| 58 |
once instead of learning each database library's syntax. |
| 59 |
|
| 60 |
* Accommodates coder apathy: |
| 61 |
libdbi is written to do The Right Thing(tm), not just some quick hack that |
| 62 |
does the job in a half-assed fashion. This saves tons of your $100/hour time |
| 63 |
from debugging, so that you can mess around having fun during the hours that |
| 64 |
clients are paying you to debug. It also strives to reduce the worldwide |
| 65 |
crisis of carpal tunnel syndrome, so it uses constructs such as this one to |
| 66 |
pack multiple function calls into one line, saving you the bother of typing |
| 67 |
more than you have to: |
| 68 |
dbi_result_get_fields(result, "id.%i firstname.%s lastname.%s fractional_value.%f", &id, &firstname, &lastname, &floatval); |
| 69 |
|
| 70 |
* Plugin interface: |
| 71 |
The dynamic linking used by libdbi allows for driver authors to license |
| 72 |
their drivers however they please - they are not restricted to the GPL or |
| 73 |
LGPL. Drivers are easy to write, and require no special installation. |
| 74 |
|
| 75 |
* Error handling: |
| 76 |
Instead of checking every single database call for errors, libdbi gives |
| 77 |
programmers the option of registering an error handler callback, similar to |
| 78 |
a signal handler. Because we know you'll "forget" to check for errors |
| 79 |
otherwise :) |
| 80 |
|
| 81 |
* Convenience: |
| 82 |
Spend your time writing clever code, not reinventing the wheel with your own |
| 83 |
single-use, #define-abusing, less featureful database interface. |
| 84 |
|
| 85 |
|
| 86 |
SUPPORTED PLATFORMS: |
| 87 |
-------------------- |
| 88 |
|
| 89 |
libdbi has been written with cross-platform availability in mind. To date, it |
| 90 |
has been successfully tested with: |
| 91 |
|
| 92 |
Linux: Debian, RedHat/Fedora Core, Slackware, Gentoo |
| 93 |
Windows: 98, NT4, 2000, XP |
| 94 |
FreeBSD: 4.3 through 9.0 |
| 95 |
SunOS: 2.8 |
| 96 |
Solaris: 7, 10 |
| 97 |
AIX: 4.2, 4.3 and 5.1 |
| 98 |
OS X: 10.2-10.4.9 |
| 99 |
|
| 100 |
If you are using libdbi on a platform not listed here, please notify the |
| 101 |
mailing list! (see below) |
| 102 |
|
| 103 |
|
| 104 |
MODIFICATIONS AND REDISTRIBUTION (LGPL): |
| 105 |
---------------------------------------- |
| 106 |
|
| 107 |
This library is free software; you can redistribute it and/or modify it under |
| 108 |
the terms of the GNU Lesser General Public License as published by the Free |
| 109 |
Software Foundation; either version 2 of the License, or (at your option) any |
| 110 |
later version. |
| 111 |
|
| 112 |
This library is distributed in the hope that it will be useful, but WITHOUT ANY |
| 113 |
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 114 |
PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
| 115 |
details. |
| 116 |
|
| 117 |
See the file COPYING or http://www.gnu.org for more details. |
| 118 |
|
| 119 |
|
| 120 |
DOCUMENTATION: |
| 121 |
-------------- |
| 122 |
|
| 123 |
If you want to write programs that use libdbi to access database |
| 124 |
engines, please see the Libdbi Programmer's Guide in the doc/ |
| 125 |
directory. It is provided in PDF and HTML formats. This API reference |
| 126 |
also includes example source code and a quickstart guide to using |
| 127 |
libdbi. |
| 128 |
|
| 129 |
If you want to write a driver for a database engine not yet supported |
| 130 |
by libdbi, please see the Driver's Guide in the doc/ directory. |
| 131 |
|
| 132 |
|
| 133 |
MAILING LISTS: |
| 134 |
-------------- |
| 135 |
|
| 136 |
http://libdbi.sourceforge.net/maillists.php |
| 137 |
|
| 138 |
* libdbi-users: [email protected] |
| 139 |
Go here if you have any general questions, ideas, or problems with using |
| 140 |
libdbi in your program. |
| 141 |
|
| 142 |
* libdbi-devel: [email protected] |
| 143 |
Discussion about development of the core library and DBD interface. |
| 144 |
|
| 145 |
* libdbi-cvs: [email protected] |
| 146 |
Automated CVS diffs and log entries are sent to this address. Subscribe |
| 147 |
here if you want to track libdbi's progress at the source-code level. |
| 148 |
|
| 149 |
|
| 150 |
CONTACT INFO: |
| 151 |
------------- |
| 152 |
|
| 153 |
http://libdbi.sourceforge.net |
| 154 |
Markus Hoenicka <[email protected]> |
| 155 |
David A. Parker <[email protected]> |
| 156 |
Mark M. Tobenkin <[email protected]> |
| 157 |
|
| 158 |
$Id: README,v 1.17 2013/02/03 22:38:31 mhoenicka Exp $ |
| 159 |
|