ADODB Manual

## ADOdb Library for PHP

V2.30 1 Aug 2002 (c) 2000-2002 John Lim (jlim@natsoft.com.my)

This software is dual licensed using BSD-Style and LGPL. Where there is any discrepancy, the BSD-Style license will take precedence. This means you can use it in proprietary and commercial products.

Introduction
Unique Features
How People are using ADOdb
Feature Requests and Bug Reports
Installation
Initializing Code ADONewConnection NewADOConnection
Supported Databases
Tutorial
Example 1: Select
Example 2: Advanced Select
Example 3: Insert
Example 4: Debugging rs2html example
Example 5: MySQL and Menus
Example 6: Connecting to Multiple Databases at once
Example 7: Generating Update and Insert SQL
Example 8: Implementing Scrolling with Next and Previous
Example 9: Exporting in CSV or Tab-Delimited Format
Using Custom Error Handlers and PEAR_Error
Data Source Names
Caching
Pivot Tables

REFERENCE
ADOConnection
Connections: Connect PConnect
Executing SQL: Execute CacheExecute SelectLimit CacheSelectLimit Prepare PrepareSP Parameter
GetOne CacheGetOne GetRow CacheGetRow GetAll CacheGetAll GetCol CacheGetCol Replace
Generates SQL: GetUpdateSQL GetInsertSQL
Blobs: UpdateBlob UpdateClob UpdateBlobFile
Paging/Scrolling: PageExecute CachePageExecute
Cleanup: CacheFlush Close
Transactions: BeginTrans CommitTrans RollbackTrans
Fetching Data: $ADODB_FETCH_MODE
Strings: concat qstr quote
Dates: DBDate DBTimeStamp UnixDate UnixTimeStamp OffsetDate
Rows Management: Affected_Rows Insert_ID GenID
Error Handling: ErrorMsg ErrorNo
Data Dictionary (metadata): MetaDatabases MetaTables MetaColumns MetaColumnNames
Deprecated: Bind BlankRecordSet
ADORecordSet
Returns one row: FetchRow FetchInto FetchObject FetchNextObject
Returns all rows: GetArray GetRows GetAssoc
Scrolling: Move MoveNext MoveFirst MoveLast AbsolutePosition CurrentRow AtFirstPage AtLastPage AbsolutePage
Menu generation:GetMenu GetMenu2
Dates:UserDate UserTimeStamp UnixDate UnixTimeStamp
Recordset Info:RecordCount PO_RecordSet
Field Info: FieldCount FetchField MetaType
Cleanup: Close
Deprecated: GetRowAssoc Fields

rs2html example
Differences between ADOdb and ADO
Database Driver Guide
Change Log

## Introduction

PHP's database access functions are not standardised. This creates a need for a database class library to hide the differences between the different database API's (encapsulate the differences) so we can easily switch databases.

We currently support MySQL, Oracle, Microsoft SQL Server, Sybase, Sybase SQL Anywhere, Informix, PostgreSQL, FrontBase, Interbase (Firebird and Borland variants), Foxpro, Access, ADO and ODBC. We have had successful reports of connecting to Progress and DB2 via ODBC. We hope more people will contribute drivers to support other databases.

PHP4 supports session variables. You can store your session information using ADOdb for true portability and scalability. See adodb-session.php for more information.

Also read http://php.weblogs.com/portable_sql (also available as tips_portable_sql.htm in the release) for tips on writing portable SQL.

## Unique Features of ADOdb

- Easy for Windows programmers to adapt to because many of the conventions are similar to Microsoft's ADO.
- Unlike other PHP database classes which focus only on select statements, we provide support code to handle inserts and updates which can be adapted to multiple databases quickly. Methods are provided for date handling, string concatenation and string quoting characters for differing databases.
- A metatype system is built in so that we can figure out that types such as CHAR, TEXT and STRING are equivalent in different databases.
- Easy to port because all the database dependant code are stored in stub functions. You do not need to port the core logic of the classes.
- PHP4 session support. See adodb-session.php.

## How People are using ADOdb

Here are some examples of how people are using ADOdb (for a much longer list, visit http://php.weblogs.com/adodb-cool-applications):

- PhpLens is a commercial data grid component that allows both cool Web designers and serious unshaved programmers to develop and maintain databases on the Web easily. Developed by the author of ADOdb.

- PHAkt: PHP Extension for DreamWeaver Ultradev allows you to script PHP in the popular Web page editor. Database handling provided by ADOdb.

- Analysis Console for Intrusion Databases (ACID): PHP-based analysis engine to search and process a database of security incidents generated by security-related software such as IDSes and firewalls (e.g. Snort, ipchains). By Roman Danyliw.

- PostNuke is a very popular free content management system and weblog system. It offers full CSS support, HTML 4.01 transitional compliance throughout, an advanced blocks system, and is fully multi-lingual enabled.

- EasyPublish CMS is another free content management system for managing information and integrated modules on your internet, intranet- and extranet-sites. From Norway.

- NOLA is a full featured accounting, inventory, and job tracking application. It is licensed under the GPL, and developed by Noguska.

## Feature Requests and Bug Reports

Feature requests and bug reports can be emailed to jlim#natsoft.com.my or posted to the ADOdb Help forums at http://phplens.com/lens/lensforum/topics.php?id=4.

## Installation Guide

Make sure you are running PHP4.01pl2 or later (it uses require_once and include_once). Unpack all the files into a directory accessible by your webserver.

To test, try modifying some of the tutorial examples. Make sure you customize the connection settings correctly. You can debug using:

    <?php
    	include('adodb/adodb.inc.php');
    	$db = ADONewConnection($database);
    	$db->debug = true;
    	$db->Connect($server, $user, $password, $database);
    	$rs = $db->Execute('select * from some_small_table');
       print "<pre>";
    	print_r($rs->GetRows());
       print "</pre>";
    ?>

### Code Initialization

When running ADOdb, at least two files are loaded. First is adodb.inc.php, which contains all functions used by all database classes. The code specific to a particular database is in the adodb-????.inc.php file.

For example, to connect to a mysql database:

    include('/path/to/set/here/adodb.inc.php');
    $conn = &ADONewConnection('mysql');

Whenever you need to connect to a database, you create a Connection object using the ADONewConnection($driver) function. NewADOConnection($driver) is an alternative name for the same function.

At this point, you are not connected to the database. You will use `$conn->Connect()` or `$conn->PConnect()` to perform the actual connection.

See the examples below in the Tutorial.

### Databases Supported

Name | Tested | Database | RecordCount() usable | Prerequisites | Operating Systems
access | B | Microsoft Access/Jet. You need to create an ODBC DSN. | Y/N | ODBC | Windows only
ado | B | Generic ADO, not tuned for specific databases. Allows DSN-less connections. For best performance, use an OLEDB provider. | ? depends on database | ADO or OLEDB provider | Windows only
ado_access | B | Microsoft Access/Jet using ADO. Allows DSN-less connections. For best performance, use an OLEDB provider. | Y/N | ADO or OLEDB provider | Windows only
ado_mssql | B | Microsoft SQL Server using ADO. Allows DSN-less connections. For best performance, use an OLEDB provider. | Y/N | ADO or OLEDB provider | Windows only
db2 | C | DB2. Should work reliably as based on ODBC driver. | Y/N | DB2 CLI/ODBC interface | Unix and Windows. Unix install hints.
vfp | A | Microsoft Visual FoxPro. You need to create an ODBC DSN. | Y/N | ODBC | Windows only
fbsql | C | FrontBase. | Y | ? | Unix and Windows
ibase | B | Interbase 6 or earlier. Some users report you might need to use this $db->PConnect('localhost:c:/ibase/employee.gdb', "sysdba", "masterkey") to connect. Lacks Affected_Rows currently. | Y/N | Interbase client | Unix and Windows
firebird | C | Firebird version of interbase. | Y/N | Interbase client | Unix and Windows
borland_ibase | C | Borland version of Interbase 6.5 or later. Very sad that the forks differ. | Y/N | Interbase client | Unix and Windows
informix72 | C | Informix databases before Informix 7.3 that do no support SELECT FIRST. | Y/N | Informix client | Unix and Windows
informix | C | Generic informix driver. | Y/N | Informix client | Unix and Windows
mssql | A | Microsoft SQL Server 7 and later. Works with Microsoft SQL Server 2000 also. Note that date formating is problematic with this driver. For example, the PHP mssql extension does not return the seconds for datetime! | Y/N | Mssql client | Unix and Windows. Unix install howto.
mssqlpo | A | Portable mssql driver. Identical to above mssql driver, except that '||', the concatenation operator, is converted to '+'. Useful for porting scripts from most other sql variants that use ||. | Y/N | Mssql client | Unix and Windows. Unix install howto.
mysql | A | MySQL without transaction support | Y/N | MySQL client | Unix and Windows
mysqlt or maxsql | A | MySQL with transaction support. We recommend using || as the concat operator for best portability. This can be done by running MySQL using: mysqld --ansi or mysqld --sql-mode=PIPES_AS_CONCAT | Y/N | MySQL client | Unix and Windows
oci8 | A | Oracle 8/9. Has more functionality than oracle driver (eg. Affected_Rows). You might have to putenv('ORACLE_HOME=...') before Connect/PConnect. There are 2 ways of connecting - with server IP and service name: PConnect('serverip:1521','scott','tiger','service') or using an entry in TNSNAMES.ORA or ONAMES or HOSTNAMES: PConnect(false, 'scott', 'tiger', $oraname). | Y/N | Oracle client | Unix and Windows
oci805 | C | Supports reduced Oracle functionality for Oracle 8.0.5. SelectLimit is not as efficient as in the oci8 or oci8po drivers. | Y/N | Oracle client | Unix and Windows
oci8po | A | Oracle 8/9 portable driver. This is nearly identical with the oci8 driver except (a) bind variables in Prepare() use the ? convention, instead of :bindvar, (b) field names use the more common PHP convention of lowercase names. Use this driver if porting from other databases is important. Otherwise the oci8 driver offers better performance. | Y/N | Oracle client | Unix and Windows
odbc | A | Generic ODBC, not tuned for specific databases. To connect, use PConnect('DSN','user','pwd'). | ? depends on database | ODBC | Unix and Windows. Unix hints.
odbc_mssql | C | Uses ODBC to connect to MSSQL | Y/N | ODBC | Unix and Windows.
odbc_oracle | C | Uses ODBC to connect to Oracle | Y/N | ODBC | Unix and Windows.
oracle | C | Implements old Oracle 7 client API. Use oci8 driver if possible for better performance. | Y/N | Oracle client | Unix and Windows
postgres | A | Generic PostgreSQL driver. Currently identical to postgres7 driver. | Y | PostgreSQL client | Unix and Windows.
postgres64 | A | For PostgreSQL 6.4 and earlier which does not support LIMIT internally. | Y | PostgreSQL client | Unix and Windows.
postgres7 | A | PostgreSQL which supports LIMIT and other version 7 functionality. | Y | PostgreSQL client | Unix and Windows.
sqlanywhere | C | Sybase SQL Anywhere. Should work reliably as based on ODBC driver. | Y/N | SQL Anywhere ODBC client | ?
sybase | C | Sybase. | Y/N | Sybase client | Unix and Windows.

###

The "Tested" column indicates how extensively the code has been tested and used.
A = well tested and used by many people
B = tested and usable, but some features might not be implemented
C = user contributed or experimental driver. Might not fully support all of the latest features of ADOdb.

The column "RecordCount() usable" indicates whether RecordCount() return the number of rows, or returns -1 when a SELECT statement is executed. If this column displays Y/N then the RecordCount() is emulated when the global variable $ADODB_COUNTRECS=true, which is the default. Note that for large recordsets, it might be better to disable RecordCount() emulation because substantial amounts of memory are required to cache the recordset for counting. This variable is checked every time a query is executed, so you can selectively choose which recordsets to count.

All databases that support $ADODB_FETCH_MODE work with ADODB_FETCH_NUM and ADODB_FETCH_ASSOC. How it supports ADODB_FETCH_DEFAULT is implementation dependant and might not be portable. Similarly ADODB_FETCH_BOTH is implementation dependant and is not supported by all databases.

# Tutorial

### Example 1: Select Statement

Task: Connect to the Access Northwind DSN, display the first 2 columns of each row.

In this example, we create a ADOConnection object, which represents the connection to the database. The connection is initiated with PConnect, which is a persistent connection. Whenever we want to query the database, we call the ADOConnection.Execute() function. This returns an ADORecordSet object which is actually a cursor that holds the current row in the array fields[]. We use MoveNext() to move from row to row.

NB: A useful function that is not used in this example is SelectLimit, which allows us to limit the number of rows shown.

    <?
    include('adodb.inc.php');	   # load code common to ADOdb
    $conn = &ADONewConnection('access');	# create a connection
    $conn->PConnect('northwind');   # connect to MS-Access, northwind DSN
    $recordSet = &$conn->Execute('select * from products');
    if (!$recordSet)
    	print $conn->ErrorMsg();
    else
    while (!$recordSet->EOF) {
    	print $recordSet->fields[0].' '.$recordSet->fields[1].'<BR>';
    	$recordSet->MoveNext();
    }

    $recordSet->Close(); # optional
    $conn->Close(); # optional

    ?>

The $recordSet returned stores the current row in the $recordSet->fields array, indexed by column number (starting from zero). We use the MoveNext() function to move to the next row. The EOF property is set to true when end-of-file is reached. If an error occurs in Execute(), we return false instead of a recordset.

The `$recordSet->fields[]` array is generated by the PHP database extension. Some database extensions only index by number and do not index the array by field name. To force indexing by name - that is associative arrays - use the $ADODB_FETCH_MODE global variable. Each recordset saves and uses whatever fetch mode was set when the recordset was created in Execute() or SelectLimit().

    	$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')

To get the number of rows in the select statement, you can use $recordSet->RecordCount(). Note that it can return -1 if the number of rows returned cannot be determined.

### Example 2: Advanced Select with Field Objects

Select a table, display the first two columns. If the second column is a date or timestamp, reformat the date to US format.

    <?
    include('adodb.inc.php');	   # load code common to ADOdb
    $conn = &ADONewConnection('access');	# create a connection
    $conn->PConnect('northwind');   # connect to MS-Access, northwind dsn
    $recordSet = &$conn->Execute('select CustomerID,OrderDate from Orders');
    if (!$recordSet)
    	print $conn->ErrorMsg();
    else
    while (!$recordSet->EOF) {
    	$fld = $recordSet->FetchField(1);
    	$type = $recordSet->MetaType($fld->type);

    	if ( $type == 'D' || $type == 'T')
    		print $recordSet->fields[0].' '.
    			$recordSet->UserDate($recordSet->fields[1],'m/d/Y').'<BR>';
    	else
    		print $recordSet->fields[0].' '.$recordSet->fields[1].'<BR>';

    	$recordSet->MoveNext();
    }
    $recordSet->Close(); # optional
    $conn->Close(); # optional

    ?>

In this example, we check the field type of the second column using FetchField(). This returns an object with at least 3 fields.

- name: name of column
- type: native field type of column
- max_length: maximum length of field. Some databases such as MySQL do not return the maximum length of the field correctly. In these cases max_length will be set to -1.

We then use MetaType() to translate the native type to a generic type. Currently the following generic types are defined:

- C: character fields that should be shown in a <input type="text"> tag.
- X: TeXt, large text fields that should be shown in a <textarea>
- B: Blobs, or Binary Large Objects. Typically images.
- D: Date field
- T: Timestamp field
- L: Logical field (boolean or bit-field)
- I: Integer field
- N: Numeric field. Includes autoincrement, numeric, floating point, real and integer.
- R: Serial field. Includes serial, autoincrement integers. This works for selected databases.

If the metatype is of type date or timestamp, then we print it using the user defined date format with UserDate(), which converts the PHP SQL date string format to a user defined one. Another use for MetaType() is data validation before doing an SQL insert or update.

### Example 3: Inserting

Insert a row to the Orders table containing dates and strings that need to be quoted before they can be accepted by the database, eg: the single-quote in the word John's.

    <?
    include('adodb.inc.php');	   # load code common to ADOdb
    $conn = &ADONewConnection('access');	# create a connection

    $conn->PConnect('northwind');   # connect to MS-Access, northwind dsn
    $shipto = $conn->qstr("John's Old Shoppe");

    $sql = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
    $sql .= "values ('ANATR',2,".$conn->DBDate(time()).",$shipto)";

    if ($conn->Execute($sql) === false) {
    	print 'error inserting: '.$conn->ErrorMsg().'<BR>';
    }
    ?>

In this example, we see the advanced date and quote handling facilities of ADOdb. The unix timestamp (which is a long integer) is appropriately formated for Access with DBDate(), and the right escape character is used for quoting the John's Old Shoppe, which is John''s Old Shoppe and not PHP's default John's Old Shoppe with qstr().

Observe the error-handling of the Execute statement. False is returned by Execute() if an error occured. The error message for the last error that occurred is displayed in ErrorMsg(). Note: php_track_errors might have to be enabled for error messages to be saved.

### Example 4: Debugging

    <?
    include('adodb.inc.php');	   # load code common to ADOdb
    $conn = &ADONewConnection('access');	# create a connection
    $conn->PConnect('northwind');   # connect to MS-Access, northwind dsn
    $shipto = $conn->qstr("John's Old Shoppe");
    $sql = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
    $sql .= "values ('ANATR',2,".$conn->FormatDate(time()).",$shipto)";
    $conn->debug = true;
    if ($conn->Execute($sql) === false) print 'error inserting';
    ?>

In the above example, we have turned on debugging by setting debug = true. This will display the SQL statement before execution, and also show any error messages. There is no need to call ErrorMsg() in this case. For displaying the recordset, see the rs2html() example.

Also see the section on Custom Error Handlers.

### Example 5: MySQL and Menus

Connect to MySQL database agora, and generate a <select> menu from an SQL statement where the <option> captions are in the 1st column, and the value to send back to the server is in the 2nd column.

    <?
    include('adodb.inc.php'); # load code common to ADOdb
    $conn = &ADONewConnection('mysql');  # create a connection
    $conn->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
    $sql = 'select CustomerName, CustomerID from customers';
    $rs = $conn->Execute($sql);
    print $rs->GetMenu('GetCust','Mary Rosli');
    ?>

Here we define a menu named GetCust, with the menu option 'Mary Rosli' selected. See GetMenu(). We also have functions that return the recordset as an array: GetArray(), and as an associative array with the key being the first column: GetAssoc().

Aslo new to ADOdb 1.50 or later is the global variable $ADODB_FETCH_MODE. This allows you to define whether you want associative or numeric indexing for your arrays.

### Example 6: Connecting to 2 Databases At Once

    <?
    include('adodb.inc.php');	 # load code common to ADOdb
    $conn1 = &ADONewConnection('mysql');  # create a mysql connection
    $conn2 = &ADONewConnection('oracle');  # create a oracle connection

    $conn1->PConnect($server, $userid, $password, $database);
    $conn2->PConnect(false, $ora_userid, $ora_pwd, $oraname);

    $conn1->Execute('insert ...');
    $conn2->Execute('update ...');
    ?>

### Example 7: Generating Update and Insert SQL

ADOdb 1.31 and later supports two new recordset functions: GetUpdateSQL( ) and GetInsertSQL( ). This allow you to perform a "SELECT * FROM table query WHERE...", make a copy of the $rs->fields, modify the fields, and then generate the SQL to update or insert into the table automatically.

We show how the functions can be used when accessing a table with the following fields: (ID, FirstName, LastName, Created).

Before these functions can be called, you need to initialize the recordset by performing a select on the table. Idea and code by Jonathan Younger jyounger#unilab.com.

    <?
    #==============================================
    # SAMPLE GetUpdateSQL() and GetInsertSQL() code
    #==============================================
    include('adodb.inc.php');
    include('tohtml.inc.php');

    #==========================
    # This code tests an insert

    $sql = "SELECT * FROM ADOXYZ WHERE id = -1";
    # Select an empty record from the database

    $conn = &ADONewConnection("mysql");  # create a connection
    $conn->debug=1;
    $conn->PConnect("localhost", "admin", "", "test"); # connect to MySQL, testdb
    $rs = $conn->Execute($sql); # Execute the query and get the empty recordset

    $record = array(); # Initialize an array to hold the record data to insert

    # Set the values for the fields in the record
    $record["firstname"] = "Bob";
    $record["lastname"] = "Smith";
    $record["created"] = time();

    # Pass the empty recordset and the array containing the data to insert
    # into the GetInsertSQL function. The function will process the data and return
    # a fully formatted insert sql statement.
    $insertSQL = $conn->GetInsertSQL($rs, $record);

    $conn->Execute($insertSQL); # Insert the record into the database

    #==========================
    # This code tests an update

    $sql = "SELECT * FROM ADOXYZ WHERE id = 1";
    # Select a record to update

    $rs = $conn->Execute($sql); # Execute the query and get the existing record to update

    $record = array(); # Initialize an array to hold the record data to update

    # Set the values for the fields in the record
    $record["firstname"] = "Caroline";
    $record["lastname"] = "Smith"; # Update Caroline's lastname from Miranda to Smith

    # Pass the single record recordset and the array containing the data to update
    # into the GetUpdateSQL function. The function will process the data and return
    # a fully formatted update sql statement with the correct WHERE clause.
    # If the data has not changed, no recordset is returned
    $updateSQL = $conn->GetUpdateSQL($rs, $record);

    $conn->Execute($updateSQL); # Update the record in the database
    $conn->Close();
    ?>

### Example 8: Implementing Scrolling with Next and Previous

The following code creates a very simple recordset pager, where you can scroll from page to page of a recordset.

    include_once('../adodb.inc.php');
    include_once('../adodb-pager.inc.php');
    session_start();

    $db = NewADOConnection('mysql');

    $db->Connect('localhost','root','','xphplens');

    $sql = "select * from adoxyz ";

    $pager = new ADODB_Pager($db,$sql);
    $pager->Render($rows_per_page=5);

This will create a basic record pager that looks like this:

`|<` `<<` `>>` `>|`
ID | First Name | Last Name | Date Created
36 | Alan | Turing | Sat 06, Oct 2001
37 | Serena | Williams | Sat 06, Oct 2001
38 | Yat Sun | Sun | Sat 06, Oct 2001
39 | Wai Hun | See | Sat 06, Oct 2001
40 | Steven | Oey | Sat 06, Oct 2001
Page 8/10

The number of rows to display at one time is controled by the Render($rows) method. If you do not pass any value to Render(), ADODB_Pager will default to 10 records per page.

You can control the column titles by modifying your SQL (supported by most databases):

    $sql = 'select id as "ID", firstname as "First Name",
    		  lastname as "Last Name", created as "Date Created"
    		from adoxyz';

The above code can be found in the adodb/tests/testpaging.php example included with this release, and the class ADODB_Pager in adodb/adodb-pager.inc.php. The ADODB_Pager code can be adapted by a programmer so that the text links can be replaced by images, and the dull white background be replaced with more interesting colors.

Some of the code used here was contributed by Iván Oliva and Cornel G.

### Example 9: Exporting in CSV or Tab-Delimited Format

We provide some helper functions to export in comma-separated-value (CSV) and tab-delimited formats:

    include_once('/path/to/adodb/toexport.inc.php');
    include_once('/path/to/adodb/adodb.inc.php');

    $db = &NewADOConnection('mysql');
    $db->Connect($server, $userid, $password, $database);

    $rs = $db->Execute('select fname as "First Name", surname as "Surname" from table');

    print "<pre>";
    print rs2csv($rs); # return a string, CSV formatprint '<hr>';

    $rs->MoveFirst(); # note, some databases do not support MoveFirst
    print rs2tab($rs,false); # return a string, tab-delimited
    						 # false == suppress field names in first lineprint '<hr>';
    $rs->MoveFirst();
    rs2tabout($rs); # send to stdout directly (there is also an rs2csvout function)
    print "</pre>";

    $rs->MoveFirst();
    $fp = fopen($path, "w");
    if ($fp) {
      rs2csvfile($rs, $fp); # write to file (there is also an rs2tabfile function)
      fclose($fp);
    }

Carriage-returns or newlines are converted to spaces. Field names are returned in the first line of text. Strings containing the delimiter character are quoted with double-quotes. Double-quotes are double-quoted again. This conforms to Excel import and export guide-lines.

All the above functions take as an optional last parameter, $addtitles which defaults to true. When set to false field names in the first line are suppressed.

## Using Custom Error Handlers and PEAR_Error

Apart from the old $con->debug = true; way of debugging, ADOdb 1.50 onwards provides another way of handling errors using ADOdb's custom error handlers.

ADOdb provides two custom handlers which you can modify for your needs. The first one is in the adodb-errorhandler.inc.php file. This makes use of the standard PHP functions error_reporting to control what error messages types to display, and trigger_error which invokes the default PHP error handler.

Including the above file will cause trigger_error($errorstring,E_USER_ERROR) to be called when
(a) Connect() or PConnect() fails, or
(b) a function that executes SQL statements such as Execute() or SelectLimit() has an error.
(c) GenID() appears to go into an infinite loop.

The $errorstring is generated by ADOdb and will contain useful debugging information similar to the error.log data generated below. This file adodb-errorhandler.inc.php should be included before you create any ADOConnection objects.

If you define error_reporting(0), no errors will be shown. If you set error_reporting(E_ALL), all errors will be displayed on the screen.

    <?php
    error_reporting(E_ALL); # show any error messages triggered
    include('adodb-errorhandler.inc.php');
    include('adodb.inc.php');
    include('tohtml.inc.php');
    $c = NewADOConnection('mysql');
    $c->PConnect('localhost','root','','northwind');
    $rs=$c->Execute('select * from productsz'); #invalid table productsz');
    if ($rs) $rs2html($rs);
    ?>

If you want to log the error message, you can do so by defining the following optional constants ADODB_ERROR_LOG_TYPE and ADODB_ERROR_LOG_DEST. ADODB_ERROR_LOG_TYPE is the error log message type (see error_log in the PHP manual). In this case we set it to 3, which means log to the file defined by the constant ADODB_ERROR_LOG_DEST.

    <?php
    error_reporting(0); # do not echo any errors
    define('ADODB_ERROR_LOG_TYPE',3);
    define('ADODB_ERROR_LOG_DEST','C:/errors.log');
    include('adodb-errorhandler.inc.php');
    include('adodb.inc.php');
    include('tohtml.inc.php');

    $c = NewADOConnection('mysql');
    $c->PConnect('localhost','root','','northwind');
    $rs=$c->Execute('select * from productsz'); ## invalid table productsz
    if ($rs) $rs2html($rs);
    ?>

The following message will be logged in the error.log file:

    (2001-10-28 14:20:38) mysql error: [1146: Table 'northwind.productsz' doesn't exist] in
     EXECUTE("select * from productsz")

The second error handler is adodb-errorpear.inc.php. This will create a PEAR_Error derived object whenever an error occurs. The last PEAR_Error object created can be retrieved using ADODB_Pear_Error().

    <?php
    include('adodb-errorpear.inc.php');
    include('adodb.inc.php');
    include('tohtml.inc.php');
    $c = NewADOConnection('mysql');
    $c->PConnect('localhost','root','','northwind');
    $rs=$c->Execute('select * from productsz'); #invalid table productsz');
    if ($rs) $rs2html($rs);
    else {
    	$e = ADODB_Pear_Error();
    	echo '<p>',$e->message,'</p>';
    }
    ?>

You can use a PEAR_Error derived class by defining the constant ADODB_PEAR_ERROR_CLASS before the adodb-errorpear.inc.php file is included. For easy debugging, you can set the default error handler in the beginning of the PHP script to PEAR_ERROR_DIE, which will cause an error message to be printed, then halt script execution:

    include('PEAR.php');
    PEAR::setErrorHandling('PEAR_ERROR_DIE');

Note that we do not explicitly return a PEAR_Error object to you when an error occurs. We return false instead. You have to call ADODB_Pear_Error() to get the last error or use the PEAR_ERROR_DIE technique.

## Data Source Names

We now support connecting using PEAR style DSN's. A DSN is a connection string of the form:

$dsn = "$driver://$username:$password@$hostname/$databasename";

You pass the DSN to the static class function DB::Connect. An example:

       include_once('../adodb/adodb-pear.inc.php');
       $username = 'root';
       $password = '';
       $hostname = 'localhost';
       $databasename = 'xphplens';
       $driver = 'mysql';
       $dsn = "$driver://$username:$password@$hostname/$databasename";

       $db = DB::Connect($dsn);
       $rs = $db->Execute('select firstname,lastname from adoxyz');
       $cnt = 0;
       while ($arr = $rs->FetchRow()) {
    		print_r($arr); print "<br>";
       }

This requires PEAR to be installed and in the default include path in php.ini.

## Caching of Recordsets

ADOdb now supports caching of recordsets using the CacheExecute( ), CachePageExecute( ) and CacheSelectLimit( ) functions. There are similar to the non-cache functions, except that they take a new first parameter, $secs2cache.

An example:

    include('adodb.inc.php'); # load code common to ADOdb
    $ADODB_CACHE_DIR = '/usr/ADODB_cache';
    $conn = &ADONewConnection('mysql');  # create a connection
    $conn->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
    $sql = 'select CustomerName, CustomerID from customers';
    $rs = $conn->CacheExecute(15,$sql);

The first parameter is the number of seconds to cache the query. Subsequent calls to that query will used the cached version stored in $ADODB_CACHE_DIR. To force a query to execute and flush the cache, call CacheExecute() with the first parameter set to zero. Alternatively, use the CacheFlush($sql) call.

For the sake of security, we recommend you set register_globals=off in php.ini if you are using $ADODB_CACHE_DIR.

In ADOdb 1.80 onwards, the secs2cache parameter is optional in CacheSelectLimit() and CacheExecute(). If you leave it out, it will use the $connection->cacheSecs parameter, which defaults to 60 minutes.

    	$conn->Connect(...);
    	$conn->cacheSecs = 3600*24; # cache 24 hours
    	$rs = $conn->CacheExecute('select * from table');

## Pivot Tables

Since ADOdb 2.3, we support the generation of SQL to create pivot tables, also known as cross-tabulations. For further explanation read this DevShed Cross-Tabulation tutorial. We assume that your database supports the SQL case-when expression.

In this example, we will use the Northwind database from Microsoft. In the database, we have a products table, and we want to analyze this table by suppliers versus product categories. We will place the suppliers on each row, and pivot on categories. So from the table on the left, we generate the pivot-table on the right:

Supplier | Category
supplier1 | category1
supplier2 | category1
supplier3 | category2
| --> |
| category1 | category2 | total
supplier1 | 1 | 0 | 1
supplier2 | 1 | 1 | 2

The following code will generate the SQL for a cross-tabulation:

    # Query the main "product" table
    # Set the rows to CompanyName
    # and the columns to the values of Categories
    # and define the joins to link to lookup tables
    # "categories" and "suppliers"
    #
     include "adodb/pivottable.php";
     $sql = PivotTableSQL(
     	$gDB,                                      # adodb connection
     	'products p ,categories c ,suppliers s',   # tables
    	'CompanyName',                             # rows (multiple fields allowed)
    	'CategoryName',                            # column to pivot on
    	'p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID' # joins/where
    );

This will generate the following SQL:

`SELECT CompanyName,
SUM(CASE WHEN CategoryName='Beverages' THEN 1 ELSE 0 END) AS "Beverages",
SUM(CASE WHEN CategoryName='Condiments' THEN 1 ELSE 0 END) AS "Condiments",
SUM(CASE WHEN CategoryName='Confections' THEN 1 ELSE 0 END) AS "Confections",
SUM(CASE WHEN CategoryName='Dairy Products' THEN 1 ELSE 0 END) AS "Dairy Products",
SUM(CASE WHEN CategoryName='Grains/Cereals' THEN 1 ELSE 0 END) AS "Grains/Cereals",
SUM(CASE WHEN CategoryName='Meat/Poultry' THEN 1 ELSE 0 END) AS "Meat/Poultry",
SUM(CASE WHEN CategoryName='Produce' THEN 1 ELSE 0 END) AS "Produce",
SUM(CASE WHEN CategoryName='Seafood' THEN 1 ELSE 0 END) AS "Seafood",
SUM(1) as Total
FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID
GROUP BY CompanyName,QuantityPerUnit`

You can also pivot on numerical columns and generate totals by using ranges. The second example shows this:

     $sql = PivotTableSQL(
     	$gDB,                                       # adodb connection
     	'products p ,categories c ,suppliers s',    # tables
    	'CompanyName',                              # rows (multiple fields allowed)
       array(                                       # column ranges
    	' 0 '      => 'UnitsInStock <= 0',
    	"1 to 5"   => '0 < UnitsInStock and UnitsInStock <= 5',
    	"6 to 10"  => '5 < UnitsInStock and UnitsInStock <= 10',
    	"11 to 15" => '10 < UnitsInStock and UnitsInStock <= 15',
    	"16+" =>'15 < UnitsInStock'
    	),
    	' p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID', # joins/where
    	'UnitsInStock',                             # sum this field
    	'Sum'                                       # sum label prefix
    );

Which generates:

`SELECT CompanyName,
SUM(CASE WHEN UnitsInStock <= 0 THEN 1 ELSE 0 END) AS " 0 ",
SUM(CASE WHEN UnitsInStock <= 0 THEN UnitsInStock ELSE 0 END) AS "Sum 0 ",
SUM(CASE WHEN 0 < UnitsInStock and UnitsInStock <= 5 THEN 1 ELSE 0 END) AS "1 to 5",
SUM(CASE WHEN 0 < UnitsInStock and UnitsInStock <= 5 THEN UnitsInStock ELSE 0 END) AS "Sum 1to 5",
SUM(CASE WHEN 5 < UnitsInStock and UnitsInStock <= 10 THEN 1 ELSE 0 END) AS "6 to 10",
SUM(CASE WHEN 5 < UnitsInStock and UnitsInStock <= 10 THEN UnitsInStock ELSE 0 END) AS "Sum 6 to 10",
SUM(CASE WHEN 10 < UnitsInStock and UnitsInStock <= 15 THEN 1 ELSE 0 END) AS "11 to 15",
SUM(CASE WHEN 10 < UnitsInStock and UnitsInStock <= 15 THEN UnitsInStock ELSE 0 END) AS "Sum _11 to 15",
SUM(CASE WHEN 15 < UnitsInStock THEN 1 ELSE 0 END) AS "16+",
SUM(CASE WHEN 15 < UnitsInStock THEN UnitsInStock ELSE 0 END) AS "Sum 16+",
SUM(1) as Total
FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID
GROUP BY CompanyName,QuantityPerUnit`

# Class Reference

Function parameters with [ ] around them are optional.

## Global Variables

### $ADODB_COUNTRECS

If the database driver API does not support counting the number of records returned in a SELECT statement, the function RecordCount() is emulated when the global variable $ADODB_COUNTRECS is set to true, which is the default. We emulate this by buffering the records, which can take up large amounts of memory for big recordsets. Set this variable to false for the best performance. This variable is checked every time a query is executed, so you can selectively choose which recordsets to count.

### $ADODB_CACHE_DIR

If you are using recordset caching, this is the directory to save your recordsets in. Define this before you call any caching functions such as CacheExecute( ). We recommend setting register_globals=off in php.ini if you use this feature for security reasons.

If you are using Unix and apache, you might need to set your cache directory permissions to something similar to the following:

chown -R apache /path/to/adodb/cache
chgrp -R apache /path/to/adodb/cache

### $ADODB_FETCH_MODE

This is a global variable that determines how arrays are retrieved by recordsets. The recordset saves this value on creation (eg. in Execute( ) or SelectLimit( )), and any subsequent changes to $ADODB_FETCH_MODE have no affect on existing recordsets, only on recordsets created in the future.

The following constants are defined:

define('ADODB_FETCH_DEFAULT',0);
define('ADODB_FETCH_NUM',1);
define('ADODB_FETCH_ASSOC',2);
define('ADODB_FETCH_BOTH',3);

An example:

    	$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')

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().

If no fetch mode is predefined, the fetch mode defaults to ADODB_FETCH_DEFAULT. The behaviour of this default mode varies from driver to driver, so do not rely on ADODB_FETCH_DEFAULT. For portability, we recommend sticking to ADODB_FETCH_NUM or ADODB_FETCH_ASSOC. Many drivers do not support ADODB_FETCH_BOTH.

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

### ADOConnection Fields

databaseType: Name of the database system we are connecting to. Eg. odbc or mssql or mysql.

dataProvider: The underlying mechanism used to connect to the database. Normally set to native, unless using odbc or ado.

host: Name of server or data source name (DSN) to connect to.

database: Name of the database or to connect to. If ado is used, it will hold the ado data provider.

user: Login id to connect to database. Password is not saved for security reasons.

raiseErrorFn: Allows you to define an error handling function. See adodb-errorhandler.inc.php for an example.

debug: Set to true to make debug statements to appear.

concat_operator: Set to '+' or '||' normally. The operator used to concatenate strings in SQL. Used by the Concat function.

fmtDate: The format used by the DBDate function to send dates to the database. is '#Y-m-d#' for Microsoft Access, and ''Y-m-d'' for MySQL.

fmtTimeStamp: The format used by the DBTimeStamp function to send timestamps to the database.

true: The value used to represent true.Eg. '.T.'. for Foxpro, '1' for Microsoft SQL.

false: The value used to represent false. Eg. '.F.'. for Foxpro, '0' for Microsoft SQL.

replaceQuote: The string used to escape quotes. Eg. double single-quotes for Microsoft SQL, and backslash-quote for MySQL. Used by qstr.

autoCommit: indicates whether automatic commit is enabled. Default is true.

charSet: set the default charset to use. Currently only interbase supports this.

dialect: set the default sql dialect to use. Currently only interbase supports this.

metaTablesSQL: SQL statement to return a list of available tables. Eg. SHOW TABLES in MySQL.

genID: The latest id generated by GenID() if supported by the database.

cacheSecs: The number of seconds to cache recordsets if CacheExecute() or CacheSelectLimit() omit the $secs2cache parameter. Defaults to 60 minutes.

sysDate: String that holds the name of the database function to call to get the current date. Useful for inserts and updates.

sysTimeStamp: String that holds the name of the database function to call to get the current timestamp/datetime value.

leftOuter: String that holds operator for left outer join, if known. Otherwise set to false.

rightOuter: String that holds operator for left outer join, if known. Otherwise set to false.

ansiOuter: Boolean that if true indicates that ANSI style outer joins are permitted. Eg. select * from table1 left join table2 on p1=p2.

connectSID: Boolean that indicates whether to treat the $database parameter in connects as the SID for the oci8 driver. Defaults to false. Useful for Oracle 8.0.5 and earlier.

autoRollback: Persistent connections are auto-rollbacked in PConnect( ) if this is set to true. Default is false.

### ADOConnection Main Functions

ADOConnection( )

Constructor function. Do not call this directly. Use ADONewConnection( ) instead.

Connect($host,[$user],[$password],[$database])

Non-persistent connect to data source or server $host, using userid $user and password $password. If the server supports multiple databases, connect to database $database.

Returns true/false depending on connection.

ADO Note: If you are using a Microsoft ADO and not OLEDB, you can set the $database parameter to the OLEDB data provider you are using.

PostgreSQL: An alternative way of connecting to the database is to pass the standard PostgreSQL connection string in the first parameter $host, and the other parameters will be ignored.

For Oracle and Oci8, there are two ways to connect. First is to use the TNS name defined in your local tnsnames.ora (or ONAMES or HOSTNAMES). Place the name in the $database field, and set the $host field to false. Alternatively, set $host to the server, and $database to the database SID, this bypassed tnsnames.ora.

Examples:

     # $oraname in tnsnames.ora/ONAMES/HOSTNAMES
     $conn->Connect(false, 'scott', 'tiger', $oraname);
     $conn->Connect('server:1521', 'scott', 'tiger', 'ServiceName'); # bypass tnsnames.ora

There are many examples of connecting to a database at php.weblogs.com/ADOdb, and in the testdatabases.inc.php file included in the release.

PConnect($host,[$user],[$password],[$database])

Persistent connect to data source or server $host, using userid $user and password $password. If the server supports multiple databases, connect to database $database.

We now perform a rollback on persistent connection for selected databases since 2.21, as advised in the PHP manual. See change log or source code for which databases are affected.

Returns true/false depending on connection. See Connect( ) above for more info.

Since ADOdb 2.21, we also support autoRollback. If you set:

     $conn = &NewADOConnection('mysql');
     $conn->autoRollback = true; # default is false
     $conn->PConnect(...); # rollback here

Then when doing a persistent connection with PConnect( ), ADOdb will perform a rollback first. This is because it is documented that PHP is not guaranteed to rollback existing failed transactions when persistent connections are used. This is implemented in Oracle, MySQL, PgSQL, MSSQL, ODBC currently.

Execute($sql,$inputarr=false)

Execute SQL statement $sql and return derived class of ADORecordSet if successful. Note that a record set is always returned on success, even if we are executing an insert or update statement.

Returns derived class of ADORecordSet. Eg. if connecting via mysql, then ADORecordSet_mysql would be returned. False is returned if there was an error in executing the sql.

The $inputarr parameter can be used for binding variables to parameters. Below is an Oracle example:

     $conn->Execute("SELECT * FROM TABLE WHERE COND=:val", array('val'=> $val));

Another example, using ODBC,which uses the ? convention:

      $conn->Execute("SELECT * FROM TABLE WHERE COND=?", array($val));

Binding variables
Variable binding speeds the compilation and caching of SQL statements, leading to higher performance. Currently Oracle and ODBC support variable binding. ODBC style ? binding is emulated in databases that do not support binding.

Variable binding in the odbc and oci8po drivers.

    $rs = $db->Execute('select * from table where val=?', array('10'));

Variable binding in the oci8 driver.

    $rs = $db->Execute('select name from table where val=:key',
      array('key' => 10));

CacheExecute([$secs2cache,]$sql,$inputarr=false)

Similar to Execute, except that the recordset is cached for $secs2cache seconds in the $ADODB_CACHE_DIR directory. If CacheExecute() is called again with the same parameters, same database, same userid, same password, and the cached recordset has not expired, the cached recordset is returned.

      include('adodb.inc.php');
      include('tohtml.inc.php');
      $ADODB_CACHE_DIR = '/usr/local/ADOdbcache';
      $conn = &ADONewConnection('mysql');
      $conn->PConnect('localhost','userid','password','database');
      $rs = $conn->CacheExecute(15, 'select * from table'); # cache 15 secs
      rs2html($rs); /* recordset to html table */

Alternatively, since ADOdb 1.80, the $secs2cache parameter is optional:

    	$conn->Connect(...);
       	$conn->cacheSecs = 3600*24; // cache 24 hours
    	$rs = $conn->CacheExecute('select * from table');

Note that the $secs2cache parameter is optional. If omitted, we use the value in $connection->cacheSecs (default is 3600 seconds, or 1 hour). Use CacheExecute() only with SELECT statements.

Performance note: I have done some benchmarks and found that they vary so greatly that it's better to talk about when caching is of benefit. When your database server is much slower than your Web server or the database is very overloaded then ADOdb's caching is good because it reduces the load on your database server. If your database server is lightly loaded or much faster than your Web server, then caching could actually reduce performance.

SelectLimit($sql,$numrows=-1,$offset=-1,$inputarr=false)

Returns a recordset if successful. Returns false otherwise. Performs a select statement, simulating PostgreSQL's SELECT statement, LIMIT $numrows OFFSET $offset clause.

In PostgreSQL, SELECT * FROM TABLE LIMIT 3 will return the first 3 records only. The equivalent is `$connection->SelectLimit('SELECT * FROM TABLE',3)`. This functionality is simulated for databases that do not possess this feature.

And SELECT * FROM TABLE LIMIT 3 OFFSET 2 will return records 3, 4 and 5 (eg. after record 2, return 3 rows). The equivalent in ADOdb is `$connection->SelectLimit('SELECT * FROM TABLE',3,2)`.

Note that this is the opposite of MySQL's LIMIT clause. You can also set `$connection->SelectLimit('SELECT * FROM TABLE',-1,10)` to get rows 11 to the last row.

The last parameter $inputarr is for databases that support variable binding such as Oracle oci8. This substantially reduces SQL compilation overhead. Below is an Oracle example:

     $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=:val", 100,-1,array('val'=> $val));

The oci8po driver (oracle portable driver) uses the more standard bind variable of ?:

     $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=?", 100,-1,array('val'=> $val));

Ron Wilson reports that SelectLimit does not work with UNIONs.

CacheSelectLimit([$secs2cache,] $sql, $numrows=-1,$offset=-1,$inputarr=false)

Similar to SelectLimit, except that the recordset returned is cached for $secs2cache seconds in the $ADODB_CACHE_DIR directory.

Since 1.80, $secs2cache has been optional, and you can define the caching time in $connection->cacheSecs.

    	$conn->Connect(...);
       	$conn->cacheSecs = 3600*24; // cache 24 hours
    	$rs = $conn->CacheSelectLimit('select * from table',10);

CacheFlush($sql=false)

Flush (delete) any cached recordsets for the SQL statement $sql in $ADODB_CACHE_DIR.

If no parameter is passed in, then all adodb_*.cache files are deleted.

If you want to flush all cached recordsets manually, execute the following PHP code (works only under Unix):
`system("rm -f `find ".$ADODB_CACHE_DIR." -name adodb_*.cache`");`

For general cleanup of all expired files, you should use crontab on Unix, or at.exe on Windows, and a shell script similar to the following:

#------------------------------------------------------
# TRUNCATING OUTPUT FILES OLDER THAN N DAYS
#
# Everything between the 3 lines above and their matching
# lines at the bottom of this section show you how to
# delete any log files whose modification time
# is older than AGED. The AGED variable can be coded in the
# script or passed on the command line.
#------------------------------------------------------
# This particular example deletes files in the TMPPATH
# directory with the string ".cache" in their name that
# are more than 7 days old.
#------------------------------------------------------
AGED=7
if [[ ${AGED} -lt 31 ]] then
find ${TMPPATH} -mtime $AGED | grep "\.cache" | xargs rm -f
fi

ErrorMsg()

Returns the last status or error message. This can return a string even if no error occurs. In general you do not need to call this function unless an ADOdb function returns false on an error.

Note: If debug is enabled, the SQL error message is always displayed when the Execute function is called.

ErrorNo()

Returns the last error number. Note that old versions of PHP (pre 4.0.6) do not support error number for ODBC. In general you do not need to call this function unless an ADOdb function returns false on an error.

GenID($seqName = 'ADOdbseq',$startID=1)

Generate a sequence number (an integer except for mssql). Works for interbase, mysql, postgresql, oci8, oci8po, mssql, ODBC based (access,vfp,db2,etc) drivers currently. Uses $seqName as the name of the sequence. GenID() will automatically create the sequence for you if it does not exist (provided the userid has permission to do so). Otherwise you will have to create the sequence yourself.

If your database driver emulates sequences, the name of the table is the sequence name. The table has one column, "id" which should be of type integer, or if you need something larger - numeric(16).

For ODBC and databases that do not support sequences natively (eg mssql, mysql), we create a table for each sequence. If the sequence has not been defined earlier, it is created with the starting value set in $startID.

Note that the mssql driver's GenID() used to generate 16 byte GUID's. We now return integers since 1.90.

UpdateBlob($table,$column,$val,$where)

Allows you to store a blob (in $val) into $table into $column in a row at $where.

Usage:

    	# for oracle
    	$conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, empty_blob())');
    	$conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');

    	# non oracle databases
    	$conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');
    	$conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');

Returns true if succesful, false otherwise. Supported by MySQL, PostgreSQL, Oci8, Oci8po and Interbase drivers. Other drivers might work, depending on the state of development.

Note that when an Interbase blob is retrieved using SELECT, it still needs to be decoded using $connection->DecodeBlob($blob); to derive the original value in versions of PHP before 4.1.0.

UpdateClob($table,$column,$val,$where)

Allows you to store a clob (in $val) into $table into $column in a row at $where. Similar to UpdateBlob (see above), but for Character Large OBjects.

Usage:

    	# for oracle
    	$conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, empty_clob())');
    	$conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');

    	# non oracle databases
    	$conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, null)');
    	$conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');

UpdateBlobFile($table,$column,$path,$where,$blobtype='BLOB')

Similar to UpdateBlob, except that we pass in a file path to where the blob resides.

returns true if successful, false otherwise.

Replace($table, $arrFields, $keyCols,$autoQuote=false)

Try to update a record, and if the record is not found, an insert statement is generated and executed. Returns 0 on failure, 1 if update statement worked, 2 if no record was found and the insert was executed successfully. This differs from the MySQL replace which deletes the record and inserts a new record. This also means you cannot update the primary key. The only exception to this is Interbase and its derivitives, which uses delete and insert because of some Interbase API limitations.

The parameters are $table which is the table name, the $keyCols which is an associative array where the keys are the field names, and keyCols is the name of the primary key, or an array of field names if it is a compound key. If $autoQuote is set to true, then Replace() will quote all values that are non-numeric; auto-quoting will not quote nulls. Note that auto-quoting will not work if you use SQL functions or operators.

Examples:

    # single field primary key
    $ret = $db->Replace('atable',
    	array('id'=>1000,'firstname'=>'Harun','lastname'=>'Al-Rashid'),
    	'id',
    	'firstname',$autoquote = true);
    # generates UPDATE atable SET firstname='Harun',lastname='Al-Rashid' WHERE id=1000
    # or INSERT INTO atable (id,firstname,lastname) VALUES (1000,'Harun','Al-Rashid')

    # compound key
    $ret = $db->Replace('atable2',
    	array('firstname'=>'Harun','lastname'=>'Al-Rashid', 'age' => 33, 'birthday' => 'null'),
    	array('lastname','firstname'),
    	'firstname',$autoquote = true);

    # no auto-quoting
    $ret = $db->Replace('atable2',
    	array('firstname'=>"'Harun'",'lastname'=>"'Al-Rashid'", 'age' => 'null'),
    	array('lastname','firstname'),
    	'firstname');

GetUpdateSQL(&$rs, $arrFields, $forceUpdate=false,$magicq=false)

Generate SQL to update a table given a recordset $rs, and the modified fields of the array $arrFields (which must be an associative array holding the column names and the new values) are compared with the current recordset. If $forceUpdate is true, then we also generate the SQL even if $arrFields is identical to $rs->fields. Requires the recordset to be associative. $magicq is used to indicate whether magic quotes are enabled (see qstr()).

GetInsertSQL(&$rs, $arrFields,$magicq=false)

Generate SQL to insert into a table given a recordset $rs. Requires the query to be associative. $magicq is used to indicate whether magic quotes are enabled (for qstr()).

PageExecute($sql, $nrows, $page, $inputarr=false)

Used for pagination of recordset. $page is 1-based. See Example 8.

CachePageExecute($secs2cache, $sql, $nrows, $page, $inputarr=false)

Used for pagination of recordset. $page is 1-based. See Example 8. Caching version of PageExecute.

Close( )

Close the database connection. PHP4 proudly states that we no longer have to clean up at the end of the connection because the reference counting mechanism of PHP4 will automatically clean up for us.

BeginTrans( )

Begin a transaction. Turns off autoCommit. Returns true if successful. Some databases will always return false if transaction support is not available. Interbase, Oracle and MSSQL support transactions. Any open transactions will be rolled back when the connection is closed.

The following is the wrong way to use transactions:

    $DB->BeginTrans();
    $DB->Execute("update table1 set val=$val1 where id=$id");
    $DB->Execute("update table2 set val=$val2 where id=$id");
    $DB->CommitTrans();

because you perform no error checking. It is possible to update table1 and for the update on table2 to fail. Here is a better way:

    $DB->BeginTrans();
    $ok = $DB->Execute("update table1 set val=$val1 where id=$id");
    if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");
    if ($ok) $DB->CommitTrans();
    else $DB->RollbackTrans();

Another way is (since ADOdb 2.0):

    $DB->BeginTrans();
    $ok = $DB->Execute("update table1 set val=$val1 where id=$id");
    if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");
    $DB->CommitTrans($ok);

You can also use the ADOdb error handler to die and rollback your transactions for you transparently. Some buggy database extensions are known to commit all outstanding tranasactions, so you might want to explicitly do a $DB->RollbackTrans() in your error handler for safety.

CommitTrans($ok=true)

End a transaction successfully. Returns true if successful. If the database does not support transactions, will return true also as data is always committed.

If you pass the parameter $ok=false, the data is rolled back. See example in BeginTrans().

RollbackTrans( )

End a transaction, rollback all changes. Returns true if successful. If the database does not support transactions, will return false as data is never rollbacked.

GetOne($sql)

Executes the SQL and returns the first field of the first row. The recordset and remaining rows are discarded for you automatically. If an error occur, false is returned.

GetRow($sql)

Executes the SQL and returns the first row as an array. The recordset and remaining rows are discarded for you automatically. If an error occurs, false is returned.

GetAll($sql)

Executes the SQL and returns the all the rows as a 2-dimensional array. The recordset is discarded for you automatically. If an error occurs, false is returned.

GetCol($sql)

Executes the SQL and returns all elements of the first column as a 1-dimensional array. The recordset is discarded for you automatically. If an error occurs, false is returned.

CacheGetOne([$secs2cache,] $sql), CacheGetRow([$secs2cache,] $sql), CacheGetAll([$secs2cache,] $sql), CacheGetCol([$secs2cache,] $sql)

Similar to above Get* functions, except that the recordset is serialized and cached in the $ADODB_CACHE_DIR directory for $secs2cache seconds. Good for speeding up queries on rarely changing data. Note that the $secs2cache parameter is optional. If omitted, we use the value in $connection->cacheSecs (default is 3600 seconds, or 1 hour).

Prepare($sql )

Prepares an SQL query for repeated execution. Only supported internally by interbase, oci8 and selected ODBC-based drivers, otherwise it is emulated. There is no performance advantage to using Prepare() with emulation.

Returns an array containing the original sql statement in the first array element; the remaining elements of the array are driver dependent. If there is an error, or we are emulating Prepare( ), we return the original $sql string. This is because all error-handling has been centralized in Execute( ).

Example:

    $stmt = $DB->Prepare('insert into table (col1,col2) values (?,?)');
    for ($i=0; $i < $max; $i++)
    	$DB->Execute($stmt,array((string) rand(), $i));

PrepareSP($sql)

In the mssql driver, preparing stored procedures requires a special function call, mssql_init( ), which is called by this function. PrepareSP( ) is available in all other drivers, and is emulated by calling Prepare( ). For examples of usage, see Parameter( ) below.

Returns the same array or $sql string as Prepare( ) above.

Parameter($stmt, $var, $name, $isOutput=false, $maxLen = 4000, $type = false )

Adds a bind parameter in a fashion that is compatible with Microsoft SQL Server and Oracle oci8. The parameters are:
$stmt Statement returned by Prepare() or PrepareSP().
$var PHP variable to bind to.
$name Name of stored procedure variable name to bind to.
[$isOutput] Indicates direction of parameter 0/false=IN 1=OUT 2= IN/OUT. This is ignored in oci8 as this driver auto-detects the direction.
[$maxLen] Maximum length of the parameter variable.
[$type] Consult mssql_bind and ocibindbyname docs at php.net for more info on legal values for type.

In mssql, $opt can hold the following elements: array('type' => integer, maxLen =>integer). Example:

    # @RETVAL = SP_RUNSOMETHING @myid,@group
    $stmt = $db->PrepareSP('SP_RUNSOMETHING');
    # note that the parameter name does not have @ in front!
    $db->Parameter($stmt,$id,'myid');
    $db->Parameter($stmt,$group,'group',false,64);
    # return value in mssql - RETVAL is hard-coded name
    $db->Parameter($stmt,$ret,'RETVAL',true);
    $db->Execute($stmt);

An oci8 example:

    # For oracle, Prepare and PrepareSP are identical
    $stmt = $db->PrepareSP(
    	"declare RETVAL integer;
    	 begin
    		:RETVAL := SP_RUNSOMETHING(:myid,:group);
    	 end;");
    $db->Parameter($stmt,$id,'myid');
    $db->Parameter($stmt,$group,'group',false,64);
    $db->Parameter($stmt,$ret,'RETVAL',true);
    $db->Execute($stmt);

Note that the only difference between the oci8 and mssql implementations is the syntax of $sql.

If $type parameter is set to false, in mssql, $type will be dynamicly determined based on the type of the PHP variable passed (string => SQLCHAR, boolean =>SQLINT1, integer =>SQLINT4 or float/double=>SQLFLT8). In oci8, $type can be set to OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File), OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID). To pass in a null, use $db->Parameter($stmt, $null=null, 'param').

Lastly, in oci8, bind parameters can be reused without calling PrepareSP( ) or Parameters again. This is not possible with mssql. An oci8 example:

    $id = 0; $i = 0;
    $stmt = $db->PrepareSP( "update table set val=:i where id=:id");
    $db->Parameter($stmt,$id,'id');
    $db->Parameter($stmt,$i, 'i');
    for ($cnt=0; $cnt < 1000; $cnt++) {
    	$id = $cnt;
    	$i = $cnt * $cnt; # works with oci8!
    	$db->Execute($stmt);
    }

Bind($stmt, $var, $size=4001, $type=false, $name=false)

This is a low-level function supported only by the oci8 driver. Avoid using unless you only want to support Oracle. The Parameter( ) function is the recommended way to go with bind variables.

Bind( ) allows you to use bind variables in your sql statement. This binds a PHP variable to a name defined in an Oracle sql statement that was previously prepared using Prepare(). Oracle named variables begin with a colon, and ADOdb requires the named variables be called :0, :1, :2, :3, etc. The first invocation of Bind() will match :0, the second invocation will match :1, etc. Binding can provide 100% speedups for insert, select and update statements.

The other variables, $size sets the buffer size for data storage, $type is the optional descriptor type OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File), OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID). Lastly, instead of using the default :0, :1, etc names, you can define your own bind-name using $name.

The following example shows 3 bind variables being used: p1, p2 and p3. These variables are bound to :0, :1 and :2.

    $stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:0, :1, :2)");
    $DB->Bind($stmt, $p1);
    $DB->Bind($stmt, $p2);
    $DB->Bind($stmt, $p3);
    for ($i = 0; $i < $max; $i++) {
       $p1 = ?; $p2 = ?; $p3 = ?;
       $DB->Execute($stmt);
    }

You can also use named variables:

    $stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:name0, :name1, :name2)");
    $DB->Bind($stmt, $p1, "name0");
    $DB->Bind($stmt, $p2, "name1");
    $DB->Bind($stmt, $p3, "name2");
    for ($i = 0; $i < $max; $i++) {
       $p1 = ?; $p2 = ?; $p3 = ?;
       $DB->Execute($stmt);
    }

### ADOConnection Utility Functions

BlankRecordSet([$queryid])

No longer available - removed since 1.99.

Concat($s1,$s2,....)

Generates the sql string used to concatenate $s1, $s2, etc together. Uses the string in the concat_operator field to generate the concatenation. Override this function if a concatenation operator is not used, eg. MySQL.

Returns the concatenated string.

DBDate($date)

Format the $date in the format the database accepts; this can be a Unix integer timestamp or an ISO format Y-m-d. Uses the fmtDate field, which holds the format to use. If null or false or '' is passed in, it will be converted to an SQL null.

Returns the date as a quoted string.

DBTimeStamp($ts)

Format the timestamp $ts in the format the database accepts; this can be a Unix integer timestamp or an ISO format Y-m-d H:i:s. Uses the fmtTimeStamp field, which holds the format to use. If null or false or '' is passed in, it will be converted to an SQL null.

Returns the timestamp as a quoted string.

qstr($s,[$magic_quotes_enabled=false])

Quotes a string to be sent to the database. The $magic_quotes_enabled parameter may look funny, but the idea is if you are quoting a string extracted from a POST/GET variable, then pass get_magic_quotes_gpc() as the second parameter. This will ensure that the variable is not quoted twice, once by qstr and once by the magic_quotes_gpc.

Eg. $s = $db->qstr(HTTP_GET_VARS['name'],get_magic_quotes_gpc());

Returns the quoted string.

Quote($s)

Quotes the string, automatically checking get_magic_quotes_gpc() first. If get_magic_quotes_gpc() is set, then we do not quote the string.

Affected_Rows( )

Returns the number of rows affected by a update or delete statement. Returns false if function not supported.

Not supported by interbase/firebird currently.

Insert_ID( )

Returns the last autonumbering ID inserted. Returns false if function not supported.

Only supported by databases that support auto-increment or object id's, such as PostgreSQL, MySQL and MSSQL currently. PostgreSQL returns the OID, which can change on a database reload. This function might only give accurate results if you perform it in a transaction if you are using persistent connections. This is because the connection you are assigned for one Execute( ) might differ from the next Execute( ).

MetaDatabases()

Returns a list of databases available on the server as an array. You have to connect to the server first. Only available for ODBC, MySQL and ADO.

MetaTables()

Returns an array of tables and views for the current database as an array. The array should exclude system catalog tables if possible.

MetaColumns($table)

Returns an array of ADOFieldObject's, one field object for every column of $table. Currently Sybase does not recognise date types, and ADO cannot identify the correct data type (so we default to varchar)..

MetaColumnNames($table)

Returns an array of column names for $table.

## ADORecordSet

When an SQL statement successfully is executed by ADOConnection->Execute($sql),an ADORecordSet object is returned. This object contains a virtual cursor so we can move from row to row, functions to obtain information about the columns and column types, and helper functions to deal with formating the results to show to the user.

### ADORecordSet Fields

fields: Array containing the current row. This is not associative, but is an indexed array from 0 to columns-1. See also the function Fields, which behaves like an associative array.

dataProvider: The underlying mechanism used to connect to the database. Normally set to native, unless using odbc or ado.

blobSize: Maximum size of a char, string or varchar object before it is treated as a Blob (Blob's should be shown with textarea's). See the MetaType function.

sql: Holds the sql statement used to generate this record set.

canSeek: Set to true if Move( ) function works.

EOF: True if we have scrolled the cursor past the last record.

### ADORecordSet Functions

ADORecordSet( )

Constructer. Normally you never call this function yourself.

GetAssoc([$force_array])

Generates an associative array from the recordset if the number of columns is greater than 2. The array is generated from the current cursor position till EOF. The first column of the recordset becomes the key to the rest of the array. If the columns is equal to two, then the key directly maps to the value unless $force_array is set to true, when an array is created for each key. Inspired by PEAR's getAssoc.

Example:

We have the following data in a recordset:

row1: Apple, Fruit, Edible
row2: Cactus, Plant, Inedible
row3: Rose, Flower, Edible

GetAssociation will generate the following associative array:

Apple => [Fruit, Edible]
Cactus => [Plant, Inedible]
Rose => [Flower,Edible]

Returns:

The associative array, or false if an error occurs.

GetArray([$number_of_rows])

Generate an array of records from the current cursor position, indexed from 0 to $number_of_rows - 1. If $number_of_rows is undefined, till EOF.

GetRows([$number_of_rows])

Generate an array of records from the current cursor position. Synonym for GetArray() for compatibility with Microsoft ADO.

GetMenu($name, [$default_str=''], [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])

Generate a HTML menu (<select><option><option></select>). The first column of the recordset (fields[0]) will hold the string to display in the option tags. If the recordset has more than 1 column, the second column (fields[1]) is the value to send back to the web server.. The menu will be given the name $name.

If $default_str is defined, then if $default_str == fields[0], that field is selected. If $blank1stItem is true, the first option is empty. $Default_str can be array for a multiple select listbox.

To get a listbox, set the $size to a non-zero value (or pass $default_str as an array). If $multiple_select is true then a listbox will be generated with $size items (or if $size==0, then 5 items) visible, and we will return an array to a server. Lastly use $moreAttr to add additional attributes such as javascript or styles.

Menu Example 1: `GetMenu('menu1','A',true)` will generate a menu:
for the data (A,1), (B,2), (C,3). Also see example 5.

Menu Example 2: For the same data, `GetMenu('menu1',array('A','B'),false)` will generate a menu with both A and B selected:

GetMenu2($name, [$default_str=''], [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])

This is nearly identical to GetMenu, except that the $default_str is matched to fields[1] (the option values).

Menu Example 3: Given the data in menu example 2, `GetMenu2('menu1',array('1','2'),false)` will generate a menu with both A and B selected in menu example 2, but this time the selection is based on the 2nd column, which holds the values to return to the Web server.

UserDate($str, [$fmt])

Converts the date string $str to another format.UserDate calls UnixDate to parse $str, and $fmt defaults to Y-m-d if not defined.

UserTimeStamp($str, [$fmt])

Converts the timestamp string $str to another format. The timestamp format is Y-m-d H:i:s, as in '2002-02-28 23:00:12'. UserTimeStamp calls UnixTimeStamp to parse $str, and $fmt defaults to Y-m-d H:i:s if not defined.

UnixDate($str)

Parses the date string $str and returns it in unix mktime format (eg. a number indicating the seconds after January 1st, 1970). Expects the date to be in Y-m-d H:i:s format, except for Sybase and Microsoft SQL Server, where M d Y is also accepted (the 3 letter month strings are controlled by a global array, which might need localisation).

This function is available in both ADORecordSet and ADOConnection since 1.91.

UnixTimeStamp($str)

Parses the timestamp string $str and returns it in unix mktime format (eg. a number indicating the seconds after January 1st, 1970). Expects the date to be in Y-m-d H:i:s format, except for Sybase and Microsoft SQL Server, where M d Y h:i:sA is also accepted (the 3 letter month strings are controlled by a global array, which might need localisation).

This function is available in both ADORecordSet and ADOConnection since 1.91.

OffsetDate($dayFraction, $basedate=false)

Allows you to calculate future and past dates based on $basedate in a portable fashion. If $basedate is not defined, then the current date (at 12 midnight) is used. Returns the SQL string that performs the calculation when passed to Execute().

For example, in Oracle, to find the date and time that is 2.5 days from today, you can use:

    # get date one week from now
    $fld = $conn->OffsetDate(7); // returns "(trunc(sysdate)+7")

    # get date and time that is 60 hours from current date and time
    $fld = $conn->OffsetDate(2.5, $conn->sysTimeStamp);	// returns "(sysdate+2.5)"

    $conn->Execute("UPDATE TABLE SET dodate=$fld WHERE ID=$id");

This function is available for mysql, mssql, oracle, oci8 and postgresql drivers since 2.13. It might work with other drivers provided they allow performing numeric day arithmetic on dates.

MoveNext( )

Move the internal cursor to the next row. The fields array is automatically updated. Return false if unable to do so, otherwise true.

Example:

    $rs = $db->Execute($sql);
    if ($rs)
    	while (!$rs->EOF) {
     		ProcessArray($rs->fields);
    		$rs->MoveNext();
    	}

Move($to)

Moves the internal cursor to a specific row $to. Rows are zero-based eg. 0 is the first row. The fields array is automatically updated. For databases that do not support scrolling internally, ADOdb will simulate forward scrolling. Some databases do not support backward scrolling. If the $to position is after the EOF, $to will move to the end of the RecordSet for most databases. Some obscure databases using odbc might not behave this way.

Note: This function uses absolute positioning, unlike Microsoft's ADO.

Returns true or false. If false, the internal cursor is not moved in most implementations, so AbsolutePosition( ) will return the last cursor position before the Move( ).

MoveFirst()

Internally calls Move(0). Note that some databases do not support this function.

MoveLast()

Internally calls Move(RecordCount()-1). Note that some databases do not support this function.

GetRowAssoc($toUpper=true)

The above function is no longer the prefered way of getting associative arrays. Use the $ADODB_FETCH_MODE variable instead.

Returns an associative array containing the current row. The keys to the array are the column names. The column names are upper-cased for easy access. To get the next row, you will still need to call MoveNext().

For example:
Array ( [ID] => 1 [FIRSTNAME] => Caroline [LASTNAME] => Miranda [CREATED] => 2001-07-05 )

Note: do not use GetRowAssoc() with $ADODB_FETCH_MODE = ADODB_FETCH_ASSOC. Because they have the same functionality, they will interfere with each other.

AbsolutePage($page=-1)

Returns the current page. Requires PageExecute()/CachePageExecute() to be called. See Example 8.

AtFirstPage($status='')

Returns true if at first page (1-based). Requires PageExecute()/CachePageExecute() to be called. See Example 8.

AtLastPage($status='')

Returns true if at last page (1-based). Requires PageExecute()/CachePageExecute() to be called. See Example 8.

Fields($colname)

This function is deprecated. Use $ADODB_FETCH_MODE instead.

Some database extensions (eg. MySQL) return arrays that are both associative and indexed if you use the native extensions. GetRowAssoc() does not return arrays that combine associative and indexed elements. Returns the value of the associated column $colname for the current row. The column name is case-insensitive.

FetchRow()

Returns array containing current row, or false if EOF. FetchRow( ) internally moves to the next record after returning the current row.

Warning: Do not mix using FetchRow() with MoveNext().

Usage:

    $rs = $db->Execute($sql);
    if ($rs)
    	while ($arr = $rs->FetchRow()) {
    	     # process $arr
    	}

FetchInto(&$array)

Sets $array to the current row. Returns PEAR_Error object if EOF, 1 if ok (DB_OK constant). If PEAR is undefined, false is returned when EOF. FetchInto( ) internally moves to the next record after returning the current row.

FetchRow() is easier to use. See above.

FetchField($column_number)

Returns an object containing the name, type and max_length of the associated field. If the max_length cannot be determined reliably, it will be set to -1. The column numbers are zero-based. See example 2.

FieldCount( )

Returns the number of fields (columns) in the record set.

RecordCount( )

Returns the number of rows in the record set. If the number of records returned cannot be determined from the database driver API, we will buffer all rows and return a count of the rows after all the records have been retrieved. This buffering can be disabled (for performance reasons) by setting the global variable $ADODB_COUNTRECS = false. When disabled, RecordCount( ) will return -1 for certain databases. See the supported databases list above for more details.

RowCount is a synonym for RecordCount.

PO_RecordCount($table, $where)

Returns the number of rows in the record set. If the database does not support this, it will perform a SELECT COUNT(*) on the table $table, with the given $where condition to return an estimate of the recordset size.

$numrows = $rs->PO_RecordCount("articles_table", "group=$group");

FetchObject($toupper=true)

Returns the current row as an object. If you set $toupper to true, then the object fields are set to upper-case. Note: The newer FetchNextObject() is the recommended way of accessing rows as objects. See below.

FetchNextObject($toupper=true)

Gets the current row as an object and moves to the next row automatically. Returns false if at end-of-file. If you set $toupper to true, then the object fields are set to upper-case.

    $rs = $db->Execute('select firstname,lastname from table');
    if ($rs) {
    	while ($o = $rs->FetchNextObject()) {
    		print "$o->FIRSTNAME, $o->LASTNAME<BR>";
    	}
    }

There is some trade-off in speed in using FetchNextObject(). If performance is important, you should access rows with the `fields[]` array.

CurrentRow( )

Returns the current row of the record set. 0 is the first row.

AbsolutePosition( )

Synonym for CurrentRow for compatibility with ADO. Returns the current row of the record set. 0 is the first row.

MetaType($nativeDBType[,$field_max_length],[$fieldobj])

Determine what generic meta type a database field type is given its native type $nativeDBType and the length of the field $field_max_length. Note that field_max_length can be -1 if it is not known. The field object returned by the database driver can be passed in $fieldobj. This is useful for databases such as mysql which has additional properties in the field object such as primary_key.

Uses the field blobSize and compares it with $field_max_length to determine whether the character field is actually a blob.

Returns:

- C: Character fields that should be shown in a <input type="text"> tag.
- X: Clob (character large objects), or large text fields that should be shown in a <textarea>
- D: Date field
- T: Timestamp field
- L: Logical field (boolean or bit-field)
- N: Numeric field. Includes decimal, numeric, floating point, and real.
- I: Integer field.
- R: Counter or Autoincrement field. Must be numeric.
- B: Blob, or binary large objects.

Close( )

Close the recordset.

### function rs2html($adorecordset,[$tableheader_attributes], [$col_titles])

This is a standalone function (rs2html = recordset to html) that is similar to PHP's odbc_result_all function, it prints a ADORecordSet, $adorecordset as a HTML table. $tableheader_attributes allow you to control the table cellpadding, cellspacing and border attributes. Lastly you can replace the database column names with your own column titles with the array $col_titles. This is designed more as a quick debugging mechanism, not a production table recordset viewer.

You will need to include the file tohtml.inc.php.

Example of rs2html:

    <?
    include('tohtml.inc.php'); # load code common to ADOdb
    include('adodb.inc.php'); # load code common to ADOdb
    $conn = &ADONewConnection('mysql');   # create a connection
    $conn->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
    $sql = 'select CustomerName, CustomerID from customers';
    $rs   = $conn->Execute($sql);
    rs2html($rs,'border=2 cellpadding=3',array('Customer Name','Customer ID'));
    ?>

### Differences between this ADOdb library and Microsoft ADO

1. ADOdb only supports recordsets created by a connection object. Recordsets cannot be created independently.
2. ADO properties are implemented as functions in ADOdb. This makes it easier to implement any enhanced ADO functionality in the future.
3. ADOdb's ADORecordSet->Move() uses absolute positioning, not relative. Bookmarks are not supported.
4. ADORecordSet->AbsolutePosition() cannot be used to move the record cursor.
5. ADO Parameter objects are not supported. Instead we have the ADOConnection::Parameter( ) function, which provides a simpler interface for calling preparing parameters and calling stored procedures.
6. Recordset properties for paging records are available, but implemented as in Example 8.

# Database Driver Guide

This describes how to create a class to connect to a new database. To ensure there is no duplication of work, kindly email me at jlim#natsoft.com.my if you decide to create such a class.

First decide on a name in lower case to call the database type. Let's say we call it xbase.

Then we need to create two classes ADOConnection_xbase and ADORecordSet_xbase in the file adodb-xbase.inc.php.

The simplest form of database driver is an adaptation of an existing ODBC driver. Then we just need to create the class ADOConnection_xbase extends ADOConnection_odbc to support the new date and timestamp formats, the concatenation operator used, true and false. For the ADORecordSet_xbase extends ADORecordSet_odbc we need to change the MetaType function. See adodb-vfp.inc.php as an example.

More complicated is a totally new database driver that connects to a new PHP extension. Then you will need to implement several functions. Fortunately, you do not have to modify most of the complex code. You only need to override a few stub functions. See adodb-mysql.inc.php for example.

The default date format of ADOdb internally is YYYY-MM-DD (Ansi-92). All dates should be converted to that format when passing to an ADOdb date function. See Oracle for an example how we use ALTER SESSION to change the default date format in _pconnect _connect.

ADOConnection Functions to Override

Defining a constructor for your ADOConnection derived function is optional. There is no need to call the base class constructor.

_connect: Low level implementation of Connect. Returns true or false. Should set the _connectionID.

_pconnect: Low level implemention of PConnect. Returns true or false. Should set the _connectionID.

_query: Execute a query. Returns the queryID, or false.

_close: Close the connection -- PHP should clean up all recordsets.

ErrorMsg: Stores the error message in the private variable _errorMsg.

The ADOConnection functions BeginTrans( ), CommitTrans( ), RollbackTrans( ) are reserved for future expansion.

ADOConnection Fields to Set

_bindInputArray: Set to true if binding of parameters for SQL inserts and updates is allowed using ?, eg. as with ODBC.

fmtDate

fmtTimeStamp

true

false

concat_operator

replaceQuote

hasLimit support SELECT * FROM TABLE LIMIT 10 of MySQL.

hasTop support Microsoft style SELECT TOP 10 * FROM TABLE.

ADORecordSet Functions to Override

You will need to define a constructor for your ADORecordSet derived class that calls the parent class constructor.

FetchField: as documented above in ADORecordSet

_initrs: low level initialization of the recordset: setup the _numOfRows and _numOfFields fields -- called by the constructor.

_seek: seek to a particular row. Do not load the data into the fields array. This is done by _fetch. Returns true or false. Note that some implementations such as Interbase do not support seek. Set canSeek to false.

_fetch: fetch a row using the database extension function and then move to the next row. Sets the fields array. If the parameter $ignore_fields is true then there is no need to populate the fields array, just move to the next row. then Returns true or false.

_close: close the recordset

Fields: If the array row returned by the PHP extension is not an associative one, you will have to override this. See adodb-odbc.inc.php for an example. For databases such as MySQL and MSSQL where an associative array is returned, there is no need to override this function.

ADOConnection Fields to Set

canSeek: Set to true if the _seek function works.

## ToDo:

See the RoadMap article.

Also see the ADOdb proxy article for bridging Windows and Unix databases using http remote procedure calls. For your education, visit palslib.com for database info, and read this article on Optimizing PHP.

## Change Log

2.30 1 Aug 2002

Added pivottable.inc.php. Thanks to daniel.lucazeau#ajornet.com for the original concept.

Added ADOConnection::outp($msg,$newline) to output error and debugging messages. Now you can override this using the ADODB_OUTP constant and use your own output handler.

Changed == to === for 'null' comparison. Reported by ericquil#yahoo.com

Fixed mssql SelectLimit( ) bug when distinct used.

2.30 1 Aug 2002

New GetCol() and CacheGetCol() from ross#bnw.com that returns the first field as a 1 dim array.

We have an empty recordset, but RecordCount() could return -1. Fixed. Reported by "Jonathan Polansky" jonathan#polansky.com.

We now check for session variable changes using strlen($sessval).crc32($sessval). Formerly we only used crc32().

Informix SelectLimit() problem with $ADODB_COUNTRECS fixed.

Fixed informix SELECT FIRST x DISTINCT, and not SELECT DISTINCT FIRST x - reported by F Riosa

Now default adodb error handlers ignores error if @ used.

If you set $conn->autoRollback=true, we auto-rollback persistent connections for odbc, mysql, oci8, mssql. Default for autoRollback is false. No need to do so for postgres. As interbase requires a transaction id (what a flawed api), we don't do it for interbase.

Changed PageExecute() to use non-greedy preg_match when searching for "FROM" keyword.

2.20 9 July 2002

Added CacheGetOne($secs2cache,$sql), CacheGetRow($secs2cache,$sql), CacheGetAll($secs2cache,$sql).

Added $conn->OffsetDate($dayFraction,$date=false) to generate sql that calcs date offsets. Useful for scheduling appointments.

Added connection properties: leftOuter, rightOuter that hold left and right outer join operators.

Added connection property: ansiOuter to indicate whether ansi outer joins supported.

New driver mssqlpo, the portable mssql driver, which converts string concat operator from || to +.

Fixed ms access bug - SelectLimit() did not support ties - fixed.

Karsten Kraus (Karsten.Kraus#web.de), contributed error-handling code to ADONewConnection. Unfortunately due to backward compat problems, had to rollback most of the changes.

Added new parameter to GetAssoc() to allow returning an array of key-value pairs, ignoring any additional columns in the recordset. Off by default.

Corrected mssql $conn->sysDate to return only date using convert().

CacheExecute() improved debugging output.

Changed rs2html() so newlines are converted to BR tags. Also optimized rs2html() based on feedback by "Jerry Workman" jerry#mtncad.com.

Added support for Replace() with Interbase, using DELETE and INSERT.

Some minor optimizations (mostly removing & references when passing arrays).

Changed GenID() to allows id's larger than the size of an integer.

Added force_session property to oci8 for better updateblob() support.

Fixed PageExecute() which did not work properly with sql containing GROUP BY.

2.12 12 June 2002

Added toexport.inc.php to export recordsets in CSV and tab-delimited format.

CachePageExecute() does not work - fixed - thx John Huong.

Interbase aliases not set properly in FetchField() - fixed. Thx Stefan Goethals.

Added cache property to adodb pager class. The number of secs to cache recordsets.

SQL rewriting bug in pageexecute() due to skipping of newlines due to missing /s modifier. Fixed.

Max size of cached recordset due to a bug was 256000 bytes. Fixed.

Speedup of 1st invocation of CacheExecute() by tuning code.

We compare $rewritesql with $sql in pageexecute code in case of rewrite failure.

2.11 7 June 2002

Fixed PageExecute() rewrite sql problem - COUNT(*) and ORDER BY don't go together with mssql, access and postgres. Thx to Alexander Zhukov alex#unipack.ru

DB2 support for CHARACTER type added - thx John Huong huongch#bigfoot.com

For ado, $argProvider not properly checked. Fixed - kalimero#ngi.it

Added $conn->Replace() function for update with automatic insert if the record does not exist. Supported by all databases except interbase.

2.10 4 June 2002

Added uniqueSort property to indicate mssql ORDER BY cols must be unique.

Optimized session handler by crc32 the data. We only write if session data has changed.

adodb_sess_read in adodb-session.php now returns ''correctly - thanks to Jorma Tuomainen, webmaster#wizactive.com

Mssql driver did not throw EXECUTE errors correctly because ErrorMsg() and ErrorNo() called in wrong order. Pointed out by Alexios Fakos. Fixed.

Changed ado to use client cursors. This fixes BeginTran() problems with ado.

Added handling of timestamp type in ado.

Added to ado_mssql support for insert_id() and affected_rows().

Added support for mssql.datetimeconvert=0, available since php 4.2.0.

Made UnixDate() less strict, so that the time is ignored if present.

Changed quote() so that it checks for magic_quotes_gpc.

Changed maxblobsize for odbc to default to 64000.

2.00 13 May 2002

Added drivers informix72 for pre-7.3 versions, and oci805 for oracle 8.0.5, and postgres64 for postgresql 6.4 and earlier. The postgres and postgres7 drivers are now identical.

Interbase now partially supports ADODB_FETCH_BOTH, by defaulting to ASSOC mode.

Proper support for blobs in mssql. Also revised blob support code is base class. Now UpdateBlobFile() calls UpdateBlob() for consistency.

Added support for changed odbc_fetch_into api in php 4.2.0 with $conn->_has_stupid_odbc_fetch_api_change.

Fixed spelling of tablock locking hint in GenID( ) for mssql.

Added RowLock( ) to several databases, including oci8, informix, sybase, etc. Fixed where error in mssql RowLock().

Added sysDate and sysTimeStamp properties to most database drivers. These are the sql functions/constants for that database that return the current date and current timestamp, and are useful for portable inserts and updates.

Support for RecordCount() caused date handling in sybase and mssql to break. Fixed, thanks to Toni Tunkkari, by creating derived classes for ADORecordSet_array for both databases. Generalized using arrayClass property. Also to support RecordCount(), changed metatype handling for ado drivers. Now the type returned in FetchField is no longer a number, but the 1-char data type returned by MetaType. At the same time, fixed a lot of date handling. Now mssql support dmy and mdy date formats. Also speedups in sybase and mssql with preg_match and ^ in date/timestamp handling. Added support in sybase and mssql for 24 hour clock in timestamps (no AM/PM).

Extensive revisions to informix driver - thanks to Samuel CARRIERE samuel_carriere#hotmail.com

Added $ok parameter to CommitTrans($ok) for easy rollbacks.

Fixed odbc MetaColumns and MetaTables to save and restore $ADODB_FETCH_MODE.

Some odbc drivers did not call the base connection class constructor. Fixed.

Fixed regex for GetUpdateSQL() and GetInsertSQL() to support more legal character combinations.

1.99 21 April 2002

Added emulated RecordCount() to all database drivers if $ADODB_COUNTRECS = true (which it is by default). Inspired by Cristiano Duarte (cunha17#uol.com.br).

Unified stored procedure support for mssql and oci8. Parameter() and PrepareSP() functions implemented.

Added support for SELECT FIRST in informix, modified hasTop property to support this.

Changed csv driver to handle updates/deletes/inserts properly (when Execute() returns true). Bind params also work now, and raiseErrorFn with csv driver. Added csv driver to QA process.

Better error checking in oci8 UpdateBlob() and UpdateBlobFile().

Added TIME type to MySQL - patch by Manfred h9125297#zechine.wu-wien.ac.at

Prepare/Execute implemented for Interbase/Firebird

Changed some regular expressions to be anchored by /^ $/ for speed.

Added UnixTimeStamp() and UnixDate() to ADOConnection(). Now these functions are in both ADOConnection and ADORecordSet classes.

Empty recordsets were not cached - fixed.

Thanks to Gaetano Giunta (g.giunta#libero.it) for the oci8 code review. We didn't agree on everything, but i hoped we agreed to disagree!

1.90 6 April 2002

Now all database drivers support fetch modes ADODB_FETCH_NUM and ADODB_FETCH_ASSOC, though still not fully tested. Eg. Frontbase, Sybase, Informix.

NextRecordSet() support for mssql. Contributed by "Sven Axelsson" sven.axelsson#bokochwebb.se

Added blob support for SQL Anywhere. Contributed by Wade Johnson wade#wadejohnson.de

Fixed some security loopholes in server.php. Server.php also supports fetch mode.

Generalized GenID() to support odbc and mssql drivers. Mssql no longer generates GUID's.

Experimental RowLock($table,$where) for mssql.

Properly implemented Prepare() in oci8 and ODBC.

Added Bind() support to oci8 to support Prepare().

Improved error handler. Catches CacheExecute() and GenID() errors now.

Now if you are running php from the command line, debugging messages do not output html formating. Not 100% complete, but getting there.

1.81 22 March 2002

Restored default $ADODB_FETCH_MODE = ADODB_FETCH_DEFAULT for backward compatibility.

SelectLimit for oci8 improved - Our FIRST_ROWS optimization now does not overwrite existing hint.

New Sybase SQL Anywhere driver. Contributed by Wade Johnson wade#wadejohnson.de

1.80 15 March 2002

Redesigned directory structure of ADOdb files. Added new driver directory where all database drivers reside.

Changed caching algorithm to create subdirectories. Now we scale better.

Informix driver now supports insert_id(). Contribution by "Andrea Pinnisi" pinnisi#sysnet.it

Added experimental ISO date and FetchField support for informix.

Fixed a quoting bug in Execute() with bind parameters, causing problems with blobs.

Mssql driver speedup by 10-15%.

Now in CacheExecute($secs2cache,$sql,...), $secs2cache is optional. If missing, it will take the value defined in $connection->cacheSecs (default is 3600 seconds). Note that CacheSelectLimit(), the secs2cache is still compulsory - sigh.

Sybase SQL Anywhere driver (using ODBC) contributed by Wade Johnson wade#wadejohnson.de

1.72 8 March 2002

Added @ when returning Fields() to prevent spurious error - "Michael William Miller" mille562#pilot.msu.edu

MetaDatabases() for postgres contributed by Phil pamelant#nerim.net

Mitchell T. Young (mitch#youngfamily.org) contributed informix driver.

Fixed rs2html() problem. I cannot reproduce, so probably a problem with pre PHP 4.1.0 versions, when supporting new ADODB_FETCH_MODEs.

Mattia Rossi (mattia#technologist.com) contributed BlobDecode() and UpdateBlobFile() for postgresql using the postgres specific pg_lo_import()/pg_lo_open() - i don't use them but hopefully others will find this useful. See this posting for an example of usage.

Added UpdateBlobFile() for uploading files to a database.

Made UpdateBlob() compatible with oci8po driver.

Added noNullStrings support to oci8 driver. Oracle changes all ' ' strings to nulls, so you need to set strings to ' ' to prevent the nullifying of strings. $conn->noNullStrings = true; will do this for you automatically. This is useful when you define a char column as NOT NULL.

Fixed UnixTimeStamp() bug - wasn't setting minutes and seconds properly. Patch from Agusti Fita i Borrell agusti#anglatecnic.com.

Toni Tunkkari added patch for sybase dates. Problem with spaces in day part of date fixed.

1.71 18 Jan 2002

Sequence start id support. Now $conn->Gen_ID('seqname', 50) to start sequence from 50.

CSV driver fix for selectlimit, from Andreas - akaiser#vocote.de.

Gam3r spotted that a global variable was undefined in the session handler.

Mssql date regex had error. Fixed - reported by Minh Hoang vb_user#yahoo.com.

DBTimeStamp() and DBDate() now accept iso dates and unix timestamps. This means that the PostgreSQL handling of dates in GetInsertSQL() and GetUpdateSQL() can be removed. Also if these functions are passed '' or null or false, we return a SQL null.

GetInsertSQL() and GetUpdateSQL() now accept a new parameter, $magicq to indicate whether quotes should be inserted based on magic quote settings - suggested by dj#4ict.com.

Reformated docs slightly based on suggestions by Chris Small.

1.65 28 Dec 2001

Fixed borland_ibase class naming bug.

Now instead of using $rs->fields[0] internally, we use reset($rs->fields) so that we are compatible with ADODB_FETCH_ASSOC mode. Reported by Nico S.

Changed recordset constructor and _initrs() for oci8 so that it returns the field definitions even if no rows in the recordset. Reported by Rick Hickerson (rhickers#mv.mv.com).

Improved support for postgresql in GetInsertSQL and GetUpdateSQL by "mike" mike#partner2partner.com and "Ryan Bailey" rebel#windriders.com

1.64 20 Dec 2001

Danny Milosavljevic <danny.milo#gmx.net> added some patches for MySQL error handling and displaying default values.

Fixed some ADODB_FETCH_BOTH inconsistencies in odbc and interbase.

Added more tests to test suite to cover ADODB_FETCH_* and ADODB_ERROR_HANDLER.

Added firebird (ibase) driver

Added borland_ibase driver for interbase 6.5

1.63 13 Dec 2001

Absolute to the adodb-lib.inc.php file not set properly. Fixed.

1.62 11 Dec 2001

Major speedup of ADOdb for low-end web sites by reducing the php code loading and compiling cycle. We conditionally compile not so common functions. Moved csv code to adodb-csvlib.inc.php to reduce adodb.inc.php parsing. This file is loaded only when the csv/proxy driver is used, or CacheExecute() is run. Also moved PageExecute(), GetSelectSQL() and GetUpdateSQL() core code to adodb-lib.inc.php. This reduced the 70K main adodb.inc.php file to 55K, and since at least 20K of the file is comments, we have reduced 50K of code in adodb.inc.php to 35K. There should be 35% reduction in memory and thus 35% speedup in compiling the php code for the main adodb.inc.php file.

Highly tuned SelectLimit() for oci8 for massive speed improvements on large files. Selecting 20 rows starting from the 20,000th row of a table is now 7 times faster. Thx to Tomas V V Cox.

Allow . and # in table definitions in GetInsertSQL and GetUpdateSQL. See ADODB_TABLE_REGEX constant. Thx to Ari Kuorikoski.

Added ADODB_PREFETCH_ROWS constant, defaulting to 10. This determines the number of records to prefetch in a SELECT statement. Only used by oci8.

Added high portability Oracle class called oci8po. This uses ? for bind variables, and lower cases column names.

Now all database drivers support $ADODB_FETCH_MODE, including interbase, ado, and odbc: ADODB_FETCH_NUM and ADODB_FETCH_ASSOC. ADODB_FETCH_BOTH is not fully implemented for all database drivers.

1.61 Nov 2001

Added PO_RecordCount() and PO_Insert_ID(). PO stands for portable. Pablo Roca [pabloroca#mvps.org]

GenID now returns 0 if not available. Safer is that you should check $conn->hasGenID for availability.

M'soft ADO we now correctly close recordset in _close() peterd#telephonetics.co.uk

MSSQL now supports GenID(). It generates a 16-byte GUID from mssql newid() function.

Changed ereg_replace to preg_replace in SelectLimit. This is a fix for mssql. Ereg doesn't support t or n! Reported by marino Carlos xaplo#postnuke-espanol.org

Added $recordset->connection. This is the ADOConnection object for the recordset. Works with cached and normal recordsets. Surprisingly, this had no affect on performance!

1.54 15 Nov 2001

Fixed some more bugs in PageExecute(). I am getting sick of bug in this and will have to reconsider my QA here. The main issue is that I don't use PageExecute() and to check whether it is working requires a visual inspection of the html generated currently. It is possible to write a test script but it would be quite complicated :(

More speedups of SelectLimit() for DB2, Oci8, access, vfp, mssql.

1.53 7 Nov 2001

Added support for ADODB_FETCH_ASSOC for ado and odbc drivers.

Tuned GetRowAssoc(false) in postgresql and mysql.

Stephen Van Dyke contributed ADOdb icon, accepted with some minor mods.

Enabled Affected_Rows() for postgresql

Speedup for Concat() using implode() - Benjamin Curtis ben_curtis#yahoo.com

Fixed some more bugs in PageExecute() to prevent infinite loops

1.52 5 Nov 2001

Spelling error in CacheExecute() caused it to fail. $ql should be $sql in line 625!

Added fixes for parsing [ and ] in GetUpdateSQL().

1.51 5 Nov 2001

Oci8 SelectLimit() speedup by using OCIFetch().

Oci8 was mistakenly reporting errors when $db->debug = true.

If a connection failed with ODBC, it was not correctly reported - fixed.

_connectionID was inited to -1, changed to false.

Added $rs->FetchRow(), to simplify API, ala PEAR DB

Added PEAR DB compat mode, which is still faster than PEAR! See adodb-pear.inc.php.

Removed postgres pconnect debugging statement.

1.50 31 Oct 2001

ADOdbConnection renamed to ADOConnection, and ADOdbFieldObject to ADOFieldObject.

PageExecute() now checks for empty $rs correctly, and the errors in the docs on this subject have been fixed.

odbc_error() does not return 6 digit error correctly at times. Implemented workaround.

Added ADORecordSet_empty class. This will speedup INSERTS/DELETES/UPDATES because the return object created is much smaller.

Added Prepare() to odbc, and oci8 (but doesn't work properly for oci8 still).

Made pgsql a synonym for postgre7, and changed SELECT LIMIT to use OFFSET for compat with postgres 7.2.

Revised adodb-cryptsession.php thanks to Ari.

Set resources to false on _close, to force freeing of resources.

Added adodb-errorhandler.inc.php, adodb-errorpear.inc.php and raiseErrorFn on Freek's urging.

GetRowAssoc($toUpper=true): $toUpper added as default.

Errors when connecting to a database were not captured formerly. Now we do it correctly.

1.40 19 September 2001

PageExecute() to implement page scrolling added. Code and idea by Iván Oliva.

Some minor postgresql fixes.

Added sequence support using GenID() for postgresql, oci8, mysql, interbase.

Added UpdateBlob support for interbase (untested).

Added encrypted sessions (see adodb-cryptsession.php). By Ari Kuorikoski <kuoriari#finebyte.com>

1.31 21 August 2001

Many bug fixes thanks to "GaM3R (Cameron)" <gamr#outworld.cx>. Some session changes due to Gam3r.

Fixed qstr() to quote also.

rs2html() now pretty printed.

Jonathan Younger jyounger#unilab.com contributed the great idea GetUpdateSQL() and GetInsertSQL() which generates SQL to update and insert into a table from a recordset. Modify the recordset fields array, then can this function to generate the SQL (the SQL is not executed).

"Nicola Fankhauser" <nicola.fankhauser#couniq.com> found some bugs in date handling for mssql.

Added minimal Oracle support for LOBs. Still under development.

Added $ADODB_FETCH_MODE so you can control whether recordsets return arrays which are numeric, associative or both. This is a global variable you set. Currently only MySQL, Oci8, Postgres drivers support this.

PostgreSQL properly closes recordsets now. Reported by several people.

Added UpdateBlob() for Oracle. A hack to make it easier to save blobs.

Oracle timestamps did not display properly. Fixed.

1.20 6 June 2001

Now Oracle can connect using tnsnames.ora or server and service name

Extensive Oci8 speed optimizations. Oci8 code revised to support variable binding, and /*+ FIRST_ROWS */ hint.

Worked around some 4.0.6 bugs in odbc_fetch_into().

Paolo S. Asioli paolo.asioli#libero.it suggested GetRowAssoc().

Escape quotes for oracle wrongly set to '. Now '' is used.

Variable binding now works in ODBC also.

Jumped to version 1.20 because I don't like 13 :-)

1.12 6 June 2001

Changed $ADODB_DIR to ADODB_DIR constant to plug a security loophole.

Changed _close() to close persistent connections also. Prevents connection leaks.

Major revision of oracle and oci8 drivers. Added OCI_RETURN_NULLS and OCI_RETURN_LOBS to OCIFetchInto(). BLOB, CLOB and VARCHAR2 recognition in MetaType() improved. MetaColumns() returns columns in correct sort order.

Interbase timestamp input format was wrong. Fixed.

1.11 20 May 2001

Improved file locking for Windows.

Probabilistic flushing of cache to avoid avalanche updates when cache timeouts.

Cached recordset timestamp not saved in some scenarios. Fixed.

1.10 19 May 2001

Added caching. CacheExecute() and CacheSelectLimit().

Added csv driver. See http://php.weblogs.com/ADODB_csv.

Fixed SelectLimit(), SELECT TOP not working under certain circumstances.

Added better Frontbase support of MetaTypes() by Frank M. Kromann.

1.01 24 April 2001

Fixed SelectLimit bug. not quoted properly.

SelectLimit: SELECT TOP -1 * FROM TABLE not support by Microsoft. Fixed.

GetMenu improved by glen.davies#cce.ac.nz to support multiple hilited items

FetchNextObject() did not work with only 1 record returned. Fixed bug reported by $tim#orotech.net

Fixed mysql field max_length problem. Fix suggested by Jim Nicholson (jnich#att.com)

1.00 16 April 2001

Given some brilliant suggestions on how to simplify ADOdb by akul. You no longer need to setup $ADODB_DIR yourself, and ADOLoadCode() is automatically called by ADONewConnection(), simplifying the startup code.

FetchNextObject() added. Suggested by Jakub Marecek. This makes FetchObject() obsolete, as this is more flexible and powerful.

Misc fixes to SelectLimit() to support Access (top must follow distinct) and Fields() in the array recordset. From Reinhard Balling.

0.96 27 Mar 2001

ADOConnection Close() did not return a value correctly. Thanks to akul#otamedia.com.

When the horrible magic_quotes is enabled, back-slash () is changed to double-backslash (\). This doesn't make sense for Microsoft/Sybase databases. We fix this in qstr().

Fixed Sybase date problem in UnixDate() thanks to Toni Tunkkari. Also fixed MSSQL problem in UnixDate() - thanks to milhouse31#hotmail.com.

MoveNext() moved to leaf classes for speed in MySQL/PostgreSQL. 10-15% speedup.

Added null handling in bindInputArray in Execute() -- Ron Baldwin suggestion.

Fixed some option tags. Thanks to john#jrmstudios.com.

0.95 13 Mar 2001

Added postgres7 database driver which supports LIMIT and other version 7 stuff in the future.

Added SelectLimit to ADOConnection to simulate PostgreSQL's "select * from table limit 10 offset 3". Added helper function GetArrayLimit() to ADORecordSet.

Fixed mysql metacolumns bug. Thanks to Freek Dijkstra (phpeverywhere#macfreek.com).

Also many PostgreSQL changes by Freek. He almost rewrote the whole PostgreSQL driver!

Added fix to input parameters in Execute for non-strings by Ron Baldwin.

Added new metatype, X for TeXt. Formerly, metatype B for Blob also included text fields. Now 'B' is for binary/image data. 'X' for textual data.

Fixed $this->GetArray() in GetRows().

Oracle and OCI8: 1st parameter is always blank -- now warns if it is filled.

Now hasLimit and hasTop added to indicate whether SELECT * FROM TABLE LIMIT 10 or SELECT TOP 10 * FROM TABLE are supported.

0.94 04 Feb 2001

Added ADORecordSet::GetRows() for compatibility with Microsoft ADO. Synonym for GetArray().

Added new metatype 'R' to represent autoincrement numbers.

Added ADORecordSet.FetchObject() to return a row as an object.

Finally got a Linux box to test PostgreSql. Many fixes.

Fixed copyright misspellings in 0.93.

Fixed mssql MetaColumns type bug.

Worked around odbc bug in PHP4 for sessions.

Fixed many documentation bugs (affected_rows, metadatabases, qstr).

Fixed MySQL timestamp format (removed comma).

Interbase driver did not call ibase_pconnect(). Fixed.

0.93 18 Jan 2002

Fixed GetMenu bug.

Simplified Interbase commit and rollback.

Default behaviour on closing a connection is now to rollback all active transactions.

Added field object handling for array recordset for future XML compatibility.

Added arr2html() to convert array to html table.

0.92 2 Jan 2002

Interbase Commit and Rollback should be working again.

Changed initialisation of ADORecordSet. This is internal and should not affect users. We are doing this to support cached recordsets in the future.

Implemented ADORecordSet_array class. This allows you to simulate a database recordset with an array.

Added UnixDate() and UnixTimeStamp() to ADORecordSet.

0.91 21 Dec 2000

Fixed ODBC so ErrorMsg() is working.

Worked around ADO unrecognised null (0x1) value problem in COM.

Added Sybase support for FetchField() type

Removed debugging code and unneeded html from various files

Changed to javadoc style comments to adodb.inc.php.

Added maxsql as synonym for mysqlt

Now ODBC downloads first 8K of blob by default

0.90 15 Nov 2000

Lots of testing of Microsoft ADO. Should be more stable now.

Added $ADODB_COUNTREC. Set to false for high speed selects.

Added Sybase support. Contributed by Toni Tunkkari (toni.tunkkari#finebyte.com). Bug in Sybase API: GetFields is unable to determine date types.

Changed behaviour of RecordSet.GetMenu() to support size parameter (listbox) properly.

Added emptyDate and emptyTimeStamp to RecordSet class that defines how to represent empty dates.

Added MetaColumns($table) that returns an array of ADOFieldObject's listing the columns of a table.

Added transaction support for PostgresSQL -- thanks to "Eric G. Werk" egw#netguide.dk.

Added adodb-session.php for session support.

0.80 30 Nov 2000

Added support for charSet for interbase. Implemented MetaTables for most databases. PostgreSQL more extensively tested.

0.71 22 Nov 2000

Switched from using require_once to include/include_once for backward compatability with PHP 4.02 and earlier.

0.70 15 Nov 2000

Calls by reference have been removed (call_time_pass_reference=Off) to ensure compatibility with future versions of PHP, except in Oracle 7 driver due to a bug in php_oracle.dll.

PostgreSQL database driver contributed by Alberto Cerezal (acerezalp#dbnet.es).

Oci8 driver for Oracle 8 contributed by George Fourlanos (fou#infomap.gr).

Added mysqlt database driver to support MySQL 3.23 which has transaction support.

Oracle default date format (DD-MON-YY) did not match ADOdb default date format (which is YYYY-MM-DD). Use ALTER SESSION to force the default date.

Error message checking is now included in test suite.

MoveNext() did not check EOF properly -- fixed.

0.60 Nov 8 2000

Fixed some constructor bugs in ODBC and ADO. Added ErrorNo function to ADOConnection class.

0.51 Oct 18 2000

Fixed some interbase bugs.

0.50 Oct 16 2000

Interbase commit/rollback changed to be compatible with PHP 4.03.

CommitTrans( ) will now return true if transactions not supported.

Conversely RollbackTrans( ) will return false if transactions not supported.

0.46 Oct 12

Many Oracle compatibility issues fixed.

0.40 Sept 26

Many bug fixes

Now Code for BeginTrans, CommitTrans and RollbackTrans is working. So is the Affected_Rows and Insert_ID. Added above functions to test.php.

ADO type handling was busted in 0.30. Fixed.

Generalised Move( ) so it works will all databases, including ODBC.

0.30 Sept 18

Renamed ADOLoadDB to ADOLoadCode. This is clearer.

Added BeginTrans, CommitTrans and RollbackTrans functions.

Added Affected_Rows() and Insert_ID(), _affectedrows() and _insertID(), ListTables(), ListDatabases(), ListColumns().

Need to add New_ID() and hasInsertID and hasAffectedRows, autoCommit

0.20 Sept 12

Added support for Microsoft's ADO.

Added new field to ADORecordSet -- canSeek

Added new parameter to _fetch($ignore_fields = false). Setting to true will not update fields array for faster performance.

Added new field to ADORecordSet/ADOConnection -- dataProvider to indicate whether a class is derived from odbc or ado.

Changed class ODBCFieldObject to ADOFieldObject -- not documented currently.

Added benchmark.php and testdatabases.inc.php to the test suite.

Added to ADORecordSet FastForward( ) for future high speed scrolling. Not documented.

Realised that ADO's Move( ) uses relative positioning. ADOdb uses absolute.

0.10 Sept 9 2000

First release