ADOdb

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<WRAP right box>
Author Credit: John Lim
</WRAP>


====== Moving from MySQL to ADOdb ======

<WRAP indent>
//
You say eether and I say eyether, \\
You say neether and I say nyther; \\
Eether, eyether, neether, nyther - \\
Let's call the whole thing off ! \\
\\
You like potato and I like po-tah-to, \\
You like tomato and I like to-mah-to; \\
Potato, po-tah-to, tomato, to-mah-to - \\
Let's call the whole thing off !
//
</WRAP>

I love this song, especially the version with Louis Armstrong and Ella singing duet. It is all about how hard it is for two people in love to be compatible with each other. It's about compromise and finding a common ground, and that's what this article is all about.

PHP is all about creating dynamic web-sites with the least fuss and the most fun. To create these websites we need to use databases to retrieve login information, to splash dynamic news onto the web page and store forum postings. So let's say we were using the popular MySQL database for this. Your company has done such a fantastic job that the Web site is more popular than your wildest dreams. You find that MySQL cannot scale to handle the workload; time to switch databases.

Unfortunately in PHP every database is accessed slightly differently. To connect to MySQL, you would use ''mysqli_connect();'' when you decide to upgrade to Oracle or Microsoft SQL Server, you would use ''ocilogon()'' or ''mssql_connect()'' respectively. What is worse is that the parameters you use for the different connect functions are different also.. One database says po-tato, the other database says pota-to. Oh-oh.

===== Let's NOT call the whole thing off =====

A database wrapper library such as ADOdb comes in handy when you need to ensure portability. It provides you with a common API to communicate with any supported database so you don't have to call things off.

ADOdb stands for Active Data Objects DataBase (sorry computer guys are sometimes not very original). ADOdb currently supports MySQL, PostgreSQL, Oracle, Interbase, Microsoft SQL Server, Access, FoxPro, Sybase, ODBC and ADO. You can download ADOdb from http://sourceforge.net/projects/adodb/files/latest/download.

===== 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.

<code php>
// Section 1
$db = mysqli_connect("localhost", "root", "password");
mysqli_select_db("mydb",$db);

// Section 2
$result = mysqli_query("SELECT * FROM employees",$db);
if ($result === false) die("failed");

// Section 3
while ($fields = mysqli_fetch_row($result)) {
    for ($i=0, $max=sizeof($fields); $i < $max; $i++) {
        print $fields[$i].' ';
    }
    print "<br>\n";
}
</code>

The above code has been split in 3 sections:
  - The connection phase. 
  - The execution of the SQL, and 
  - 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

<code php>
// Section 1
include("adodb.inc.php");
$db = newADOConnection('mysqli');
$db->connect("localhost", "root", "password", "mydb");

// Section 2
$result = $db->execute("SELECT * FROM employees");
if ($result === false) die("failed");

// Section 3
while (!$result->EOF) {
    for ($i=0, $max=$result->fieldCount(); $i < $max; $i++) {
        print $result->fields[$i].' ';
    }
    $result->moveNext();
    print "<br>\n";
}
</code>
 
Now porting to Oracle is as simple as changing the second line to ''newADOConnection('oracle')''. Let's walk through the code...

==== Connecting to the Database ====

<code php>
include("adodb.inc.php");
$db = newADOConnection('mysql');
$db->connect("localhost", "root", "password", "mydb");
</code>

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 ''NewADOConnection(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 ====

<code php>
$result = $db->execute("SELECT * FROM employees");
if ($result === false) die("failed");
</code>
 
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 ====
<code php>
while (!$result->EOF)
{
    for ($i=0, $max=$result->fieldCount(); $i < $max; $i++)
        print $result->fields[$i].' ';
    $result->moveNext();
    print "<br>\n";
}
</code>

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. To force indexing by name - that is associative arrays - use the ''$ADODB_FETCH_MODE'' global variable.

<code php>
$ADODB_FETCH_MODE = ADODB_FETCH_NUM;
$rs1 = $db->execute('select * from table');
$ADODB_FETCH_MODE = ADODB_FETCH_ASSOC;
$rs2 = $db->execute('select * from table');
print_r($rs1->fields); // shows array([0]=>'v0',[1] =>'v1')
print_r($rs2->fields); // shows array(['col1']=>'v0',['col2'] =>'v1')
</code>

As you can see in the above example, both recordsets store and use different fetch modes based on the ''$ADODB_FETCH_MODE'' setting when the recordset was created by ''Execute()''.

===== ADOConnection =====

Object that performs the connection to the database, executes SQL statements and has a set of utility functions for standardising the format of SQL statements for issues such as concatenation and date formats.

===== 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 generates a HTML table based on the $recordset passed to it. An example with the relevant lines in bold:

<code php>
include('adodb.inc.php');
include('tohtml.inc.php'); /* includes the rs2html function */
$conn = newADOConnection('mysqli');
$conn->pConnect('localhost','userid','password','database');
$rs = $conn->execute('select * from table');
rs2html($rs); /* recordset to html table */ 
</code>


===== Advanced Material =====

==== Inserts and Updates ====

Let's say you want to insert the following data into a database.

<code>
ID = 3
TheDate=mktime(0,0,0,8,31,2001) /* 31st August 2001 */
Note= sugar why don't we call it off
</code>

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 [[v5:reference:connection:dbdate|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 [[v5:reference:connection:qStr()]] function addresses this issue.

So how do we use the functions? Like this:

<code php>
$sql = "INSERT INTO table (id, thedate,note) values ("
   . $ID . ','
   . $db->dbDate($TheDate) .','
   . $db->qStr($Note).")";
$db->execute($sql);

</code>

ADOdb also supports ''[[v5:reference:connection:affected_rows|$connection->affected_rows()]]'' (returns the number of rows affected by last update or delete) and ''[[v5:reference:connection:insert_id|$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 interchangeably) you are selecting by calling the recordset method ''FetchField($fieldoffset)''. This will return an object with 3 properties: //name//, //type// and //max_length//.

For example:
<code php>
$recordset = $conn->execute("select adate from table");
$f0 = $recordset->fetchField(0);
</code>

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:

^ MetaType ^ Description ^
| C | character and varchar types |
| X | text or long character (eg. more than 255 bytes wide). |
| B | blob or binary image |
| D | date |
| T | timestamp |
| L | logical (boolean) |
| I | integer |
| N | numeric (float, double, money) |

In the above date example,

<code php>
$recordset = $conn->execute("select adate from table");
$f0 = $recordset->fetchField(0);
$type = $recordset->metaType($f0->type, $f0->max_length);
print $type; /* should print 'D' */
</code>

==== Select Limit and Top Support ====

ADOdb has a function called ''[[v5:reference:connection:selectlimit|$connection->SelectLimit($sql,$nrows,$offset)]]'' that allows you to retrieve a subset of the recordset. This will take advantage of native ''SELECT TOP'' on Microsoft products and ''SELECT ... LIMIT'' with PostgreSQL and MySQL, and emulated if the database does not support it.

==== Caching Support ====

ADOdb allows you to cache recordsets in your file system, and only requery the database server after a certain timeout period with 

  * ''$connection->cacheExecute($secs2cache,$sql)''
  * ''$connection->cacheSelectLimit($secs2cache,$sql,$nrows,$offset)''.

==== Session Handler Support ====

ADOdb also supports session handlers. You can store your session variables in a database for true scalability using ADOdb. For further information, see the section on [[v5:session:session_index|Sessions]].

===== Commercial Use Encouraged =====

If you plan to write commercial PHP applications that you want to resell, you should consider ADOdb. It has been released using the lesser GPL, which means you can legally include it in commercial applications, while keeping your code proprietary. Commercial use of ADOdb is strongly encouraged! We are using it internally for this reason.

===== Conclusion =====

As a thank you for finishing this article, here are the complete lyrics for //let's call the whole thing off//.

<WRAP indent>
//
Refrain \\
You say eether and I say eyether, \\
You say neether and I say nyther; \\
Eether, eyether, neether, nyther - \\
Let's call the whole thing off ! \\
\\
You like potato and I like po-tah-to, \\
You like tomato and I like to-mah-to; \\
Potato, po-tah-to, tomato, to-mah-to - \\
Let's call the whole thing off ! \\
\\
But oh, if we call the whole thing off, then we must part. \\
And oh, if we ever part, then that might break my heart. \\
\\
So, if you like pajamas and I like pa-jah-mas, \\
I'll wear pajamas and give up pa-jah-mas. \\
For we know we \\
Need each other, so we \\
Better call the calling off off. \\
Let's call the whole thing off ! \\
\\
Second Refrain \\
\\
You say laughter and I say lawfter, \\
You say after and I say awfter; \\
Laughter, lawfter, after, awfter - \\
Let's call the whole thing off ! \\
\\
You like vanilla and I like vanella, \\
You, sa's'parilla and I sa's'parella; \\
Vanilla, vanella, choc'late, strawb'ry - \\
Let's call the whole thing off ! \\
\\
But oh, if we call the whole thing off, then we must part. \\
And oh, if we ever part, then that might break my heart. \\
\\
So, if you go for oysters and I go for ersters, \\
I'll order oysters and cancel the ersters. \\
For we know we \\
Need each other, so we \\
Better call the calling off off. \\
Let's call the whole thing off !
//
</WRAP>

Song and lyrics by George and Ira Gershwin, introduced by Fred Astaire and Ginger Rogers in the film "Shall We Dance?"

(c) 2001-2014 John Lim.