MySQL Example

The most common database used with PHP is MySQL, so I guess you should be familiar with the following code. It connects to a MySQL server at localhost, database mydb, and executes an SQL select statement. The results are printed, one line per row.

$db = mysql_connect("localhost", "root", "password");
    mysql_select_db("mydb",$db);
    $result = mysql_query("SELECT * FROM employees",$db);
    if ($result === false) die("failed"); 
    while ($fields = mysql_fetch_row($result)) {
    for ($i=0, $max=sizeof($fields); $i < $max; $i++) {
    print $fields[$i].' ';
    }
    print "
\\n";
    } 
    

The above code has been color-coded by section. The first section is the connection phase. The second is the execution of the SQL, and the last section is displaying the fields. The while loop scans the rows of the result, while the for loop scans the fields in one row.
Here is the equivalent code in ADODB

 include("adodb.inc.php");
    ADOLoadCode('mysql');
    $db = NewADOConnection();
    $db->Connect("localhost", "root", "password", "mydb");
    $result = $db->Execute("SELECT * FROM employees");
    if ($result === false) die("failed"); 
    while (!$result->EOF) {
    for ($i=0, $max=$result->FieldCount(); $i < $max; $i++)
    print $result->fields[$i].' ';
    $result->MoveNext();
    print "
\\n";
    } 

Now porting to Oracle is as simple as changing the second line toADOLoadCode('oracle'). Let's walk through the code...

Connecting to the Database

include("adodb.inc.php");
    ADOLoadCode('mysql');
    $db = NewADOConnection();
    $db->Connect("localhost", "root", "password", "mydb");

The connection code is a bit more sophisticated than MySQL's because our needs are more sophisticated. In ADODB, we use an object-oriented approach to managing the complexity of handling multiple databases. We have different classes to handle different databases. If you aren't familiar with object-oriented programing, don't worry -- the complexity is all hidden away in the NewADOConnection() function.
To conserve memory, we only load the PHP code specific to the database you are connecting to. We do this by calling ADOLoadCode(databasedriver). Legal database drivers include mysql, mssql, oracle, oci8, postgres, sybase, vfp, access, ibase and many others.
Then we create a new instance of the connection class by calling NewADOConnection(). Finally we connect to the database using $db->Connect().

Executing the SQL

$result = $db->Execute("SELECT * FROM employees");
if ($result === false) die("failed");
Sending the SQL statement to the server is straight forward. Execute() will return a recordset object on successful execution. You should check $result as we do above.
An issue that confuses beginners is the fact that we have two types of objects in ADODB, the connection object and the recordset object. When do we use each?
The connection object ($db) is responsible for connecting to the database, formatting your SQL and querying the database server. The recordset object ($result) is responsible for retrieving the results and formatting the reply as text or as an array.
The only thing I need to add is that ADODB provides several helper functions for making INSERT and UPDATE statements easier, which we will cover in the Advanced section.

Retrieving the Data

while (!$result->EOF) {
    for ($i=0, $max=$result->FieldCount(); $i < $max; $i++)
    print $result->fields[$i].' ';
    $result->MoveNext();
    print "
\\n";
    }

The paradigm for getting the data is that it's like reading a file. For every line, we check first whether we have reached the end-of-file (EOF). While not end-of-file, loop through each field in the row. Then move to the next line (MoveNext) and repeat.
The $result->fields[] array is generated by the PHP database extension. Some database extensions do not index the array by field name (unlike MySQL). To guarantee portability, use $result->Fields($fieldname). Note that this is a function, not an array.

Other Useful Functions

$recordset->Move($pos) scrolls to that particular row. ADODB supports forward scrolling for all databases. Some databases will not support backwards scrolling. This is normally not a problem as you can always cache records to simulate backwards scrolling.
$recordset->RecordCount() returns the number of records accessed by the SQL statement. Some databases will return -1 because it is not supported.
$recordset->GetArray() returns the result as an array.
rs2html($recordset) is a function that is generates a HTML table based on the $recordset passed to it. An example with the relevant lines in bold:

include('adodb.inc.php'); 
    include('tohtml.inc.php'); /* includes the rs2html function */
    ADOLoadCode('mysql'); 
    $conn = &ADONewConnection(); 
    $conn->PConnect('localhost','userid','password','database');
    $rs = $conn->Execute('select * from table');
     rs2html($rs); /* recordset to html table */ 

There are many other helper functions that are listed in the documentation available at http://php.weblogs.com/adodb_manual.

Advanced Material

Inserts and Updates

Let's say you want to insert the following data into a database.
ID = 3
TheDate=mktime(0,0,0,8,31,2001) /* 31st August 2001 */
Note= sugar why don't we call it off
When you move to another database, your insert might no longer work.
The first problem is that each database has a different default date format. MySQL expects YYYY-MM-DD format, while other databases have different defaults. ADODB has a function called DBDate() that addresses this issue by converting converting the date to the correct format.
The next problem is that the don't in the Note needs to be quoted. In MySQL, we use don\\'t but in some other databases (Sybase, Access, Microsoft SQL Server) we use don''t. The qstr() function addresses this issue.
So how do we use the functions? Like this:

$sql = "INSERT INTO table (id, thedate,note) values (" 
    . $ID . ','
    . $db->DBDate($TheDate) .','
    . $db->qstr($Note).")";
    $db->Execute($sql);

ADODB also supports $connection->Affected_Rows() (returns the number of rows affected by last update or delete) and $recordset->Insert_ID() (returns last autoincrement number generated by an insert statement). Be forewarned that not all databases support the two functions.

MetaTypes

You can find out more information about each of the fields (I use the words fields and columns interchangebly) you are selecting by calling the recordset methodFetchField($fieldoffset). This will return an object with 3 properties: name, type and max_length.

For example:

$recordset = $conn->Execute("select adate from table");
$f0 = $recordset->FetchField(0);
    

Then $f0->name will hold 'adata', $f0->type will be set to 'date'. If the max_length is unknown, it will be set to -1.

One problem with handling different databases is that each database often calls the same type by a different name. For example a timestamp type is called datetime in one database and time in another. So ADODB has a special MetaType($type, $max_length) function that standardises the types to the following:

C: character type
B: blob or long character type (eg. more than 255 bytes wide).
D: date
T: timestamp
L: logical (boolean)
N: numeric (float, double, integer)
In the above date example,
$recordset = $conn->Execute("select adate from table");
$f0 = $recordset->FetchField(0);
$type = $recordset->MetaType($f0->type, $f0->max_length);
print $type; /* should print 'D' */