[!!!][TASK] Doctrine: Remove ext:dbal
[Packages/TYPO3.CMS.git] / typo3 / sysext / adodb / adodb / README.md
1 ADOdb Library for PHP5
2 ======================
3
4 [![Join chat on Gitter](https://img.shields.io/gitter/room/form-data/form-data.svg)](https://gitter.im/adodb/adodb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5
6 (c) 2000-2013 John Lim (jlim@natsoft.com)  
7 (c) 2014      Damien Regad, Mark Newnham and the ADOdb community
8
9 Released under both [BSD 3-Clause](https://github.com/ADOdb/ADOdb/blob/master/LICENSE.md#bsd-3-clause-license) 
10 and [GNU Lesser GPL library 2.1](https://github.com/ADOdb/ADOdb/blob/master/LICENSE.md#gnu-lesser-general-public-license) 
11 licenses.  
12 This means you can use it in proprietary products; 
13 see [License](https://github.com/ADOdb/ADOdb/blob/master/LICENSE.md) for details.
14
15 Home page: http://adodb.sourceforge.net/
16
17 > **WARNING: known issue with Associative Fetch Mode in ADOdb v5.19
18 -- PLEASE UPGRADE TO v5.20 !**  
19 > When fetching data in Associative mode (i.e. when `$ADODB_FETCH_MODE` is
20 > set to *ADODB_FETCH_ASSOC*), recordsets do not return any data (empty strings)
21 > when using some database drivers. The problem has been reported on MSSQL,
22 > Interbase and Foxpro, but possibly affects other drivers as well; all drivers
23 > derived from the above are also impacted.
24 > For further details, please refer to [Issue #20](https://github.com/ADOdb/ADOdb/issues/20).
25
26
27 Introduction
28 ============
29
30 PHP's database access functions are not standardized. This creates a
31 need for a database class library to hide the differences between the
32 different databases (encapsulate the differences) so we can easily
33 switch databases.
34
35 The library currently supports MySQL, Interbase, Sybase, PostgreSQL, Oracle,
36 Microsoft SQL server,  Foxpro ODBC, Access ODBC, Informix, DB2,
37 Sybase SQL Anywhere, generic ODBC and Microsoft's ADO.
38
39 We hope more people will contribute drivers to support other databases.
40
41
42 Installation
43 ============
44
45 Unpack all the files into a directory accessible by your web server.
46
47 To test, try modifying some of the tutorial examples.
48 Make sure you customize the connection settings correctly.
49
50 You can debug using:
51
52 ``` php
53 <?php
54 include('adodb/adodb.inc.php');
55
56 $db = ADONewConnection($driver); # eg. 'mysql' or 'oci8'
57 $db->debug = true;
58 $db->Connect($server, $user, $password, $database);
59 $rs = $db->Execute('select * from some_small_table');
60 print "<pre>";
61 print_r($rs->GetRows());
62 print "</pre>";
63 ```
64
65
66 Documentation and Examples
67 ==========================
68
69 Refer to the `docs` directory for library documentation and examples.
70
71 - Main documentation: `docs-adodb.htm`.
72   Query, update and insert records using a portable API.
73 - Data dictionary docs: `docs-datadict.htm`.
74   Describes how to create database tables and indexes in a portable manner.
75 - Database performance monitoring docs: `docs-perf.htm`.
76   Allows you to perform health checks, tune and monitor your database.
77 - Database-backed session docs: `docs-session.htm`.
78
79 There is also a tutorial `tute.htm` that contrasts ADOdb code with
80 mysql code.
81
82
83 Files
84 =====
85
86 - `adodb.inc.php` is the library's main file. You only need to include this file.
87 - `adodb-*.inc.php` are the database specific driver code.
88 - `adodb-session.php` is the PHP4 session handling code.
89 - `test.php` contains a list of test commands to exercise the class library.
90 - `testdatabases.inc.php` contains the list of databases to apply the tests on.
91 - `Benchmark.php` is a simple benchmark to test the throughput of a SELECT
92 statement for databases described in testdatabases.inc.php. The benchmark
93 tables are created in test.php.
94
95
96 Support
97 =======
98
99 To discuss with the ADOdb development team and users, connect to our
100 [Gitter chatroom](https://gitter.im/adodb/adodb) using your Github credentials.
101
102 Please report bugs, issues and feature requests on Github:
103
104 https://github.com/ADOdb/ADOdb/issues
105
106 You may also find legacy issues in
107
108 - the old [ADOdb forums](http://phplens.com/lens/lensforum/topics.php?id=4) on phplens.com
109 - the [SourceForge tickets section](http://sourceforge.net/p/adodb/_list/tickets)
110
111 However, please note that they are not actively monitored and should
112 only be used as reference.