diff options
Diffstat (limited to 'framework/3rdParty/adodb/docs')
| -rw-r--r-- | framework/3rdParty/adodb/docs/docs-active-record.htm | 497 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/docs-adodb.htm | 3368 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/docs-oracle.htm | 542 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/old-changelog.htm | 822 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/readme.htm | 68 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/tips_portable_sql.htm | 362 | ||||
| -rw-r--r-- | framework/3rdParty/adodb/docs/tute.htm | 290 |
7 files changed, 5949 insertions, 0 deletions
diff --git a/framework/3rdParty/adodb/docs/docs-active-record.htm b/framework/3rdParty/adodb/docs/docs-active-record.htm new file mode 100644 index 00000000..c6820399 --- /dev/null +++ b/framework/3rdParty/adodb/docs/docs-active-record.htm @@ -0,0 +1,497 @@ +<html> +<style> +pre { + background-color: #eee; + padding: 0.75em 1.5em; + font-size: 12px; + border: 1px solid #ddd; +} + +li,p { +font-family: Arial, Helvetica, sans-serif ; +} +</style> +<title>ADOdb Active Record</title> +<body> +<h1>ADOdb Active Record</h1> +<p> (c) 2000-2006 John Lim (jlim#natsoft.com)</p> +<p><font size="1">This software is dual licensed using BSD-Style and LGPL. This + means you can use it in compiled proprietary and commercial products.</font></p> +<p><hr> +<ol> + +<h3><li>Introduction</h3> +<p> +ADOdb_Active_Record is an Object Relation Mapping (ORM) implementation using PHP. In an ORM system, the tables and rows of the database are abstracted into native PHP objects. This allows the programmer to focus more on manipulating the data and less on writing SQL queries. +<p> +This implementation differs from Zend Framework's implementation in the following ways: +<ul> +<li>Works with PHP4 and PHP5 and provides equivalent functionality in both versions of PHP.<p> +<li>ADOdb_Active_Record works when you are connected to multiple databases. Zend's only works when connected to a default database.<p> +<li>Support for $ADODB_ASSOC_CASE. The field names are upper-cased, lower-cased or left in natural case depending on this setting.<p> +<li>No field name conversion to camel-caps style, unlike Zend's implementation which will convert field names such as 'first_name' to 'firstName'.<p> +<li>New ADOConnection::GetActiveRecords() and ADOConnection::GetActiveRecordsClass() functions in adodb.inc.php.<p> +<li>Caching of table metadata so it is only queried once per table, no matter how many Active Records are created.<p> +<li>The additional functionality is described <a href=#additional>below</a>. +</ul> +<P> +ADOdb_Active_Record is designed upon the principles of the "ActiveRecord" design pattern, which was first described by Martin Fowler. The ActiveRecord pattern has been implemented in many forms across the spectrum of programming languages. ADOdb_Active_Record attempts to represent the database as closely to native PHP objects as possible. +<p> +ADOdb_Active_Record maps a database table to a PHP class, and each instance of that class represents a table row. Relations between tables can also be defined, allowing the ADOdb_Active_Record objects to be nested. +<p> + +<h3><li>Setting the Database Connection</h3> +<p> +The first step to using ADOdb_Active_Record is to set the default connection that an ADOdb_Active_Record objects will use to connect to a database. + +<pre> +require_once('adodb/adodb-active-record.php'); + +$db = new ADOConnection('mysql://root:pwd@localhost/dbname'); +ADOdb_Active_Record::SetDatabaseAdapter($db); +</pre> + +<h3><li>Table Rows as Objects</h3> +<p> +First, let's create a temporary table in our MySQL database that we can use for demonstrative purposes throughout the rest of this tutorial. We can do this by sending a CREATE query: + +<pre> +$db->Execute("CREATE TEMPORARY TABLE `persons` ( + `id` int(10) unsigned NOT NULL auto_increment, + `name_first` varchar(100) NOT NULL default '', + `name_last` varchar(100) NOT NULL default '', + `favorite_color` varchar(100) NOT NULL default '', + PRIMARY KEY (`id`) + ) ENGINE=MyISAM; + "); + </pre> +<p> +ADOdb_Active_Record's are object representations of table rows. Each table in the database is represented by a class in PHP. To begin working with a table as a ADOdb_Active_Record, a class that extends ADOdb_Active_Records needs to be created for it. + +<pre> +class Person extends ADOdb_Active_Record{} +$person = new Person(); +</pre> + +<p> +In the above example, a new ADOdb_Active_Record object $person was created to access the "persons" table. Zend_Db_DataObject takes the name of the class, pluralizes it (according to American English rules), and assumes that this is the name of the table in the database. +<p> +This kind of behavior is typical of ADOdb_Active_Record. It will assume as much as possible by convention rather than explicit configuration. In situations where it isn't possible to use the conventions that ADOdb_Active_Record expects, options can be overridden as we'll see later. + +<h3><li>Table Columns as Object Properties</h3> +<p> +When the $person object was instantiated, ADOdb_Active_Record read the table metadata from the database itself, and then exposed the table's columns (fields) as object properties. +<p> +Our "persons" table has three fields: "name_first", "name_last", and "favorite_color". Each of these fields is now a property of the $person object. To see all these properties, use the ADOdb_Active_Record::getAttributeNames() method: +<pre> +var_dump($person->getAttributeNames()); + +/** + * Outputs the following: + * array(4) { + * [0]=> + * string(2) "id" + * [1]=> + * string(9) "name_first" + * [2]=> + * string(8) "name_last" + * [3]=> + * string(13) "favorite_color" + * } + */ + </pre> +<p> +One big difference between ADOdb and Zend's implementation is we do not automatically convert to camelCaps style. +<p> +<h3><li>Inserting and Updating a Record</h3><p> + +An ADOdb_Active_Record object is a representation of a single table row. However, when our $person object is instantiated, it does not reference any particular row. It is a blank record that does not yet exist in the database. An ADOdb_Active_Record object is considered blank when its primary key is NULL. The primary key in our persons table is "id". +<p> +To insert a new record into the database, change the object's properties and then call the ADOdb_Active_Record::save() method: +<pre> +$person = new Person(); +$person->nameFirst = 'Andi'; +$person->nameLast = 'Gutmans'; +$person->save(); + </pre> +<p> +Oh, no! The above code snippet does not insert a new record into the database. Instead, outputs an error: +<pre> +1048: Column 'name_first' cannot be null + </pre> +<p> +This error occurred because MySQL rejected the INSERT query that was generated by ADOdb_Active_Record. If exceptions are enabled in ADOdb and you are using PHP5, an error will be thrown. In the definition of our table, we specified all of the fields as NOT NULL; i.e., they must contain a value. +<p> +ADOdb_Active_Records are bound by the same contraints as the database tables they represent. If the field in the database cannot be NULL, the corresponding property in the ADOdb_Active_Record also cannot be NULL. In the example above, we failed to set the property $person->favoriteColor, which caused the INSERT to be rejected by MySQL. +<p> +To insert a new ADOdb_Active_Record in the database, populate all of ADOdb_Active_Record's properties so that they satisfy the constraints of the database table, and then call the save() method: +<pre> +/** + * Calling the save() method will successfully INSERT + * this $person into the database table. + */ +$person = new Person(); +$person->name_first = 'Andi'; +$person->name_last = 'Gutmans'; +$person->favorite_color = 'blue'; +$person->save(); +</pre> +<p> +Once this $person has been INSERTed into the database by calling save(), the primary key can now be read as a property. Since this is the first row inserted into our temporary table, its "id" will be 1: +<pre> +var_dump($person->id); + +/** + * Outputs the following: + * string(1) + */ + </pre> +<p> +From this point on, updating it is simply a matter of changing the object's properties and calling the save() method again: + +<pre> +$person->favorite_color = 'red'; +$person->save(); + </pre> +<p> +The code snippet above will change the favorite color to red, and then UPDATE the record in the database. + +<a name=additional> +<h2>ADOdb Specific Functionality</h2> +<h3><li>Setting the Table Name</h3> +<p>The default behaviour on creating an ADOdb_Active_Record is to "pluralize" the class name and use that as the table name. Often, this is not the case. For example, the Person class could be reading from the "People" table. We provide a constructor parameter to override the default table naming behaviour. +<pre> + class Person extends ADOdb_Active_Record{} + $person = new Person('People'); +</pre> +<h3><li>$ADODB_ASSOC_CASE</h3> +<p>This allows you to control the case of field names and properties. For example, all field names in Oracle are upper-case by default. So you +can force field names to be lowercase using $ADODB_ASSOC_CASE. Legal values are as follows: +<pre> + 0: lower-case + 1: upper-case + 2: native-case +</pre> +<p>So to force all Oracle field names to lower-case, use +<pre> +$ADODB_ASSOC_CASE = 0; +$person = new Person('People'); +$person->name = 'Lily'; +$ADODB_ASSOC_CASE = 2; +$person2 = new Person('People'); +$person2->NAME = 'Lily'; +</pre> + +<p>Also see <a href=http://phplens.com/adodb/reference.constants.adodb_assoc_case.html>$ADODB_ASSOC_CASE</a>. + +<h3><li>ADOdb_Active_Record::Save</h3> +<p> +Saves a record by executing an INSERT or UPDATE SQL statement as appropriate. +<p>Returns false on unsuccessful INSERT, true if successsful INSERT. +<p>Returns 0 on failed UPDATE, and 1 on UPDATE if data has changed, and -1 if no data was changed, so no UPDATE statement was executed. + +<h3><li>ADOdb_Active_Record::Replace</h3> +<p> +ADOdb supports replace functionality, whereby the record is inserted if it does not exists, or updated otherwise. +<pre> +$rec = new ADOdb_Active_Record("product"); +$rec->name = 'John'; +$rec->tel_no = '34111145'; +$ok = $rec->replace(); // 0=failure, 1=update, 2=insert +</pre> + + +<h3><li>ADOdb_Active_Record::Load()</h3> +<p>Sometimes, we want to load a single record into an Active Record. We can do so using: +<pre> +$person->load("id=3"); + +// or using bind parameters + +$person->load("id=?", array(3)); +</pre> +<p>Returns false if an error occurs. + +<h3><li>Error Handling and Debugging</h3> +<p> +In PHP5, if adodb-exceptions.inc.php is included, then errors are thrown. Otherwise errors are handled by returning a value. False by default means an error has occurred. You can get the last error message using the ErrorMsg() function. +<p> +To check for errors in ADOdb_Active_Record, do not poll ErrorMsg() as the last error message will always be returned, even if it occurred several operations ago. Do this instead: +<pre> +# right! +$ok = $rec->Save(); +if (!$ok) $err = $rec->ErrorMsg(); + +# wrong :( +$rec->Save(); +if ($rec->ErrorMsg()) echo "Wrong way to detect error"; +</pre> +<p>The ADOConnection::Debug property is obeyed. So +if $db->debug is enabled, then ADOdb_Active_Record errors are also outputted to standard output and written to the browser. + +<h3><li>ADOdb_Active_Record::Set()</h3> +<p>You can convert an array to an ADOdb_Active_Record using Set(). The array must be numerically indexed, and have all fields of the table defined in the array. The elements of the array must be in the table's natural order too. +<pre> +$row = $db->GetRow("select * from tablex where id=$id"); + +# PHP4 or PHP5 without enabling exceptions +$obj =& new ADOdb_Active_Record('Products'); +if ($obj->ErrorMsg()){ + echo $obj->ErrorMsg(); +} else { + $obj->Set($row); +} + +# in PHP5, with exceptions enabled: + +include('adodb-exceptions.inc.php'); +try { + $obj =& new ADOdb_Active_Record('Products'); + $obj->Set($row); +} catch(exceptions $e) { + echo $e->getMessage(); +} +</pre> +<p> +<h3><li>Primary Keys</h3> +<p> +ADOdb_Active_Record does not require the table to have a primary key. You can insert records for such a table, but you will not be able to update nor delete. +<p>Sometimes you are retrieving data from a view or table that has no primary key, but has a unique index. You can dynamically set the primary key of a table through the constructor, or using ADOdb_Active_Record::SetPrimaryKeys(): +<pre> + $pkeys = array('category','prodcode'); + + // set primary key using constructor + $rec = new ADOdb_Active_Record('Products', $pkeys); + + // or use method + $rec->SetPrimaryKeys($pkeys); +</pre> + + +<h3><li>Retrieval of Auto-incrementing ID</h3> +When creating a new record, the retrieval of the last auto-incrementing ID is not reliable for databases that do not support the Insert_ID() function call (check $connection->hasInsertID). In this case we perform a <b>SELECT MAX($primarykey) FROM $table</b>, which will not work reliably in a multi-user environment. You can override the ADOdb_Active_Record::LastInsertID() function in this case. + +<h3><li>Dealing with Multiple Databases</h3> +<p> +Sometimes we want to load data from one database and insert it into another using ActiveRecords. This can be done using the optional parameter of the ADOdb_Active_Record constructor. In the following example, we read data from db.table1 and store it in db2.table2: +<pre> +$db = NewADOConnection(...); +$db2 = NewADOConnection(...); + +ADOdb_Active_Record::SetDatabaseAdapter($db2); + +$activeRecs = $db->GetActiveRecords('table1'); + +foreach($activeRecs as $rec) { + $rec2 = new ADOdb_Active_Record('table2',$db2); + $rec2->id = $rec->id; + $rec2->name = $rec->name; + + $rec2->Save(); +} +</pre> +<p> +If you have to pass in a primary key called "id" and the 2nd db connection in the constructor, you can do so too: +<pre> +$rec = new ADOdb_Active_Record("table1",array("id"),$db2); +</pre> + +<h3><li>$ADODB_ACTIVE_CACHESECS</h3> +<p>You can cache the table metadata (field names, types, and other info such primary keys) in $ADODB_CACHE_DIR (which defaults to /tmp) by setting +the global variable $ADODB_ACTIVE_CACHESECS to a value greater than 0. This will be the number of seconds to cache. + You should set this to a value of 30 seconds or greater for optimal performance. + +<h3><li>Active Record Considered Bad?</h3> +<p>Although the Active Record concept is useful, you have to be aware of some pitfalls when using Active Record. The level of granularity of Active Record is individual records. It encourages code like the following, used to increase the price of all furniture products by 10%: +<pre> + $recs = $db->GetActiveRecords("Products","category='Furniture'"); + foreach($recs as $rec) { + $rec->price *= 1.1; // increase price by 10% for all Furniture products + $rec->save(); + } +</pre> +Of course a SELECT statement is superior because it's simpler and much more efficient (probably by a factor of x10 or more): +<pre> + $db->Execute("update Products set price = price * 1.1 where category='Furniture'"); +</pre> +<p>Another issue is performance. For performance sensitive code, using direct SQL will always be faster than using Active Records due to overhead and the fact that all fields in a row are retrieved (rather than only the subset you need) whenever an Active Record is loaded. + +<h3><li>Transactions</h3> +<p> +The default transaction mode in ADOdb is autocommit. So that is the default with active record too. +The general rules for managing transactions still apply. Active Record to the database is a set of insert/update/delete statements, and the db has no knowledge of active records. +<p> +Smart transactions, that does an auto-rollback if an error occurs, is still the best method to multiple activities (inserts/updates/deletes) that need to be treated as a single transaction: +<pre> +$conn->StartTrans(); +$parent->save(); +$child->save(); +$conn->CompleteTrans(); +</pre> + +<h2>ADOConnection Supplement</h2> + +<h3><li>ADOConnection::GetActiveRecords()</h3> +<p> +This allows you to retrieve an array of ADOdb_Active_Records. Returns false if an error occurs. +<pre> +$table = 'products'; +$whereOrderBy = "name LIKE 'A%' ORDER BY Name"; +$activeRecArr = $db->GetActiveRecords($table, $whereOrderBy); +foreach($activeRecArr as $rec) { + $rec->id = rand(); + $rec->save(); +} +</pre> +<p> +And to retrieve all records ordered by specific fields: +<pre> +$whereOrderBy = "1=1 ORDER BY Name"; +$activeRecArr = $db->ADOdb_Active_Records($table); +</pre> +<p> +To use bind variables (assuming ? is the place-holder for your database): +<pre> +$activeRecArr = $db->GetActiveRecords($tableName, 'name LIKE ?', + array('A%')); +</pre> +<p>You can also define the primary keys of the table by passing an array of field names: +<pre> +$activeRecArr = $db->GetActiveRecords($tableName, 'name LIKE ?', + array('A%'), array('id')); +</pre> + +<h3><li>ADOConnection::GetActiveRecordsClass()</h3> +<p> +This allows you to retrieve an array of objects derived from ADOdb_Active_Records. Returns false if an error occurs. +<pre> +class Product extends ADOdb_Active_Records{}; +$table = 'products'; +$whereOrderBy = "name LIKE 'A%' ORDER BY Name"; +$activeRecArr = $db->GetActiveRecordsClass('Product',$table, $whereOrderBy); + +# the objects in $activeRecArr are of class 'Product' +foreach($activeRecArr as $rec) { + $rec->id = rand(); + $rec->save(); +} +</pre> +<p> +To use bind variables (assuming ? is the place-holder for your database): +<pre> +$activeRecArr = $db->GetActiveRecordsClass($className,$tableName, 'name LIKE ?', + array('A%')); +</pre> +<p>You can also define the primary keys of the table by passing an array of field names: +<pre> +$activeRecArr = $db->GetActiveRecordsClass($className,$tableName, 'name LIKE ?', + array('A%'), array('id')); +</pre> + +</ol> + +<h2>Code Sample</h2> +<p>The following works with PHP4 and PHP5 +<pre> +include('../adodb.inc.php'); +include('../adodb-active-record.inc.php'); + +// uncomment the following if you want to test exceptions +#if (PHP_VERSION >= 5) include('../adodb-exceptions.inc.php'); + +$db = NewADOConnection('mysql://root@localhost/northwind'); +$db->debug=1; +ADOdb_Active_Record::SetDatabaseAdapter($db); + +$db->Execute("CREATE TEMPORARY TABLE `persons` ( + `id` int(10) unsigned NOT NULL auto_increment, + `name_first` varchar(100) NOT NULL default '', + `name_last` varchar(100) NOT NULL default '', + `favorite_color` varchar(100) NOT NULL default '', + PRIMARY KEY (`id`) + ) ENGINE=MyISAM; + "); + +class Person extends ADOdb_Active_Record{} +$person = new Person(); + +echo "<p>Output of getAttributeNames: "; +var_dump($person->getAttributeNames()); + +/** + * Outputs the following: + * array(4) { + * [0]=> + * string(2) "id" + * [1]=> + * string(9) "name_first" + * [2]=> + * string(8) "name_last" + * [3]=> + * string(13) "favorite_color" + * } + */ + +$person = new Person(); +$person->nameFirst = 'Andi'; +$person->nameLast = 'Gutmans'; +$person->save(); // this save() will fail on INSERT as favorite_color is a must fill... + + +$person = new Person(); +$person->name_first = 'Andi'; +$person->name_last = 'Gutmans'; +$person->favorite_color = 'blue'; +$person->save(); // this save will perform an INSERT successfully + +echo "<p>The Insert ID generated:"; print_r($person->id); + +$person->favorite_color = 'red'; +$person->save(); // this save() will perform an UPDATE + +$person = new Person(); +$person->name_first = 'John'; +$person->name_last = 'Lim'; +$person->favorite_color = 'lavender'; +$person->save(); // this save will perform an INSERT successfully + +// load record where id=2 into a new ADOdb_Active_Record +$person2 = new Person(); +$person2->Load('id=2'); +var_dump($person2); + +// retrieve an array of records +$activeArr = $db->GetActiveRecordsClass($class = "Person",$table = "persons","id=".$db->Param(0),array(2)); +$person2 =& $activeArr[0]; +echo "<p>Name first (should be John): ",$person->name_first, "<br>Class = ",get_class($person2); +</pre> + + <h3>Todo (Code Contributions welcome)</h3> + <p>Check _original and current field values before update, only update changes. Also if the primary key value is changed, then on update, we should save and use the original primary key values in the WHERE clause! + <p>Handle 1-to-many relationships. + <p>PHP5 specific: Make GetActiveRecords*() return an Iterator. + <p>PHP5 specific: Change PHP5 implementation of Active Record to use __get() and __set() for better performance. + +<h3> Change Log</h3> +<p>0.03 <br> +- Now we only update fields that have changed, using $this->_original.<br> +- We do not include auto_increment fields in replace(). Thx Travis Cline<br> +- Added ADODB_ACTIVE_CACHESECS.<br> + +<p>0.02 <br> +- Much better error handling. ErrorMsg() implemented. Throw implemented if adodb-exceptions.inc.php detected.<br> +- You can now define the primary keys of the view or table you are accessing manually.<br> +- The Active Record allows you to create an object which does not have a primary key. You can INSERT but not UPDATE in this case. +- Set() documented.<br> +- Fixed _pluralize bug with y suffix. + +<p> + 0.01 6 Mar 2006<br> +- Fixed handling of nulls when saving (it didn't save nulls, saved them as '').<br> +- Better error handling messages.<br> +- Factored out a new method GetPrimaryKeys().<br> + <p> + 0.00 5 Mar 2006<br> + 1st release +</body> +</html>
\ No newline at end of file diff --git a/framework/3rdParty/adodb/docs/docs-adodb.htm b/framework/3rdParty/adodb/docs/docs-adodb.htm new file mode 100644 index 00000000..2402223a --- /dev/null +++ b/framework/3rdParty/adodb/docs/docs-adodb.htm @@ -0,0 +1,3368 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><title>ADODB Manual</title> + +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + + +<style> +pre { + background-color: #eee; + padding: 0.75em 1.5em; + font-size: 12px; + border: 1px solid #ddd; +} +</style></head> +<body bgcolor="#ffffff" text="black"> + +<h2>ADOdb Library for PHP</h2> +<p>V4.81 3 May 2006 (c) 2000-2006 John Lim (jlim#natsoft.com)</p> +<p><font size="1">This software is dual licensed using BSD-Style and LGPL. This + means you can use it in compiled proprietary and commercial products.</font></p> + + + <p>Useful ADOdb links: <a href="http://adodb.sourceforge.net/#download">Download</a> <a href="http://adodb.sourceforge.net/#docs">Other Docs</a> + +</p><p><a href="#intro"><b>Introduction</b></a><b><br> + <a href="#features">Unique Features</a><br> + <a href="#users">How People are using ADOdb</a><br> + <a href="#bugs">Feature Requests and Bug Reports</a><br> + </b><b><a href="#install">Installation</a><br> + <a href="#mininstall">Minimum Install</a><br> + <a href="#coding">Initializing Code and Connectioning to Databases</a><br> + </b><font size="2"> <a href="#dsnsupport">Data Source Name (DSN) Support</a></font> <a href="#connect_ex">Connection Examples</a> <br> + <b><a href="#speed">High Speed ADOdb - tuning tips</a></b><br> + <b><a href="#hack">Hacking and Modifying ADOdb Safely</a><br> + <a href="#php5">PHP5 Features</a></b><br> + <font size="2"><a href="#php5iterators">foreach iterators</a> <a href="#php5exceptions">exceptions</a></font><br> + <b> <a href="#drivers">Supported Databases</a></b><br> + <b> <a href="#quickstart">Tutorials</a></b><br> + <a href="#ex1">Example 1: Select</a><br> + <a href="#ex2">Example 2: Advanced Select</a><br> + <a href="#ex3">Example 3: Insert</a><br> + <a href="#ex4">Example 4: Debugging</a> <a href="#exrs2html">rs2html + example</a><br> + <a href="#ex5">Example 5: MySQL and Menus</a><br> + <a href="#ex6">Example 6: Connecting to Multiple Databases at once</a> <br> + <a href="#ex7">Example 7: Generating Update and Insert SQL</a> <br> + <a href="#ex8">Example 8: Implementing Scrolling with Next and Previous</a><br> + <a href="#ex9">Example 9: Exporting in CSV or Tab-Delimited Format</a> <br> + <a href="#ex10">Example 10: Custom filters</a><br> + <a href="#ex11">Example 11: Smart Transactions</a><br> + <br> + <b> <a href="#errorhandling">Using Custom Error Handlers and PEAR_Error</a><br> + <a href="#DSN">Data Source Names</a><br> + <a href="#caching">Caching</a><br> + <a href="#pivot">Pivot Tables</a></b> +</p><p><a href="#ref"><b>REFERENCE</b></a> +</p><p> <font size="2">Variables: <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> +<a href="#adodb_ansi_padding_off">$ADODB_ANSI_PADDING_OFF</a> + <a href="#adodb_cache_dir">$ADODB_CACHE_DIR</a> <br> + <a href="#force_type">$ADODB_FORCE_TYPE</a> + <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a> + <a href="#adodb_lang">$ADODB_LANG</a> <br> + Constants: </font><font size="2"><a href="#adodb_assoc_case">ADODB_ASSOC_CASE</a> + </font><br> + <a href="#ADOConnection"><b> ADOConnection</b></a><br> + <font size="2">Connections: <a href="#connect">Connect</a> <a href="#pconnect">PConnect</a> + <a href="#nconnect">NConnect</a> <a href="#isconnected">IsConnected</a><br> + Executing SQL: <a href="#execute">Execute</a> <a href="#cacheexecute"><i>CacheExecute</i></a> + <a href="#selectlimit">SelectLimit</a> <a href="#cacheSelectLimit"><i>CacheSelectLimit</i></a> + <a href="#param">Param</a> <a href="#prepare">Prepare</a> <a href="#preparesp">PrepareSP</a> + <a href="#inparameter">InParameter</a> <a href="#outparameter">OutParameter</a> <a href="#autoexecute">AutoExecute</a> + <br> + <a href="#getone">GetOne</a> + <a href="#cachegetone"><i>CacheGetOne</i></a> <a href="#getrow">GetRow</a> <a href="#cachegetrow"><i>CacheGetRow</i></a> + <a href="#getall">GetAll</a> <a href="#cachegetall"><i>CacheGetAll</i></a> <a href="#getcol">GetCol</a> + <a href="#cachegetcol"><i>CacheGetCol</i></a> <a href="#getassoc1">GetAssoc</a> <a href="#cachegetassoc"><i>CacheGetAssoc</i></a> <a href="#replace">Replace</a> + <br> + <a href="#executecursor">ExecuteCursor</a> + (oci8 only)<br> + Generates SQL strings: <a href="#getupdatesql">GetUpdateSQL</a> <a href="#getinsertsql">GetInsertSQL</a> + <a href="#concat">Concat</a> <a href="#ifnull">IfNull</a> <a href="#length">length</a> <a href="#random">random</a> <a href="#substr">substr</a> + <a href="#qstr">qstr</a> <a href="#param">Param</a> <a href="#OffsetDate">OffsetDate</a> <a href="#SQLDate">SQLDate</a> + <a href="#dbdate">DBDate</a> <a href="#dbtimestamp">DBTimeStamp</a> + <br> + Blobs: <a href="#updateblob">UpdateBlob</a> <a href="#updateclob">UpdateClob</a> + <a href="#updateblobfile">UpdateBlobFile</a> <a href="#blobencode">BlobEncode</a> + <a href="#blobdecode">BlobDecode</a><br> + Paging/Scrolling: <a href="#pageexecute">PageExecute</a> <a href="#cachepageexecute">CachePageExecute</a><br> + Cleanup: <a href="#cacheflush">CacheFlush</a> <a href="#Close">Close</a><br> + Transactions: <a href="#starttrans">StartTrans</a> <a href="#completetrans">CompleteTrans</a> + <a href="#failtrans">FailTrans</a> <a href="#hasfailedtrans">HasFailedTrans</a> + <a href="#begintrans">BeginTrans</a> <a href="#committrans">CommitTrans</a> + <a href="#rollbacktrans">RollbackTrans</a> <br> + Fetching Data: </font> <font size="2"><a href="#setfetchmode">SetFetchMode</a><br> + Strings: <a href="#concat">concat</a> <a href="#length">length</a> <a href="#qstr">qstr</a> <a href="#quote">quote</a> <a href="#substr">substr</a><br> + Dates: <a href="#dbdate">DBDate</a> <a href="#dbtimestamp">DBTimeStamp</a> <a href="#unixdate">UnixDate</a> + <a href="#unixtimestamp">UnixTimeStamp</a> <a href="#OffsetDate">OffsetDate</a> + <a href="#SQLDate">SQLDate</a> <br> + Row Management: <a href="#affected_rows">Affected_Rows</a> <a href="#inserted_id">Insert_ID</a> <a href="#rowlock">RowLock</a> + <a href="#genid">GenID</a> <a href="#createseq">CreateSequence</a> <a href="#dropseq">DropSequence</a> + <br> + Error Handling: <a href="#errormsg">ErrorMsg</a> <a href="#errorno">ErrorNo</a> + <a href="#metaerror">MetaError</a> <a href="#metaerrormsg">MetaErrorMsg</a><br> + Data Dictionary (metadata): <a href="#metadatabases">MetaDatabases</a> <a href="#metatables">MetaTables</a> + <a href="#metacolumns">MetaColumns</a> <a href="#metacolumnames">MetaColumnNames</a> + <a href="#metaprimarykeys">MetaPrimaryKeys</a> <a href="#metaforeignkeys">MetaForeignKeys</a> + <a href="#serverinfo">ServerInfo</a> <br> + Statistics and Query-Rewriting: <a href="#logsql">LogSQL</a> <a href="#fnexecute">fnExecute + and fnCacheExecute</a><br> + </font><font size="2">Deprecated: <a href="#bind">Bind</a> <a href="#blankrecordset">BlankRecordSet</a> + <a href="#parameter">Parameter</a></font> + <a href="#adorecordSet"><b><br> + ADORecordSet</b></a><br> + <font size="2"> + Returns one field: <a href="#fields">Fields</a><br> + Returns one row:<a href="#fetchrow">FetchRow</a> <a href="#fetchinto">FetchInto</a> + <a href="#fetchobject">FetchObject</a> <a href="#fetchnextobject">FetchNextObject</a> + <a href="#fetchobj">FetchObj</a> <a href="#fetchnextobj">FetchNextObj</a> + <a href="#getrowassoc">GetRowAssoc</a> <br> + Returns all rows:<a href="#getarray">GetArray</a> <a href="#getrows">GetRows</a> + <a href="#getassoc">GetAssoc</a><br> + Scrolling:<a href="#move">Move</a> <a href="#movenext">MoveNext</a> <a href="#movefirst">MoveFirst</a> + <a href="#movelast">MoveLast</a> <a href="#abspos">AbsolutePosition</a> <a href="#currentrow">CurrentRow</a> + <a href="#atfirstpage">AtFirstPage</a> <a href="#atlastpage">AtLastPage</a> + <a href="#absolutepage">AbsolutePage</a> </font> <font size="2"><br> + Menu generation:<a href="#getmenu">GetMenu</a> <a href="#getmenu2">GetMenu2</a><br> + Dates:<a href="#userdate">UserDate</a> <a href="#usertimestamp">UserTimeStamp</a> + <a href="#unixdate">UnixDate</a> <a href="#unixtimestamp">UnixTimeStamp<br> + </a>Recordset Info:<a href="#recordcount">RecordCount</a> <a href="#po_recordcount">PO_RecordSet</a> + <a href="#nextrecordset">NextRecordSet</a><br> + Field Info:<a href="#fieldcount">FieldCount</a> <a href="#fetchfield">FetchField</a> + <a href="#metatype">MetaType</a><br> + Cleanup: <a href="#rsclose">Close</a></font> +</p> +<p><font size="2"><a href="#rs2html"><b>rs2html</b></a> <a href="#exrs2html">example</a></font><br> + <a href="#adodiff">Differences between ADOdb and ADO</a><br> + <a href="#driverguide"><b>Database Driver Guide<br> + </b></a><b><a href="#changes">Change Log</a></b><br> +</p> +<h2>Introduction<a name="intro"></a></h2> +<p>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. PHP 4.0.5 or later + is now required (because we use array-based str_replace).</p> +<p>We currently support MySQL, Oracle, Microsoft SQL Server, Sybase, Sybase SQL Anywhere, Informix, + PostgreSQL, FrontBase, SQLite, Interbase (Firebird and Borland variants), Foxpro, Access, ADO, DB2, SAP DB and ODBC. + We have had successful reports of connecting to Progress and CacheLite via ODBC. We hope more people + will contribute drivers to support other databases.</p> +<p>PHP4 supports session variables. You can store your session information using + ADOdb for true portability and scalability. See adodb-session.php for more information.</p> +<p>Also read <a href="http://phplens.com/lens/adodb/tips_portable_sql.htm">tips_portable_sql.htm</a> + for tips on writing + portable SQL.</p> +<h2>Unique Features of ADOdb<a name="features"></a></h2> +<ul> + <li><b>Easy for Windows programmers</b> to adapt to because many of the conventions + are similar to Microsoft's ADO.</li> + <li>Unlike other PHP database classes which focus only on select statements, + <b>we provide support code to handle inserts and updates which can be adapted + to multiple databases quickly.</b> Methods are provided for date handling, + string concatenation and string quoting characters for differing databases.</li> + <li>A<b> metatype system </b>is built in so that we can figure out that types + such as CHAR, TEXT and STRING are equivalent in different databases.</li> + <li><b>Easy to port</b> because all the database dependant code are stored in + stub functions. You do not need to port the core logic of the classes.</li> + <li><b>Portable table and index creation</b> with the <a href="docs-datadict.htm">datadict</a> classes. + </li><li><b>Database performance monitoring and SQL tuning</b> with the <a href="docs-perf.htm">performance monitoring</a> classes. + </li><li><b>Database-backed sessions</b> with the <a href="docs-session.htm">session management</a> classes. Supports session expiry notification. +<li><b>Object-Relational Mapping</b> using <a href="docs-active-record.htm">ADOdb_Active_Record</a> classes. +</li></ul> +<h2>How People are using ADOdb<a name="users"></a></h2> +Here are some examples of how people are using ADOdb (for a much longer list, +visit <a href="http://phplens.com/phpeverywhere/adodb-cool-apps">adodb-cool-apps</a>): +<ul> +<li><a href="http://phplens.com/">PhpLens</a> 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.<p> + +</p></li><li><a href="http://www.interakt.ro/phakt/">PHAkt: PHP Extension for DreamWeaver Ultradev</a> allows you to script PHP in the popular Web page editor. Database handling provided by ADOdb.<p> + +</p></li><li><a href="http://www.andrew.cmu.edu/%7Erdanyliw/snort/snortacid.html">Analysis Console for Intrusion Databases</a> +(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.<p> + +</p></li><li><a href="http://www.postnuke.com/">PostNuke</a> 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. <p> + +</p></li><li><a href="http://www.auto-net.no/easypublish.php?page=index&lang_id=2">EasyPublish CMS</a> +is another free content management system for managing information and +integrated modules on your internet, intranet- and extranet-sites. From +Norway.<p> + +</p></li><li><a href="http://nola.noguska.com/">NOLA</a> is a full featured accounting, inventory, and job tracking application. It is licensed under the GPL, and developed by Noguska. +</li></ul><p> + +</p><h2>Feature Requests and Bug Reports<a name="bugs"></a></h2> +<p>Feature requests and bug reports can be emailed to <a href="mailto:jlim#natsoft.com.my">jlim#natsoft.com.my</a> + or posted to the ADOdb Help forums at <a href="http://phplens.com/lens/lensforum/topics.php?id=4">http://phplens.com/lens/lensforum/topics.php?id=4</a>.</p> +<h2>Installation Guide<a name="install"></a></h2> +<p>Make sure you are running PHP 4.0.5 or later. + Unpack all the files into a directory accessible by your webserver.</p> +<p>To test, try modifying some of the tutorial examples. Make sure you customize + the connection settings correctly. You can debug using <i>$db->debug = true</i> as shown below:</p> +<pre><?php<br> include('adodb/adodb.inc.php');<br> $db = <a href="#adonewconnection">ADONewConnection</a>($dbdriver); # eg 'mysql' or 'postgres'<br> $db->debug = true;<br> $db-><a href="#connect">Connect</a>($server, $user, $password, $database);<br> $rs = $db-><a href="#execute">Execute</a>('select * from some_small_table');<br> print "<pre>";<br> print_r($rs-><a href="#getrows">GetRows</a>());<br> print "</pre>";<br>?></pre> + + <h3>Minimum Install<a name="mininstall"></a></h3> +<p>For developers who want to release a minimal install of ADOdb, you will need: +</p><ul> +<li>adodb.inc.php +</li><li>adodb-lib.inc.php +</li><li>adodb-time.inc.php +</li><li>drivers/adodb-$database.inc.php +</li><li>license.txt (for legal reasons) +</li><li>adodb-php4.inc.php +</li><li>adodb-iterator.inc.php (php5 functionality) +</li></ul> +Optional: +<ul> +<li>adodb-error.inc.php and lang/adodb-$lang.inc.php (if you use MetaError()) +</li><li>adodb-csvlib.inc.php (if you use cached recordsets - CacheExecute(), etc) +</li><li>adodb-exceptions.inc.php and adodb-errorhandler.inc.php (if you use adodb error handler or php5 exceptions). +<li>adodb-active-record.inc.php if you use <a href=docs-active-record.htm>Active Records</a>. +</li></ul> + +<h3>Code Initialization Examples<a name="coding"></a></h3> +<p>When running ADOdb, at least two files are loaded. First is adodb/adodb.inc.php, + which contains all functions used by all database classes. The code specific + to a particular database is in the adodb/driver/adodb-????.inc.php file.</p> + <a name="adonewconnection"></a> +<p>For example, to connect to a mysql database:</p> +<pre>include('/path/to/set/here/adodb.inc.php');<br>$conn = &ADONewConnection('mysql');<br></pre> +<p>Whenever you need to connect to a database, you create a Connection object + using the <b>ADONewConnection</b>($driver) function. + <b>NewADOConnection</b>($driver) is an alternative name for the same function.</p> + +<p>At this point, you are not connected to the database (no longer true if you pass in a <a href="#dsnsupport">dsn</a>). You will first need to decide +whether to use <i>persistent</i> or <i>non-persistent</i> connections. The advantage of <i>persistent</i> +connections is that they are faster, as the database connection is never closed (even +when you call Close()). <i>Non-persistent </i>connections take up much fewer resources though, +reducing the risk of your database and your web-server becoming overloaded. +</p><p>For persistent connections, +use $conn-><a href="#pconnect">PConnect()</a>, + or $conn-><a href="#connect">Connect()</a> for non-persistent connections. +Some database drivers also support <a href="#nconnect">NConnect()</a>, which forces +the creation of a new connection. + +<a name="connection_gotcha"></a> +</p><p><b>Connection Gotcha</b>: If you create two connections, but both use the same userid and password, +PHP will share the same connection. This can cause problems if the connections are meant to +different databases. The solution is to always use different userid's for different databases, + or use NConnect(). + + <a name="dsnsupport"></a> + </p><h3>Data Source Name (DSN) Support</h3> + <p> Since ADOdb 4.51, you can connect to a database by passing a dsn to NewADOConnection() (or ADONewConnection, which is + the same function). The dsn format is: +</p><pre> $driver://$username:$password@hostname/$database?options[=value]<br></pre><p> +NewADOConnection() calls Connect() or PConnect() internally for you. If the connection fails, false is returned. +</p><pre> <font color="#008000"># non-persistent connection</font> + $dsn = 'mysql://root:pwd@localhost/mydb'; + $db = NewADOConnection($dsn); + if (!$db) die("Connection failed"); + + <font color="#008000"># no need to call connect/pconnect!</font> + $arr = $db->GetArray("select * from table"); + + <font color="#008000"># persistent connection</font> + $dsn2 = 'mysql://root:pwd@localhost/mydb?persist'; +</pre> +<p> +If you have special characters such as /:? in your dsn, then you need to rawurlencode them first: +</p><pre> $pwd = rawurlencode($pwd);<br> $dsn = "mysql://root:$pwd@localhost/mydb";<br></pre> +<p> +Legal options are: +</p><p> +<table align="center" border="1"><tbody><tr><td>For all drivers</td><td> + 'persist', 'persistent', 'debug', 'fetchmode', 'new' + </td></tr><tr><td>Interbase/Firebird + </td><td> + 'dialect','charset','buffers','role' + </td></tr><tr><td>M'soft ADO</td><td> + 'charpage' + + </td></tr><tr><td>MySQL</td><td> + 'clientflags' +</td></tr><tr><td>MySQLi</td><td> + 'port', 'socket', 'clientflags' +</td></tr><tr><td>Oci8</td><td> + 'nls_date_format','charset' +</td></tr></tbody></table> +</p><p> +For all drivers, when the options <i>persist</i> or <i>persistent</i> are set, a persistent connection is forced; similarly, when <i>new</i> is set, then +a new connection will be created using NConnect if the underlying driver supports it. +The <i>debug</i> option enables debugging. The <i>fetchmode</i> calls <a href="#setfetchmode">SetFetchMode()</a>. +If no value is defined for an option, then the value is set to 1. +</p><p> +ADOdb DSN's are compatible with version 1.0 of PEAR DB's DSN format. +<a name="connect_ex"> +</a></p><h3><a name="connect_ex">Examples of Connecting to Databases</a></h3> +<h4><a name="connect_ex">MySQL and Most Other Database Drivers</a></h4> +<p><a name="connect_ex">MySQL connections are very straightforward, and the parameters are identical + to mysql_connect:</a></p> +<pre><a name="connect_ex"> $conn = &ADONewConnection('mysql'); <br> $conn->PConnect('localhost','userid','password','database');<br> <br> <font color="#008000"># or dsn </font> + $dsn = 'mysql://user:pwd@localhost/mydb'; + $conn = ADONewConnection($dsn); # no need for Connect() + + <font color="#008000"># or persistent dsn</font> + $dsn = 'mysql://user:pwd@localhost/mydb?persist'; + $conn = ADONewConnection($dsn); # no need for PConnect() + + <font color="#008000"># a more complex example:</font> + $pwd = urlencode($pwd); + $flags = MYSQL_CLIENT_COMPRESS; + $dsn = "mysql://user:$pwd@localhost/mydb?persist&clientflags=$flags"; + $conn = ADONewConnection($dsn); # no need for PConnect() + </a></pre> +<p><a name="connect_ex"> For most drivers, you can use the standard function: Connect($server, $user, $password, $database), or +a </a><a href="dsnsupport">DSN</a> since ADOdb 4.51. Exceptions to this are listed below. +</p> +<a name=pdo> +<h4>PDO</h4> +<p>PDO, which only works with PHP5, accepts a driver specific connection string: +<pre> + $conn =& NewADConnection('pdo'); + $conn->Connect('mysql:host=localhost',$user,$pwd,$mydb); + $conn->Connect('mysql:host=localhost;dbname=mydb',$user,$pwd); + $conn->Connect("mysql:host=localhost;dbname=mydb;username=$user;password=$pwd"); +</pre> +<p>The DSN mechanism is also supported: +<pre> + $conn =& NewADConnection("pdo_mysql://user:pwd@localhost/mydb?persist"); # persist is optional +</pre> +<h4>PostgreSQL</h4> +<p>PostgreSQL 7 and 8 accepts connections using: </p> +<p>a. the standard connection string:</p> +<pre> $conn = &ADONewConnection('postgres'); <br> $conn->PConnect('host=localhost port=5432 dbname=mary');</pre> +<p> b. the classical 4 parameters:</p> + <pre> $conn->PConnect('localhost','userid','password','database');<br> </pre> +<p>c. dsn: +</p><pre> $dsn = 'postgres://user:pwd@localhost/mydb?persist'; # persist is optional + $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> +<a name="ldap"></a> + + <h4>LDAP</h4> + <p>Here is an example of querying a LDAP server. Thanks to Josh Eldridge for the driver and this example: +</p><pre> +require('/path/to/adodb.inc.php'); + +/* Make sure to set this BEFORE calling Connect() */ +$LDAP_CONNECT_OPTIONS = Array( + Array ("OPTION_NAME"=>LDAP_OPT_DEREF, "OPTION_VALUE"=>2), + Array ("OPTION_NAME"=>LDAP_OPT_SIZELIMIT,"OPTION_VALUE"=>100), + Array ("OPTION_NAME"=>LDAP_OPT_TIMELIMIT,"OPTION_VALUE"=>30), + Array ("OPTION_NAME"=>LDAP_OPT_PROTOCOL_VERSION,"OPTION_VALUE"=>3), + Array ("OPTION_NAME"=>LDAP_OPT_ERROR_NUMBER,"OPTION_VALUE"=>13), + Array ("OPTION_NAME"=>LDAP_OPT_REFERRALS,"OPTION_VALUE"=>FALSE), + Array ("OPTION_NAME"=>LDAP_OPT_RESTART,"OPTION_VALUE"=>FALSE) +); +$host = 'ldap.baylor.edu'; +$ldapbase = 'ou=People,o=Baylor University,c=US'; + +$ldap = NewADOConnection( 'ldap' ); +$ldap->Connect( $host, $user_name='', $password='', $ldapbase ); + +echo "<pre>"; + +print_r( $ldap->ServerInfo() ); +$ldap->SetFetchMode(ADODB_FETCH_ASSOC); +$userName = 'eldridge'; +$filter="(|(CN=$userName*)(sn=$userName*)(givenname=$userName*)(uid=$userName*))"; + +$rs = $ldap->Execute( $filter ); +if ($rs) + while ($arr = $rs->FetchRow()) { + print_r($arr); + } + +$rs = $ldap->Execute( $filter ); +if ($rs) + while (!$rs->EOF) { + print_r($rs->fields); + $rs->MoveNext(); + } + +print_r( $ldap->GetArray( $filter ) ); +print_r( $ldap->GetRow( $filter ) ); + +$ldap->Close(); +echo "</pre>"; +</pre> +<p>Using DSN: +<pre> +$dsn = "ldap://ldap.baylor.edu/ou=People,o=Baylor University,c=US"; +$db = NewADOConnection($dsn); +</pre> +<h4>Interbase/Firebird</h4> +You define the database in the $host parameter: +<pre> $conn = &ADONewConnection('ibase'); <br> $conn->PConnect('localhost:c:\ibase\employee.gdb','sysdba','masterkey');<br></pre> +<p>Or dsn: +</p><pre> $dsn = 'firebird://user:pwd@localhost/mydb?persist&dialect=3'; # persist is optional<br> $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> +<h4>SQLite</h4> +Sqlite will create the database file if it does not exist. +<pre> $conn = &ADONewConnection('sqlite'); + $conn->PConnect('c:\path\to\sqlite.db'); # sqlite will create if does not exist<br></pre> +<p>Or dsn: +</p><pre> $path = urlencode('c:\path\to\sqlite.db'); + $dsn = "sqlite://$path/?persist"; # persist is optional + $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> +<h4>Oracle (oci8)</h4> +<p>With oci8, you can connect in multiple ways. Note that oci8 works fine with +newer versions of the Oracle, eg. 9i and 10g.</p> +<p>a. PHP and Oracle reside on the same machine, use default SID.</p> +<pre> $conn->Connect(false, 'scott', 'tiger');</pre> +<p>b. TNS Name defined in tnsnames.ora (or ONAMES or HOSTNAMES), eg. 'myTNS'</p> +<pre> $conn->PConnect(false, 'scott', 'tiger', 'myTNS');</pre> +<p>or</p> +<pre> $conn->PConnect('myTNS', 'scott', 'tiger');</pre> +<p>c. Host Address and SID</p> +<pre> + $conn->connectSID = true; + $conn->Connect('192.168.0.1', 'scott', 'tiger', 'SID');</pre> +<p>d. Host Address and Service Name</p> +<pre> $conn->Connect('192.168.0.1', 'scott', 'tiger', 'servicename');</pre> +<p>e. Oracle connection string: +</p><pre> $cstr = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=$host)(PORT=$port))<br> (CONNECT_DATA=(SID=$sid)))";<br> $conn->Connect($cstr, 'scott', 'tiger');<br></pre> +<p>f. ADOdb dsn: +</p><pre> $dsn = 'oci8://user:pwd@tnsname/?persist'; # persist is optional<br> $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br> <br> $dsn = 'oci8://user:pwd@host/sid';<br> $conn = ADONewConnection($dsn);<br> <br> $dsn = 'oci8://user:pwd@/'; # oracle on local machine<br> $conn = ADONewConnection($dsn);<br></pre> +<p>You can also set the charSet for Oracle 9.2 and later, supported since PHP 4.3.2, ADOdb 4.54: +</p><pre> $conn->charSet = 'we8iso8859p1';<br> $conn->Connect(...);<br> <br> # or<br> $dsn = 'oci8://user:pwd@tnsname/?charset=WE8MSWIN1252';<br> $db = ADONewConnection($dsn);<br></pre> +<a name="dsnless"></a> +<h4>DSN-less ODBC ( Access, MSSQL and DB2 examples)</h4> +<p>ODBC DSN's can be created in the ODBC control panel, or you can use a DSN-less + connection.To use DSN-less connections with ODBC you need PHP 4.3 or later. +</p> +<p>For Microsoft Access:</p> +<pre> $db =& ADONewConnection('access');<br> $dsn = <strong>"Driver={Microsoft Access Driver (*.mdb)};Dbq=d:\\northwind.mdb;Uid=Admin;Pwd=;";</strong> + $db->Connect($dsn); +</pre> +For Microsoft SQL Server: +<pre> $db =& ADONewConnection('odbc_mssql');<br> $dsn = <strong>"Driver={SQL Server};Server=localhost;Database=northwind;"</strong>;<br> $db->Connect($dsn,'userid','password');<br></pre> +or if you prefer to use the mssql extension (which is limited to mssql 6.5 functionality): +<pre> $db =& ADONewConnection('mssql');<br> $db->Execute('localhost', 'userid', 'password', 'northwind');<br></pre> +For DB2: +<pre> + $dbms = 'db2'; # or 'odbc_db2' if db2 extension not available + $db =& ADONewConnection($dbms); + $dsn = "driver={IBM db2 odbc DRIVER};Database=sample;hostname=localhost;port=50000;protocol=TCPIP;". + "uid=root; pwd=secret";<br> $db->Connect($dsn); +</pre> +<b>DSN-less Connections with ADO</b><br> +If you are using versions of PHP earlier than PHP 4.3.0, DSN-less connections +only work with Microsoft's ADO, which is Microsoft's COM based API. An example +using the ADOdb library and Microsoft's ADO: +<pre><?php<br> include('adodb.inc.php'); <br> $db = &ADONewConnection("ado_mssql");<br> print "<h1>Connecting DSN-less $db->databaseType...</h1>";<br> <br> <b>$myDSN="PROVIDER=MSDASQL;DRIVER={SQL Server};"<br> . "SERVER=flipper;DATABASE=ai;UID=sa;PWD=;" ;</b> + $db->Connect($myDSN); + + $rs = $db->Execute("select * from table"); + $arr = $rs->GetArray(); + print_r($arr); +?> +</pre><a name="speed"></a> +<h2>High Speed ADOdb - tuning tips</h2> +<p>ADOdb is a big class library, yet it <a href="http://phplens.com/lens/adodb/">consistently beats</a> all other PHP class + libraries in performance. This is because it is designed in a layered fashion, + like an onion, with the fastest functions in the innermost layer. Stick to the + following functions for best performance:</p> +<table align="center" border="1" width="40%"> + <tbody><tr> + <td><div align="center"><b>Innermost Layer</b></div></td> + </tr> + <tr> + <td><p align="center">Connect, PConnect, NConnect<br> + Execute, CacheExecute<br> + SelectLimit, CacheSelectLimit<br> + MoveNext, Close <br> + qstr, Affected_Rows, Insert_ID</p></td> + </tr> +</tbody></table> +<p>The fastest way to access the field data is by accessing the array $recordset->fields + directly. Also set the global variables <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a> + = ADODB_FETCH_NUM, and (for oci8, ibase/firebird and odbc) <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> = false + before you connect to your database.</p> +<p>Consider using bind parameters if your database supports it, as it improves + query plan reuse. Use ADOdb's performance tuning system to identify bottlenecks + quickly. At the time of writing (Dec 2003), this means oci8 and odbc drivers.</p> + <p>Lastly make sure you have a PHP accelerator cache installed such as APC, Turck + MMCache, Zend Accelerator or ionCube.</p> + <p>Some examples:</p> + <table align="center" border="1"><tbody><tr><td><b>Fastest data retrieval using PHP</b></td><td><b>Fastest data retrieval using ADOdb extension</b></td></tr> +<tr><td> +<pre>$rs =& $rs->Execute($sql);<br>while (!$rs->EOF) {<br> var_dump($rs->fields);<br> $rs->MoveNext();<br>}</pre></td><td> +<pre>$rs =& $rs->Execute($sql);<br>$array = adodb_getall($rs);<br>var_dump($array);<br><br><br></pre></td></tr></tbody></table> + <p><b>Advanced Tips</b> + </p><p>If you have the <a href="http://adodb.sourceforge.net/#extension">ADOdb C extension</a> installed, + you can replace your calls to $rs->MoveNext() with adodb_movenext($rs). + This doubles the speed of this operation. For retrieving entire recordsets at once, +use GetArray(), which uses the high speed extension function adodb_getall($rs) internally. + </p><p>Execute() is the default way to run queries. You can use the low-level functions _Execute() and _query() +to reduce query overhead. Both these functions share the same parameters as Execute(). +</p><p>If you do not have any bind parameters or your database supports +binding (without emulation), +then you can call _Execute() directly. Calling this function bypasses +bind emulation. Debugging is still supported in _Execute(). +</p><p>If you do not require debugging facilities nor emulated +binding, and do not require a recordset to be returned, then you can +call _query. This is great for inserts, updates and deletes. Calling +this function +bypasses emulated binding, debugging, and recordset handling. Either +the resultid, true or false are returned by _query(). </p><p>For Informix, you can disable scrollable cursors with $db->cursorType = 0. +</p><p><a name="hack"></a> </p> +<h2>Hacking ADOdb Safely</h2> +<p>You might want to modify ADOdb for your own purposes. Luckily you can +still maintain backward compatibility by sub-classing ADOdb and using the $ADODB_NEWCONNECTION +variable. $ADODB_NEWCONNECTION allows you to override the behaviour of ADONewConnection(). +ADOConnection() checks for this variable and will call +the function-name stored in this variable if it is defined. +</p><p>In the following example, new functionality for the connection object +is placed in the <i>hack_mysql</i> and <i>hack_postgres7</i> classes. The recordset class naming convention +can be controlled using $rsPrefix. Here we set it to 'hack_rs_', which will make ADOdb use +<i>hack_rs_mysql</i> and <i>hack_rs_postgres7</i> as the recordset classes. + + +</p><pre>class hack_mysql extends adodb_mysql {<br>var $rsPrefix = 'hack_rs_';<br> /* Your mods here */<br>}<br><br>class hack_rs_mysql extends ADORecordSet_mysql {<br> /* Your mods here */<br>}<br><br>class hack_postgres7 extends adodb_postgres7 {<br>var $rsPrefix = 'hack_rs_';<br> /* Your mods here */<br>}<br><br>class hack_rs_postgres7 extends ADORecordSet_postgres7 {<br> /* Your mods here */<br>}<br><br>$ADODB_NEWCONNECTION = 'hack_factory';<br><br>function& hack_factory($driver)<br>{<br> if ($driver !== 'mysql' && $driver !== 'postgres7') return false;<br> <br> $driver = 'hack_'.$driver;<br> $obj = new $driver();<br> return $obj;<br>}<br><br>include_once('adodb.inc.php');<br></pre> +<p></p><p>Don't forget to call the constructor of the parent class in +your constructor. If you want to use the default ADOdb drivers return +false in the above hack_factory() function. +<a name="php5"></a> +</p><h2>PHP5 Features</h2> + ADOdb 4.02 or later will transparently determine which version of PHP you are using. +If PHP5 is detected, the following features become available: +<ul> + +<li><b>PDO</b>: PDO drivers are available. See the <a href=#pdo>connection examples</a>. Currently PDO drivers are + not as powerful as native drivers, and should be treated as experimental.<br><br> +<a name="php5iterators"></a> +<li><b>Foreach iterators</b>: This is a very natural way of going through a recordset: +<pre> $ADODB_FETCH_MODE = ADODB_FETCH_NUM;<br> $rs = $db->Execute($sql);<br> foreach($rs as $k => $row) {<br> echo "r1=".$row[0]." r2=".$row[1]."<br>";<br> }<br></pre> +<p> +<a name="php5exceptions"></a> +</p></li><li><b>Exceptions</b>: Just include <i>adodb-exceptions.inc.php</i> and you can now +catch exceptions on errors as they occur. +<pre> <b>include("../adodb-exceptions.inc.php");</b> <br> include("../adodb.inc.php"); <br> try { <br> $db = NewADOConnection("oci8"); <br> $db->Connect('','scott','bad-password'); <br> } catch (exception $e) { <br> var_dump($e); <br> adodb_backtrace($e->gettrace());<br> } <br></pre> +<p>Note that reaching EOF is <b>not</b> considered an error nor an exception. +</p></li></ul> +<h3><a name="drivers"></a>Databases Supported</h3> +The <i>name</i> below is the value you pass to NewADOConnection($name) to create a connection object for that database. +<p> +</p><p> +</p><table border="1" width="100%"> + <tbody><tr valign="top"> + <td><b>Name</b></td> + <td><b>Tested</b></td> + <td><b>Database</b></td> + <td><b><font size="2">RecordCount() usable</font></b></td> + <td><b>Prerequisites</b></td> + <td><b>Operating Systems</b></td> + </tr> + <tr valign="top"> + <td><b><font size="2">access</font></b></td> + <td><font size="2">B</font></td> + <td><font size="2">Microsoft Access/Jet. You need to create an ODBC DSN.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ODBC </font></td> + <td><font size="2">Windows only</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">ado</font></b></td> + <td><font size="2">B</font></td> + <td><p><font size="2">Generic ADO, not tuned for specific databases. Allows + DSN-less connections. For best performance, use an OLEDB provider. This + is the base class for all ado drivers.</font></p> + <p><font size="2">You can set $db->codePage before connecting.</font></p></td> + <td><font size="2">? depends on database</font></td> + <td><font size="2">ADO or OLEDB provider</font></td> + <td><font size="2">Windows only</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">ado_access</font></b></td> + <td><font size="2">B</font></td> + <td><font size="2">Microsoft Access/Jet using ADO. Allows DSN-less connections. + For best performance, use an OLEDB provider.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ADO or OLEDB provider</font></td> + <td><font size="2">Windows only</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">ado_mssql</font></b></td> + <td><font size="2">B</font></td> + <td><font size="2">Microsoft SQL Server using ADO. Allows DSN-less connections. + For best performance, use an OLEDB provider.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ADO or OLEDB provider</font></td> + <td><font size="2">Windows only</font></td> + </tr> + <tr valign="top"> + <td height="54"><b><font size="2">db2</font></b></td> + <td height="54"><font size="2">C</font></td> + <td height="54"><font size="2">Uses PHP's db2-specific extension for better performance.</font></td> + <td height="54"><font size="2">Y/N</font></td> + <td height="54"><font size="2">DB2 CLI/ODBC interface</font></td> + <td height="54"> <p><font size="2">Unix and Windows. Requires IBM DB2 Universal Database client.</font></p></td> + </tr> + <tr valign="top"> + <td height="54"><b><font size="2">odbc_db2</font></b></td> + <td height="54"><font size="2">C</font></td> + <td height="54"><font size="2">Connects to DB2 using generic ODBC extension.</font></td> + <td height="54"><font size="2">Y/N</font></td> + <td height="54"><font size="2">DB2 CLI/ODBC interface</font></td> + <td height="54"> <p><font size="2">Unix and Windows. <a href="http://www.faqts.com/knowledge_base/view.phtml/aid/6283/fid/14">Unix + install hints</a>. I have had reports that the $host and $database params have to be reversed in Connect() when using the CLI interface.</font></p></td> + </tr> + <tr valign="top"> + <td><b><font size="2">vfp</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">Microsoft Visual FoxPro. You need to create an ODBC DSN.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ODBC</font></td> + <td><font size="2">Windows only</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">fbsql</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">FrontBase. </font></td> + <td><font size="2">Y</font></td> + <td><font size="2">?</font></td> + <td> <p><font size="2">Unix and Windows</font></p></td> + </tr> + <tr valign="top"> + <td><b><font size="2">ibase</font></b></td> + <td><font size="2">B</font></td> + <td><font size="2">Interbase 6 or earlier. Some users report you might need + to use this<br> + $db->PConnect('localhost:c:/ibase/employee.gdb', "sysdba", "masterkey") + to connect. Lacks Affected_Rows currently.<br> + <br> + You can set $db->role, $db->dialect, $db->buffers and $db->charSet before connecting.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Interbase client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><i><font size="2">firebird</font></i></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Firebird version of interbase.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Interbase client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><i><font size="2">borland_ibase</font></i></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Borland version of Interbase 6.5 or later. Very sad that + the forks differ.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Interbase client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + + <tr valign="top"> + <td><b><font size="2">informix</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Generic informix driver. Use this if you are using Informix 7.3 or later.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Informix client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">informix72</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2"> Informix databases before Informix 7.3 that do no support + SELECT FIRST.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Informix client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">ldap</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">LDAP driver. See this example for usage information.</font></td> + <td> </td> + <td><font size="2">LDAP extension</font></td> + <td><font size="2">?</font></td> + </tr> + <tr valign="top"> + <td height="73"><b><font size="2">mssql</font></b></td> + <td height="73"><font size="2">A</font></td> + <td height="73"> <p><font size="2">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!</font></p></td> + <td height="73"><font size="2">Y/N</font></td> + <td height="73"><font size="2">Mssql client</font></td> + <td height="73"> <p><font size="2">Unix and Windows. <br> + <a href="http://phpbuilder.com/columns/alberto20000919.php3">Unix install + howto</a> and <a href="http://linuxjournal.com/article.php?sid=6636&mode=thread&order=0">another + one</a>. </font></p></td> + </tr> + <tr valign="top"> + <td height="73"><b><font size="2">mssqlpo</font></b></td> + <td height="73"><font size="2">A</font></td> + <td height="73"> <p><font size="2">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 + ||.</font></p></td> + <td height="73"><font size="2">Y/N</font></td> + <td height="73"><font size="2">Mssql client</font></td> + <td height="73"> <p><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3"><br> + Unix install howto</a>.</font></p></td> + </tr> + <tr valign="top"> + <td><b><font size="2">mysql</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">MySQL without transaction support. You can also set $db->clientFlags + before connecting.</font></td> + <td><font size="2">Y</font></td> + <td><font size="2">MySQL client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><font size="2"><b>mysqlt</b> or <b>maxsql</b></font></td> + <td><font size="2">A</font></td> + <td> <p><font size="2">MySQL with transaction support. We recommend using + || as the concat operator for best portability. This can be done by running + MySQL using: <br> + <i>mysqld --ansi</i> or <i>mysqld --sql-mode=PIPES_AS_CONCAT</i></font></p></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">MySQL client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">oci8</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">Oracle 8/9. Has more functionality than <i>oracle</i> driver + (eg. Affected_Rows). You might have to putenv('ORACLE_HOME=...') before + Connect/PConnect. </font> <p><font size="2"> There are 2 ways of connecting + - with server IP and service name: <br> + <i>PConnect('serverip:1521','scott','tiger','service'</i>)<br> + or using an entry in TNSNAMES.ORA or ONAMES or HOSTNAMES: <br> + <i>PConnect(false, 'scott', 'tiger', $oraname)</i>. </font> + </p><p><font size="2">Since 2.31, we support Oracle REF cursor variables directly + (see <a href="#executecursor">ExecuteCursor</a>).</font> </p></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Oracle client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">oci805</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Supports reduced Oracle functionality for Oracle 8.0.5. + SelectLimit is not as efficient as in the oci8 or oci8po drivers.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Oracle client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">oci8po</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">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. </font> <p><font size="2">Use this driver if porting + from other databases is important. Otherwise the oci8 driver offers better + performance. </font> </p></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Oracle client</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">odbc</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">Generic ODBC, not tuned for specific databases. To connect, + use <br> + PConnect('DSN','user','pwd'). This is the base class for all odbc derived + drivers.</font></td> + <td><font size="2">? depends on database</font></td> + <td><font size="2">ODBC</font></td> + <td><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3?page=4">Unix + hints.</a></font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">odbc_mssql</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Uses ODBC to connect to MSSQL</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ODBC</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">odbc_oracle</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Uses ODBC to connect to Oracle</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">ODBC</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + + <tr valign="top"> + <td><b><font size="2">odbtp</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Generic odbtp driver. <a href="http://odbtp.sourceforge.net/">Odbtp</a> is a software for + accessing Windows ODBC data sources from other operating systems.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">odbtp</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">odbtp_unicode</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Odtbp with unicode support</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">odbtp</font></td> + <td><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td height="34"><b><font size="2">oracle</font></b></td> + <td height="34"><font size="2">C</font></td> + <td height="34"><font size="2">Implements old Oracle 7 client API. Use oci8 + driver if possible for better performance.</font></td> + <td height="34"><font size="2">Y/N</font></td> + <td height="34"><font size="2">Oracle client</font></td> + <td height="34"><font size="2">Unix and Windows</font></td> + </tr> + <tr valign="top"> + <td height="34"><b><font size="2">netezza</font></b></td> + <td height="34"><font size="2">C</font></td> + <td height="34"><font size="2">Netezza driver. Netezza is based on postgres code-base.</font></td> + <td height="34"><font size="2">Y</font></td> + <td height="34"><font size="2">?</font></td> + <td height="34"><font size="2">?</font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">pdo</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Generic PDO driver for PHP5. </font></td> + <td><font size="2">Y</font></td> + <td><font size="2">PDO extension and database specific drivers</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">postgres</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">Generic PostgreSQL driver. Currently identical to postgres7 + driver.</font></td> + <td><font size="2">Y</font></td> + <td><font size="2">PostgreSQL client</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">postgres64</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">For PostgreSQL 6.4 and earlier which does not support LIMIT + internally.</font></td> + <td><font size="2">Y</font></td> + <td><font size="2">PostgreSQL client</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">postgres7</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">PostgreSQL which supports LIMIT and other version 7 functionality.</font></td> + <td><font size="2">Y</font></td> + <td><font size="2">PostgreSQL client</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">postgres8</font></b></td> + <td><font size="2">A</font></td> + <td><font size="2">PostgreSQL which supports version 8 functionality.</font></td> + <td><font size="2">Y</font></td> + <td><font size="2">PostgreSQL client</font></td> + <td><font size="2">Unix and Windows. </font></td> + </tr> + <tr valign="top"> + <td><b><font size="2">sapdb</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">SAP DB. Should work reliably as based on ODBC driver.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">SAP ODBC client</font></td> + <td> <p><font size="2">?</font></p></td> + </tr> + <tr valign="top"> + <td><b><font size="2">sqlanywhere</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Sybase SQL Anywhere. Should work reliably as based on ODBC + driver.</font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">SQL Anywhere ODBC client</font></td> + <td> <p><font size="2">?</font></p></td> + </tr> + <tr valign="top"> + <td height="54"><b><font size="2">sqlite</font></b></td> + <td height="54"><font size="2">B</font></td> + <td height="54"><font size="2">SQLite.</font></td> + <td height="54"><font size="2">Y</font></td> + <td height="54"><font size="2">-</font></td> + <td height="54"> <p><font size="2">Unix and Windows.</font></p></td> + </tr> + <tr valign="top"> + <td height="54"><b><font size="2">sqlitepo</font></b></td> + <td height="54"><font size="2">B</font></td> + <td height="54"><font size="2">Portable SQLite driver. This is because assoc mode does not work like other drivers in sqlite. + Namely, when selecting (joining) multiple tables, the table + names are included in the assoc keys in the "sqlite" driver.</font><p> +<font size="2"> In "sqlitepo" driver, the table names are stripped from the returned column names. + When this results in a conflict, the first field get preference. + </font></p></td> + <td height="54"><font size="2">Y</font></td> + <td height="54"><font size="2">-</font></td> + <td height="54"> <p><font size="2">Unix and Windows.</font></p></td> + </tr> + + + <tr valign="top"> + <td><b><font size="2">sybase</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Sybase. </font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Sybase client</font></td> + <td> <p><font size="2">Unix and Windows.</font></p></td> + </tr> + + <tr valign="top"> + <td><b><font size="2">sybase_ase</font></b></td> + <td><font size="2">C</font></td> + <td><font size="2">Sybase ASE. </font></td> + <td><font size="2">Y/N</font></td> + <td><font size="2">Sybase client</font></td> + <td> <p><font size="2">Unix and Windows.</font></p></td> + </tr> + </tbody></table> + +<p></p><p>The "Tested" column indicates how extensively the code has been tested + and used. <br> + A = well tested and used by many people<br> + B = tested and usable, but some features might not be implemented<br> + C = user contributed or experimental driver. Might not fully support all of + the latest features of ADOdb. </p> +<p>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 (this 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. Also there is a + speed penalty of 40-50% if emulation is required. This is emulated in most databases + except for PostgreSQL and MySQL. This variable is checked every time a query + is executed, so you can selectively choose which recordsets to count.</p> +<p> +</p><hr /> +<h1>Tutorials<a name="quickstart"></a></h1> +<h3>Example 1: Select Statement<a name="ex1"></a></h3> +<p>Task: Connect to the Access Northwind DSN, display the first 2 columns of each + row.</p> +<p>In this example, we create a ADOConnection object, which represents the connection + to the database. The connection is initiated with <a href="#pconnect"><font face="Courier New, Courier, mono">PConnect</font></a>, + which is a persistent connection. Whenever we want to query the database, we + call the <font face="Courier New, Courier, mono">ADOConnection.<a href="#execute">Execute</a>()</font> + function. This returns an ADORecordSet object which is actually a cursor that + holds the current row in the array <font face="Courier New, Courier, mono">fields[]</font>. + We use <font face="Courier New, Courier, mono"><a href="#movenext">MoveNext</a>()</font> + to move from row to row.</p> +<p>NB: A useful function that is not used in this example is <font face="Courier New, Courier, mono"><a href="#selectlimit">SelectLimit</a></font>, + which allows us to limit the number of rows shown. +</p><pre><?<br><font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind DSN<br>$<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select * from products');<br>if (!$<font color="#660000">recordSet</font>) <br> print $<font color="#660000">conn</font>->ErrorMsg();<br>else<br><b>while</b> (!$<font color="#660000">recordSet</font>->EOF) {<br> <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';<br> $<font color="#660000">recordSet</font>->MoveNext();<br>}</font><font face="Courier New, Courier, mono"> + +$<font color="#660000">recordSet</font>->Close(); # optional<br>$<font color="#660000">conn</font>->Close(); # optional<br></font> +?> +</pre> +<p>The $<font face="Courier New, Courier, mono">recordSet</font> returned stores + the current row in the <font face="Courier New, Courier, mono">$recordSet->fields</font> + array, indexed by column number (starting from zero). We use the <font face="Courier New, Courier, mono"><a href="#movenext">MoveNext</a>()</font> + function to move to the next row. The <font face="Courier New, Courier, mono">EOF</font> + property is set to true when end-of-file is reached. If an error occurs in Execute(), + we return false instead of a recordset.</p> +<p>The <code>$recordSet->fields[]</code> 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 SetFetchMode function. Each recordset saves and uses whatever fetch + mode was set when the recordset was created in Execute() or SelectLimit(). +</p><pre> $db->SetFetchMode(ADODB_FETCH_NUM);<br> $rs1 = $db->Execute('select * from table');<br> $db->SetFetchMode(ADODB_FETCH_ASSOC);<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> + print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i> +</pre> +<p> </p> +<p>To get the number of rows in the select statement, you can use <font face="Courier New, Courier, mono">$recordSet-><a href="#recordcount">RecordCount</a>()</font>. + Note that it can return -1 if the number of rows returned cannot be determined.</p> +<h3>Example 2: Advanced Select with Field Objects<a name="ex2"></a></h3> +<p>Select a table, display the first two columns. If the second column is a date + or timestamp, reformat the date to US format.</p> +<pre><?<br><font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br>$<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select CustomerID,OrderDate from Orders');<br>if (!$<font color="#660000">recordSet</font>) <br> print $<font color="#660000">conn</font>->ErrorMsg();<br>else<br><b>while</b> (!$<font color="#660000">recordSet</font>->EOF) {<br> $<font color="#660000">fld</font> = <font color="#336600"><b>$</b><font color="#660000">recordSet</font><b>->FetchField</b></font><font color="#006600">(</font>1<font color="#006600">);</font> + $<font color="#660000">type</font> = <font color="#336600"><b>$</b><font color="#660000">recordSet</font><b>->MetaType</b></font>($fld->type);<br><br> <b>if</b> ( $<font color="#660000">type</font> == 'D' || $<font color="#660000">type</font> == 'T') <br> <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.<br> <b><font color="#336600">$</font></b><font color="#660000">recordSet</font><b><font color="#336600">->UserDate</font></b>($<font color="#660000">recordSet</font>->fields[1],'<b>m/d/Y</b>').'<BR>';<br> <b>else </b> + <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';<br><br> $<font color="#660000">recordSet</font>->MoveNext();<br>}</font><font face="Courier New, Courier, mono"> +$<font color="#660000">recordSet</font>->Close(); # optional<br>$<font color="#660000">conn</font>->Close(); # optional<br></font> +?> +</pre> +<p>In this example, we check the field type of the second column using <font face="Courier New, Courier, mono"><a href="#fetchfield">FetchField</a>().</font> + This returns an object with at least 3 fields.</p> +<ul> + <li><b>name</b>: name of column</li> + <li> <b>type</b>: native field type of column</li> + <li> <b>max_length</b>: 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.</li> +</ul> +<p>We then use <font face="Courier New, Courier, mono"><a href="#metatype">MetaType</a>()</font> + to translate the native type to a <i>generic</i> type. Currently the following + <i>generic</i> types are defined:</p> +<ul> + <li><b>C</b>: character fields that should be shown in a <input type="text"> + tag.</li> + <li><b>X</b>: TeXt, large text fields that should be shown in a <textarea></li> + <li><b>B</b>: Blobs, or Binary Large Objects. Typically images. + </li><li><b>D</b>: Date field</li> + <li><b>T</b>: Timestamp field</li> + <li><b>L</b>: Logical field (boolean or bit-field)</li> + <li><b>I</b>: Integer field</li> + <li><b>N</b>: Numeric field. Includes autoincrement, numeric, floating point, + real and integer. </li> + <li><b>R</b>: Serial field. Includes serial, autoincrement integers. This works + for selected databases. </li> +</ul> +<p>If the metatype is of type date or timestamp, then we print it using the user + defined date format with <font face="Courier New, Courier, mono"><a href="#userdate">UserDate</a>(),</font> + which converts the PHP SQL date string format to a user defined one. Another + use for <font face="Courier New, Courier, mono"><a href="#metatype">MetaType</a>()</font> + is data validation before doing an SQL insert or update.</p> +<h3>Example 3: Inserting<a name="ex3"></a></h3> +<p>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 <i>John's</i>.</p> +<pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br><br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br>$<font color="#660000">shipto</font> = <font color="#006600"><b>$conn->qstr</b></font>("<i>John's Old Shoppe</i>");<br><br>$<font color="#660000">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";<br>$<font color="#660000">sql</font> .= "values ('ANATR',2,".<b><font color="#006600">$conn->DBDate(</font>time()<font color="#006600">)</font></b><font color="#006600">.</font>",$<font color="#660000">shipto</font>)";<br><br><b>if</b> ($<font color="#660000">conn</font>->Execute($<font color="#660000">sql</font>) <font color="#336600"><b>=== false</b></font>) {<br> <b>print</b> 'error inserting: '.<font color="#336600"><b>$conn->ErrorMsg()</b></font>.'<BR>';<br>}<br>?><br></pre> +<p>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 <font face="Courier New, Courier, mono"><a href="#dbdate">DBDate</a>()</font>, + and the right escape character is used for quoting the <i>John's Old Shoppe</i>, + which is<b> </b><i>John'<b>'</b>s Old Shoppe</i> and not PHP's default <i>John<b>'</b>s + Old Shoppe</i> with <font face="Courier New, Courier, mono"><a href="#qstr">qstr</a>()</font>. +</p> +<p>Observe the error-handling of the Execute statement. False is returned by<font face="Courier New, Courier, mono"> + <a href="#execute">Execute</a>() </font>if an error occured. The error message + for the last error that occurred is displayed in <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font>. + Note: <i>php_track_errors</i> might have to be enabled for error messages to + be saved.</p> +<h3> Example 4: Debugging<a name="ex4"></a></h3> +<pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br><font>$<font color="#663300">shipto</font> = <b>$conn->qstr</b>("John's Old Shoppe");<br>$<font color="#663300">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";<br>$<font color="#663300">sql</font> .= "values ('ANATR',2,".$<font color="#663300">conn</font>->FormatDate(time()).",$shipto)";<br><b><font color="#336600">$<font color="#663300">conn</font>->debug = true;</font></b> +<b>if</b> ($<font color="#663300">conn</font>->Execute($sql) <b>=== false</b>) <b>print</b> 'error inserting';</font> +?> +</pre> +<p>In the above example, we have turned on debugging by setting <b>debug = true</b>. + This will display the SQL statement before execution, and also show any error + messages. There is no need to call <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font> + in this case. For displaying the recordset, see the <font face="Courier New, Courier, mono"><a href="#exrs2html">rs2html</a>() + </font>example.</p> +<p>Also see the section on <a href="#errorhandling">Custom Error Handlers</a>.</p> +<h3>Example 5: MySQL and Menus<a name="ex5"></a></h3> +<p>Connect to MySQL database <i>agora</i>, 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.</p> +<pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br><font>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';<br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->Execute($sql);<br><b>print</b> <b><font color="#336600">$<font color="#663300">rs</font>->GetMenu('GetCust','Mary Rosli');<br>?></font></b></font></pre> +<p>Here we define a menu named GetCust, with the menu option 'Mary Rosli' selected. + See <a href="#getmenu"><font face="Courier New, Courier, mono">GetMenu</font></a><font face="Courier New, Courier, mono">()</font>. + We also have functions that return the recordset as an array: <font face="Courier New, Courier, mono"><a href="#getarray">GetArray</a>()</font>, + and as an associative array with the key being the first column: <a href="#getassoc1">GetAssoc</a>().</p> +<h3>Example 6: Connecting to 2 Databases At Once<a name="ex6"></a></h3> +<pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn1</font> = &ADONewConnection('mysql'); # create a mysql connection<br>$<font color="#663300">conn2</font> = &ADONewConnection('oracle'); # create a oracle connection<br><br>$conn1->PConnect($server, $userid, $password, $database);<br>$conn2->PConnect(false, $ora_userid, $ora_pwd, $oraname);<br><br>$conn1->Execute('insert ...');<br>$conn2->Execute('update ...');<br>?></pre> +<p> +</p><h3>Example 7: Generating Update and Insert SQL<a name="ex7"></a></h3> +<p>Since ADOdb 4.56, we support <a href="reference.functions.getupdatesql.html#autoexecute">AutoExecute()</a>, +which simplifies things by providing an advanced wrapper for GetInsertSQL() and GetUpdateSQL(). For example, +an INSERT can be carried out with: + +<pre> + $record["firstname"] = "Bob"; + $record["lastname"] = "Smith"; + $record["created"] = time(); + $insertSQL = $conn->AutoExecute($rs, $record, 'INSERT'); +</pre> + +and an UPDATE with: +<pre> + $record["firstname"] = "Caroline"; + $record["lastname"] = "Smith"; # Update Caroline's lastname from Miranda to Smith + $insertSQL = $conn->AutoExecute($rs, $record, 'UPDATE', 'id = 1'); +</pre> +<p> +The rest of this section is out-of-date: +<p>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. +<p> We show how the functions can be used when accessing a table with the following + fields: (ID, FirstName, LastName, Created). +</p><p> 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. + Since ADOdb 2.42, you can pass a table name instead of a recordset into +GetInsertSQL (in $rs), and it will generate an insert statement for that table. +</p><p> +</p><pre><?<br>#==============================================<br># SAMPLE GetUpdateSQL() and GetInsertSQL() code<br>#==============================================<br>include('adodb.inc.php');<br>include('tohtml.inc.php');<br><br>#==========================<br># This code tests an insert<br><br>$sql = "SELECT * FROM ADOXYZ WHERE id = -1"; <br># Select an empty record from the database<br><br>$conn = &ADONewConnection("mysql"); # create a connection<br>$conn->debug=1;<br>$conn->PConnect("localhost", "admin", "", "test"); # connect to MySQL, testdb<br>$rs = $conn->Execute($sql); # Execute the query and get the empty recordset<br><br>$record = array(); # Initialize an array to hold the record data to insert<br><br># Set the values for the fields in the record<br># Note that field names are case-insensitive<br>$record["firstname"] = "Bob";<br>$record["lastNamE"] = "Smith";<br>$record["creaTed"] = time();<br><br># Pass the empty recordset and the array containing the data to insert<br># into the GetInsertSQL function. The function will process the data and return<br># a fully formatted insert sql statement.<br>$insertSQL = $conn->GetInsertSQL($rs, $record);<br><br>$conn->Execute($insertSQL); # Insert the record into the database<br><br>#==========================<br># This code tests an update<br><br>$sql = "SELECT * FROM ADOXYZ WHERE id = 1"; <br># Select a record to update<br><br>$rs = $conn->Execute($sql); # Execute the query and get the existing record to update<br><br>$record = array(); # Initialize an array to hold the record data to update<br><br># Set the values for the fields in the record<br># Note that field names are case-insensitive<br>$record["firstname"] = "Caroline";<br>$record["LasTnAme"] = "Smith"; # Update Caroline's lastname from Miranda to Smith<br><br># Pass the single record recordset and the array containing the data to update<br># into the GetUpdateSQL function. The function will process the data and return<br># a fully formatted update sql statement with the correct WHERE clause.<br># If the data has not changed, no recordset is returned<br>$updateSQL = $conn->GetUpdateSQL($rs, $record);<br><br>$conn->Execute($updateSQL); # Update the record in the database<br>$conn->Close();<br>?><br></pre> +<a name="ADODB_FORCE_TYPE"></a> +<b>$ADODB_FORCE_TYPE</b><p> +The behaviour of AutoExecute(), GetUpdateSQL() and GetInsertSQL() +when converting empty or null PHP variables to SQL is controlled by the + global $ADODB_FORCE_TYPE variable. Set it to one of the values below. Default + is ADODB_FORCE_VALUE (3): +</p><pre>0 = ignore empty fields. All empty fields in array are ignored.<br>1 = force null. All empty, php null and string 'null' fields are changed to sql NULL values.<br>2 = force empty. All empty, php null and string 'null' fields are changed to sql empty '' or 0 values.<br>3 = force value. Value is left as it is. Php null and string 'null' are set to sql NULL values and <br> empty fields '' are set to empty '' sql values.<br><br>define('ADODB_FORCE_IGNORE',0);<br>define('ADODB_FORCE_NULL',1);<br>define('ADODB_FORCE_EMPTY',2);<br>define('ADODB_FORCE_VALUE',3);<br></pre> +<p> +Thanks to Niko (nuko#mbnet.fi) for the $ADODB_FORCE_TYPE code. +</p><p> +Note: the constant ADODB_FORCE_NULLS is obsolete since 4.52 and is ignored. Set $ADODB_FORCE_TYPE = ADODB_FORCE_NULL +for equivalent behaviour. +<p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. +</p><h3>Example 8: Implementing Scrolling with Next and Previous<a name="ex8"></a></h3> +<p> The following code creates a very simple recordset pager, where you can scroll + from page to page of a recordset.</p> +<pre>include_once('../adodb.inc.php');<br>include_once('../adodb-pager.inc.php');<br>session_start();<br><br>$db = NewADOConnection('mysql');<br><br>$db->Connect('localhost','root','','xphplens');<br><br>$sql = "select * from adoxyz ";<br><br>$pager = new ADODB_Pager($db,$sql);<br>$pager->Render($rows_per_page=5);</pre> +<p>This will create a basic record pager that looks like this: <a name="scr"></a> +</p><p> +<table bgcolor="beige" border="1"> + <tbody><tr> + <td> <a href="#scr"><code>|<</code></a> <a href="#scr"><code><<</code></a> + <a href="#scr"><code>>></code></a> <a href="#scr"><code>>|</code></a> + </td> + </tr> + <tr> + <td><table bgcolor="white" border="1" cols="4" width="100%"> + <tbody><tr><th>ID</th> + <th>First Name</th> + <th>Last Name</th> + <th>Date Created</th> + </tr><tr> + <td align="right">36 </td> + <td>Alan </td> + <td>Turing </td> + <td>Sat 06, Oct 2001 </td> + </tr> + <tr> + <td align="right">37 </td> + <td>Serena </td> + <td>Williams </td> + <td>Sat 06, Oct 2001 </td> + </tr> + <tr> + <td align="right">38 </td> + <td>Yat Sun </td> + <td>Sun </td> + <td>Sat 06, Oct 2001 </td> + </tr> + <tr> + <td align="right">39 </td> + <td>Wai Hun </td> + <td>See </td> + <td>Sat 06, Oct 2001 </td> + </tr> + <tr> + <td align="right">40 </td> + <td>Steven </td> + <td>Oey </td> + <td>Sat 06, Oct 2001 </td> + </tr> + </tbody></table></td> + </tr> + <tr> + <td><font size="-1">Page 8/10</font></td> + </tr> +</tbody></table> +</p><p>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. +</p><p>You can control the column titles by modifying your SQL (supported by most + databases): +</p><pre>$sql = 'select id as "ID", firstname as "First Name", <br> lastname as "Last Name", created as "Date Created" <br> from adoxyz';</pre> +<p>The above code can be found in the <i>adodb/tests/testpaging.php</i> example + included with this release, and the class ADODB_Pager in <i>adodb/adodb-pager.inc.php</i>. + 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. +</p><p>You can also allow display of html by setting $pager->htmlSpecialChars = false. +</p><p>Some of the code used here was contributed by Iván Oliva and Cornel + G. </p> +<h3><a name="ex9"></a>Example 9: Exporting in CSV or Tab-Delimited Format</h3> +<p>We provide some helper functions to export in comma-separated-value (CSV) and + tab-delimited formats:</p> +<pre><b>include_once('/path/to/adodb/toexport.inc.php');</b><br>include_once('/path/to/adodb/adodb.inc.php');<br> +$db = &NewADOConnection('mysql');<br>$db->Connect($server, $userid, $password, $database);<br><br>$rs = $db->Execute('select fname as "First Name", surname as "Surname" from table');<br><br>print "<pre>";<br>print <b>rs2csv</b>($rs); # return a string, CSV format<p>print '<hr>';<br><br>$rs->MoveFirst(); # note, some databases do not support MoveFirst<br>print <b>rs2tab</b>($rs,<i>false</i>); # return a string, tab-delimited<br> # false == suppress field names in first line</p>print '<hr>';<br>$rs->MoveFirst();<br><b>rs2tabout</b>($rs); # send to stdout directly (there is also an rs2csvout function)<br>print "</pre>";<br><br>$rs->MoveFirst();<br>$fp = fopen($path, "w");<br>if ($fp) {<br> <b>rs2csvfile</b>($rs, $fp); # write to file (there is also an rs2tabfile function)<br> fclose($fp);<br>}<br></pre> +<p> 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. +</p><p>All the above functions take as an optional last parameter, $addtitles which + defaults to <i>true</i>. When set to <i>false</i> field names in the first line + are suppressed. <br> +</p><h3>Example 10: Recordset Filters<a name="ex10"></a></h3> +<p>Sometimes we want to pre-process all rows in a recordset before we use it. + For example, we want to ucwords all text in recordset. +</p><pre>include_once('adodb/rsfilter.inc.php');<br>include_once('adodb/adodb.inc.php');<br><br>// ucwords() every element in the recordset<br>function do_ucwords(&$arr,$rs)<br>{<br> foreach($arr as $k => $v) {<br> $arr[$k] = ucwords($v);<br> }<br>}<br><br>$db = NewADOConnection('mysql');<br>$db->PConnect('server','user','pwd','db');<br><br>$rs = $db->Execute('select ... from table');<br>$rs = <b>RSFilter</b>($rs,'do_ucwords');<br></pre> +<p>The <i>RSFilter</i> function takes 2 parameters, the recordset, and the name + of the <i>filter</i> function. It returns the processed recordset scrolled to + the first record. The <i>filter</i> function takes two parameters, the current + row as an array, and the recordset object. For future compatibility, you should + not use the original recordset object. </p> +<h3>Example 11:<a name="ex11"></a> Smart Transactions</h3> +The old way of doing transactions required you to use +<pre>$conn-><b>BeginTrans</b>();<br>$ok = $conn->Execute($sql);<br>if ($ok) $ok = $conn->Execute($sql2);<br>if (!$ok) $conn-><b>RollbackTrans</b>();<br>else $conn-><b>CommitTrans</b>();<br></pre> +This is very complicated for large projects because you have to track the error +status. Smart Transactions is much simpler. You start a smart transaction by calling +StartTrans(): +<pre>$conn-><b>StartTrans</b>();<br>$conn->Execute($sql);<br>$conn->Execute($Sql2);<br>$conn-><b>CompleteTrans</b>();<br></pre> +CompleteTrans() detects when an SQL error occurs, and will Rollback/Commit as +appropriate. To specificly force a rollback even if no error occured, use FailTrans(). +Note that the rollback is done in CompleteTrans(), and not in FailTrans(). +<pre>$conn-><b>StartTrans</b>();<br>$conn->Execute($sql);<br>if (!CheckRecords()) $conn-><strong>FailTrans</strong>();<br>$conn->Execute($Sql2);<br>$conn-><b>CompleteTrans</b>();<br></pre> +<p>You can also check if a transaction has failed, using HasFailedTrans(), which + returns true if FailTrans() was called, or there was an error in the SQL execution. + Make sure you call HasFailedTrans() before you call CompleteTrans(), as it is + only works between StartTrans/CompleteTrans. +</p><p>Lastly, StartTrans/CompleteTrans is nestable, and only the outermost block + is executed. In contrast, BeginTrans/CommitTrans/RollbackTrans is NOT nestable. +</p><pre>$conn-><strong>StartTrans</strong>();<br>$conn->Execute($sql);<br> $conn-><strong>StartTrans</strong>(); <font color="#006600"># ignored</font> + if (!CheckRecords()) $conn->FailTrans(); + $conn-><strong>CompleteTrans</strong>(); <font color="#006600"># ignored</font> +$conn->Execute($Sql2); +$conn-><strong>CompleteTrans</strong>();<br></pre> +<p>Note: Savepoints are currently not supported. +</p><h2><a name="errorhandling"></a>Using Custom Error Handlers and PEAR_Error</h2> +<p>ADOdb supports PHP5 exceptions. Just include <i>adodb-exceptions.inc.php</i> and you can now +catch exceptions on errors as they occur. +</p><pre> <b>include("../adodb-exceptions.inc.php");</b> <br> include("../adodb.inc.php"); <br> try { <br> $db = NewADOConnection("oci8://scott:bad-password@mytns/"); <br> } catch (exception $e) { <br> var_dump($e); <br> adodb_backtrace($e->gettrace());<br> } <br></pre> +<p> ADOdb also provides two custom handlers which you can modify for your needs. The + first one is in the <b>adodb-errorhandler.inc.php</b> file. This makes use of + the standard PHP functions <a href="http://php.net/error_reporting">error_reporting</a> + to control what error messages types to display, and <a href="http://php.net/trigger_error">trigger_error</a> + which invokes the default PHP error handler. +</p><p> Including the above file will cause <i>trigger_error($errorstring,E_USER_ERROR)</i> + to be called when<br> + (a) Connect() or PConnect() fails, or <br> + (b) a function that executes SQL statements such as Execute() or SelectLimit() + has an error.<br> + (c) GenID() appears to go into an infinite loop. +</p><p> 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. +</p><p> If you define error_reporting(0), no errors will be passed to the error handler. + If you set error_reporting(E_ALL), all errors will be passed to the error handler. + You still need to use <b>ini_set("display_errors", "0" or "1")</b> to control + the display of errors. +</p><pre><?php<br><b>error_reporting(E_ALL); # pass any error messages triggered to error handler<br>include('adodb-errorhandler.inc.php');</b> +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); +?> +</pre> +<p> 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 <a href="http://php.net/error_log">error_log</a> + 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. +</p><pre><?php<br><b>error_reporting(E_ALL); # report all errors<br>ini_set("display_errors", "0"); # but do not echo the errors<br>define('ADODB_ERROR_LOG_TYPE',3);<br>define('ADODB_ERROR_LOG_DEST','C:/errors.log');<br>include('adodb-errorhandler.inc.php');</b> +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); +?> +</pre> +The following message will be logged in the error.log file: +<pre>(2001-10-28 14:20:38) mysql error: [1146: Table 'northwind.productsz' doesn't exist] in<br> EXECUTE("select * from productsz")<br></pre> +<h3>PEAR_ERROR</h3> +The second error handler is <b>adodb-errorpear.inc.php</b>. 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(). +<pre><?php<br><b>include('adodb-errorpear.inc.php');</b> +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 { + <b>$e = ADODB_Pear_Error();<br> echo '<p>',$e->message,'</p>';</b> +} +?> +</pre> +<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: +</p><pre>include('PEAR.php');<br>PEAR::setErrorHandling('PEAR_ERROR_DIE');<br></pre> +<p> 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. +</p> +<h3>MetaError and MetaErrMsg</h3> + <p>If you need error messages that work across multiple databases, then use <a href="#metaerror">MetaError()</a>, which returns a virtualized error number, based on PEAR DB's error number system, and <a href=<a href="#metaerrmsg">MetaErrMsg()</a>. + +<h4>Error Messages</h4> +<p>Error messages are outputted using the static method ADOConnnection::outp($msg,$newline=true). + By default, it sends the messages to the client. You can override this to perform + error-logging. +</p><h2><a name="dsn"></a> Data Source Names</h2> +<p>We now support connecting using PEAR style DSN's. A DSN is a connection string + of the form:</p> +<p>$dsn = <i>"$driver://$username:$password@$hostname/$databasename"</i>;</p> +<p>An example:</p> +<pre> $username = 'root';<br> $password = '';<br> $hostname = 'localhost';<br> $databasename = 'xphplens';<br> $driver = 'mysql';<br> $dsn = "$driver://$username:$password@$hostname/$databasename"<br> $db = NewADOConnection(); <br> # DB::Connect($dsn) also works if you include 'adodb/adodb-pear.inc.php' at the top<br> $rs = $db->query('select firstname,lastname from adoxyz');<br> $cnt = 0;<br> while ($arr = $rs->fetchRow()) {<br> print_r($arr); print "<br>";<br> }</pre> + <p></p> +<p> <a href="#dsnsupport">More info and connection examples</a> on the DSN format. + +</p><h2><a name="pear"></a>PEAR Compatibility</h2> + We support DSN's (see above), and the following functions: + <pre><b> DB_Common</b> + query - returns PEAR_Error on error + limitQuery - return PEAR_Error on error + prepare - does not return PEAR_Error on error + execute - does not return PEAR_Error on error + setFetchMode - supports ASSOC and ORDERED + errorNative + quote + nextID + disconnect + + getOne + getAssoc + getRow + getCol + +<b> DB_Result</b> + numRows - returns -1 if not supported + numCols + fetchInto - does not support passing of fetchmode + fetchRows - does not support passing of fetchmode + free +</pre> +<h2><a name="caching"></a>Caching of Recordsets</h2> +<p>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. +</p><p> An example: +</p><pre><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$ADODB_CACHE_DIR = '/usr/ADODB_cache';<br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br><font>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';<br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->CacheExecute(15,$sql);</font></pre> +<p><font> 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. </font></p> +<p><font>For the sake of security, we recommend you set <i>register_globals=off</i> + in php.ini if you are using $ADODB_CACHE_DIR.</font></p> +<p>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. +</p><pre> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; # cache 24 hours<br> $rs = $conn->CacheExecute('select * from table');<br></pre> +<p>Please note that magic_quotes_runtime should be turned off. <a href="http://phplens.com/lens/lensforum/msgs.php?LeNs#LensBM_forummsg">More + info</a>, and do not change $ADODB_FETCH_MODE (or SetFetchMode) + as the cached recordset will use the $ADODB_FETCH_MODE set when the query was executed. <font> +<h2><a name="pivot"></a>Pivot Tables</h2> +</font> </p><p><font>Since ADOdb 2.30, we support the generation of +SQL to create pivot tables, also known as cross-tabulations. For further explanation +read this DevShed <a href="http://www.devshed.com/Server_Side/MySQL/MySQLWiz/">Cross-Tabulation +tutorial</a>. We assume that your database supports the SQL case-when expression. </font></p> +<font> +<p>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 <i>suppliers + versus product categories</i>. 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:</p> +</font> +<table align="center" border="0" cellpadding="2" cellspacing="2"> + <tbody><tr> + <td> + <table align="center" border="1" cellpadding="2" cellspacing="2" width="142"> + <tbody><tr> + <td><i>Supplier</i></td> + <td><i>Category</i></td> + </tr> + <tr> + <td>supplier1</td> + <td>category1</td> + </tr> + <tr> + <td>supplier2</td> + <td>category1</td> + </tr> + <tr> + <td>supplier2</td> + <td>category2</td> + </tr> + </tbody></table> + </td> + <td> <font face="Courier New, Courier, mono">--></font></td> + <td> + <table align="center" border="1" cellpadding="2" cellspacing="2"> + <tbody><tr> + <td> </td> + <td><i>category1</i></td> + <td><i>category2</i></td> + <td><i>total</i></td> + </tr> + <tr> + <td><i>supplier1</i></td> + <td align="right">1</td> + <td align="right">0</td> + <td align="right">1</td> + </tr> + <tr> + <td><i>supplier2</i></td> + <td align="right">1</td> + <td align="right">1</td> + <td align="right">2</td> + </tr> + </tbody></table> + </td> + </tr> +</tbody></table> +<font> +</font><p><font>The following code will generate the SQL for a cross-tabulation: +</font></p><pre><font># Query the main "product" table<br># Set the rows to SupplierName<br># and the columns to the values of Categories<br># and define the joins to link to lookup tables <br># "categories" and "suppliers"<br>#<br> include "adodb/pivottable.inc.php";<br> $sql = PivotTableSQL(<br> $gDB, # adodb connection<br> 'products p ,categories c ,suppliers s', # tables<br> 'SupplierName', # rows (multiple fields allowed)<br> 'CategoryName', # column to pivot on <br> 'p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID' # joins/where<br>);<br></font></pre> + +<p><font> This will generate the following SQL:</font></p> +<p><code><font size="2">SELECT SupplierName, <br> + SUM(CASE WHEN CategoryName='Beverages' THEN 1 ELSE 0 END) AS "Beverages", + <br> + SUM(CASE WHEN CategoryName='Condiments' THEN 1 ELSE 0 END) AS "Condiments", + <br> + SUM(CASE WHEN CategoryName='Confections' THEN 1 ELSE 0 END) AS "Confections", + <br> + SUM(CASE WHEN CategoryName='Dairy Products' THEN 1 ELSE 0 END) AS "Dairy + Products", <br> + SUM(CASE WHEN CategoryName='Grains/Cereals' THEN 1 ELSE 0 END) AS "Grains/Cereals", + <br> + SUM(CASE WHEN CategoryName='Meat/Poultry' THEN 1 ELSE 0 END) AS "Meat/Poultry", + <br> + SUM(CASE WHEN CategoryName='Produce' THEN 1 ELSE 0 END) AS "Produce", + <br> + SUM(CASE WHEN CategoryName='Seafood' THEN 1 ELSE 0 END) AS "Seafood", + <br> + SUM(1) as Total <br> + FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID + and s.SupplierID= p.SupplierID <br> + GROUP BY SupplierName</font></code></p> +<p> You can also pivot on <i>numerical columns</i> and <i>generate totals</i> + by using ranges. <font>This code was revised in ADODB 2.41 + and is not backward compatible.</font> The second example shows this:</p> +<pre> $sql = PivotTableSQL(<br> $gDB, # adodb connection<br> 'products p ,categories c ,suppliers s', # tables<br> 'SupplierName', #<font> rows (multiple fields allowed)</font> + 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 +); +</pre> +<p>Which generates: </p> +<p> <code> <font size="2">SELECT SupplierName, <br> + SUM(CASE WHEN UnitsInStock <= 0 THEN UnitsInStock ELSE 0 END) AS "Sum + 0 ", <br> + SUM(CASE WHEN 0 < UnitsInStock and UnitsInStock <= 5 THEN UnitsInStock + ELSE 0 END) AS "Sum 1 to 5",<br> + SUM(CASE WHEN 5 < UnitsInStock and UnitsInStock <= 10 THEN UnitsInStock + ELSE 0 END) AS "Sum 6 to 10",<br> + SUM(CASE WHEN 10 < UnitsInStock and UnitsInStock <= 15 THEN UnitsInStock + ELSE 0 END) AS "Sum 11 to 15", <br> + SUM(CASE WHEN 15 < UnitsInStock THEN UnitsInStock ELSE 0 END) AS "Sum + 16+", <br> + SUM(UnitsInStock) AS "Sum UnitsInStock", <br> + SUM(1) as Total,<br> + FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID + and s.SupplierID= p.SupplierID <br> + GROUP BY SupplierName</font></code><font size="2"><br> + </font> </p> +<font><hr /> +<h1>Class Reference<a name="ref"></a></h1> +<p>Function parameters with [ ] around them are optional.</p> +</font> +<h2>Global Variables</h2> +<h3><font><a name="adodb_countrecs"></a></font>$ADODB_COUNTRECS</h3> +<p>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.</p> +<h3><font><a name="adodb_cache_dir"></a>$ADODB_CACHE_DIR</font></h3> +<font> +<p>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 <i>register_globals=off</i> in php.ini if you use this + feature for security reasons.</p> +<p>If you are using Unix and apache, you might need to set your cache directory + permissions to something similar to the following:</p> +</font> +<p>chown -R apache /path/to/adodb/cache<br> + chgrp -R apache /path/to/adodb/cache </p> +<h3><font><a name="adodb_ansi_padding_off"></a>$ADODB_ANSI_PADDING_OFF</font></h3> +<p><font>Determines whether to right trim CHAR fields (and also VARCHAR for ibase/firebird). +Set to true to trim. Default is false. Currently works for oci8po, ibase and firebird +drivers. Added in ADOdb 4.01. +</font></p><h3><font><a name="adodb_lang"></a>$ADODB_LANG</font></h3> +<p><font>Determines the language used in MetaErrorMsg(). The default is 'en', for English. +To find out what languages are supported, see the files +in adodb/lang/adodb-$lang.inc.php, where $lang is the supported langauge. +</font></p><h3><font><a name="adodb_fetch_mode"></a>$ADODB_FETCH_MODE</font></h3> +<p><font>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.</font></p> +<p><font>The following constants are defined:</font></p> + +<p><font>define('ADODB_FETCH_DEFAULT',0);<br> + define('ADODB_FETCH_NUM',1);<br> + define('ADODB_FETCH_ASSOC',2);<br> + define('ADODB_FETCH_BOTH',3); </font></p> +<font> +</font><p><font> An example: +</font></p><pre><font> $ADODB_<b>FETCH_MODE</b> = ADODB_FETCH_NUM;<br> $rs1 = $db->Execute('select * from table');<br> $ADODB_<b>FETCH_MODE</b> = ADODB_FETCH_ASSOC;<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> + print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i> +</font></pre> +<p><font> 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().</font></p> +<p><font>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.</font></p> +<p><font><strong>SetFetchMode Function</strong></font></p> +<p><font>If you have multiple connection objects, and want to have different fetch modes for each +connection, then use <a href="#setfetchmode">SetFetchMode</a>. + Once this function is called for a connection object, that connection object + will ignore the global variable $ADODB_FETCH_MODE and will use the internal + fetchMode property exclusively.</font></p> +<pre><font> $db->SetFetchMode(ADODB_FETCH_NUM);<br> $rs1 = $db->Execute('select * from table');<br> $db->SetFetchMode(ADODB_FETCH_ASSOC);<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> + print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i></font></pre> +<p><font>To retrieve the previous fetch mode, you can use check the $db->fetchMode + property, or use the return value of SetFetchMode( ). +</font></p><p><font><strong><a name="adodb_assoc_case"></a>ADODB_ASSOC_CASE</strong></font></p> +<p><font>You can control the associative fetch case for certain drivers which behave + differently. For the sybase, oci8po, mssql, odbc and ibase drivers and all + drivers derived from them, ADODB_ASSOC_CASE will by default generate recordsets + where the field name keys are lower-cased. Use the constant ADODB_ASSOC_CASE + to change the case of the keys. There are 3 possible values:</font></p> +<p><font>0 = assoc lowercase field names. $rs->fields['orderid']<br> + 1 = assoc uppercase field names. $rs->fields['ORDERID']<br> + 2 = use native-case field names. $rs->fields['OrderID'] -- this is the + default since ADOdb 2.90</font></p> +<p><font>To use it, declare it before you incldue adodb.inc.php.</font></p> +<p><font>define('ADODB_ASSOC_CASE', 2); # use native-case for ADODB_FETCH_ASSOC<br> + include('adodb.inc.php'); </font></p> +<h3><font><a name="force_type"></a>$ADODB_FORCE_TYPE</font></h3> +<p><font>See the <a href="#ADODB_FORCE_TYPE">GetUpdateSQL tutorial</a>. +</font></p><hr /> +<h2><font>ADOConnection<a name="adoconnection"></a></font></h2> +<p><font>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.</font></p> +<h3><font>ADOConnection Fields</font></h3> +<p><font><b>databaseType</b>: Name of the database system we are connecting to. Eg. + <b>odbc</b> or <b>mssql</b> or <b>mysql</b>.</font></p> +<p><font><b>dataProvider</b>: The underlying mechanism used to connect to the database. + Normally set to <b>native</b>, unless using <b>odbc</b> or <b>ado</b>.</font></p> +<p><font><b>host: </b>Name of server or data source name (DSN) to connect to.</font></p> +<p><font><b>database</b>: Name of the database or to connect to. If ado is used, it + will hold the ado data provider.</font></p> +<p><font><b>user</b>: Login id to connect to database. Password is not saved for security + reasons.</font></p> +<p><font><b>raiseErrorFn</b>: Allows you to define an error handling function. See adodb-errorhandler.inc.php + for an example.</font></p> +<p><font><b>debug</b>: Set to <i>true</i> to make debug statements to appear.</font></p> +<p><font><b>concat_operator</b>: Set to '+' or '||' normally. The operator used to concatenate + strings in SQL. Used by the <b><a href="#concat">Concat</a></b> function.</font></p> +<p><font><b>fmtDate</b>: The format used by the <b><a href="#dbdate">DBDate</a></b> + function to send dates to the database. is '#Y-m-d#' for Microsoft Access, + and ''Y-m-d'' for MySQL.</font></p> +<p><font><b>fmtTimeStamp: </b>The format used by the <b><a href="#dbtimestamp">DBTimeStamp</a></b> + function to send timestamps to the database. </font></p> +<p><font><b>true</b>: The value used to represent true.Eg. '.T.'. for Foxpro, '1' for + Microsoft SQL.</font></p> +<p><font><b>false: </b> The value used to represent false. Eg. '.F.'. for Foxpro, '0' + for Microsoft SQL.</font></p> +<p><font><b>replaceQuote</b>: The string used to escape quotes. Eg. double single-quotes + for Microsoft SQL, and backslash-quote for MySQL. Used by <a href="#qstr">qstr</a>.</font></p> +<p><font><b>autoCommit</b>: indicates whether automatic commit is enabled. Default is + true.</font></p> +<p><font><b>charSet</b>: set the default charset to use. Currently only interbase/firebird supports + this.</font></p> +<p><font><b>dialect</b>: set the default sql dialect to use. Currently only interbase/firebird + supports this.</font></p> + <p><font><b>role</b>: set the role. Currently only interbase/firebird + supports this.</font></p> +<p><font><b>metaTablesSQL</b>: SQL statement to return a list of available tables. Eg. + <i>SHOW TABLES</i> in MySQL.</font></p> +<p><font><b>genID</b>: The latest id generated by GenID() if supported by the database.</font></p> +<p><font><b>cacheSecs</b>: The number of seconds to cache recordsets if CacheExecute() + or CacheSelectLimit() omit the $secs2cache parameter. Defaults to 60 minutes.</font></p> +<p><font><b>sysDate</b>: String that holds the name of the database function to call + to get the current date. Useful for inserts and updates.</font></p> +<p><font><b>sysTimeStamp</b>: String that holds the name of the database function to + call to get the current timestamp/datetime value.</font></p> +<p><font><b>leftOuter</b>: String that holds operator for left outer join, if known. + Otherwise set to false.</font></p> +<p><font><b>rightOuter</b>: String that holds operator for left outer join, if known. + Otherwise set to false.</font></p> +<p><font><b>ansiOuter</b>: Boolean that if true indicates that ANSI style outer joins + are permitted. Eg. <i>select * from table1 left join table2 on p1=p2.</i></font></p> +<p><font><b>connectSID</b>: 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.</font></p> +<p><font><b>autoRollback</b>: Persistent connections are auto-rollbacked in PConnect( + ) if this is set to true. Default is false.</font></p> +<hr /> +<h3><font>ADOConnection Main Functions</font></h3> +<p><font><b>ADOConnection( )</b></font></p> +<p><font>Constructor function. Do not call this directly. Use ADONewConnection( ) instead.</font></p> +<p><font><b>Connect<a name="connect"></a>($host,[$user],[$password],[$database])</b></font></p> +<p><font>Non-persistent connect to data source or server $<b>host</b>, using userid + $<b>user </b>and password $<b>password</b>. If the server supports multiple + databases, connect to database $<b>database</b>. </font></p> +<p><font>Returns true/false depending on connection success. Since 4.23, null is returned if the extension is not loaded.</font></p> +<p><font>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.</font></p> +<p><font>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.</font></p> +<p><font>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. +</font></p><p><font>Examples: +</font></p><pre><font> # $oraname in tnsnames.ora/ONAMES/HOSTNAMES<br> $conn->Connect(false, 'scott', 'tiger', $oraname); <br> $conn->Connect('server:1521', 'scott', 'tiger', 'ServiceName'); # bypass tnsnames.ora</font></pre> +<p><font>There are many examples of connecting to a database. +See <a href="#connect_ex">Connection Examples</a> for many examples. + +</font></p><p><font><b>PConnect<a name="pconnect"></a>($host,[$user],[$password],[$database])</b></font></p> +<p><font>Persistent connect to data source or server $<b>host</b>, using userid $<b>user</b> + and password $<b>password</b>. If the server supports multiple databases, + connect to database $<b>database</b>.</font></p> +<p><font>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. +</font></p><p><font>Returns true/false depending on connection. Since 4.23, 0 is returned if the extension is not loaded. +See Connect( ) above for more info.</font></p> +<p><font>Since ADOdb 2.21, we also support autoRollback. If you set:</font></p> + +<pre> $conn = &NewADOConnection('mysql');<br> $conn->autoRollback = true; # default is false<br> $conn->PConnect(...); # rollback here</pre> +<p> 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. +</p><p>Since ADOdb 3.11, you can force non-persistent +connections even if PConnect is called by defining the constant +ADODB_NEVER_PERSIST before you call PConnect. +</p><p> +Since 4.23, null is returned if the extension is not loaded. +</p><p><b>NConnect<a name="nconnect"></a>($host,[$user],[$password],[$database])</b></p> +<p>Always force a new connection. In contrast, PHP sometimes reuses connections + when you use Connect() or PConnect(). Currently works only on mysql (PHP 4.3.0 + or later), postgresql and oci8-derived drivers. For other drivers, NConnect() works like + Connect().</p> +<p><font><b>IsConnected( )<a name="isconnected"></a></b></font></p> +<p> +<font>Returns true if connected to database. Added in 4.53. + +</font></p><p><font><b>Execute<a name="execute"></a>($sql,$inputarr=false)</b></font></p> +<p><font>Execute SQL statement $<b>sql</b> 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. You can also pass in $sql a statement prepared + in <a href="#prepare">Prepare()</a>.</font></p> +<p><font>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.</font></p> +<p><font>The $inputarr parameter can be used for binding variables to parameters. Below + is an Oracle example:</font></p> +<pre><font> $conn->Execute("SELECT * FROM TABLE WHERE COND=:val", array('val'=> $val));<br> </font></pre> +<p><font>Another example, using ODBC,which uses the ? convention:</font></p> +<pre><font> $conn->Execute("SELECT * FROM TABLE WHERE COND=?", array($val));<br></font></pre> +<font><a name="binding"></a> +<i>Binding variables</i></font><p> +<font>Variable binding speeds the compilation and caching of SQL statements, leading +to higher performance. Currently Oracle, Interbase and ODBC supports variable binding. +Interbase/ODBC style ? binding is emulated in databases that do not support binding. +Note that you do not have to quote strings if you use binding. +</font></p><p><font> Variable binding in the odbc, interbase and oci8po drivers. +</font></p><pre><font>$rs = $db->Execute('select * from table where val=?', array('10'));<br></font></pre> +<font>Variable binding in the oci8 driver: +</font><pre><font>$rs = $db->Execute('select name from table where val=:key', <br> array('key' => 10));<br></font></pre> +<font><a name="bulkbind"></a> +<i>Bulk binding</i> +</font><p><font>Since ADOdb 3.80, we support bulk binding in Execute(), in which you pass in a 2-dimensional array to +be bound to an INSERT/UPDATE or DELETE statement. +</font></p><pre><font>$arr = array(<br> array('Ahmad',32),<br> array('Zulkifli', 24),<br> array('Rosnah', 21)<br> );<br>$ok = $db->Execute('insert into table (name,age) values (?,?)',$arr);<br></font></pre> +<p><font>This provides very high performance as the SQL statement is prepared first. +The prepared statement is executed repeatedly for each array row until all rows are completed, +or until the first error. Very useful for importing data. + +</font></p><p><font><b>CacheExecute<a name="cacheexecute"></a>([$secs2cache,]$sql,$inputarr=false)</b></font></p> +<p><font>Similar to Execute, except that the recordset is cached for $secs2cache seconds + in the $ADODB_CACHE_DIR directory, and $inputarr only accepts 1-dimensional arrays. + If CacheExecute() is called again with the same $sql, $inputarr, + and also the same database, same userid, and the cached recordset + has not expired, the cached recordset is returned. +</font></p><pre><font> include('adodb.inc.php'); <br> include('tohtml.inc.php');<br> $ADODB_<b>CACHE_DIR</b> = '/usr/local/ADOdbcache';<br> $conn = &ADONewConnection('mysql'); <br> $conn->PConnect('localhost','userid','password','database');<br> $rs = $conn-><b>CacheExecute</b>(15, 'select * from table'); # cache 15 secs<br> rs2html($rs); /* recordset to html table */ <br></font></pre> +<p><font> Alternatively, since ADOdb 1.80, the $secs2cache parameter is optional:</font></p> +<pre><font> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; // cache 24 hours<br> $rs = $conn->CacheExecute('select * from table');<br></font></pre> +<font>If $secs2cache is omitted, we use the value +in $connection->cacheSecs (default is 3600 seconds, or 1 hour). Use CacheExecute() +only with SELECT statements. +</font><p><font>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 <i>much slower </i>than your Web server or the database is <i>very + overloaded </i>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. </font></p> +<p><font><b>ExecuteCursor<a name="executecursor"></a>($sql,$cursorName='rs',$parameters=false)</b></font></p> +<p><font>Execute an Oracle stored procedure, and returns an Oracle REF cursor variable as + a regular ADOdb recordset. Does not work with any other database except oci8. + Thanks to Robert Tuttle for the design. +</font></p><pre><font> $db = ADONewConnection("oci8"); <br> $db->Connect("foo.com:1521", "uid", "pwd", "FOO"); <br> $rs = $db->ExecuteCursor("begin :cursorvar := getdata(:param1); end;", <br> 'cursorvar',<br> array('param1'=>10)); <br> # $rs is now just like any other ADOdb recordset object<br> rs2html($rs);</font></pre> +<p><font>ExecuteCursor() is a helper function that does the following internally: +</font></p><pre><font> $stmt = $db->Prepare("begin :cursorvar := getdata(:param1); end;", true); <br> $db->Parameter($stmt, $cur, 'cursorvar', false, -1, OCI_B_CURSOR);<br> $rs = $db->Execute($stmt,$bindarr);<br></font></pre> +<p><font>ExecuteCursor only accepts 1 out parameter. So if you have 2 out parameters, use: +</font></p><pre><font> $vv = 'A%';<br> $stmt = $db->PrepareSP("BEGIN list_tabs(:crsr,:tt); END;");<br> $db->OutParameter($stmt, $cur, 'crsr', -1, OCI_B_CURSOR);<br> $db->OutParameter($stmt, $vv, 'tt', 32); # return varchar(32)<br> $arr = $db->GetArray($stmt);<br> print_r($arr);<br> echo " val = $vv"; ## outputs 'TEST'<br></font></pre> +<font>for the following PL/SQL: +</font><pre><font> TYPE TabType IS REF CURSOR RETURN TAB%ROWTYPE;<br><br> PROCEDURE list_tabs(tabcursor IN OUT TabType,tablenames IN OUT VARCHAR) IS<br> BEGIN<br> OPEN tabcursor FOR SELECT * FROM TAB WHERE tname LIKE tablenames;<br> tablenames := 'TEST';<br> END list_tabs;<br></font></pre> +<p><font><b>SelectLimit<a name="selectlimit"></a>($sql,$numrows=-1,$offset=-1,$inputarr=false)</b></font></p> +<p><font>Returns a recordset if successful. Returns false otherwise. Performs a select + statement, simulating PostgreSQL's SELECT statement, LIMIT $numrows OFFSET + $offset clause.</font></p> +<p><font>In PostgreSQL, SELECT * FROM TABLE LIMIT 3 will return the first 3 records + only. The equivalent is <code>$connection->SelectLimit('SELECT * FROM TABLE',3)</code>. + This functionality is simulated for databases that do not possess this feature.</font></p> +<p><font>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 <code>$connection->SelectLimit('SELECT + * FROM TABLE',3,2)</code>.</font></p> +<p><font>Note that this is the <i>opposite</i> of MySQL's LIMIT clause. You can also + set <code>$connection->SelectLimit('SELECT * FROM TABLE',-1,10)</code> to + get rows 11 to the last row.</font></p> +<p><font>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:</font></p> +<pre><font> $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=:val", 100,-1,array('val'=> $val));<br> </font></pre> +<p><font>The oci8po driver (oracle portable driver) uses the more standard bind variable + of ?: +</font></p><pre><font> $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=?", 100,-1,array('val'=> $val));<br></font></pre> +<p><font> +</font></p><p><font>Ron Wilson reports that SelectLimit does not work with UNIONs. +</font></p><p><font><b>CacheSelectLimit<a name="cacheselectlimit"></a>([$secs2cache,] $sql, $numrows=-1,$offset=-1,$inputarr=false)</b></font></p> +<p><font>Similar to SelectLimit, except that the recordset returned is cached for $secs2cache + seconds in the $ADODB_CACHE_DIR directory. </font></p> +<p><font>Since 1.80, $secs2cache has been optional, and you can define the caching time + in $connection->cacheSecs.</font></p> + +<pre><font> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; // cache 24 hours<br> $rs = $conn->CacheSelectLimit('select * from table',10);</font></pre> +<font> +</font><p><font><b>CacheFlush<a name="cacheflush"></a>($sql=false,$inputarr=false)</b></font></p> +<p><font>Flush (delete) any cached recordsets for the SQL statement $sql in $ADODB_CACHE_DIR. +</font></p><p><font>If no parameter is passed in, then all adodb_*.cache files are deleted. +</font></p><p><font> If you want to flush all cached recordsets manually, execute the following + PHP code (works only under Unix): <br> + <code> system("rm -f `find ".$ADODB_CACHE_DIR." -name + adodb_*.cache`");</code></font></p> +<p><font>For general cleanup of all expired files, you should use <a href="http://www.superscripts.com/tutorial/crontab.html">crontab</a> + on Unix, or at.exe on Windows, and a shell script similar to the following:<font face="Courier New, Courier, mono"><br> + #------------------------------------------------------ <br> + # This particular example deletes files in the TMPPATH <br> + # directory with the string ".cache" in their name that <br> + # are more than 7 days old. <br> + #------------------------------------------------------ <br> + AGED=7 <br> + find ${TMPPATH} -mtime +$AGED | grep "\.cache" | xargs rm -f <br> + </font> </font></p> +<p><font><b>MetaError<a name="metaerror"></a>($errno=false)</b></font></p> +<p><font>Returns a virtualized error number, based on PEAR DB's error number system. You might +need to include adodb-error.inc.php before you call this function. The parameter $errno +is the native error number you want to convert. If you do not pass any parameter, MetaError +will call ErrorNo() for you and convert it. If the error number cannot be virtualized, MetaError +will return -1 (DB_ERROR).</font></p> + +<p><font><b>MetaErrorMsg<a name="metaerrormsg"></a>($errno)</b></font></p> +<p><font>Pass the error number returned by MetaError() for the equivalent textual error message.</font></p> +<p><font><b>ErrorMsg<a name="errormsg"></a>()</b></font></p> +<p><font>Returns the last status or error message. The error message is reset after every +call to Execute(). +</font></p><p> +<font>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. </font></p> +<p><font>Note: If <b>debug</b> is enabled, the SQL error message is always displayed + when the <b>Execute</b> function is called.</font></p> +<p><font><b>ErrorNo<a name="errorno"></a>()</b></font></p> +<p><font>Returns the last error number. The error number is reset after every call to Execute(). +If 0 is returned, no error occurred. +</font></p><p> +<font>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.</font></p> + +<p><font><b>SetFetchMode<a name="setfetchmode"></a>($mode)</b></font></p> +<p><font>Sets the current fetch mode for the connection and stores + it in $db->fetchMode. Legal modes are ADODB_FETCH_ASSOC and ADODB_FETCH_NUM. + For more info, see <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a>.</font></p> +<p><font>Returns the previous fetch mode, which could be false + if SetFetchMode( ) has not been called before.</font></p> +<font> +</font><p><font><b>CreateSequence<a name="createseq"></a>($seqName = 'adodbseq',$startID=1)</b></font></p> +<p><font>Create a sequence. The next time GenID( ) is called, the value returned will + be $startID. Added in 2.60. +</font></p><p><font><b>DropSequence<a name="dropseq"></a>($seqName = 'adodbseq')</b></font></p> +<p><font>Delete a sequence. Added in 2.60. +</font></p><p><font><b>GenID<a name="genid"></a>($seqName = 'adodbseq',$startID=1)</b></font></p> +<p><font>Generate a sequence number . 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. +</font></p><p><font> 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). +</font></p><p><font> 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.</font></p> +<p><font>Note that the mssql driver's GenID() before 1.90 used to generate 16 byte GUID's.</font></p> +<p><font><b>UpdateBlob<a name="updateblob"></a>($table,$column,$val,$where)</b></font></p> +<font>Allows you to store a blob (in $val) into $table into $column in a row at $where. +</font><p><font> Usage: +</font></p><p><font> +</font></p><pre><font> # for oracle<br> $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, empty_blob())');<br> $conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');<br> <br> # non oracle databases<br> $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');<br> $conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');<br></font></pre> +<p><font> 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.</font></p> +<p><font>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. +</font></p><p><font>For PostgreSQL, you can store your blob using blob oid's or as a bytea field. + You can use bytea fields but not blob oid's currently with UpdateBlob( ). + Conversely UpdateBlobFile( ) supports oid's, but not bytea data.<br> + <br> + If you do not pass in an oid, then UpdateBlob() assumes that you are storing + in bytea fields. + <p>If you do not have any blob fields, you can improve you can improve general SQL query performance by disabling blob handling with $connection->disableBlobs = true. +</font></p><p><font><b>UpdateClob<a name="updateclob"></a>($table,$column,$val,$where)</b></font></p> +<font>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. +</font><p><font> Usage: +</font></p><pre><font> # for oracle<br> $conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, empty_clob())');<br> $conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');<br> <br> # non oracle databases<br> $conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, null)');<br> $conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');<br></font></pre> +<p><font><b>UpdateBlobFile<a name="updateblobfile"></a>($table,$column,$path,$where,$blobtype='BLOB')</b></font></p> +<p><font>Similar to UpdateBlob, except that we pass in a file path to where the blob + resides. +</font></p><p><font>For PostgreSQL, if you are using blob oid's, use this interface. This interface + does not support bytea fields. +</font></p><p><font>Returns true if successful, false otherwise. +</font></p><p><font><b>BlobEncode<a name="blobencode" id="blobencode"></a>($blob)</b> +</font></p><p><font>Some databases require blob's to be encoded manually before upload. Note if + you use UpdateBlob( ) or UpdateBlobFile( ) the conversion is done automatically + for you and you do not have to call this function. For PostgreSQL, currently, + BlobEncode() can only be used for bytea fields. +</font></p><p><font>Returns the encoded blob value. +</font></p><p><font>Note that there is a connection property called <em>blobEncodeType</em> which + has 3 legal values: +</font></p><p><font>false - no need to perform encoding or decoding.<br> + 'I' - blob encoding required, and returned encoded blob is a numeric value + (no need to quote).<br> + 'C' - blob encoding required, and returned encoded blob is a character value + (requires quoting). +</font></p><p><font>This is purely for documentation purposes, so that programs that accept multiple + database drivers know what is the right thing to do when processing blobs. +</font></p><p><font><strong>BlobDecode<a name="blobdecode"></a>($blob, $maxblobsize = false)</strong> +</font></p><p><font>Some databases require blob's to be decoded manually after doing a select statement. + If the database does not require decoding, then this function will return + the blob unchanged. Currently BlobDecode is only required for one database, + PostgreSQL, and only if you are using blob oid's (if you are using bytea fields, + we auto-decode for you).</font> The default maxblobsize is set in $connection->maxblobsize, which + is set to 256K in adodb 4.54. </p><p> + In ADOdb 4.54 and later, the blob is the return value. In earlier versions, the blob data is sent to stdout.</p><font> +</font><p></p><pre><font>$rs = $db->Execute("select bloboid from postgres_table where id=$key");<br>$blob = $db->BlobDecode( reset($rs->fields) );</font></pre> +<p><font><b>Replace<a name="replace"></a>($table, $arrFields, $keyCols,$autoQuote=false)</b></font></p> +<p><font>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 MySQL's 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. +</font></p><p><font>The parameters are $table which is the table name, the $arrFields 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. +</font></p><p><font>Examples: +</font></p><pre><font># single field primary key<br>$ret = $db->Replace('atable', <br> array('id'=>1000,'firstname'=>'Harun','lastname'=>'Al-Rashid'),<br> 'id',$autoquote = true); <br># generates UPDATE atable SET firstname='Harun',lastname='Al-Rashid' WHERE id=1000<br># or INSERT INTO atable (id,firstname,lastname) VALUES (1000,'Harun','Al-Rashid')<br><br># compound key<br>$ret = $db->Replace('atable2', <br> array('firstname'=>'Harun','lastname'=>'Al-Rashid', 'age' => 33, 'birthday' => 'null'),<br> array('lastname','firstname'),<br> $autoquote = true);<br><br># no auto-quoting<br>$ret = $db->Replace('atable2', <br> array('firstname'=>"'Harun'",'lastname'=>"'Al-Rashid'", 'age' => 'null'),<br> array('lastname','firstname')); <br></font></pre> +<p><font><b>AutoExecute<a name="autoexecute"></a>($table, $arrFields, $mode, $where=false, $forceUpdate=true,$magicq=false)</b></font></p> +<p>Since ADOdb 4.56, you can automatically generate and execute INSERTs and UPDATEs on a given table with this +function, which is a wrapper for GetInsertSQL() and GetUpdateSQL(). +<p>AutoExecute() inserts or updates $table given an array of $arrFields, where the keys are the field names and the array values are the +field values to store. Note that there is some overhead because the table is first queried to extract key information +before the SQL is generated. We generate an INSERT or UPDATE based on $mode (see below). +<p> +Legal values for $mode are +<ul> +<li>'INSERT' or 1 or DB_AUTOQUERY_INSERT +<li>'UPDATE' or 2 or DB_AUTOQUERY_UPDATE +</ul> +<p>You have to define the constants DB_AUTOQUERY_UPDATE and DB_AUTOQUERY_INSERT yourself or include adodb-pear.inc.php. +<p>The $where clause is required if $mode == 'UPDATE'. If $forceUpdate=false then we will query the +database first and check if the field value returned by the query matches the current field value; only if they differ do we update that field. +<p>Returns true on success, false on error. +<p>An example of its use is: +<pre> +$record["firstName"] = "Carol"; +$record["lasTname"] = "Smith"; +$conn->AutoExecute($table,$record,'INSERT'); +# executes <i>"INSERT INTO $table (firstName,lasTname) values ('Carol',Smith')"</i>; + +$record["firstName"] = "Carol"; +$record["lasTname"] = "Jones"; +$conn->AutoExecute($table,$record,'UPDATE', "lastname like 'Sm%'"); +# executes <i>"UPDATE $table SET firstName='Carol',lasTname='Jones' WHERE lastname like 'Sm%'"</i>; +</pre> +<p>Note: One of the strengths of ADOdb's AutoExecute() is that only valid field names for $table are updated. If $arrFields +contains keys that are invalid field names for $table, they are ignored. There is some overhead in doing this as we have to +query the database to get the field names, but given that you are not directly coding the SQL yourself, you probably aren't interested in +speed at all, but convenience. +<p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. +<p><font><b>GetUpdateSQL<a name="getupdatesql"></a>(&$rs, $arrFields, $forceUpdate=false,$magicq=false, $force=null)</b></font></p> +<p><font>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()). The field names in the array + are case-insensitive.</font></p> +<font> </font><p><font>Since 4.52, we allow you to pass the $force type parameter, and this overrides the <a href="#ADODB_FORCE_TYPE">$ADODB_FORCE_TYPE</a> + global variable. +<p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. +</font></p><p><font><b>GetInsertSQL<a name="getinsertsql"></a>(&$rs, $arrFields,$magicq=false,$force_type=false)</b></font></p> +<p><font>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()). The field names in the array are case-insensitive.</font></p> +<p> +<font> Since 2.42, you can pass a table name instead of a recordset into +GetInsertSQL (in $rs), and it will generate an insert statement for that table. +</font></p><p><font>Since 4.52, we allow you to pass the $force_type parameter, and this overrides the <a href="#ADODB_FORCE_TYPE">$ADODB_FORCE_TYPE</a> + global variable. +<p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. +</font></p><p><font><b>PageExecute<a name="pageexecute"></a>($sql, $nrows, $page, $inputarr=false)</b> +</font></p><p><font>Used for pagination of recordset. $page is 1-based. See <a href="#ex8">Example + 8</a>.</font></p> + +<p><font><b>CachePageExecute<a name="cachepageexecute"></a>($secs2cache, + $sql, $nrows, $page, $inputarr=false)</b> </font></p> +<p><font>Used for pagination of recordset. $page is 1-based. See + <a href="#ex8">Example 8</a>. Caching version of PageExecute.</font></p> +<font> +</font><p></p> +<p><font><b>Close<a name="close"></a>( )</b></font></p> +<p><font>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.</font></p> +<font> </font><p><font><b>StartTrans<a name="starttrans"></a>( )</b></font></p> +<font> </font><p><font>Start a monitored transaction. As SQL statements are executed, ADOdb will monitor + for SQL errors, and if any are detected, when CompleteTrans() is called, we auto-rollback. + </font></p><p> +<font> </font></p><p><font> To understand why StartTrans() is superior to BeginTrans(), + let us examine a few ways of using BeginTrans(). + The following is the wrong way to use transactions: +</font></p><pre><font>$DB->BeginTrans();<br>$DB->Execute("update table1 set val=$val1 where id=$id");<br>$DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CommitTrans();<br></font></pre> +<p><font>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: +</font></p><pre><font>$DB->BeginTrans();<br>$ok = $DB->Execute("update table1 set val=$val1 where id=$id");<br>if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");<br>if ($ok) $DB->CommitTrans();<br>else $DB->RollbackTrans();<br></font></pre> +<p><font>Another way is (since ADOdb 2.0): +</font></p><pre><font>$DB->BeginTrans();<br>$ok = $DB->Execute("update table1 set val=$val1 where id=$id");<br>if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CommitTrans($ok);<br></font></pre> +<p><font> Now it is a headache monitoring $ok all over the place. StartTrans() is an +improvement because it monitors all SQL errors for you. This is particularly +useful if you are calling black-box functions in which SQL queries might be executed. + Also all BeginTrans, CommitTrans and RollbackTrans calls inside a StartTrans block + will be disabled, so even if the black box function does a commit, it will be ignored. +</font></p><pre><font>$DB->StartTrans();<br>CallBlackBox();<br>$DB->Execute("update table1 set val=$val1 where id=$id");<br>$DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CompleteTrans();<br></font></pre> +<p><font>Note that a StartTrans blocks are nestable, the inner blocks are ignored. + </font></p><p><font><b>CompleteTrans<a name="completetrans"></a>($autoComplete=true)</b></font></p> +<font> </font><p><font>Complete a transaction called with StartTrans(). This function monitors + for SQL errors, and will commit if no errors have occured, otherwise it will rollback. + Returns true on commit, false on rollback. If the parameter $autoComplete is true + monitor sql errors and commit and rollback as appropriate. Set $autoComplete to false + to force rollback even if no SQL error detected. + </font></p><p><font><b>FailTrans<a name="failtrans"></a>( )</b></font></p> +<font> </font><p><font>Fail a transaction started with StartTrans(). The rollback will only occur when + CompleteTrans() is called. + </font></p><p><font><b>HasFailedTrans<a name="hasfailedtrans"></a>( )</b></font></p> +<font> </font><p><font>Check whether smart transaction has failed, + eg. returns true if there was an error in SQL execution or FailTrans() was called. + If not within smart transaction, returns false. +</font></p><p><font><b>BeginTrans<a name="begintrans"></a>( )</b></font></p> +<p><font>Begin a transaction. Turns off autoCommit. Returns true if successful. Some + databases will always return false if transaction support is not available. + Any open transactions will be rolled back when the connection is closed. Among the + databases that support transactions are Oracle, PostgreSQL, Interbase, MSSQL, certain + versions of MySQL, DB2, Informix, Sybase, etc.</font></p> +<font> </font><p><font>Note that <a href="#starttrans">StartTrans()</a> and CompleteTrans() is a superior method of + handling transactions, available since ADOdb 3.40. For a explanation, see the <a href="#starttrans">StartTrans()</a> documentation. + +</font></p><p><font>You can also use the ADOdb <a href="#errorhandling">error handler</a> 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. + </font></p><h4><font>Detecting Transactions</font></h4> +<font> </font><p><font>Since ADOdb 2.50, you are able to detect when you are inside a transaction. Check + that $connection->transCnt > 0. This variable is incremented whenever BeginTrans() is called, + and decremented whenever RollbackTrans() or CommitTrans() is called. +</font></p><p><font><b>CommitTrans<a name="committrans"></a>($ok=true)</b></font></p> +<p><font>End a transaction successfully. Returns true if successful. If the database + does not support transactions, will return true also as data is always committed. +</font></p> +<p><font>If you pass the parameter $ok=false, the data is rolled back. See example in + BeginTrans().</font></p> +<p><font><b>RollbackTrans<a name="rollbacktrans"></a>( )</b></font></p> +<p><font>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. +</font></p> +<font> +</font><p><font><b>GetAssoc<a name="getassoc1"></a>($sql,$inputarr=false,$force_array=false,$first2cols=false)</b></font></p> +<p><font>Returns an associative array for the given query $sql with optional bind parameters + in $inputarr. If the number of columns returned is greater to two, a 2-dimensional + array is returned, with the first column of the recordset becomes the keys + to the rest of the rows. If the columns is equal to two, a 1-dimensional array + is created, where the the keys directly map to the values (unless $force_array + is set to true, when an array is created for each value). +</font></p><p><font> Examples:<a name="getassocex"></a></font></p> + +<p><font>We have the following data in a recordset:</font></p> +<p><font>row1: Apple, Fruit, Edible<br> + row2: Cactus, Plant, Inedible<br> + row3: Rose, Flower, Edible</font></p> +<p><font>GetAssoc will generate the following 2-dimensional associative + array:</font></p> +<p><font>Apple => array[Fruit, Edible]<br> + Cactus => array[Plant, Inedible]<br> + Rose => array[Flower,Edible]</font></p> +<p><font>If the dataset is:</font></p> +<p><font>row1: Apple, Fruit<br> +row2: Cactus, Plant<br> +row3: Rose, Flower </font></p> +<p><font>GetAssoc will generate the following 1-dimensional associative + array (with $force_array==false):</font></p> +<p><font>Apple => Fruit</font><br> + Cactus=>Plant<br> + Rose=>Flower </p> +<p><font>The function returns:</font></p> +<p><font>The associative array, or false if an error occurs.</font></p> +<font> +<p><b>CacheGetAssoc<a name="cachegetassoc"></a>([$secs2cache,] $sql,$inputarr=false,$force_array=false,$first2cols=false)</b></p> +</font> +<p><font>Caching version of <a href="#getassoc1">GetAssoc</a> function above. +</font></p><p><font><b>GetOne<a name="getone"></a>($sql,$inputarr=false)</b></font></p> +<p><font>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.</font></p> +<p><font><b>GetRow<a name="getrow"></a>($sql,$inputarr=false)</b></font></p> +<p><font>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.</font></p> +<p><font><b>GetAll<a name="getall"></a>($sql,$inputarr=false)</b></font></p> + +<p>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. <i>GetArray</i> is a synonym for <i>GetAll</i>.</p> + <p><b>GetCol<a name="getcol"></a>($sql,$inputarr=false,$trim=false)</b></p> + +<p><font>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.</font></p> +<p><font><b>CacheGetOne<a name="cachegetone"></a>([$secs2cache,] + $sql,$inputarr=false), CacheGetRow<a name="cachegetrow"></a>([$secs2cache,] $sql,$inputarr=false), CacheGetAll<a name="cachegetall"></a>([$secs2cache,] + $sql,$inputarr=false), CacheGetCol<a name="cachegetcol"></a>([$secs2cache,] + $sql,$inputarr=false,$trim=false)</b></font></p> +<font> +</font><p><font>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).</font></p> +<p><font><b>Prepare<a name="prepare"></a>($sql )</b></font></p> + +<p><font>Prepares (compiles) an SQL query for repeated execution. Bind parameters +are denoted by ?, except for the oci8 driver, which uses the traditional Oracle :varname +convention. + </font></p> +<p><font>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( + ).</font></p> +<p><font>Prepare( ) cannot be used with functions that use SQL + query rewriting techniques, e.g. PageExecute( ) and SelectLimit( ).</font></p> +<p>Example:</p> +<pre><font>$stmt = $DB->Prepare('insert into table (col1,col2) values (?,?)');<br>for ($i=0; $i < $max; $i++)<br></font> $DB-><font>Execute($stmt,array((string) rand(), $i));<br></font></pre> +<font> +</font><p><font>Also see InParameter(), OutParameter() and PrepareSP() below. 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. +</font></p><p><font> Important: Due to limitations or bugs in PHP, if you are getting errors when + you using prepared queries, try setting $ADODB_COUNTRECS = false before preparing. + This behaviour has been observed with ODBC. +</font></p><p><font><b>IfNull<a name="ifnull"></a>($field, $nullReplacementValue)</b></font></p> +<p><font>Portable IFNULL function (NVL in Oracle). Returns a string that represents + the function that checks whether a $field is null for the given database, and + if null, change the value returned to $nullReplacementValue. Eg.</font></p> +<pre><font>$sql = <font color="#993300">'SELECT '</font>.$db->IfNull('name', <font color="#993300">"'- unknown -'"</font>).<font color="#993300"> ' FROM table'</font>;</font></pre> + +<p><font><b>length<a name="length"></a></b></font></p> +<p><font>This is not a function, but a property. Some databases have "length" and others "len" +as the function to measure the length of a string. To use this property: +</font></p><pre><font> $sql = <font color="#993300">"SELECT "</font>.$db->length.<font color="#993300">"(field) from table"</font>;<br> $rs = $db->Execute($sql);<br></font></pre> + +<p><font><b>random<a name="random"></a></b></font></p> +<p><font>This is not a function, but a property. This is a string that holds the sql to +generate a random number between 0.0 and 1.0 inclusive. + +</font></p><p><font><b>substr<a name="substr"></a></b></font></p> +<p><font>This is not a function, but a property. Some databases have "substr" and others "substring" +as the function to retrieve a sub-string. To use this property: +</font></p><pre><font> $sql = <font color="#993300">"SELECT "</font>.$db->substr.<font color="#993300">"(field, $offset, $length) from table"</font>;<br> $rs = $db->Execute($sql);<br></font></pre> +<p><font>For all databases, the 1st parameter of <i>substr</i> is the field, the 2nd is the +offset (1-based) to the beginning of the sub-string, and the 3rd is the length of the sub-string. + + +</font></p><p><font><b>Param<a name="param"></a>($name)</b></font></p> +<p><font>Generates a bind placeholder portably. For most databases, the bind placeholder + is "?". However some databases use named bind parameters such as Oracle, eg + ":somevar". This allows us to portably define an SQL statement with bind parameters: +</font></p><pre><font>$sql = <font color="#993300">'insert into table (col1,col2) values ('</font>.$DB->Param('a').<font color="#993300">','</font>.$DB->Param('b').<font color="#993300">')'</font>;<br><font color="#006600"># generates 'insert into table (col1,col2) values (?,?)'<br># or 'insert into table (col1,col2) values (:a,:b)</font>'<br>$stmt = $DB->Prepare($sql);<br>$stmt = $DB->Execute($stmt,array('one','two'));<br></font></pre> +<font> </font> +<p></p> +<p><font><b>PrepareSP</b><b><a name="preparesp"></a></b><b>($sql, +$cursor=false )</b></font></p> +<p><font>When calling stored procedures in mssql and oci8 (oracle), + and you might want to directly bind to parameters that return values, or +for special LOB handling. PrepareSP() allows you to do so. </font></p> +<p><font>Returns the same array or $sql string as Prepare( ) + above. If you do not need to bind to return values, you should use Prepare( + ) instead.</font></p> +<p><font>The 2nd parameter, $cursor is not used except with oci8. + Setting it to true will force OCINewCursor to be called; this is to support +output REF CURSORs. </font></p> +<p><font>For examples of usage of PrepareSP( ), see InParameter( +) below. </font></p> +<p><font>Note: 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( ). </font></p> +<p><font><b> InParameter<a name="inparameter"></a>($stmt, $var, + $name, $maxLen = 4000, $type = false )</b></font></p> +<font>Binds a PHP variable as input to a stored procedure variable. +The parameter <i>$stmt</i> is the value returned by PrepareSP(), <i>$var</i> is +the PHP variable you want to bind, $name is the name of the stored procedure +variable. Optional is <i>$maxLen</i>, the maximum length of the data to bind, +and $type which is database dependant. Consult <a href="http://php.net/mssql_bind">mssql_bind</a> and <a href="http://php.net/ocibindbyname">ocibindbyname</a> docs +at php.net for more info on legal values for $type. </font> +<p> +<font>InParameter() is a wrapper function that calls Parameter() +with $isOutput=false. The advantage of this function is that it is self-documenting, +because the $isOutput parameter is no longer needed. Only for mssql and oci8 +currently. </font></p> +<p><font>Here is an example using oci8: </font></p> +<pre><font><font color="green"># For oracle, Prepare and PrepareSP are identical</font> +$stmt = $db->PrepareSP( + <font color="#993300">"declare RETVAL integer; <br> begin<br> :RETVAL := </font><font color="#993300">SP_RUNSOMETHING</font><font color="#993300">(:myid,:group);<br> end;"</font>);<br>$db->InParameter($stmt,$id,'myid');<br>$db->InParameter($stmt,$group,'group',64);<br>$db->OutParameter($stmt,$ret,'RETVAL');<br>$db->Execute($stmt);<br></font></pre> +<p><font> The same example using mssql:</font></p> +<font> +</font><pre><font><font color="green"># @RETVAL = SP_RUNSOMETHING @myid,@group</font> +$stmt = $db->PrepareSP(<font color="#993333">'<font color="#993300">SP_RUNSOMETHING</font>'</font>); <br><font color="green"># note that the parameter name does not have @ in front!</font> +$db->InParameter($stmt,$id,'myid'); +$db->InParameter($stmt,$group,'group',64); +<font color="green"># return value in mssql - RETVAL is hard-coded name</font> <br>$db->OutParameter($stmt,$ret,'RETVAL');<br>$db->Execute($stmt); </font></pre> + +<p><font>Note that the only difference between the oci8 and mssql implementations is $sql.</font></p> +<p> +<font> If $type parameter is set to false, in mssql, $type will be dynamicly determined +based on the type of the PHP variable passed <font face="Courier New, Courier, mono">(string +=> SQLCHAR, boolean =>SQLINT1, integer =>SQLINT4 or float/double=>SQLFLT8)</font>. +</font></p><p><font> +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<font face="Courier New, Courier, mono"> $db->Parameter($stmt, +$null=null, 'param')</font>. + </font></p><p><font><b> OutParameter<a name="outparameter"></a>($stmt, $var, $name, + $maxLen = 4000, $type = false )</b></font></p> +<font> Binds a PHP variable as output from a stored procedure variable. The parameter <i>$stmt</i> + is the value returned by PrepareSP(), <i>$var</i> is the PHP variable you want to bind, <i>$name</i> + is the name of the stored procedure variable. Optional is <i>$maxLen</i>, the maximum length of the + data to bind, and <i>$type</i> which is database dependant. +</font><p> +<font> OutParameter() is a wrapper function that calls Parameter() with $isOutput=true. + The advantage of this function is that it is self-documenting, because +the $isOutput parameter is no longer needed. Only for mssql + and oci8 currently. +</font></p><p> +<font>For an example, see <a href="#inparameter">InParameter</a>. + +</font></p><p><font><b> Parameter<a name="parameter"></a>($stmt, $var, $name, $isOutput=false, + $maxLen = 4000, $type = false )</b></font></p> +<p><font>Note: This function is deprecated, because of the new InParameter() and OutParameter() functions. +These are superior because they are self-documenting, unlike Parameter(). +</font></p><p><font>Adds a bind parameter suitable for return values or special data handling (eg. + LOBs) after a statement has been prepared using PrepareSP(). Only for mssql + and oci8 currently. The parameters are:<br> + <br> + $<i><b>stmt</b></i> Statement returned by Prepare() or PrepareSP().<br> + $<i><b>var</b></i> PHP variable to bind to. Make sure you pre-initialize it!<br> + $<i><b>name</b></i> Name of stored procedure variable name to bind to.<br> + [$<i><b>isOutput</b></i>] Indicates direction of parameter 0/false=IN 1=OUT + 2= IN/OUT. This is ignored in oci8 as this driver auto-detects the direction.<br> + [$<b>maxLen</b>] Maximum length of the parameter variable.<br> + [$<b>type</b>] Consult <a href="http://php.net/mssql_bind">mssql_bind</a> and + <a href="http://php.net/ocibindbyname">ocibindbyname</a> docs at php.net for + more info on legal values for type.</font></p> +<p><font>Lastly, in oci8, bind parameters can be reused without calling PrepareSP( ) + or Parameters again. This is not possible with mssql. An oci8 example:</font></p> +<pre><font>$id = 0; $i = 0;<br>$stmt = $db->PrepareSP( <font color="#993300">"update table set val=:i where id=:id"</font>);<br>$db->Parameter($stmt,$id,'id');<br>$db->Parameter($stmt,$i, 'i');<br>for ($cnt=0; $cnt < 1000; $cnt++) {<br> $id = $cnt; <br> $i = $cnt * $cnt; <font color="green"># works with oci8!</font> + $db->Execute($stmt); <br>}</font></pre> +<p><font><b>Bind<a name="bind"></a>($stmt, $var, $size=4001, $type=false, $name=false)</b></font></p> + +<p><font>This is a low-level function supported only by the oci8 + driver. <b>Avoid using</b> unless you only want to support Oracle. The Parameter( + ) function is the recommended way to go with bind variables.</font></p> +<p><font>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. + </font></p> +<p>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. +</p><p><font>The following example shows 3 bind variables being used: + p1, p2 and p3. These variables are bound to :0, :1 and :2.</font></p> +<pre>$stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:0, :1, :2)");<br>$DB->Bind($stmt, $p1);<br>$DB->Bind($stmt, $p2);<br>$DB->Bind($stmt, $p3);<br>for ($i = 0; $i < $max; $i++) { <br> $p1 = ?; $p2 = ?; $p3 = ?;<br> $DB->Execute($stmt);<br>}</pre> +<p>You can also use named variables:</p> +<pre>$stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:name0, :name1, :name2)");<br>$DB->Bind($stmt, $p1, "name0");<br>$DB->Bind($stmt, $p2, "name1");<br>$DB->Bind($stmt, $p3, "name2");<br>for ($i = 0; $i < $max; $i++) { <br> $p1 = ?; $p2 = ?; $p3 = ?;<br> $DB->Execute($stmt);<br>}</pre> +<p><b>LogSQL($enable=true)<a name="logsql"></a></b></p> +Call this method to install a SQL logging and timing function (using fnExecute). +Then all SQL statements are logged into an adodb_logsql table in a database. If +the adodb_logsql table does not exist, ADOdb will create the table if you have +the appropriate permissions. Returns the previous logging value (true for enabled, +false for disabled). Here are samples of the DDL for selected databases: +<p> +</p><pre> <b>mysql:</b> + CREATE TABLE adodb_logsql ( + created datetime NOT NULL, + sql0 varchar(250) NOT NULL, + sql1 text NOT NULL, + params text NOT NULL, + tracer text NOT NULL, + timer decimal(16,6) NOT NULL + ) + + <b>postgres:</b> + CREATE TABLE adodb_logsql ( + created timestamp NOT NULL, + sql0 varchar(250) NOT NULL, + sql1 text NOT NULL, + params text NOT NULL, + tracer text NOT NULL, + timer decimal(16,6) NOT NULL + ) + + <b>mssql:</b> + CREATE TABLE adodb_logsql ( + created datetime NOT NULL, + sql0 varchar(250) NOT NULL, + sql1 varchar(4000) NOT NULL, + params varchar(3000) NOT NULL, + tracer varchar(500) NOT NULL, + timer decimal(16,6) NOT NULL + ) + + <b>oci8:</b> + CREATE TABLE adodb_logsql ( + created date NOT NULL, + sql0 varchar(250) NOT NULL, + sql1 varchar(4000) NOT NULL, + params varchar(4000), + tracer varchar(4000), + timer decimal(16,6) NOT NULL + ) +</pre> +Usage: +<pre> $conn->LogSQL(); // turn on logging<br> :<br> $conn->Execute(...);<br> :<br> $conn->LogSQL(false); // turn off logging<br> <br> # output summary of SQL logging results<br> $perf = NewPerfMonitor($conn);<br> echo $perf->SuspiciousSQL();<br> echo $perf->ExpensiveSQL();<br></pre> +<p>One limitation of logging is that rollback also prevents SQL from being logged. +</p><p> +If you prefer to use another name for the table used to store the SQL, you can override it by calling +adodb_perf::table($tablename), where $tablename is the new table name (you will still need to manually +create the table yourself). An example: +</p><pre> include('adodb.inc.php');<br> include('adodb-perf.inc.php');<br> adodb_perf::table('my_logsql_table');<br></pre> +Also see <a href="docs-perf.htm">Performance Monitor</a>. +<p><font><b>fnExecute and fnCacheExecute properties<a name="fnexecute" id="fnexecute"></a></b></font></p> +<p>These two properties allow you to define bottleneck functions for all sql statements + processed by ADOdb. This allows you to perform statistical analysis and query-rewriting + of your sql. +</p><p><b>Examples of fnExecute</b></p> +<p>Here is an example of using fnExecute, to count all cached queries and non-cached + queries, you can do this:</p> +<pre><font color="#006600"># $db is the connection object</font> +function CountExecs($db, $sql, $inputarray) +{ +global $EXECS; + +if (!is_array(inputarray)) $EXECS++; +<font color="#006600"># handle 2-dimensional input arrays</font> +else if (is_array(reset($inputarray))) $EXECS += sizeof($inputarray); +else $EXECS++; +} + +<font color="#006600"># $db is the connection object</font> +function CountCachedExecs($db, $secs2cache, $sql, $inputarray) +{<br>global $CACHED; $CACHED++;<br>}<br><br>$db = NewADOConnection('mysql');<br>$db->Connect(...);<br>$db-><strong>fnExecute</strong> = 'CountExecs';<br>$db-><strong>fnCacheExecute</strong> = 'CountCachedExecs';<br> :<br> :<br><font color="#006600"># After many sql statements:</font>`<br>printf("<p>Total queries=%d; total cached=%d</p>",$EXECS+$CACHED, $CACHED);<br></pre> +<p>The fnExecute function is called before the sql is parsed and executed, so + you can perform a query rewrite. If you are passing in a prepared statement, + then $sql is an array (see <a href="#prepare">Prepare</a>). The fnCacheExecute + function is only called if the recordset returned was cached.<font> + The function parameters match the Execute and CacheExecute functions respectively, + except that $this (the connection object) is passed as the first parameter.</font></p> +<p>Since ADOdb 3.91, the behaviour of fnExecute varies depending on whether the + defined function returns a value. If it does not return a value, then the $sql + is executed as before. This is useful for query rewriting or counting sql queries. +</p><p> On the other hand, you might want to replace the Execute function with one + of your own design. If this is the case, then have your function return a value. + If a value is returned, that value is returned immediately, without any further + processing. This is used internally by ADOdb to implement LogSQL() functionality. +</p> +<p> +</p><hr /> +<h3><font>ADOConnection Utility Functions</font></h3> +<p><font><b>BlankRecordSet<a name="blankrecordset"></a>([$queryid])</b></font></p> +<p><font>No longer available - removed since 1.99.</font></p> +<p><font><b>Concat<a name="concat"></a>($s1,$s2,....)</b></font></p> +<p><font>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.</font></p> +<p><font>Returns the concatenated string.</font></p> +<p><font><b>DBDate<a name="dbdate"></a>($date)</b></font></p> +<p><font>Format the $<b>date</b> in the format the database accepts. This is used in + INSERT/UPDATE statements; for SELECT statements, use <a href="#sqldate">SQLDate</a>. + The $<b>date</b> parameter 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.</font></p> +<p><font>Returns the date as a quoted string.</font></p> +<p><font><b>DBTimeStamp<a name="dbtimestamp"></a>($ts)</b></font></p> +<p><font>Format the timestamp $<b>ts</b> 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.</font></p> +<p><font>Returns the timestamp as a quoted string.</font></p> +<p><font><b>qstr<a name="qstr"></a>($s,[$magic_quotes_enabled</b>=false]<b>)</b></font></p> +<p><font>Quotes a string to be sent to the database. The $<b>magic_quotes_enabled</b> + 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 <i>qstr</i> + and once by the <i>magic_quotes_gpc</i>.</font></p> +<p><font>Eg.<font face="Courier New, Courier, mono"> $s = $db->qstr(HTTP_GET_VARS['name'],get_magic_quotes_gpc());</font></font></p> +<p><font>Returns the quoted string.</font></p> +<p><font><b>Quote<a name="quote"></a>($s)</b></font></p> +<p><font>Quotes the string $s, escaping the database specific quote character as appropriate. + Formerly checked magic quotes setting, but this was disabled since 3.31 for + compatibility with PEAR DB. +</font></p><p><font><b>Affected_Rows<a name="affected_rows"></a>( )</b></font></p> +<p><font>Returns the number of rows affected by a update or delete statement. Returns + false if function not supported.</font></p> +<p><font>Not supported by interbase/firebird currently. </font></p> +<p><font><b>Insert_ID<a name="inserted_id"></a>( )</b></font></p> +<p><font>Returns the last autonumbering ID inserted. Returns false if function not supported. +</font></p> +<p><font>Only supported by databases that support auto-increment or object id's, such + as PostgreSQL, MySQL and MS SQL Server currently. PostgreSQL returns the OID, which + can change on a database reload.</font></p> +<p><font><b>RowLock<a name="rowlock"></a>($table,$where)</b></font></p> +<p><font>Lock a table row for the duration of a transaction. For example to lock record $id in table1: +</font></p><pre><font> $DB->StartTrans();<br> $DB->RowLock("table1","rowid=$id");<br> $DB->Execute($sql1);<br> $DB->Execute($sql2);<br> $DB->CompleteTrans();<br></font></pre> +<p><font>Supported in db2, interbase, informix, mssql, oci8, postgres, sybase. +</font></p><p><font><b>MetaDatabases<a name="metadatabases"></a>()</b></font></p> +<p><font>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.</font></p> +<p><font><b>MetaTables<a name="metatables"></a>($ttype = false, $showSchema = false, + $mask=false)</b></font></p> +<p><font>Returns an array of tables and views for the current database as an array. + The array should exclude system catalog tables if possible. To only show tables, + use $db->MetaTables('TABLES'). To show only views, use $db->MetaTables('VIEWS'). + The $showSchema parameter currently works only for DB2, and when set to true, + will add the schema name to the table, eg. "SCHEMA.TABLE". </font></p> +<p><font>You can define a mask for matching. For example, setting $mask = 'TMP%' will + match all tables that begin with 'TMP'. Currently only mssql, oci8, odbc_mssql + and postgres* support $mask. +</font></p><p><font><b>MetaColumns<a name="metacolumns"></a>($table,$notcasesensitive=true)</b></font></p> +<p><font>Returns an array of ADOFieldObject's, one field object for every column of + $table. A field object is a class instance with (name, type, max_length) defined. + Currently Sybase does not recognise date types, and ADO cannot identify + the correct data type (so we default to varchar). + </font></p><p><font> The $notcasesensitive parameter determines whether we uppercase or lowercase the table name to normalize it + (required for some databases). Does not work with MySQL ISAM tables. + </font></p><p><font>For schema support, pass in the $table parameter, "$schema.$tablename". This is only + supported for selected databases. +</font></p><p><font><b>MetaColumnNames<a name="metacolumnames"></a>($table,$numericIndex=false)</b></font></p> +<p><font>Returns an array of column names for $table. Since ADOdb 4.22, this is an associative array, with the +keys in uppercase. Set $numericIndex=true if you want the old behaviour of numeric indexes (since 4.23). +</font></p><p> +<font>e.g. array('FIELD1' => 'Field1', 'FIELD2'=>'Field2') +</font></p><p> +</p><p><font><b>MetaPrimaryKeys<a name="metaprimarykeys"></a>($table, + $owner=false)</b></font> +</p> +<p><font>Returns an array containing column names that are the + primary keys of $table. Supported by mysql, odbc (including db2, odbc_mssql, +etc), mssql, postgres, interbase/firebird, oci8 currently. </font></p> +<p><font>Views (and some tables) have primary keys, but sometimes this information is not available from the +database. You can define a function ADODB_View_PrimaryKeys($databaseType, $database, $view, $owner) that +should return an array containing the fields that make up the primary key. If that function exists, +it will be called when MetaPrimaryKeys() cannot find a primary key for a table or view. +</font></p><pre><font>// In this example: dbtype = 'oci8', $db = 'mydb', $view = 'dataView', $owner = false <br>function ADODB_View_PrimaryKeys($dbtype,$db,$view,$owner)<br>{<br> switch(strtoupper($view)) {<br> case 'DATAVIEW': return array('DATAID');<br> default: return false;<br> }<br>}<br><br>$db = NewADOConnection('oci8');<br>$db->Connect('localhost','root','','mydb'); <br>$db->MetaPrimaryKeys('dataView');<br></font></pre> +<p><font><b>ServerInfo<a name="serverinfo" id="serverinfo"></a>()</b></font> +</p> +<p><font>Returns an array of containing two elements 'description' + and 'version'. The 'description' element contains the string description of + the database. The 'version' naturally holds the version number (which is also +a string).</font></p> +<p><font><b>MetaForeignKeys<a name="metaforeignkeys"></a>($table, $owner=false, $upper=false)</b> +</font></p><p><font>Returns an associate array of foreign keys, or false if not supported. For + example, if table employee has a foreign key where employee.deptkey points to + dept_table.deptid, and employee.posn=posn_table.postionid and employee.poscategory=posn_table.category, + then $conn->MetaForeignKeys('employee') will return +</font></p><pre><font> array(<br> 'dept_table' => array('deptkey=deptid'),<br> 'posn_table' => array('posn=positionid','poscategory=category')<br> )<br></font></pre> +<p><font>The optional schema or owner can be defined in $owner. If $upper is true, then + the table names (array keys) are upper-cased. +</font></p><hr /> +<h2><font>ADORecordSet<a name="adorecordset"></a></font></h2> +<p><font>When an SQL statement successfully is executed by <font face="Courier New, Courier, mono">ADOConnection->Execute($sql),</font>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.</font></p> +<h3><font>ADORecordSet Fields</font></h3> +<p><font><b>fields: </b>Array containing the current row. This is not associative, but + is an indexed array from 0 to columns-1. See also the function <b><a href="#fields">Fields</a></b>, + which behaves like an associative array.</font></p> +<p><font><b>dataProvider</b>: The underlying mechanism used to connect to the database. + Normally set to <b>native</b>, unless using <b>odbc</b> or <b>ado</b>.</font></p> +<p><font><b>blobSize</b>: 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 <a href="#metatype">MetaType</a> + function.</font></p> +<p><font><b>sql</b>: Holds the sql statement used to generate this record set.</font></p> +<p><font><b>canSeek</b>: Set to true if Move( ) function works.</font></p> +<p><font><b>EOF</b>: True if we have scrolled the cursor past the last record.</font></p> +<h3><font>ADORecordSet Functions</font></h3> +<p><font><b>ADORecordSet( )</b></font></p> +<p><font>Constructer. Normally you never call this function yourself.</font></p> +<p><font><b>GetAssoc<a name="getassoc"></a>([$force_array])</b></font></p> +<p><font>Generates an associative array from the recordset. Note that is this function + is also <a href="#getassoc1">available</a> in the connection object. More details + can be found there.</font></p> +<font> </font> +<p><font><b>GetArray<a name="getarray"></a>([$number_of_rows])</b></font></p> +<p><font>Generate a 2-dimensional array of records from the current + cursor position, indexed from 0 to $number_of_rows - 1. If $number_of_rows + is undefined, till EOF.</font></p> +<p><font><b>GetRows<a name="getrows"></a>([$number_of_rows])</b></font></p> +<font>Generate a 2-dimensional array of records from the current +cursor position. Synonym for GetArray() for compatibility with Microsoft ADO. </font> +<p><font> <b>GetMenu<a name="getmenu"></a>($name, [$default_str=''], + [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])</b></font></p> +<p><font>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 $<i>name</i>. </font></p> +<p><font> If $<i>default_str</i> is defined, then if $<i>default_str</i> == + fields[0], that field is selected. If $<i>blank1stItem</i> is true, the first + option is empty. You can also set the first option strings by setting $blank1stItem + = "$value:$text".</font></p> +<p><font>$<i>Default_str</i> can be array for a multiple select +listbox.</font></p> +<p><font>To get a listbox, set the $<i>size</i> to a non-zero + value (or pass $default_str as an array). If $<i>multiple_select</i> is true + then a listbox will be generated with $<i>size</i> items (or if $size==0, + then 5 items) visible, and we will return an array to a server. Lastly use + $<i>moreAttr </i> to add additional attributes such as javascript or styles. </font></p> +<p><font>Menu Example 1: <code>GetMenu('menu1','A',true)</code> will + generate a menu: + <select name="menu1"><option> </option><option value="1" selected="selected">A </option><option value="2">B </option><option value="3">C </option></select> +for the data (A,1), (B,2), (C,3). Also see <a href="#ex5">example 5</a>.</font></p> +<p><font>Menu Example 2: For the same data, <code>GetMenu('menu1',array('A','B'),false)</code> will + generate a menu with both A and B selected: <br> + <select name="menu1" multiple="multiple" size="3"><option value="1" selected="selected">A </option><option value="2" selected="selected">B </option><option value="3">C </option></select> +</font></p> +<p><font> <b>GetMenu2<a name="getmenu2"></a>($name, [$default_str=''], + [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])</b></font></p> +<p><font>This is nearly identical to GetMenu, except that the + $<i>default_str</i> is matched to fields[1] (the option values).</font></p> +<p><font>Menu Example 3: Given the data in menu example 2, <code>GetMenu2('menu1',array('1','2'),false)</code> 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. </font></p> +<p><font><b>UserDate<a name="userdate"></a>($str, [$fmt])</b></font></p> +<p><font>Converts the date string $<i>str</i> to another format. + The date format is Y-m-d, or Unix timestamp format. The default $<i>fmt</i> is +Y-m-d.</font></p> +<p><font><b>UserTimeStamp<a name="usertimestamp"></a>($str, [$fmt])</b></font></p> +<p><font>Converts the timestamp string $<b>str</b> to another + format. The timestamp format is Y-m-d H:i:s, as in '2002-02-28 23:00:12', + or Unix timestamp format. UserTimeStamp calls UnixTimeStamp to parse $<i>str</i>, +and $<i>fmt</i> defaults to Y-m-d H:i:s if not defined. </font></p> +<p><font><b>UnixDate<a name="unixdate"></a>($str)</b></font></p> +<p><font>Parses the date string $<b>str</b> 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).</font></p> +<p><font>This function is available in both ADORecordSet and +ADOConnection since 1.91.</font></p> +<p><font><b>UnixTimeStamp<a name="unixtimestamp"></a>($str)</b></font></p> +<p><font>Parses the timestamp string $<b>str</b> 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" (1970-12-24, 00:00:00) + or "Y-m-d H:i:s" (1970-12-24 00:00:00) or "YmdHis" (19701225000000) format, + except for Sybase and Microsoft SQL Server, where "M d Y h:i:sA" (Dec 25 + 1970 00:00:00AM) is also accepted (the 3 letter month strings are controlled +by a global array, which might need localisation).</font></p> +<font> +</font><p><font>This function is available in both ADORecordSet + and ADOConnection since 1.91. </font></p> +<p><font><b>OffsetDate<a name="offsetdate"></a>($dayFraction, + $basedate=false)</b></font></p> +<p><font>Returns a string with the native SQL functions 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(). </font></p> +<p><font>For example, in Oracle, to find the date and time that + is 2.5 days from today, you can use:</font></p> +<pre><font># get date one week from now<br>$fld = $conn->OffsetDate(7); // returns "(trunc(sysdate)+7")</font></pre> +<pre><font># get date and time that is 60 hours from current date and time<br>$fld = $conn->OffsetDate(2.5, $conn->sysTimeStamp); // returns "(sysdate+2.5)"<br><br>$conn->Execute("UPDATE TABLE SET dodate=$fld WHERE ID=$id");</font></pre> +<p><font> 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.</font></p> +<font> </font> +<p><font><b>SQLDate<a name="sqldate"></a>($dateFormat, $basedate=false)</b></font></p> +<font>Returns a string which contains the native SQL functions +to format a date or date column $basedate. This is used in SELECT statements. +For INSERT/UPDATE statements, use <a href="#dbdate">DBDate</a>. It uses a case-sensitive +$dateFormat, which supports: </font> +<pre><font> + Y: 4-digit Year + Q: Quarter (1-4) + M: Month (Jan-Dec) + m: Month (01-12) + d: Day (01-31) + H: Hour (00-23) + h: Hour (1-12) + i: Minute (00-59) + s: Second (00-60) + A: AM/PM indicator + w: day of week (0-6 or 1-7 depending on DB) + l: day of week (as string - lowercase L) + W: week in year (0..53 for MySQL, 1..53 for PostgreSQL and Oracle) + </font></pre> +<p><font>All other characters are treated as strings. You can + also use \ to escape characters. Available on selected databases, including +mysql, postgresql, mssql, oci8 and DB2. </font></p> +<p><font>This is useful in writing portable sql statements that + GROUP BY on dates. For example to display total cost of goods sold broken +by quarter (dates are stored in a field called postdate): </font></p> +<pre><font> $sqlfn = $db->SQLDate('Y-\QQ','postdate'); # get sql that formats postdate to output 2002-Q1<br> $sql = "SELECT $sqlfn,SUM(cogs) FROM table GROUP BY $sqlfn ORDER BY 1 desc";<br> </font></pre> +<p><font><b>MoveNext<a name="movenext"></a>( )</b></font></p> +<p><font>Move the internal cursor to the next row. The <i>$this->fields</i> array + is automatically updated. Returns false if unable to do so (normally because +EOF has been reached), otherwise true. </font></p> +<p><font> If EOF is reached, then the $this->fields array + is set to false (this was only implemented consistently in ADOdb 3.30). For + the pre-3.30 behaviour of $this->fields (at EOF), set the global variable + $ADODB_COMPAT_FETCH = true.</font></p> +<p><font>Example:</font></p> +<pre><font>$rs = $db->Execute($sql);<br>if ($rs) <br> while (!$rs->EOF) {<br> ProcessArray($rs->fields); <br> $rs->MoveNext();<br> } </font></pre> +<p><font><b>Move<a name="move"></a>($to)</b></font></p> +<p><font>Moves the internal cursor to a specific row $<b>to</b>. + Rows are zero-based eg. 0 is the first row. The <b>fields</b> 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 $<b>to</b> position is after the EOF, $<b>to</b> will move to the + end of the RecordSet for most databases. Some obscure databases using odbc + might not behave this way.</font></p> +<p><font>Note: This function uses <i>absolute positioning</i>, +unlike Microsoft's ADO.</font></p> +<p><font>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( ). </font></p> +<p><font><b>MoveFirst<a name="movefirst"></a>()</b></font></p> +<p><font>Internally calls Move(0). Note that some databases do +not support this function.</font></p> +<p><font><b>MoveLast<a name="movelast"></a>()</b></font></p> +<p><font>Internally calls Move(RecordCount()-1). Note that some + databases do not support this function.</font></p> +<p><font><b>GetRowAssoc</b><a name="getrowassoc"></a>($toUpper=true)</font></p> +<p><font>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(). </font></p> +<p><font>For example:<br> +Array ( [ID] => 1 [FIRSTNAME] => Caroline [LASTNAME] => Miranda [CREATED] +=> 2001-07-05 ) </font></p> +<p><font>Note: do not use GetRowAssoc() with $ADODB_FETCH_MODE + = ADODB_FETCH_ASSOC. Because they have the same functionality, they will + interfere with each other.</font></p> +<font> +</font><p><font><b>AbsolutePage<a name="absolutepage"></a>($page=-1) </b></font></p> +<p><font>Returns the current page. Requires PageExecute()/CachePageExecute() to be called. + See <a href="#ex8">Example 8</a>.</font></p> +<font> +<p><b>AtFirstPage<a name="atfirstpage">($status='')</a></b></p> +<p>Returns true if at first page (1-based). Requires PageExecute()/CachePageExecute() + to be called. See <a href="#ex8">Example 8</a>.</p> +<p><b>AtLastPage<a name="atlastpage">($status='')</a></b></p> +<p>Returns true if at last page (1-based). Requires PageExecute()/CachePageExecute() + to be called. See <a href="#ex8">Example 8</a>.</p> +<p><b>Fields</b><a name="fields"></a>(<b>$colname</b>)</p> +<p>Returns the value of the associated column $<b>colname</b> for the current + row. The column name is case-insensitive.</p> +<p>This is a convenience function. For higher performance, use <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a>. </p> +<p><b>FetchRow</b><a name="fetchrow"></a>()</p> +</font><p><font>Returns array containing current row, or false + if EOF. FetchRow( ) internally moves to the next record after returning the + current row. </font></p> +<p><font>Warning: Do not mix using FetchRow() with MoveNext().</font></p> +<p><font>Usage:</font></p> +<pre><font>$rs = $db->Execute($sql);<br>if ($rs)<br> while ($arr = $rs->FetchRow()) {<br> # process $arr <br> }</font></pre> +<p><font><b>FetchInto</b><a name="fetchinto"></a>(<b>&$array</b>)</font></p> +<p><font> 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. </font></p> +<p><font> FetchRow() is easier to use. See above.</font></p> +<font> </font> +<p><font><b>FetchField<a name="fetchfield"></a>($column_number)</b></font></p> +<p><font>Returns an object containing the <b>name</b>, <b>type</b> and <b>max_length</b> 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 <a href="#ex2">example + 2.</a></font></p> +<p><font><b>FieldCount<a name="fieldcount"></a>( )</b></font></p> +<p><font>Returns the number of fields (columns) in the record +set.</font></p> +<p><font><b>RecordCount<a name="recordcount"></a>( )</b></font></p> +<p><font>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. </font></p> +<p><font> RowCount is a synonym for RecordCount.</font></p> +<p><font><b>PO_RecordCount<a name="po_recordcount"></a>($table, +$where)</b></font></p> +<p><font>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.</font></p> +<p><font>$numrows = $rs->PO_RecordCount("articles_table", "group=$group");</font></p> +<font><b> NextRecordSet<a name="nextrecordset" id="nextrecordset"></a>()</b> </font> +<p><font>For databases that allow multiple recordsets to be returned + in one query, this function allows you to switch to the next recordset. Currently + only supported by mssql driver.</font></p> +<pre><font>$rs = $db->Execute('execute return_multiple_rs');<br>$arr1 = $rs->GetArray();<br>$rs->NextRecordSet();<br>$arr2 = $rs->GetArray();</font></pre> +<p><font><b>FetchObject<a name="fetchobject"></a>($toupper=true)</b></font></p> +<p><font>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.</font></p> +<p><font><b>FetchNextObject<a name="fetchnextobject"></a>($toupper=true)</b></font></p> +<p><font>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. Note that for some drivers such as mssql, you need to SetFetchMode(ADODB_FETCH_ASSOC) or SetFetchMode(ADODB_FETCH_BOTH).</font></p> +<pre><font>$rs = $db->Execute('select firstname,lastname from table');<br>if ($rs) {<br> while ($o = $rs->FetchNextObject()) {<br> print "$o->FIRSTNAME, $o->LASTNAME<BR>";<br> }<br>}<br></font></pre> +<p><font>There is some trade-off in speed in using FetchNextObject(). +If performance is important, you should access rows with the <code>fields[]</code> array. <b>FetchObj<a name="fetchobj" id="fetchobj"></a>()</b> </font></p> +<p><font>Returns the current record as an object. Fields are + not upper-cased, unlike FetchObject. +</font></p> +<p><font><b>FetchNextObj<a name="fetchnextobj" id="fetchnextobj"></a>()</b> </font></p> +<p><font>Returns the current record as an object and moves to + the next record. If EOF, false is returned. Fields are not upper-cased, unlike + FetctNextObject. </font></p> +<font> +<p><b>CurrentRow<a name="currentrow"></a>( )</b></p> +<p>Returns the current row of the record set. 0 is the first row.</p> +<p><b>AbsolutePosition<a name="abspos"></a>( )</b></p> +<p>Synonym for <b>CurrentRow</b> for compatibility with ADO. Returns the current + row of the record set. 0 is the first row.</p> +<p><b>MetaType<a name="metatype"></a>($nativeDBType[,$field_max_length],[$fieldobj])</b></p> +<p>Determine what <i>generic</i> meta type a database field type is given its + native type $<b>nativeDBType</b> as a string and the length of the field $<b>field_max_length</b>. + Note that field_max_length can be -1 if it is not known. The field object returned + by FetchField() can be passed in $<b>fieldobj</b> or as the 1st parameter <b>$nativeDBType</b>. + This is useful for databases such as <i>mysql</i> which has additional properties + in the field object such as <i>primary_key</i>. </p> +<p>Uses the field <b>blobSize</b> and compares it with $<b>field_max_length</b> to + determine whether the character field is actually a blob.</p> +For example, $db->MetaType('char') will return 'C'. +<p>Returns:</p> +<ul> + <li><b>C</b>: Character fields that should be shown in a <input type="text"> tag. </li> + <li><b>X</b>: Clob (character large objects), or large text fields that should + be shown in a <textarea></li> + <li><b>D</b>: Date field</li> + <li><b>T</b>: Timestamp field</li> + <li><b>L</b>: Logical field (boolean or bit-field)</li> + <li><b>N</b>: Numeric field. Includes decimal, numeric, floating point, and + real. </li> + <li><b>I</b>: Integer field. </li> + <li><b>R</b>: Counter or Autoincrement field. Must be numeric.</li> + <li><b>B</b>: Blob, or binary large objects. </li> +</ul> +</font><p><font> Since ADOdb 3.0, MetaType accepts $fieldobj + as the first parameter, instead of $nativeDBType. </font></p> +<font> </font> +<p><font><b>Close( )<a name="rsclose"></a></b></font></p> +<p><font>Closes the recordset, cleaning all memory and resources +associated with the recordset. </font></p> +<p> +<font>If memory management is not an issue, you do not need to +call this function as recordsets are closed for you by PHP at the end of the +script. SQL statements such as INSERT/UPDATE/DELETE do not really return a recordset, +so you do not have to call Close() for such SQL statements.</font></p> +<hr /> +<h3><font>function rs2html<a name="rs2html"></a>($adorecordset,[$tableheader_attributes], + [$col_titles])</font></h3> +<p><font>This is a standalone function (rs2html = recordset to + html) that is similar to PHP's <i>odbc_result_all</i> function, it prints + a ADORecordSet, $<b>adorecordset</b> as a HTML table. $<b>tableheader_attributes</b> allow + you to control the table <i>cellpadding</i>, <i>cellspacing</i> and <i>border</i> attributes. + Lastly you can replace the database column names with your own column titles + with the array $<b>col_titles</b>. This is designed more as a quick debugging + mechanism, not a production table recordset viewer.</font></p> +<p><font>You will need to include the file <i>tohtml.inc.php</i>.</font></p> +<p><font>Example of rs2html:<b><font color="#336600"><a name="exrs2html"></a></font></b></font></p> +<pre><font><b><font color="#336600"><?<br>include('tohtml.inc.php')</font></b>; # load code common to ADOdb <br><b>include</b>('adodb.inc.php'); # load code common to ADOdb <br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection <br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers'; <br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->Execute($sql); <br><font color="#336600"><b>rs2html</b></font><b>($<font color="#663300">rs</font>,'<i>border=2 cellpadding=3</i>',array('<i>Customer Name','Customer ID</i>'));<br>?></b></font></pre> +<hr /> +<h3><font>Differences between this ADOdb library and Microsoft +ADO<a name="adodiff"></a></font></h3> +<ol> +<font> +<li>ADOdb only supports recordsets created by a connection object. Recordsets + cannot be created independently.</li> +<li>ADO properties are implemented as functions in ADOdb. This makes it easier + to implement any enhanced ADO functionality in the future.</li> +<li>ADOdb's <font face="Courier New, Courier, mono">ADORecordSet->Move()</font> uses + absolute positioning, not relative. Bookmarks are not supported.</li> +<li><font face="Courier New, Courier, mono">ADORecordSet->AbsolutePosition() </font>cannot + be used to move the record cursor.</li> +<li>ADO Parameter objects are not supported. Instead we have the ADOConnection::<a href="#parameter">Parameter</a>( + ) function, which provides a simpler interface for calling preparing parameters + and calling stored procedures.</li> +<li>Recordset properties for paging records are available, but implemented as + in <a href="#ex8">Example 8</a>.</li> +</font></ol> +<hr /> +<h1><font>Database Driver Guide<a name="driverguide"></a></font></h1> +<p><font>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.</font></p> +<p><font>First decide on a name in lower case to call the database + type. Let's say we call it xbase. </font></p> +<p><font>Then we need to create two classes ADODB_xbase and ADORecordSet_xbase + in the file adodb-xbase.inc.php.</font></p> +<p><font>The simplest form of database driver is an adaptation + of an existing ODBC driver. Then we just need to create the class <i>ADODB_xbase + extends ADODB_odbc</i> to support the new <b>date</b> and <b>timestamp</b> formats, + the <b>concatenation</b> operator used, <b>true</b> and <b>false</b>. For + the<i> ADORecordSet_xbase extends ADORecordSet_odbc </i>we need to change + the <b>MetaType</b> function. See<b> adodb-vfp.inc.php</b> as an example.</font></p> +<p><font>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 <b>adodb-mysql.inc.php</b> for + example.</font></p> +<p><font>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.</font></p> +<p><font><b>ADOConnection Functions to Override</b></font></p> +<p><font>Defining a constructor for your ADOConnection derived + function is optional. There is no need to call the base class constructor.</font></p> +<p><font>_<b>connect</b>: Low level implementation of Connect. + Returns true or false. Should set the _<b>connectionID</b>.</font></p> +<p><font>_<b>pconnect:</b> Low level implemention of PConnect. + Returns true or false. Should set the _<b>connectionID</b>.</font></p> +<p><font>_<b>query</b>: Execute a query. Returns the queryID, +or false.</font></p> +<p><font>_<b>close: </b>Close the connection -- PHP should clean +up all recordsets. </font></p> +<p><font><b>ErrorMsg</b>: Stores the error message in the private +variable _errorMsg. </font></p> +<p><font><b>ADOConnection Fields to Set</b></font></p> +<p><font>_<b>bindInputArray</b>: Set to true if binding of parameters + for SQL inserts and updates is allowed using ?, eg. as with ODBC.</font></p> +<p><font><b>fmtDate</b></font></p> +<p><font><b>fmtTimeStamp</b></font></p> +<p><font><b>true</b></font></p> +<p><font><b>false</b></font></p> +<p><font><b>concat_operator</b></font></p> +<p><font><b>replaceQuote</b></font></p> +<p><font><b>hasLimit</b> support SELECT * FROM TABLE LIMIT 10 +of MySQL.</font></p> +<p><font><b>hasTop</b> support Microsoft style SELECT TOP 10 +* FROM TABLE.</font></p> +<p><font><b>ADORecordSet Functions to Override</b></font></p> +<p><font>You will need to define a constructor for your ADORecordSet + derived class that calls the parent class constructor.</font></p> +<p><font><b>FetchField: </b> as documented above in ADORecordSet</font></p> +<p><font>_<b>initrs</b>: low level initialization of the recordset: + setup the _<b>numOfRows</b> and _<b>numOfFields</b> fields -- called by the + constructor.</font></p> +<p><font>_<b>seek</b>: 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.</font></p> +<p><font>_<b>fetch</b>: fetch a row using the database extension + function and then move to the next row. Sets the <b>fields</b> array. If + the parameter $ignore_fields is true then there is no need to populate the <b>fields</b> array, + just move to the next row. then Returns true or false.</font></p> +<p><font>_<b>close</b>: close the recordset</font></p> +<p><font><b>Fields</b>: 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.</font></p> +<p><font><b>ADOConnection Fields to Set</b></font></p> +<p><font>canSeek: Set to true if the _seek function works.</font></p> +<h2><font>Optimizing PHP</font></h2> + For info on tuning PHP, read this article on <a href="http://phplens.com/lens/php-book/optimizing-debugging-php.php">Optimizing + PHP</a>. </font></p> + +<h2><font>Change Log<a name="Changes"></a><a name="changes"></a><a name="changelog"></a></font></h2> +<P> +<p><a name="4.81"></a><b>4.81 ? 2006</b> +<p>Fixed variable ref errors in adodb-ado5.inc.php in _query(). +<p>Mysqli setcharset fix using method_exists(). +<p>The adodb-perf.inc.php CreateLogTable() code now works for user-defined table names. +<p>Error in ibase_blob_open() fixed. See http://phplens.com/lens/lensforum/msgs.php?id=14997 +<p><a name="4.80"></a><b>4.80 8 Mar 2006</b> +<p>Added activerecord support. +<p>Added mysql $conn->compat323 = true if you want MySQL 3.23 compat enabled. Fixes GetOne() Select-Limit problems. +<p>Added adodb-xmlschema03.inc.php to support XML Schema version 3 and updated adodb-datadict.htm docs. +<p>Better memory management in Execute. Thx Mike Fedyk. +<p><a name="4.72"></a><b>4.72 21 Feb 2006</b> +<p>Added 'new' DSN parameter for NConnect(). +<p>Pager now sanitizes $PHP_SELF to protect against XSS. Thx to James Bercegay and others. +<p>ADOConnection::MetaType changed to setup $rs->connection correctly. +<p>New native DB2 driver contributed by Larry Menard, Dan Scott, Andy Staudacher, Bharat Mediratta. +<p>The mssql CreateSequence() did not BEGIN TRANSACTION correctly. Fixed. Thx Sean Lee. +<p>The _adodb_countrecs() function in adodb-lib.inc.php has been revised to handle more ORDER BY variations. +<p><a name="4.71"></a><b>4.71 24 Jan 2006</b> +<p>Fixes postgresql security issue related to binary strings. Thx to Andy Staudacher. +<p>Several DSN bugs found: +<p>1. Fix bugs in DSN connections introduced in 4.70 when underscores are found in the DSN. +<p>2. DSN with _ did not work properly in PHP5 (fine in PHP4). Fixed. +<p>3. Added support for PDO DSN connections in NewADOConnection(), and database parameter in PDO::Connect(). +<p>The oci8 datetime flag not correctly implemented in ADORecordSet_array. Fixed. +<p>Added BlobDelete() to postgres, as a counterpoint to UpdateBlobFile(). +<p>Fixed GetInsertSQL() to support oci8po. +<p>Fixed qstr() issue with postgresql with \0 in strings. +<p>Fixed some datadict driver loading issues in _adodb_getdriver(). +<p>Added register shutdown function session_write_close in adodb-session.inc.php for PHP 5 compat. See http://phplens.com/lens/lensforum/msgs.php?id=14200. +<p><a name="4.70"></a><b>4.70 6 Jan 2006</b> +<p>Many fixes from Danila Ulyanov to ibase, oci8, postgres, mssql, odbc_oracle, odbtp, etc drivers. +<p>Changed usage of binary hint in adodb-session.inc.php for mysql. See +http://phplens.com/lens/lensforum/msgs.php?id=14160 +<p>Fixed invalid variable reference problem in undomq(), adodb-perf.inc.php. +<p>Fixed http://phplens.com/lens/lensforum/msgs.php?id=14254 in adodb-perf.inc.php, _DBParameter() settings of fetchmode was wrong. +<p>Fixed security issues in server.php and tmssql.php discussed by Andreas Sandblad in a Secunia security advisory. Added $ACCEPTIP = 127.0.0.1 +and changed suggested root password to something more secure. +<p>Changed pager to close recordset after RenderLayout(). +<p><a name="4.68"></a><b>4.68 25 Nov 2005</b> +<p>PHP 5 compat for mysqli. MetaForeignKeys repeated twice and MYSQLI_BINARY_FLAG missing. +<p>PHP 5.1 support for postgresql bind parameters using ? did not work if >= 10 parameters. Fixed. Thx to Stanislav Shramko. +<p>Lots of PDO improvements. +<p>Spelling error fixed in mysql MetaForeignKeys, $associative parameter. +<p><a name="4.67"></a><b>4.67 16 Nov 2005</b> +<p>Postgresql not_null flag not set to false correctly. Thx Cristian MARIN. +<p>We now check in Replace() if key is in fieldArray. Thx Sébastien Vanvelthem. +<p>_file_get_contents() function was missing in xmlschema. fixed. +<p>Added week in year support to SQLDate(), using 'W' flag. Thx Spider. +<p>In sqlite metacolumns was repeated twice, causing PHP 5 problems. Fixed. +<p>Made debug output XHTML compliant. +<p><a name="4.66"></a><b>4.66 28 Sept 2005</b> +<p>ExecuteCursor() in oci8 did not clean up properly on failure. Fixed. +<p>Updated xmlschema.dtd, by "Alec Smecher" asmecher#smecher.bc.ca +<p>Hardened SelectLimit, typecasting nrows and offset to integer. +<p>Fixed misc bugs in AutoExecute() and GetInsertSQL(). +<p>Added $conn->database as the property holding the database name. The older $conn->databaseName is retained for backward +compat. +<p>Changed _adodb_backtrace() compat check to use function_exists(). +<p>Bug in postgresql MetaIndexes fixed. Thx Kevin Jamieson. +<p>Improved OffsetDate for MySQL, reducing rounding error. +<p>Metacolumns added to sqlite. Thx Mark Newnham. +<p>PHP 4.4 compat fixes for GetAssoc(). +<p>Added postgresql bind support for php 5.1. Thx Cristiano da Cunha Duarte +<p>OffsetDate() fixes for postgresql, typecasting strings to date or timestamp. +<p>DBTimeStamp formats for mssql, odbc_mssql and postgresql made to conform with other db's. +<p>Changed PDO constants from PDO_ to PDO:: to support latest spec. +<p><a name="4.65"></a><b>4.65 22 July 2005</b> +<p>Reverted 'X' in mssql datadict to 'TEXT' to be compat with mssql driver. However now you can +set $datadict->typeX = 'varchar(4000)' or 'TEXT' or 'CLOB' for mssql and oci8 drivers. +<p>Added charset support when using DSN for Oracle. +<p>_adodb_getmenu did not use fieldcount() to get number of fields. Fixed. +<p>MetaForeignKeys() for mysql/mysqli contributed by Juan Carlos Gonzalez. +<p>MetaDatabases() now correctly returns an array for mysqli driver. Thx Cristian MARIN. +<p>CompleteTrans(false) did not return false. Fixed. Thx to JMF. +<p>AutoExecute() did not work with Oracle. Fixed. Thx José Moreira. +<p>MetaType() added to connection object. +<p>More PHP 4.4 reference return fixes. Thx Ryan C Bonham and others. + +<p><a name="4.64"></a><b>4.64 20 June 2005</b> +<p>In datadict, if the default field value is set to '', then it is not applied when the field is created. Fixed by Eugenio. +<p>MetaPrimaryKeys for postgres did not work because of true/false change in 4.63. Fixed. +<p>Tested ocifetchstatement in oci8. Rejected at the end. +<p>Added port to dsn handling. Supported in postgres, mysql, mysqli,ldap. +<p>Added 'w' and 'l' to mysqli SQLDate(). +<p>Fixed error handling in ldap _connect() to be more consistent. Also added ErrorMsg() handling to ldap. +<p>Added support for union in _adodb_getcount, adodb-lib.inc.php for postgres and oci8. +<p>rs2html() did not work with null dates properly. +<p>PHP 4.4 reference return fixes. + +<p><a name="4.63"></a><b>4.63 18 May 2005</b> +<p>Added $nrows<0 check to mysqli's SelectLimit(). +<p>Added OptimizeTable() and OptimizeTables() in adodb-perf.inc.php. By Markus Staab. +<p>PostgreSQL inconsistencies fixed. true and false set to TRUE and FALSE, and boolean type in datadict-postgres.inc.php set +to 'L' => 'BOOLEAN'. Thx Kevin Jamieson. +<p>New adodb_session_create_table() function in adodb-session.inc.php. By Markus Staab. +<p>Added null check to UserTimeStamp(). +<p>Fixed typo in mysqlt driver in adorecordset. Thx to Andy Staudacher. +<p>GenID() had a bug in the raiseErrorFn handling. Fixed. Thx Marcos Pont. +<p>Datadict name quoting now handles ( ) in index fields correctly - they aren't part of the index field. +<p>Performance monitoring: (1) oci8 Ixora checks moved down; (2) expensive sql changed so that only those sql with +count(*)>1 are shown; (3) changed sql1 field to a length+crc32 checksum - this breaks backward compat. +<p>We remap firebird15 to firebird in data dictionary. + +<p><a name="4.62"></a><b>4.62 2 Apr 2005</b> +<p>Added 'w' (dow as 0-6 or 1-7) and 'l' (dow as string) for SQLDate for oci8, postgres and mysql. +<p>Rolled back MetaType() changes for mysqli done in prev version. +<p>Datadict change by chris, cblin#tennaxia.com data mappings from: +<pre> +oci8: X->varchar(4000) XL->CLOB +mssql: X->XL->TEXT +mysql: X->XL->LONGTEXT +fbird: X->XL->varchar(4000) +</pre> +<p>to: +<pre> +oci8: X->varchar(4000) XL->CLOB +mssql: X->VARCHAR(4000) XL->TEXT +mysql: X->TEXT XL->LONGTEXT +fbird: X->VARCHAR(4000) XL->VARCHAR(32000) +</pre> +<p>Added $connection->disableBlobs to postgresql to improve performance when no bytea is used (2-5% improvement). +<p>Removed all HTTP_* vars. +<p>Added $rs->tableName to be set before calling AutoExecute(). +<p>Alex Rootoff rootoff#pisem.net contributed ukrainian language file. +<p>Added new mysql_option() support using $conn->optionFlags array. +<p>Added support for ldap_set_option() using the $LDAP_CONNECT_OPTIONS global variable. Contributed by Josh Eldridge. +<p>Added LDAP_* constant definitions to ldap. +<p>Added support for boolean bind variables. We use $conn->false and $conn->true to hold values to set false/true to. +<p>We now do not close the session connection in adodb-session.inc.php as other objects could be using this connection. +<p>We now strip off \0 at end of Ixora SQL strings in $perf->tohtml() for oci8. +<p><a name="4.61"></a><b>4.61 23 Feb 2005</b> +<p>MySQLi added support for mysqli_connect_errno() and mysqli_connect_error(). +<p>Massive improvements to alpha PDO driver. +<p>Quote string bind parameters logged by performance monitor for easy type checking. Thx Jason Judge. +<p>Added support for $role when connecting with Interbase/firebird. +<p>Added support for enum recognition in MetaColumns() mysql and mysqli. Thx Amedeo Petrella. +<p>The sybase_ase driver contributed by Interakt Online. Thx Cristian Marin cristic#interaktonline.com. +<p>Removed not_null, has_default, and default_value from ADOFieldObject. +<p>Sessions code, fixed quoting of keys when handling LOBs in session write() function. +<p>Sessions code, added adodb_session_regenerate_id(), to reduce risk of session hijacking by changing session cookie dynamically. Thx Joe Li. +<p>Perf monitor, polling for CPU did not work for PHP 4.3.10 and 5.0.0-5.0.3 due to PHP bugs, so we special case these versions. +<p>Postgresql, UpdateBlob() added code to handle type==CLOB. +<p><a name="4.60"></a><b>4.60 24 Jan 2005</b> +<p>Implemented PEAR DB's autoExecute(). Simplified design because I don't like using constants when +strings work fine. +<p>_rs2serialize will now update $rs->sql and $rs->oldProvider. +<p>Added autoExecute(). +<p>Added support for postgres8 driver. Currently just remapped to postgres7 driver. +<p>Changed oci8 _query(), so that OCIBindByName() sets the length to -1 if element size is > 4000. This provides better support +for LONGs. +<p>Added SetDateLocale() support for netherlands (Nl). +<p>Spelling error in pivot code ($iff should be $iif). +</p><p>mysql insert_id() did not work with mysql 3.x. Fixed. +</p><p>"\r\n" not converted to spaces correctly in exporting data. Fixed. +</p><p>_nconnect() in mysqli did not return value correctly. Fixed. +</p><p>Arne Eckmann contributed danish language file. +</p><p>Added clone() support to FetchObject() for PHP5.<br> +</p> +<p>Removed SQL_CUR_USE_ODBC from odbc_mssql.<br> +</p> +<p><a name="4.55"></a><b>4.55 5 Jan 2005</b> +</p><p>Found bug in Execute() with bind params for db's that do not support binding natively. +</p><p>DropSequence() now correctly uses default parameter. +</p><p>Now Execute() ignores locale for floats, so 1.23 is NEVER converted to 1,23. +</p><p>SetFetchMode() not properly saved in adodb-perf, suspicious sql and expensive sql. Fixed. +</p><p>Added INET to postgresql metatypes. Thx motzel. +</p><p>Allow oracle hints to work when counting with _adodb_getcount in adodb-lib.inc.php. Thx Chris Wrye. +</p><p>Changed mysql insert_id() to use SELECT LAST_INSERT_ID(). +</p><p>If alter col in datadict does not modify col type/size of actual +col, then it is removed from alter col code. By Mark Newham. Not +perfect as MetaType() !== ActualType(). +</p><p>Added handling of view fields in metacolumns() for postgresql. Thx Renato De Giovanni. +</p><p>Added to informix MetaPrimaryKeys and MetaColumns fixes for null bit. Thx to Cecilio Albero. +</p><p>Removed obsolete connection_timeout() from perf code. +</p><p>Added support for arrayClass in adodb-csv.inc.php. +</p><p>RSFilter now accepts methods of the form $array($obj, 'methodname'). Thx to blake#near-time.com. +</p><p>Changed CacheFlush to $cmd = 'rm -rf '.$ADODB_CACHE_DIR.'/[0-9a-f][0-9a-f]/'; +</p><p>For better cursor concurrency, added code to free ref cursors in +oci8 when $rs->Close() is called. Note that CLose() is called +internally by the Get* functions too. +</p><p>Added IIF support for access when pivoting. Thx Volodia Krupach. +</p><p>Added mssql datadict support for timestamp. Thx Alexios. +</p><p>Informix pager fix. By Mario Ramirez. +</p><p>ADODB_TABLE_REGEX now includes ':'. By Mario Ramirez. +</p><p>Mark Newnham contributed MetaIndexes for oci8 and db2. +</p><p><a name="4.54"></a><b>4.54 5 Nov 2004</b> +</p><p> +Now you can set $db->charSet = ?? before doing a Connect() in oci8. +</p><p> +Added adodbFetchMode to sqlite. +</p><p> +Perf code, added a string typecast to substr in adodb_log_sql(). +</p><p> +Postgres: Changed BlobDecode() to use po_loread, added new $maxblobsize parameter, and now it returns the blob instead +of sending it to stdout - make sure to mention that as a compat warning. +Also added $db->IsOID($oid) function; uses a heuristic, not guaranteed to work 100%. +</p><p> +Contributed arabic language file by "El-Shamaa, Khaled" k.el-shamaa#cgiar.org +</p><p> +PHP5 exceptions did not handle @ protocol properly. Fixed. +</p><p> +Added ifnull handling for postgresql (using coalesce). +</p><p> +Added metatables() support for Postgresql 8.0 (no longer uses pg_% dictionary tables). +</p><p> +Improved Sybase ErrorMsg() function. By Gaetano Giunta. +</p><p> +Improved oci8 SelectLimit() to use Prepare(). By Cristiano Duarte. +</p><p> +Type-cast $row parameter in ifx_fetch_row() to int. Thx stefan bodgan. +</p><p>Ralf becker contributed improvements in postgresql, sapdb, mysql data dictionary handling:<br> +- MySql and Postgres MetaType was reporting every int column which was +part of a primary key and unique as serial<br> +- Postgres was not reporting the scale of decimal types<br> +- MaxDB was padding the defaults of none-string types with spaces<br> +- MySql now correctly converts enum columns to varchar +</p><p> +Ralf also changed Postgresql datadict:<br> +- you cant add NOT NULL columns in postgres in one go, they need to be +added as NULL and then altered to NOT NULL<br> +- AlterColumnSQL could not change a varchar column with numbers into an +integer column, postgres need an explicit conversation<br> +- a re-created sequence was not set to the correct value, if the name +was the old name (no implicit sequence), now always the new name of the +implicit sequence is used<br> +</p><p>Sergio Strampelli added extra $intoken check to Lens_ParseArgs() in datadict code. +</p><p><a name="4.53"></a><b>4.53 28 Sept 2004</b> +</p><p>FetchMode cached in recordset is sometimes mapped to native db fetchMode. Normally this does not matter, +but when using cached recordsets, we need to switch back to using adodb fetchmode. So we cache this +in $rs->adodbFetchMode if it differs from the db's fetchMode. +</p><p>For informix we now set canSeek = false driver because stefan bodgan tells me that seeking doesn't work. +</p><p>SetDateLocale() never worked till now ;-) Thx david#tomato.it +</p><p>Set $_bindInputArray = true in sapdb driver. Required for clob support. +</p><p>Fixed some PEAR::DB emulation issues with isError() and isWarning. Thx to Gert-Rainer Bitterlich. +</p><p>Empty() used in getupdatesql without strlen() check. Fixed.</p> +<p>Added unsigned detection to mysql and mysqli drivers. Thx to dan cech. +</p><p>Added hungarian language file. Thx to Halászvári Gábor. +</p><p>Improved fieldname-type formatting of datadict SQL generated (adding $widespacing parameter to _GenField). +</p><p>Datadict oci8 DROP CONSTRAINTS misspelt. Fixed. Thx Mark Newnham. +</p><p>Changed odbtp to dynamically change databaseType based on connection, eg. from 'odbtp' to 'odbtp_mssql' when connecting +to mssql database. +</p><p>In datadict, MySQL I4 was wrongly mapped to MEDIUMINT, which is actually I3. Fixed. +</p><p>Fixed mysqli MetaType() recognition. Mysqli returns numeric types unlike mysql extension. Thx Francesco Riosa. +</p><p>VFP odbc driver curmode set wrongly, causing problems with memo fields. Fixed. +</p><p>Odbc driver did not recognize odbc version 2 driver date types properly. Fixed. Thx Bostjan. +</p><p>ChangeTableSQL() fixes to datadict-db2.inc.php by Mark Newnham. +</p><p>Perf monitoring with odbc improved. Now we try in perf code to manually set the sysTimeStamp using date() if sysTimeStamp +is empty. +</p><p>All ADO errors are thrown as exceptions in PHP5. +So we added exception handling to ado in PHP5 by creating new adodb-ado5.inc.php driver. +</p><p>Added IsConnected(). Returns true if connection object connected. By Luca.Gioppo. +</p><p>"Ralf Becker" +RalfBecker#digitalROCK.de contributed new sapdb data-dictionary driver +and a large patch that implements field and table renaming for oracle, +mssql, postgresql, mysql and sapdb. See the new RenameTableSQL() and +RenameColumnSQL() functions. +</p><p>We now check ExecuteCursor to see if PrepareSP was initially called. +</p><p>Changed oci8 datadict to use MODIFY for $dd->alterCol. Thx Mark Newnham. +</p><p><a name="4.52"></a><b>4.52 10 Aug 2004</b> +</p><p>Bug found in Replace() when performance logging enabled, introduced in ADOdb 4.50. Fixed. +</p><p>Replace() checks update stmt. If update stmt fails, we now return immediately. Thx to alex. +</p><p>Added support for $ADODB_FORCE_TYPE in GetUpdateSQL/GetInsertSQL. Thx to niko. +</p><p>Added ADODB_ASSOC_CASE support to postgres/postgres7 driver. +</p><p>Support for DECLARE stmt in oci8. Thx Lochbrunner. +</p><p><a name="4.51"></a><b>4.51 29 July 2004</b> +</p><p>Added adodb-xmlschema 1.0.2. Thx dan and richard. +</p><p>Added new adorecordset_ext_* classes. If ADOdb extension installed for mysql, mysqlt and oci8 +(but not oci8po), we use the superfast ADOdb extension code for movenext. +</p><p>Added schema support to mssql and odbc_mssql MetaPrimaryKeys(). +</p><p>Patched MSSQL driver to support PHP NULL and Boolean values +while binding the input array parameters in the _query() function. By Stephen Farmer. +</p><p>Added support for clob's for mssql, UpdateBlob(). Thx to gfran#directa.com.br +</p><p>Added normalize support for postgresql (true=lowercase table name, or false=case-sensitive table names) +to MetaColumns($table, $normalize=true). +</p><p>PHP5 variant dates in ADO not working. Fixed in adodb-ado.inc.php. +</p><p>Constant ADODB_FORCE_NULLS was not working properly for many releases (for GetUpdateSQL). Fixed. +Also GetUpdateSQL strips off ORDER BY now - thx Elieser Leão. +</p><p>Perf Monitor for oci8 now dynamically highlights optimizer_* params if too high/low. +</p><p>Added dsn support to NewADOConnection/ADONewConnection. +</p><p>Fixed out of page bounds bug in _adodb_pageexecute_all_rows() Thx to "Sergio Strampelli" sergio#rir.it +</p><p>Speedup of movenext for mysql and oci8 drivers. +</p><p>Moved debugging code _adodb_debug_execute() to adodb-lib.inc.php. +</p><p>Fixed postgresql bytea detection bug. See http://phplens.com/lens/lensforum/msgs.php?id=9849. +</p><p>Fixed ibase datetimestamp typo in PHP5. Thx stefan. +</p><p>Removed whitespace at end of odbtp drivers. +</p><p>Added db2 metaprimarykeys fix. +</p><p>Optimizations to MoveNext() for mysql and oci8. Misc speedups to Get* functions. +</p><p><a name="4.50"></a><b>4.50 6 July 2004</b> +</p><p>Bumped it to 4.50 to avoid confusion with PHP 4.3.x series. +</p><p>Added db2 metatables and metacolumns extensions. +</p><p>Added alpha PDO driver. Very buggy, only works with odbc. +</p><p>Tested mysqli. Set poorAffectedRows = true. Cleaned up movenext() and _fetch(). +</p><p>PageExecute does not work properly with php5 (return val not a variable). Reported Dmytro Sychevsky sych#php.com.ua. Fixed. +</p><p>MetaTables() for mysql, $showschema parameter was not backward compatible with older versions of adodb. Fixed. +</p><p>Changed mysql GetOne() to work with mysql 3.23 when using with non-select stmts (e.g. SHOW TABLES). +</p><p>Changed TRIG_ prefix to a variable in datadict-oci8.inc.php. Thx to Luca.Gioppo#csi.it. +</p><p>New to adodb-time code. We allow you to define your own daylights savings function, +adodb_daylight_sv for pre-1970 dates. If the function is defined +(somewhere in an include), then you can correct +for daylights savings. See http://phplens.com/phpeverywhere/node/view/16#daylightsavings +for more info. +</p><p>New sqlitepo driver. This is because assoc mode does not work like other drivers in sqlite. + Namely, when selecting (joining) multiple tables, in assoc mode the table + names are included in the assoc keys in the "sqlite" driver. + In "sqlitepo" driver, the table names are stripped from the returned column names. + When this results in a conflict, the first field get preference. + Contributed by Herman Kuiper herman#ozuzo.net +</p><p>Added $forcenull parameter to GetInsertSQL/GetUpdateSQL. Idea by Marco Aurelio Silva. +</p><p>More XHTML changes for GetMenu. By Jeremy Evans. +</p><p>Fixes some ibase date issues. Thx to stefan bogdan. +</p><p>Improvements to mysqli driver to support $ADODB_COUNTRECS. +</p><p>Fixed adodb-csvlib.inc.php problem when reading stream from socket. We need to poll stream continiously. +</p><p><a name="4.23"></a><b>4.23 16 June 2004</b> +</p><p> +New interbase/firebird fixes thx to Lester Caine. +Driver fixes a problem with getting field names in the result array, and +corrects a couple of data conversions. Also we default to dialect3 for firebird. +Also ibase sysDate property was wrong. Changed to cast as timestamp. +</p><p> +The datadict driver is set up to give quoted tables and fields as this +was the only way round reserved words being used as field names in +TikiWiki. TikiPro is tidying that up, and I hope to be able to produce a +build of THAT which uses what I consider proper UPPERCASE field and +table names. The conversion of TikiWiki to ADOdb helped in that, but +until the database is completely tidied up in TikiPro ... +</p><p>Modified _gencachename() to include fetchmode in name hash. +This means you should clear your cache directory after installing this release as the +cache name algorithm has changed. +</p><p>Now Cache* functions work in safe +mode, because we do not create sub-directories in the $ADODB_CACHE_DIR +in safe mode. In non-safe mode we still create sub-directories. Done by +modifying _gencachename(). +</p><p>Added $gmt parameter (true/false) +to UserDate and UserTimeStamp in connection class, to force conversion +of input (in local time) to be converted to UTC/GMT. +</p><p>Mssql datadict did not support INT types properly (no size param allowed). +Added _GetSize() to datadict-mssql.inc.php. +</p><p>For borland_ibase, BeginTrans(), changed:<br> +</p><pre> $this->_transactionID = $this->_connectionID;</pre> +to<br> +<pre> $this->_transactionID = ibase_trans($this->ibasetrans, $this->_connectionID);</pre> + +<p>Fixed typo in mysqi_field_seek(). Thx to Sh4dow (sh4dow#php.pl). +</p><p>LogSQL did not work with Firebird/Interbase. Fixed. +</p><p>Postgres: made errorno() handling more consistent. Thx to Michael Jahn, Michael.Jahn#mailbox.tu-dresden.de. +</p><p>Added informix patch to better support metatables, metacolumns by "Cecilio Albero" c-albero#eos-i.com +</p><p>Cyril Malevanov contributed patch to oci8 to support passing of LOB parameters: +</p><pre> $text = 'test test test';<br> $sql = "declare rs clob; begin :rs := lobinout(:sa0); end;";<br> $stmt = $conn -> PrepareSP($sql);<br> $conn -> InParameter($stmt,$text,'sa0', -1, OCI_B_CLOB);<br> $rs = '';<br> $conn -> OutParameter($stmt,$rs,'rs', -1, OCI_B_CLOB);<br> $conn -> Execute($stmt);<br> echo "return = ".$rs."<br>";<br></pre> +As he says, the LOBs limitations are: +<pre> - use OCINewDescriptor before binding<br> - if Param is IN, uses save() before each execute. This is done automatically for you.<br> - if Param is OUT, uses load() after each execute. This is done automatically for you.<br> - when we bind $var as LOB, we create new descriptor and return it as a<br> Bind Result, so if we want to use OUT parameters, we have to store<br> somewhere &$var to load() data from LOB to it.<br> - IN OUT params are not working now (should not be a big problem to fix it)<br> - now mass binding not working too (I've wrote about it before)<br></pre> +<p>Simplified Connect() and PConnect() error handling. +</p><p>When extension not loaded, Connect() and PConnect() will return null. On connect error, the fns will return false. +</p><p>CacheGetArray() added to code. +</p><p>Added Init() to adorecordset_empty(). +</p><p>Changed postgres64 driver, MetaColumns() to not strip off quotes in default value if :: detected (type-casting of default). +</p><p>Added test: if (!defined('ADODB_DIR')) die(). Useful to prevent hackers from detecting file paths. +</p><p>Changed metaTablesSQL to ignore Postgres 7.4 information schemas (sql_*). +</p><p>New polish language file by Grzegorz Pacan +</p><p>Added support for UNION in _adodb_getcount(). +</p><p>Added security check for ADODB_DIR to limit path disclosure issues. Requested by postnuke team. +</p><p>Added better error message support to oracle driver. Thx to Gaetano Giunta. +</p><p>Added showSchema support to mysql. +</p><p>Bind in oci8 did not handle $name=false properly. Fixed. +</p><p>If extension not loaded, Connect(), PConnect(), NConnect() will return null. +</p><p><b>4.22 15 Apr 2004</b> +</p><p>Moved docs to own adodb/docs folder. +</p><p>Fixed session bug when quoting compressed/encrypted data in Replace(). +</p><p>Netezza Driver and LDAP drivers contributed by Josh Eldridge. +</p><p>GetMenu now uses rtrim() on values instead of trim(). +</p><p>Changed MetaColumnNames to return an associative array, keys being the field names in uppercase. +</p><p>Suggested fix to adodb-ado.inc.php affected_rows to support PHP5 variants. Thx to Alexios Fakos. +</p><p>Contributed bulgarian language file by Valentin Sheiretsky valio#valio.eu.org. +</p><p>Contributed romanian language file by stefan bogdan. +</p><p>GetInsertSQL now checks for table name (string) in $rs, and will create a recordset for that +table automatically. Contributed by Walt Boring. Also added OCI_B_BLOB in bind on Walt's request - hope +it doesn't break anything :-) +</p><p>Some minor postgres speedups in _initrs(). +</p><p> ChangeTableSQL checks now if MetaColumns returns empty. Thx Jason Judge. +</p><p>Added ADOConnection::Time(), returns current database time in unix timestamp format, or false. +</p><p><b>4.21 20 Mar 2004</b> +</p><p>We no longer in SelectLimit for VFP driver add SELECT TOP X unless an ORDER BY exists. +</p><p>Pim Koeman contributed dutch language file adodb-nl.inc.php. +</p><p>Rick Hickerson added CLOB support to db2 datadict. +</p><p>Added odbtp driver. Thx to "stefan bogdan" sbogdan#rsb.ro. +</p><p>Changed PrepareSP() 2nd parameter, $cursor, to default to true (formerly false). Fixes oci8 backward +compat problems with OUT params. +</p><p>Fixed month calculation error in adodb-time.inc.php. 2102-June-01 appeared as 2102-May-32. +</p><p>Updated PHP5 RC1 iterator support. API changed, hasMore() renamed to valid(). +</p><p>Changed internal format of serialized cache recordsets. As we store a version number, this should be +backward compatible. +</p><p>Error handling when driver file not found was flawed in ADOLoadCode(). Fixed. +</p><p><b>4.20 27 Feb 2004</b> +</p><p>Updated to AXMLS 1.01. +</p><p>MetaForeignKeys for postgres7 modified by Edward Jaramilla, works on pg 7.4. +</p><p>Now numbers accepts function calls or sequences for GetInsertSQL/GetUpdateSQL numeric fields. +</p><p>Changed quotes of 'delete from $perf_table' to "". Thx Kehui (webmaster#kehui.net) +</p><p>Added ServerInfo() for ifx, and putenv trim fix. Thx Fernando Ortiz. +</p><p>Added addq(), which is analogous to addslashes(). +</p><p>Tested with php5b4. Fix some php5 compat problems with exceptions and sybase. +</p><p>Carl-Christian Salvesen added patch to mssql _query to support binds greater than 4000 chars. +</p><p>Mike suggested patch to PHP5 exception handler. $errno must be numeric. +</p><p>Added double quotes (") to ADODB_TABLE_REGEX. +</p><p>For oci8, Prepare(...,$cursor), +$cursor's meaning was accidentally inverted in 4.11. This causes +problems with ExecuteCursor() too, which calls Prepare() internally. +Thx to William Lovaton. +</p><p>Now dateHasTime property in connection object renamed to datetime for consistency. This could break bc. +</p><p>Csongor Halmai reports that db2 SelectLimit with input array is not working. Fixed.. +</p><p><b>4.11 27 Jan 2004</b> +</p><p>Csongor Halmai reports db2 binding not working. Reverted back to emulated binding. +</p><p>Dan Cech modifies datadict code. Adds support for DropIndex. Minor cleanups. +</p><p>Table misspelt in perf-oci8.inc.php. Changed v$conn_cache_advice to v$db_cache_advice. Reported by Steve W. +</p><p>UserTimeStamp and DBTimeStamp did not handle YYYYMMDDHHMMSS format properly. Reported by Mike Muir. Fixed. +</p><p>Changed oci8 Prepare(). Does not auto-allocate OCINewCursor automatically, unless 2nd param is set to true. +This will break backward compat, if Prepare/Execute is used instead of ExecuteCursor. Reported by Chris Jones. +</p><p>Added InParameter() and OutParameter(). Wrapper functions to Parameter(), but nicer because they +are self-documenting. +</p><p>Added 'R' handling in ActualType() to datadict-mysql.inc.php +</p><p>Added ADOConnection::SerializableRS($rs). Returns a recordset that can be serialized in a session. +</p><p>Added "Run SQL" to performance UI(). +</p><p>Misc spelling corrections in adodb-mysqli.inc.php, adodb-oci8.inc.php and datadict-oci8.inc.php, from Heinz Hombergs. +</p><p>MetaIndexes() for ibase contributed by Heinz Hombergs. +</p><p><b>4.10 12 Jan 2004</b> +</p><p>Dan Cech contributed extensive changes to data dictionary to support name quoting (with `), and drop table/index. +</p><p>Informix added cursorType property. Default remains IFX_SCROLL, but you can change to 0 (non-scrollable cursor) for performance. +</p><p>Added ADODB_View_PrimaryKeys() for returning view primary keys to MetaPrimaryKeys(). +</p><p>Simplified chinese file, adodb-cn.inc.php from cysoft. +</p><p>Added check for ctype_alnum in adodb-datadict.inc.php. Thx to Jason Judge. +</p><p>Added connection parameter to ibase Prepare(). Fix by Daniel Hassan. +</p><p>Added nameQuote for quoting identifiers and names to connection obj. Requested by Jason Judge. Also the +data dictionary parser now detects `field name` and generates column names with spaces correctly. +</p><p>BOOL type not recognised correctly as L. Fixed. +</p><p>Fixed paths in ADODB_DIR for session files, and back-ported it to 4.05 (15 Dec 2003) +</p><p>Added Schema to postgresql MetaTables. Thx to col#gear.hu +</p><p>Empty postgresql recordsets that had blob fields did not set EOF properly. Fixed. +</p><p>CacheSelectLimit internal parameters to SelectLimit were wrong. Thx to Nio. +</p><p>Modified adodb_pr() and adodb_backtrace() to support command-line usage (eg. no html). +</p><p>Fixed some fr and it lang errors. Thx to Gaetano G. +</p><p>Added contrib directory, with adodb rs to xmlrpc convertor by Gaetano G. +</p><p>Fixed array recordset bugs when _skiprow1 is true. Thx to Gaetano G. +</p><p>Fixed pivot table code when count is false. +</p><p> + +</p><p><b>4.05 13 Dec 2003 </b> +</p><p>Added MetaIndexes to data-dict code - thx to Dan Cech. +</p><p>Rewritten session code by Ross Smith. Moved code to adodb/session directory. +</p><p>Added function exists check on connecting to most drivers, so we don't crash with the unknown function error. +</p><p>Smart Transactions failed with GenID() when it no seq table has been created because the sql + statement fails. Fix by Mark Newnham. +</p><p>Added $db->length, which holds name of function that returns strlen. +</p><p>Fixed error handling for bad driver in ADONewConnection - passed too few params to error-handler. +</p><p>Datadict did not handle types like 16.0 properly in _GetSize. Fixed. +</p><p>Oci8 driver SelectLimit() bug &= instead of =& used. Thx to Swen Thümmler. +</p><p>Jesse Mullan suggested not flushing outp when output buffering enabled. Due to Apache 2.0 bug. Added. +</p><p>MetaTables/MetaColumns return ref bug with PHP5 fixed in adodb-datadict.inc.php. +</p><p>New mysqli driver contributed by Arjen de Rijke. Based on adodb 3.40 driver. +Then jlim added BeginTrans, CommitTrans, RollbackTrans, IfNull, SQLDate. Also fixed return ref bug. +</p><p>$ADODB_FLUSH added, if true then force flush in debugging outp. Default is false. In earlier +versions, outp defaulted to flush, which is not compat with apache 2.0. +</p><p>Mysql driver's GenID() function did not work when when sql logging is on. Fixed. +</p><p>$ADODB_SESSION_TBL not declared as global var. Not available if adodb-session.inc.php included in function. Fixed. +</p><p>The input array not passed to Execute() in _adodb_getcount(). Fixed. +</p><p><b>4.04 13 Nov 2003 </b> +</p><p>Switched back to foreach - faster than list-each. +</p><p>Fixed bug in ado driver - wiping out $this->fields with date fields. +</p><p>Performance Monitor, View SQL, Explain Plan did not work if strlen($SQL)>max($_GET length). Fixed. +</p><p>Performance monitor, oci8 driver added memory sort ratio. +</p><p>Added random property, returns SQL to generate a floating point number between 0 and 1; +</p><p><b>4.03 6 Nov 2003 </b> +</p><p>The path to adodb-php4.inc.php and adodb-iterators.inc.php was not setup properly. +</p><p>Patched SQLDate in interbase to support hours/mins/secs. Thx to ari kuorikoski. +</p><p>Force autorollback for pgsql persistent connections - +apparently pgsql did not autorollback properly before 4.3.4. See http://bugs.php.net/bug.php?id=25404 +</p><p><b>4.02 5 Nov 2003 </b> +</p><p>Some errors in adodb_error_pg() fixed. Thx to Styve. +</p><p>Spurious Insert_ID() error was generated by LogSQL(). Fixed. +</p><p>Insert_ID was interfering with Affected_Rows() and Replace() when LogSQL() enabled. Fixed. +</p><p>More foreach loops optimized with list/each. +</p><p>Null dates not handled properly in ADO driver (it becomes 31 Dec 1969!). +</p><p>Heinz Hombergs contributed patches for mysql MetaColumns - adding scale, made +interbase MetaColumns work with firebird/interbase, and added lang/adodb-de.inc.php. +</p><p>Added INFORMIXSERVER environment variable. +</p><p>Added $ADODB_ANSI_PADDING_OFF for interbase/firebird. +</p><p>PHP 5 beta 2 compat check. Foreach (Iterator) support. Exceptions support. +</p><p><b>4.01 23 Oct 2003 </b> +</p><p>Fixed bug in rs2html(), tohtml.inc.php, that generated blank table cells. +</p><p>Fixed insert_id() incorrectly generated when logsql() enabled. +</p><p>Modified PostgreSQL _fixblobs to use list/each instead of foreach. +</p><p>Informix ErrorNo() implemented correctly. +</p><p>Modified several places to use list/each, including GetRowAssoc(). +</p><p>Added UserTimeStamp() to connection class. +</p><p>Added $ADODB_ANSI_PADDING_OFF for oci8po. +</p><p><b>4.00 20 Oct 2003 </b> +</p><p>Upgraded adodb-xmlschema to 1 Oct 2003 snapshot. +</p><p>Fix to rs2html warning message. Thx to Filo. +</p><p>Fix for odbc_mssql/mssql SQLDate(), hours was wrong. +</p><p>Added MetaColumns and MetaPrimaryKeys for sybase. Thx to Chris Phillipson. +</p><p>Added autoquoting to datadict for MySQL and PostgreSQL. Suggestion by Karsten Dambekalns +</p><p><b>3.94 11 Oct 2003 </b> +</p><p>Create trigger in datadict-oci8.inc.php did not work, because all cr/lf's must be removed. +</p><p>ErrorMsg()/ErrorNo() did not work for many databases when logging enabled. Fixed. +</p><p>Removed global variable $ADODB_LOGSQL as it does not work properly with multiple connections. +</p><p>Added SQLDate support for sybase. Thx to Chris Phillipson +</p><p>Postgresql checking of pgsql resultset resource was incorrect. Fix by Bharat Mediratta bharat#menalto.com. +Same patch applied to _insertid and _affectedrows for adodb-postgres64.inc.php. +</p><p>Added support for NConnect for postgresql. +</p><p>Added Sybase data dict support. Thx to Chris Phillipson +</p><p>Extensive improvements in $perf->UI(), eg. Explain now opens in new window, we show scripts +which call sql, etc. +</p><p>Perf Monitor UI works with magic quotes enabled. +</p><p>rsPrefix was declared twice. Removed. +</p><p>Oci8 stored procedure support, eg. "begin func(); end;" was incorrect in _query. Fixed. +</p><p>Tiraboschi Massimiliano contributed italian language file. +</p><p>Fernando Ortiz, fortiz#lacorona.com.mx, contributed informix performance monitor. +</p><p>Added _varchar (varchar arrays) support for postgresql. Reported by PREVOT Stéphane.<hr /> +<p><strong>0.10 Sept 9 2000</strong> First release +</p><h3><strong>Old change log history moved to <a href="old-changelog.htm">old-changelog.htm</a>. + </strong></h3> +<p> </p> +<p> +</p></body></html>
\ No newline at end of file diff --git a/framework/3rdParty/adodb/docs/docs-oracle.htm b/framework/3rdParty/adodb/docs/docs-oracle.htm new file mode 100644 index 00000000..ad7677e3 --- /dev/null +++ b/framework/3rdParty/adodb/docs/docs-oracle.htm @@ -0,0 +1,542 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<style> +pre { + background-color: #eee; + padding: 0.75em 1.5em; + font-size: 12px; + border: 1px solid #ddd; +} +.greybg { + background-color: #eee; + padding: 0.75em 1.5em; + font-size: 12px; + border: 1px solid #ddd; +} +.style1 {color: #660000} +</style> +<title>ADOdb with PHP and Oracle</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</style> +</head> + +<body> +<table width=100%><tr><td> +<h2>Using ADOdb with PHP and Oracle: an advanced tutorial</h2> +</td><td><div align="right"><img src=cute_icons_for_site/adodb.gif width="88" height="31"></div></tr></table> +<p><font size="1">(c)2004-2005 John Lim. All rights reserved.</font></p> +<h3>1. Introduction</h3> +<p>Oracle is the most popular commercial database used with PHP. There are many ways of accessing Oracle databases in PHP. These include:</p> +<ul> + <li>The oracle extension</li> + <li>The oci8 extension</li> + <li>PEAR DB library</li> + <li>ADOdb library</li> +</ul> +<p>The wide range of choices is confusing to someone just starting with Oracle and PHP. I will briefly summarize the differences, and show you the advantages of using <a href="http://adodb.sourceforge.net/">ADOdb</a>. </p> +<p>First we have the C extensions which provide low-level access to Oracle functionality. These C extensions are precompiled into PHP, or linked in dynamically when the web server starts up. Just in case you need it, here's a <a href=http://www.oracle.com/technology/tech/opensource/php/apache/inst_php_apache_linux.html>guide to installing Oracle and PHP on Linux</a>.</p> +<table width="75%" border="1" align="center"> + <tr valign="top"> + <td nowrap><b>Oracle extension</b></td> + <td>Designed for Oracle 7 or earlier. This is obsolete.</td> + </tr> + <tr valign="top"> + <td nowrap><b>Oci8 extension</b></td> + <td> Despite it's name, which implies it is only for Oracle 8i, this is the standard method for accessing databases running Oracle 8i, 9i or 10g (and later).</td> + </tr> +</table> +<p>Here is an example of using the oci8 extension to query the <i>emp</i> table of the <i>scott</i> schema with bind parameters: +<pre> +$conn = OCILogon("scott","tiger", $tnsName); + +$stmt = OCIParse($conn,"select * from emp where empno > :emp order by empno"); +$emp = 7900; +OCIBindByName($stmt, ':emp', $emp); +$ok = OCIExecute($stmt); +while (OCIFetchInto($stmt,$arr)) { + print_r($arr); + echo "<hr>"; +} +</pre> +<p>This generates the following output: +<div class=greybg> +Array ( [0] => 7902 [1] => FORD [2] => ANALYST [3] => 7566 [4] => 03/DEC/81 [5] => 3000 [7] => 20 ) +<hr /> + Array ( [0] => 7934 [1] => MILLER [2] => CLERK [3] => 7782 [4] => 23/JAN/82 [5] => 1300 [7] => 10 ) +</div> +<p>We also have many higher level PHP libraries that allow you to simplify the above code. The most popular are <a href="http://pear.php.net/">PEAR DB</a> and <a href="http://adodb.sourceforge.net/">ADOdb</a>. Here are some of the differences between these libraries:</p> +<table width="75%" border="1" align="center"> + <tr> + <td><b>Feature</b></td> + <td><b>PEAR DB 1.6</b></td> + <td><b>ADOdb 4.52</b></td> + </tr> + <tr valign="top"> + <td>General Style</td> + <td>Simple, easy to use. Lacks Oracle specific functionality.</td> + <td>Has multi-tier design. Simple high-level design for beginners, and also lower-level advanced Oracle functionality.</td> + </tr> + <tr valign="top"> + <td>Support for Prepare</td> + <td>Yes, but only on one statement, as the last prepare overwrites previous prepares.</td> + <td>Yes (multiple simultaneous prepare's allowed)</td> + </tr> + <tr valign="top"> + <td>Support for LOBs</td> + <td>No</td> + <td>Yes, using update semantics</td> + </tr> + <tr valign="top"> + <td>Support for REF Cursors</td> + <td>No</td> + <td>Yes</td> + </tr> + <tr valign="top"> + <td>Support for IN Parameters</td> + <td>Yes</td> + <td>Yes</td> + </tr> + <tr valign="top"> + <td>Support for OUT Parameters</td> + <td>No</td> + <td>Yes</td> + </tr> + <tr valign="top"> + <td>Schema creation using XML</td> + <td>No</td> + <td>Yes, including ability to define tablespaces and constraints</td> + </tr> + <tr valign="top"> + <td>Provides database portability features</td> + <td>No</td> + <td>Yes, has some ability to abstract features that differ between databases such as dates, bind parameters, and data types.</td> + </tr> + <tr valign="top"> + <td>Performance monitoring and tracing</td> + <td>No</td> + <td>Yes. SQL can be traced and linked to web page it was executed on. Explain plan support included.</td> + </tr> + <tr valign="top"> + <td>Recordset caching for frequently used queries</td> + <td>No</td> + <td>Yes. Provides great speedups for SQL involving complex <i>where, group-by </i>and <i>order-by</i> clauses.</td> + </tr> + <tr valign="top"> + <td>Popularity</td> + <td>Yes, part of PEAR release</td> + <td>Yes, many open source projects are using this software, including PostNuke, Xaraya, Mambo, Tiki Wiki.</td> + </tr> + <tr valign="top"> + <td>Speed</td> + <td>Medium speed.</td> + <td>Very high speed. Fastest database abstraction library available for PHP. <a href="http://phplens.com/lens/adodb/">Benchmarks are available</a>.</td> + </tr> + <tr valign="top"> + <td>High Speed Extension available</td> + <td>No</td> + <td>Yes. You can install the optional ADOdb extension, which reimplements the most frequently used parts of ADOdb as fast C code. Note that the source code version of ADOdb runs just fine without this extension, and only makes use of the extension if detected.</td> + </tr> +</table> +<p> PEAR DB is good enough for simple web apps. But if you need more power, you can see ADOdb offers more sophisticated functionality. The rest of this article will concentrate on using ADOdb with Oracle. You can find out more about <a href="#connecting">connecting to Oracle</a> later in this guide.</p> +<h4>ADOdb Example</h4> +<p>In ADOdb, the above oci8 example querying the <i>emp</i> table could be written as:</p> +<pre> +include "/path/to/adodb.inc.php"; +$db = NewADOConnection("oci8"); +$db->Connect($tnsName, "scott", "tiger"); + +$rs = $db->Execute("select * from emp where empno>:emp order by empno", + array('emp' => 7900)); +while ($arr = $rs->FetchRow()) { + print_r($arr); + echo "<hr>"; +} +</pre> +<p>The Execute( ) function returns a recordset object, and you can retrieve the rows returned using $recordset->FetchRow( ). </p> +<p>If we ignore the initial connection preamble, we can see the ADOdb version is much easier and simpler:</p> +<table width="100%" border="1"> + <tr valign="top" bgcolor="#FFFFFF"> + <td width="50%" bgcolor="#e0e0e0"><b>Oci8</b></td> + <td bgcolor="#e0e0e0"><b>ADOdb</b></td> + </tr> + <tr valign="top" bgcolor="#CCCCCC"> + <td><pre><font size="1">$stmt = <b>OCIParse</b>($conn, + "select * from emp where empno > :emp"); +$emp = 7900; +<b>OCIBindByName</b>($stmt, ':emp', $emp); +$ok = <b>OCIExecute</b>($stmt); + +while (<b>OCIFetchInto</b>($stmt,$arr)) { + print_r($arr); + echo "<hr>"; +} </font></pre></td> + <td><pre><font size="1">$recordset = $db-><b>Execute</b>("select * from emp where empno>:emp", + array('emp' => 7900)); + +while ($arr = $recordset-><b>FetchRow</b>()) { + print_r($arr); + echo "<hr>"; +}</font></pre></td> + </tr> +</table> +<p> </p> +<h3>2. ADOdb Query Semantics</h3> +<p>You can also query the database using the standard Microsoft ADO MoveNext( ) metaphor. The data array for the current row is stored in the <i>fields</i> property of the recordset object, $rs. +MoveNext( ) offers the highest performance among all the techniques for iterating through a recordset: +<pre> +$rs = $db->Execute("select * from emp where empno>:emp", array('emp' => 7900)); +while (!$rs->EOF) { + print_r($rs->fields); + $rs->MoveNext(); +} +</pre> +<p>And if you are interested in having the data returned in a 2-dimensional array, you can use: +<pre> +$arr = $db->GetArray("select * from emp where empno>:emp", array('emp' => 7900)); +</pre> +<p>Now to obtain only the first row as an array: +<pre> +$arr = $db->GetRow("select * from emp where empno=:emp", array('emp' => 7900)); +</pre> +<p>Or to retrieve only the first field of the first row: +<pre> +$arr = $db->GetOne("select ename from emp where empno=:emp", array('emp' => 7900)); +</pre> +<p>For easy pagination support, we provide the SelectLimit function. The following will perform a select query, limiting it to 100 rows, starting from row 200: +<pre> +$offset = 200; $limitrows = 100; +$rs = $db->SelectLimit('select * from table', $offset, $limitrows); +</pre> +<p>The $limitrows parameter is optional. +<h4>Array Fetch Mode</h4> +<p>When data is being returned in an array, you can choose the type of array the data is returned in. +<ol> + <li> Numeric indexes - use <font size="2" face="Courier New, Courier, mono">$connection->SetFetchMode(ADODB_FETCH_NUM).</font></li> + <li>Associative indexes - the keys of the array are the names of the fields (in upper-case). Use <font size="2" face="Courier New, Courier, mono">$connection->SetFetchMode(ADODB_FETCH_ASSOC)</font><font face="Courier New, Courier, mono">.</font></li> + <li>Both numeric and associative indexes - use <font size="2" face="Courier New, Courier, mono">$connection->SetFetchMode(ADODB_FETCH_BOTH).</font></li> +</ol> +<p>The default is ADODB_FETCH_BOTH for Oracle.</p> +<h4><b>Caching</b></h4> +<p>You can define a database cache directory using $ADODB_CACHE_DIR, and cache the results of frequently used queries that rarely change. This is particularly useful for SQL with complex where clauses and group-by's and order-by's. It is also good for relieving heavily-loaded database servers.</p> +<p>This example will cache the following select statement for 3600 seconds (1 hour):</p> +<pre> +$ADODB_CACHE_DIR = '/var/adodb/tmp'; +$rs = $db->CacheExecute(3600, "select names from allcountries order by 1"); +</pre> +There are analogous CacheGetArray( +), CacheGetRow( ), CacheGetOne( ) and CacheSelectLimit( ) functions. The first parameter is the number of seconds to cache. You can also pass a bind array as a 3rd parameter (not shown above). +<p>There is an alternative syntax for the caching functions. The first parameter is omitted, and you set the cacheSecs + property of the connection object: +<pre> +$ADODB_CACHE_DIR = '/var/adodb/tmp'; +$connection->cacheSecs = 3600; +$rs = $connection->CacheExecute($sql, array('id' => 1)); +</pre> +<h3> </h3> +<h3>3. Using Prepare( ) For Frequently Used Statements</h3> +<p>Prepare( ) is for compiling frequently used SQL statement for reuse. For example, suppose we have a large array which needs to be inserted into an Oracle database. The following will result in a massive speedup in query execution (at least 20-40%), as the SQL statement only needs to be compiled once:</p> +<pre> +$stmt = $db->Prepare('insert into table (field1, field2) values (:f1, :f2)'); +foreach ($arrayToInsert as $key => $value) { + $db->Execute($stmt, array('f1' => $key, 'f2' => $val); +} +</pre> +<p> </p> +<h3>4. Working With LOBs</h3> +<p>Oracle treats data which is more than 4000 bytes in length specially. These are called Large Objects, or LOBs for short. Binary LOBs are BLOBs, and character LOBs are CLOBs. In most Oracle libraries, you need to do a lot of work to process LOBs, probably because Oracle designed it to work in systems with little memory. ADOdb tries to make things easy by assuming the LOB can fit into main memory. </p> +<p>ADOdb will transparently handle LOBs in <i>select</i> statements. The LOBs are automatically converted to PHP variables without any special coding.</p> +<p>For updating records with LOBs, the functions UpdateBlob( ) and UpdateClob( ) are provided. Here's a BLOB example. The parameters should be self-explanatory: +<pre> +$ok = $db->Execute("insert into aTable (id, name, ablob) + values (aSequence.nextVal, 'Name', null)"); +if (!$ok) return LogError($db->ErrorMsg()); +<font color="#006600"># params: $tableName, $blobFieldName, $blobValue, $whereClause</font> +$db->UpdateBlob('aTable', 'ablob', $blobValue, 'id=aSequence.currVal'); +</pre> +<p>and the analogous CLOB example: +<pre> +$ok = $db->Execute("insert into aTable (id, name, aclob) + values (aSequence.nextVal, 'Name', null)"); +if (!$ok) return LogError($db->ErrorMsg()); +$db->UpdateClob('aTable', 'aclob', $clobValue, 'id=aSequence.currVal'); +</pre> +<p>Note that LogError( ) is a user-defined function, and not part of ADOdb. +<p>Inserting LOBs is more complicated. Since ADOdb 4.55, we allow you to do this + (assuming that the <em>photo</em> field is a BLOB, and we want to store $blob_data into + this field, and the primary key is the <em>id</em> field): +<pre> + $sql = <span class="style1">"INSERT INTO photos ( ID, photo) ". + "VALUES ( :id, empty_blob() )". + " RETURNING photo INTO :xx"</span>; + + $stmt = $db->PrepareSP($sql); + $db->InParameter($stmt, $<strong>id</strong>, <span class="style1">'id'</span>); + $blob = $db->InParameter($stmt, $<strong>blob_data</strong>, <span class="style1">'xx'</span>,-1, OCI_B_BLOB); + $db->StartTrans(); + $ok = $db->Execute($stmt); + $db->CompleteTrans(); +</pre> +<p> +<h3>5. REF CURSORs</h3> +<p>Oracle recordsets can be passed around as variables called REF Cursors. For example, in PL/SQL, we could define a function <i>open_tab</i> that returns a REF CURSOR in the first parameter:</p> +<pre> +TYPE TabType IS REF CURSOR RETURN TAB%ROWTYPE; + +PROCEDURE open_tab (tabcursor IN OUT TabType,tablenames IN VARCHAR) IS + BEGIN + OPEN tabcursor FOR SELECT * FROM TAB WHERE tname LIKE tablenames; + END open_tab; +</pre> +<p>In ADOdb, we could access this REF Cursor using the ExecuteCursor() function. The following will find + all table names that begin with 'A' in the current schema: +<pre> +$rs = $db->ExecuteCursor("BEGIN open_tab(:refc,'A%'); END;",'refc'); +while ($arr = $rs->FetchRow()) print_r($arr); +</pre> +<p>The first parameter is the PL/SQL statement, and the second parameter is the name of the REF Cursor. +</p> +<p> </p> +<h3>6. In and Out Parameters</h3> +<p>The following PL/SQL +stored procedure requires an input variable, and returns a result into an output variable: +<pre> +PROCEDURE data_out(input IN VARCHAR, output OUT VARCHAR) IS + BEGIN + output := 'I love '||input; + END; +</pre> +<p>The following ADOdb code allows you to call the stored procedure:</p> +<pre> +$stmt = $db->PrepareSP("BEGIN adodb.data_out(:a1, :a2); END;"); +$input = 'Sophia Loren'; +$db->InParameter($stmt,$input,'a1'); +$db->OutParameter($stmt,$output,'a2'); +$ok = $db->Execute($stmt); +if ($ok) echo ($output == 'I love Sophia Loren') ? 'OK' : 'Failed'; +</pre> +<p>PrepareSP( ) is a special function that knows about bind parameters. +The main limitation currently is that IN OUT parameters do not work. +<h4>Bind Parameters and REF CURSORs</h4> +<p>We could also rewrite the REF CURSOR example to use InParameter (requires ADOdb 4.53 or later): +<pre> +$stmt = $db->PrepareSP("BEGIN adodb.open_tab(:refc,:tabname); END;"); +$input = 'A%'; +$db->InParameter($stmt,$input,'tabname'); +$rs = $db->ExecuteCursor($stmt,'refc'); +while ($arr = $rs->FetchRow()) print_r($arr); +</pre> +<h4>Bind Parameters and LOBs</h4> +<p>You can also operate on LOBs. In this example, we have IN and OUT parameters using CLOBs. +<pre> + $text = 'test test test'; + $sql = "declare rs clob; begin :rs := lobinout(:sa0); end;"; + $stmt = $conn -> PrepareSP($sql); + $conn -> InParameter($stmt,$text,'sa0', -1, OCI_B_CLOB); # -1 means variable length + $rs = ''; + $conn -> OutParameter($stmt,$rs,'rs', -1, OCI_B_CLOB); + $conn -> Execute($stmt); + echo "return = ".$rs."<br>"; +</pre> +<p>Similarly, you can use the constant OCI_B_BLOB to indicate that you are using BLOBs. +<h4>Reusing Bind Parameters with CURSOR_SHARING=FORCE</h4> +<p>Many web programmers do not care to use bind parameters, and prefer to enter the SQL directly. So instead of:</p> +<pre> +$arr = $db->GetArray("select * from emp where empno>:emp", array('emp' => 7900)); +</pre> +<p>They prefer entering the values inside the SQL: +<pre> +$arr = $db->GetArray("select * from emp where empno>7900"); +</pre> +<p>This reduces Oracle performance because Oracle will reuse compiled SQL which is identical to previously compiled SQL. The above example with the values inside the SQL +is unlikely to be reused. As an optimization, from Oracle 8.1 onwards, you can set the following session parameter after you login: +<pre> +ALTER SESSION SET CURSOR_SHARING=FORCE +</pre> +<p>This will force Oracle to convert all such variables (eg. the 7900 value) into constant bind parameters, improving SQL reuse.</p> +<p>More <a href="http://phplens.com/adodb/code.initialization.html#speed">speedup tips</a>.</p> +<p> </p> +<h3>7. Dates and Datetime in ADOdb</h3> +<p>There are two things you need to know about dates in ADOdb. </p> +<p>First, to ensure cross-database compability, ADOdb assumes that dates are returned in ISO format (YYYY-MM-DD H24:MI:SS).</p> +<p>Secondly, since Oracle treats dates and datetime as the same data type, we decided not to display the time in the default date format. So on login, ADOdb will set the NLS_DATE_FORMAT to 'YYYY-MM-DD'. If you prefer to show the date and time by default, do this:</p> +<pre> +$db = NewADOConnection('oci8'); +$db->NLS_DATE_FORMAT = 'RRRR-MM-DD HH24:MI:SS'; +$db->Connect($tns, $user, $pwd); +</pre> +<p>Or execute:</p> +<pre>$sql = "ALTER SESSION SET NLS_DATE_FORMAT = 'RRRR-MM-DD HH24:MI:SS'"; +$db->Execute($sql); +</pre> +<p>If you are not concerned about date portability and do not use ADOdb's portability layer, you can use your preferred date format instead. +<p> +<h3>8. Database Portability Layer</h3> +<p>ADOdb provides the following functions for portably generating SQL functions + as strings to be merged into your SQL statements:</p> +<table width="75%" border="1" align=center> + <tr> + <td width=30%><b>Function</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td>DBDate($date)</td> + <td>Pass in a UNIX timestamp or ISO date and it will convert it to a date + string formatted for INSERT/UPDATE</td> + </tr> + <tr> + <td>DBTimeStamp($date)</td> + <td>Pass in a UNIX timestamp or ISO date and it will convert it to a timestamp + string formatted for INSERT/UPDATE</td> + </tr> + <tr> + <td>SQLDate($date, $fmt)</td> + <td>Portably generate a date formatted using $fmt mask, for use in SELECT + statements.</td> + </tr> + <tr> + <td>OffsetDate($date, $ndays)</td> + <td>Portably generate a $date offset by $ndays.</td> + </tr> + <tr> + <td>Concat($s1, $s2, ...)</td> + <td>Portably concatenate strings. Alternatively, for mssql use mssqlpo driver, + which allows || operator.</td> + </tr> + <tr> + <td>IfNull($fld, $replaceNull)</td> + <td>Returns a string that is the equivalent of MySQL IFNULL or Oracle NVL.</td> + </tr> + <tr> + <td>Param($name)</td> + <td>Generates bind placeholders, using ? or named conventions as appropriate.</td> + </tr> + <tr><td>$db->sysDate</td><td>Property that holds the SQL function that returns today's date</td> +</tr> +<tr><td>$db->sysTimeStamp</td><td>Property that holds the SQL function that returns the current +timestamp (date+time). +</td> +</tr> +<tr> +<td>$db->concat_operator</td><td>Property that holds the concatenation operator +</td> +</tr> +<tr><td>$db->length</td><td>Property that holds the name of the SQL strlen function. +</td></tr> + +<tr><td>$db->upperCase</td><td>Property that holds the name of the SQL strtoupper function. +</td></tr> +<tr><td>$db->random</td><td>Property that holds the SQL to generate a random number between 0.00 and 1.00. +</td> +</tr> +<tr><td>$db->substr</td><td>Property that holds the name of the SQL substring function. +</td></tr> +</table> +<p>ADOdb also provides multiple oracle oci8 drivers for different scenarios:</p> +<table width="75%" border="1" align="center"> + <tr> + <td nowrap><b>Driver Name</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td>oci805 </td> + <td>Specifically for Oracle 8.0.5. This driver has a slower SelectLimit( ).</td> + </tr> + <tr> + <td>oci8</td> + <td>The default high performance driver. The keys of associative arrays returned in a recordset are upper-case.</td> + </tr> + <tr> + <td>oci8po</td> + <td> The portable Oracle driver. Slightly slower than oci8. This driver uses ? instead of :<i>bindvar</i> for binding variables, which is the standard for other databases. Also the keys of associative arrays are in lower-case like other databases.</td> + </tr> +</table> +<p>Here's an example of calling the <i>oci8po</i> driver. Note that the bind variables use question-mark:</p> +<pre>$db = NewADOConnection('oci8po'); +$db->Connect($tns, $user, $pwd); +$db->Execute("insert into atable (f1, f2) values (?,?)", array(12, 'abc'));</pre> +<p> <a name=connecting></a> +<h3>9. Connecting to Oracle</h3> +<p>Before you can use ADOdb, you need to have the Oracle client installed and setup the oci8 extension. This extension comes pre-compiled for Windows (but you still need to enable it in the php.ini file). For information on compiling the oci8 extension for PHP and Apache on Unix, there is an excellent guide at <a href="http://www.oracle.com/technology/tech/opensource/php/apache/inst_php_apache_linux.html">oracle.com</a>. </p> +<h4>Should You Use Persistent Connections</h4> +<p>One question that is frequently asked is should you use persistent connections to Oracle. Persistent connections allow PHP to recycle existing connections, reusing them after the previous web pages have completed. Non-persistent connections close automatically after the web page has completed. Persistent connections are faster because the cost of reconnecting is expensive, but there is additional resource overhead. As an alternative, Oracle allows you to pool and reuse server processes; this is called <a href="http://www.cise.ufl.edu/help/database/oracle-docs/server.920/a96521/manproc.htm#13132">Shared Server</a> (also known as MTS).</p> +<p>The author's benchmarks suggest that using non-persistent connections and the Shared Server configuration offer the best performance. If Shared Server is not an option, only then consider using persistent connections.</p> +<h4>Connection Examples</h4> +<p>Just in case you are having problems connecting to Oracle, here are some examples:</p> +<p>a. PHP and Oracle reside on the same machine, use default SID, with non-persistent connections:</p> +<pre> $conn = NewADOConnection('oci8'); + $conn->Connect(false, 'scott', 'tiger');</pre> +<p>b. TNS Name defined in tnsnames.ora (or ONAMES or HOSTNAMES), eg. 'myTNS', using persistent connections:</p> +<pre> $conn = NewADOConnection('oci8'); + $conn->PConnect(false, 'scott', 'tiger', 'myTNS');</pre> +<p>or</p> +<pre> $conn->PConnect('myTNS', 'scott', 'tiger');</pre> +<p>c. Host Address and SID</p> +<pre> + $conn->connectSID = true; + $conn->Connect('192.168.0.1', 'scott', 'tiger', 'SID');</pre> +<p>d. Host Address and Service Name</p> +<pre> $conn->Connect('192.168.0.1', 'scott', 'tiger', 'servicename');</pre> +<p>e. Oracle connection string: +<pre> $cstr = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=$host)(PORT=$port)) + (CONNECT_DATA=(SID=$sid)))"; + $conn->Connect($cstr, 'scott', 'tiger'); +</pre> +<p>f. ADOdb data source names (dsn): +<pre> + $dsn = 'oci8://user:pwd@tnsname/?persist'; # persist is optional + $conn = ADONewConnection($dsn); # no need for Connect/PConnect + + $dsn = 'oci8://user:pwd@host/sid'; + $conn = ADONewConnection($dsn); + + $dsn = 'oci8://user:pwd@/'; # oracle on local machine + $conn = ADONewConnection($dsn);</pre> +<p>With ADOdb data source names, +you don't have to call Connect( ) or PConnect( ). +</p> +<p> </p> +<h3>10. Error Checking</h3> +<p>The examples in this article are easy to read but a bit simplistic because we ignore error-handling. Execute( ) and Connect( ) will return false on error. So a more realistic way to call Connect( ) and Execute( ) is: +<pre>function InvokeErrorHandler() +{<br>global $db; ## assume global + MyLogFunction($db->ErrorNo(), $db->ErrorMsg()); +} +if (!$db->Connect($tns, $usr, $pwd)) InvokeErrorHandler(); + +$rs = $db->Execute("select * from emp where empno>:emp order by empno", + array('emp' => 7900)); +if (!$rs) return InvokeErrorHandler(); +while ($arr = $rs->FetchRow()) { + print_r($arr); + echo "<hr>"; +} +</pre> +<p>You can retrieve the error message and error number of the last SQL statement executed from ErrorMsg( ) and ErrorNo( ). You can also <a href=http://phplens.com/adodb/using.custom.error.handlers.and.pear_error.html>define a custom error handler function</a>. +ADOdb also supports throwing exceptions in PHP5. +<p> </p> +<h3>Handling Large Recordsets (added 27 May 2005)</h3> +The oci8 driver does not support counting the number of records returned in a SELECT statement, so the function RecordCount() +is emulated when the global variable $ADODB_COUNTRECS is set to true, which is the default. +We emulate this by buffering all the records. This can take up large amounts of memory for big recordsets. + Set $ADODB_COUNTRECS to false for the best performance. + <p> +This variable is checked every time a query is executed, so you can selectively choose which recordsets to count. +<p> </p> +<h3>11. Other ADOdb Features</h3> +<p><a href="http://phplens.com/lens/adodb/docs-datadict.htm">Schema generation</a>. This allows you to define a schema using XML and import it into different RDBMS systems portably.</p> +<p><a href="http://phplens.com/lens/adodb/docs-perf.htm">Performance monitoring and tracing</a>. Highlights of performance monitoring include identification of poor and suspicious SQL, with explain plan support, and identifying which web pages the SQL ran on.</p> +<p> </p> +<h3>12. Download</h3> +<p>You can <a href="http://adodb.sourceforge.net/#download">download ADOdb from sourceforge</a>. ADOdb uses a BSD style license. That means that it is free for commercial use, and redistribution without source code is allowed.</p> +<p> </p> +<h3>13. Resources</h3> +<ul> + <li>Oracle's <a href="http://www.oracle.com/technology/pub/articles/php_experts/index.html">Hitchhiker Guide to PHP</a></li> + <li>OTN article on <a href=http://www.oracle.com/technology/pub/articles/deployphp/lim_deployphp.html>Optimizing PHP and Oracle</a> by this author. + <li>Oracle has an excellent <a href="http://www.oracle.com/technology/tech/opensource/php/php_troubleshooting_faq.html">FAQ on PHP</a></li> + <li>PHP <a href="http://php.net/oci8">oci8</a> manual pages</li> + <li><a href=http://phplens.com/lens/lensforum/topics.php?id=4>ADOdb forums</a>. +</ul> +</body> +</html> diff --git a/framework/3rdParty/adodb/docs/old-changelog.htm b/framework/3rdParty/adodb/docs/old-changelog.htm new file mode 100644 index 00000000..bf8a1af2 --- /dev/null +++ b/framework/3rdParty/adodb/docs/old-changelog.htm @@ -0,0 +1,822 @@ +<html><title>Old Changelog: ADOdb</title><body>
+<h3>Old Changelog</h3>
+
+</p><p><b>3.92 22 Sept 2003</b>
+</p><p>Added GetAssoc and CacheGetAssoc to connection object.
+</p><p>Removed TextMax and CharMax functions from adodb.inc.php.
+</p><p>HasFailedTrans() returned false when trans failed. Fixed.
+</p><p>Moved perf driver classes into adodb/perf/*.php.
+</p><p>Misc improvements to performance monitoring, including UI().
+</p><p>RETVAL in mssql Parameter(), we do not append @ now.
+</p><p>Added Param($name) to connection class, returns '?' or ":$name", for defining
+ bind parameters portably.
+</p><p>LogSQL traps affected_rows() and saves its value properly now. Also fixed oci8
+ _stmt and _affectedrows() bugs.
+</p><p>Session code timestamp check for oci8 works now. Formerly default NLS_DATE_FORMAT
+ stripped off time portion. Thx to Tony Blair (tonanbarbarian#hotmail.com). Also
+ added new $conn->datetime field to oci8, controls whether MetaType() returns
+ 'D' ($this->datetime==false) or 'T' ($this->datetime == true) for DATE type.
+</p><p>Fixed bugs in adodb-cryptsession.inc.php and adodb-session-clob.inc.php.
+</p><p>Fixed misc bugs in adodb_key_exists, GetInsertSQL() and GetUpdateSQL().
+</p><p>Tuned include_once handling to reduce file-system checking overhead.
+</p><p><b>3.91 9 Sept 2003</b>
+</p><p>Only released to InterAkt
+</p><p>Added LogSQL() for sql logging and $ADODB_NEWCONNECTION to override factory
+ for driver instantiation.
+</p><p>Added IfNull($field,$ifNull) function, thx to johnwilk#juno.com
+</p><p>Added portable substr support.
+</p><p>Now rs2html() has new parameter, $echo. Set to false to return $html instead
+ of echoing it.
+</p><p><b>3.90 5 Sept 2003</b>
+</p><p>First beta of performance monitoring released.
+</p><p>MySQL supports MetaTable() masking.
+</p><p>Fixed key_exists() bug in adodb-lib.inc.php
+</p><p>Added sp_executesql Prepare() support to mssql.
+</p><p>Added bind support to db2.
+</p><p>Added swedish language file - Christian Tiberg" christian#commsoft.nu
+</p><p>Bug in drop index for mssql data dict fixed. Thx to Gert-Rainer Bitterlich.
+</p><p>Left join setting for oci8 was wrong. Thx to johnwilk#juno.com
+</p><p><b>3.80 27 Aug 2003</b>
+</p><p>Patch for PHP 4.3.3 cached recordset csv2rs() fread loop incompatibility.
+</p><p>Added matching mask for MetaTables. Only for oci8, mssql and postgres currently.
+</p><p>Rewrite of "oracle" driver connection code, merging with "oci8", by Gaetano.
+</p><p>Added better debugging for Smart Transactions.
+</p><p>Postgres DBTimeStamp() was wrongly using TO_DATE. Changed to TO_TIMESTAMP.
+</p><p>ADODB_FETCH_CASE check pushed to ADONewConnection to allow people to define
+ it after including adodb.inc.php.
+</p><p>Added portugese (brazilian) to languages. Thx to "Levi Fukumori".
+</p><p>Removed arg3 parameter from Execute/SelectLimit/Cache* functions.
+</p><p>Execute() now accepts 2-d array as $inputarray. Also changed docs of fnExecute()
+ to note change in sql query counting with 2-d arrays.
+</p><p>Added MONEY to MetaType in PostgreSQL.
+</p><p>Added more debugging output to CacheFlush().
+</p><p><b>3.72 9 Aug 2003</b>
+</p><p>Added qmagic($str), which is a qstr($str) that auto-checks for magic quotes
+ and does the right thing...
+</p><p>Fixed CacheFlush() bug - Thx to martin#gmx.de
+</p><p>Walt Boring contributed MetaForeignKeys for postgres7.
+</p><p>_fetch() called _BlobDecode() wrongly in interbase. Fixed.
+</p><p>adodb_time bug fixed with dates after 2038 fixed by Jason Pell. http://phplens.com/lens/lensforum/msgs.php?id=6980
+</p><p><b>3.71 4 Aug 2003</b>
+</p><p>The oci8 driver, MetaPrimaryKeys() did not check the owner correctly when $owner
+ == false.
+</p><p>Russian language file contributed by "Cyrill Malevanov" cyrill#malevanov.spb.ru.
+</p><p>Spanish language file contributed by "Horacio Degiorgi" horaciod#codigophp.com.
+</p><p>Error handling in oci8 bugfix - if there was an error in Execute(), then when
+ calling ErrorNo() and/or ErrorMsg(), the 1st call would return the error, but
+ the 2nd call would return no error.
+</p><p>Error handling in odbc bugfix. ODBC would always return the last error, even
+ if it happened 5 queries ago. Now we reset the errormsg to '' and errorno to
+ 0 everytime before CacheExecute() and Execute().
+</p><p><b>3.70 29 July 2003</b>
+</p><p>Added new SQLite driver. Tested on PHP 4.3 and PHP 5.
+</p><p>Added limited "sapdb" driver support - mainly date support.
+</p><p>The oci8 driver did not identify NUMBER with no defined precision correctly.
+</p><p>Added ADODB_FORCE_NULLS, if set, then PHP nulls are converted to SQL nulls
+ in GetInsertSQL/GetUpdateSQL.
+</p><p>DBDate() and DBTimeStamp() format for postgresql had problems. Fixed.
+</p><p>Added tableoptions to ChangeTableSQL(). Thx to Mike Benoit.
+</p><p>Added charset support to postgresql. Thx to Julian Tarkhanov.
+</p><p>Changed OS check for MS-Windows to prevent confusion with darWIN (MacOS)
+</p><p>Timestamp format for db2 was wrong. Changed to yyyy-mm-dd-hh.mm.ss.nnnnnn.
+</p><p>adodb-cryptsession.php includes wrong. Fixed.
+</p><p>Added MetaForeignKeys(). Supported by mssql, odbc_mssql and oci8.
+</p><p>Fixed some oci8 MetaColumns/MetaPrimaryKeys bugs. Thx to Walt Boring.
+</p><p>adodb_getcount() did not init qryRecs to 0. Missing "WHERE" clause checking
+ in GetUpdateSQL fixed. Thx to Sebastiaan van Stijn.
+</p><p>Added support for only 'VIEWS' and "TABLES" in MetaTables. From Walt Boring.
+</p><p>Upgraded to adodb-xmlschema.inc.php 0.0.2.
+</p><p>NConnect for mysql now returns value. Thx to Dennis Verspuij.
+</p><p>ADODB_FETCH_BOTH support added to interbase/firebird.
+</p><p>Czech language file contributed by Kamil Jakubovic jake#host.sk.
+</p><p>PostgreSQL BlobDecode did not use _connectionID properly. Thx to Juraj Chlebec.
+</p><p>Added some new initialization stuff for Informix. Thx to "Andrea Pinnisi" pinnisi#sysnet.it
+</p><p>ADODB_ASSOC_CASE constant wrong in sybase _fetch(). Fixed.
+</p><p><b>3.60 16 June 2003</b>
+</p><p>We now SET CONCAT_NULL_YIELDS_NULL OFF for odbc_mssql driver to be compat with
+ mssql driver.
+</p><p>The property $emptyDate missing from connection class. Also changed 1903 to
+ constant (TIMESTAMP_FIRST_YEAR=100). Thx to Sebastiaan van Stijn.
+</p><p>ADOdb speedup optimization - we now return all arrays by reference.
+</p><p>Now DBDate() and DBTimeStamp() now accepts the string 'null' as a parameter.
+ Suggested by vincent.
+</p><p>Added GetArray() to connection class.
+</p><p>Added not_null check in informix metacolumns().
+</p><p>Connection parameters for postgresql did not work correctly when port was defined.
+</p><p>DB2 is now a tested driver, making adodb 100% compatible. Extensive changes
+ to odbc driver for DB2, including implementing serverinfo() and SQLDate(), switching
+ to SQL_CUR_USE_ODBC as the cursor mode, and lastAffectedRows and SelectLimit()
+ fixes.
+</p><p>The odbc driver's FetchField() field names did not obey ADODB_ASSOC_CASE. Fixed.
+</p><p>Some bugs in adodb_backtrace() fixed.
+</p><p>Added "INT IDENTITY" type to adorecordset::MetaType() to support odbc_mssql
+ properly.
+</p><p>MetaColumns() for oci8, mssql, odbc revised to support scale. Also minor revisions
+ to odbc MetaColumns() for vfp and db2 compat.
+</p><p>Added unsigned support to mysql datadict class. Thx to iamsure.
+</p><p>Infinite loop in mssql MoveNext() fixed when ADODB_FETCH_ASSOC used. Thx to
+ Josh R, Night_Wulfe#hotmail.com.
+</p><p>ChangeTableSQL contributed by Florian Buzin.
+</p><p>The odbc_mssql driver now sets CONCAT_NULL_YIELDS_NULL OFF for compat with
+ mssql driver.
+</p>
+
+<p><b>3.50 19 May 2003</b></p>
+<p>Fixed mssql compat with FreeTDS. FreeTDS does not implement mssql_fetch_assoc().
+<p>Merged back connection and recordset code into adodb.inc.php.
+<p>ADOdb sessions using oracle clobs contributed by achim.gosse#ddd.de. See adodb-session-clob.php.
+<p>Added /s modifier to preg_match everywhere, which ensures that regex does not
+ stop at /n. Thx Pao-Hsi Huang.
+<p>Fixed error in metacolumns() for mssql.
+<p>Added time format support for SQLDate.
+<p>Image => B added to metatype.
+<p>MetaType now checks empty($this->blobSize) instead of empty($this).
+<p>Datadict has beta support for informix, sybase (mapped to mssql), db2 and generic
+ (which is a fudge).
+<p>BlobEncode for postgresql uses pg_escape_bytea, if available. Needed for compat
+ with 7.3.
+<p>Added $ADODB_LANG, to support multiple languages in MetaErrorMsg().
+<p>Datadict can now parse table definition as declarative text.
+<p>For DataDict, oci8 autoincrement trigger missing semi-colon. Fixed.
+<p>For DataDict, when REPLACE flag enabled, drop sequence in datadict for autoincrement
+ field in postgres and oci8.s
+<p>Postgresql defaults to template1 database if no database defined in connect/pconnect.
+<p>We now clear _resultid in postgresql if query fails.
+<p><b>3.40 19 May 2003</b></p>
+<p>Added insert_id for odbc_mssql.
+<p>Modified postgresql UpdateBlobFile() because it did not work in safe mode.
+<p>Now connection object is passed to raiseErrorFn as last parameter. Needed by
+ StartTrans().
+<p>Added StartTrans() and CompleteTrans(). It is recommended that you do not modify
+ transOff, but use the above functions.
+<p>oci8po now obeys ADODB_ASSOC_CASE settings.
+<p>Added virtualized error codes, using PEAR DB equivalents. Requires you to manually
+ include adodb-error.inc.php yourself, with MetaError() and MetaErrorMsg($errno).
+<p>GetRowAssoc for mysql and pgsql were flawed. Fix by Ross Smith.
+<p>Added to datadict types I1, I2, I4 and I8. Changed datadict type 'T' to map
+ to timestamp instead of datetime for postgresql.
+<p>Error handling in ExecuteSQLArray(), adodb-datadict.inc.php did not work.
+<p>We now auto-quote postgresql connection parameters when building connection
+ string.
+<p>Added session expiry notification.
+<p>We now test with odbc mysql - made some changes to odbc recordset constructor.
+<p>MetaColumns now special cases access and other databases for odbc.
+<p><b>3.31 17 March 2003</b></p>
+<p>Added row checking for _fetch in postgres.
+<p>Added Interval type to MetaType for postgres.
+<p>Remapped postgres driver to call postgres7 driver internally.
+<p>Adorecordset_array::getarray() did not return array when nRows >= 0.
+<p>Postgresql: at times, no error message returned by pg_result_error() but error
+ message returned in pg_last_error(). Recoded again.
+<p>Interbase blob's now use chunking for updateblob.
+<p>Move() did not set EOF correctly. Reported by Jorma T.
+<p>We properly support mysql timestamp fields when we are creating mysql tables
+ using the data-dict interface.
+<p>Table regex includes backticks character now.
+<p><b>3.30 3 March 2003</b></p>
+<p>Added $ADODB_EXTENSION and $ADODB_COMPAT_FETCH constant.
+<p>Made blank1stItem configurable using syntax "value:text" in GetMenu/GetMenu2.
+ Thx to Gabriel Birke.
+<p>Previously ADOdb differed from the Microsoft standard because it did not define
+ what to set $this->fields when EOF was reached. Now at EOF, ADOdb sets $this->fields
+ to false for all databases, which is consist with Microsoft's implementation.
+ Postgresql and mysql have always worked this way (in 3.11 and earlier). If you
+ are experiencing compatibility problems (and you are not using postgresql nor
+ mysql) on upgrading to 3.30, try setting the global variables $ADODB_COUNTRECS
+ = true (which is the default) and $ADODB_FETCH_COMPAT = true (this is a new
+ global variable).
+<p>We now check both pg_result_error and pg_last_error as sometimes pg_result_error
+ does not display anything. Iman Mayes
+<p> We no longer check for magic quotes gpc in Quote().
+<p> Misc fixes for table creation in adodb-datadict.inc.php. Thx to iamsure.
+<p> Time calculations use adodb_time library for all negative timestamps due to
+ problems in Red Hat 7.3 or later. Formerly, only did this for Windows.
+<p> In mssqlpo, we now check if $sql in _query is a string before we change ||
+ to +. This is to support prepared stmts.
+<p> Move() and MoveLast() internals changed to support to support EOF and $this->fields
+ change.
+<p> Added ADODB_FETCH_BOTH support to mssql. Thx to Angel Fradejas afradejas#mediafusion.es
+<p> We now check if link resource exists before we run mysql_escape_string in
+ qstr().
+<p> Before we flock in csv code, we check that it is not a http url.
+<p><b>3.20 17 Feb 2003</b></p>
+<p>Added new Data Dictionary classes for creating tables and indexes. Warning
+ - this is very much alpha quality code. The API can still change. See adodb/tests/test-datadict.php
+ for more info.
+<p>We now ignore $ADODB_COUNTRECS for mysql, because PHP truncates incomplete
+ recordsets when mysql_unbuffered_query() is called a second time.
+<p>Now postgresql works correctly when $ADODB_COUNTRECS = false.
+<p>Changed _adodb_getcount to properly support SELECT DISTINCT.
+<p>Discovered that $ADODB_COUNTRECS=true has some problems with prepared queries
+ - suspect PHP bug.
+<p>Now GetOne and GetRow run in $ADODB_COUNTRECS=false mode for better performance.
+<p>Added support for mysql_real_escape_string() and pg_escape_string() in qstr().
+<p>Added an intermediate variable for mysql _fetch() and MoveNext() to store fields,
+ to prevent overwriting field array with boolean when mysql_fetch_array() returns
+ false.
+<p>Made arrays for getinsertsql and getupdatesql case-insensitive. Suggested by
+ Tim Uckun" tim#diligence.com
+<p><b>3.11 11 Feb 2003</b></p>
+<p>Added check for ADODB_NEVER_PERSIST constant in PConnect(). If defined, then
+ PConnect() will actually call non-persistent Connect().
+<p>Modified interbase to properly work with Prepare().
+<p>Added $this->ibase_timefmt to allow you to change the date and time format.
+<p>Added support for $input_array parameter in CacheFlush().
+<p>Added experimental support for dbx, which was then removed when i found that
+ it was slower than using native calls.
+<p>Added MetaPrimaryKeys for mssql and ibase/firebird.
+<p>Added new $trim parameter to GetCol and CacheGetCol
+<p>Uses updated adodb-time.inc.php 0.06.
+<p><b>3.10 27 Jan 2003</b>
+<p>Added adodb_date(), adodb_getdate(), adodb_mktime() and adodb-time.inc.php.
+<p>For interbase, added code to handle unlimited number of bind parameters. From
+ Daniel Hasan daniel#hasan.cl.
+<p>Added BlobDecode and UpdateBlob for informix. Thx to Fernando Ortiz.
+<p>Added constant ADODB_WINDOWS. If defined, means that running on Windows.
+<p>Added constant ADODB_PHPVER which stores php version as a hex num. Removed
+ $ADODB_PHPVER variable.
+<p>Felho Bacsi reported a minor white-space regular expression problem in GetInsertSQL.
+<p>Modified ADO to use variant to store _affectedRows
+<p>Changed ibase to use base class Replace(). Modified base class Replace() to
+ support ibase.
+<p>Changed odbc to auto-detect when 0 records returned is wrong due to bad odbc
+ drivers.
+<p>Changed mssql to use datetimeconvert ini setting only when 4.30 or later (does
+ not work in 4.23).
+<p>ExecuteCursor($stmt, $cursorname, $params) now accepts a new $params array
+ of additional bind parameters -- William Lovaton walovaton#yahoo.com.mx.
+<p>Added support for sybase_unbuffered_query if ADODB_COUNTRECS == false. Thx
+ to chuck may.
+<p>Fixed FetchNextObj() bug. Thx to Jorma Tuomainen.
+<p>We now use SCOPE_IDENTITY() instead of @@IDENTITY for mssql - thx to marchesini#eside.it
+<p>Changed postgresql movenext logic to prevent illegal row number from being
+ passed to pg_fetch_array().
+<p>Postgresql initrs bug found by "Bogdan RIPA" bripa#interakt.ro $f1 accidentally
+ named $f
+<p><b>3.00 6 Jan 2003</b>
+<p>Fixed adodb-pear.inc.php syntax error.
+<p>Improved _adodb_getcount() to use SELECT COUNT(*) FROM ($sql) for languages
+ that accept it.
+<p>Fixed _adodb_getcount() caching error.
+<p>Added sql to retrive table and column info for odbc_mssql.
+<p><strong>2.91 3 Jan 2003</strong>
+<p>Revised PHP version checking to use $ADODB_PHPVER with legal values 0x4000,
+ 0x4050, 0x4200, 0x4300.
+<p>Added support for bytea fields and oid blobs in postgres by allowing BlobDecode()
+ to detect and convert non-oid fields. Also added BlobEncode to postgres when
+ you want to encode oid blobs.
+<p>Added blobEncodeType property for connections to inform phpLens what encoding
+ method to use for blobs.
+<p>Added BlobDecode() and BlobEncode() to base ADOConnection class.
+<p>Added umask() to _gencachename() when creating directories.
+<p>Added charPage for ado drivers, so you can set the code page.
+<pre>
+$conn->charPage = CP_UTF8;
+$conn->Connect($dsn);
+</pre>
+<p>Modified _seek in mysql to check for num rows=0.
+<p>Added to metatypes new informix types for IDS 9.30. Thx Fernando Ortiz.
+<p>_maxrecordcount returned in CachePageExecute $rsreturn
+<p>Fixed sybase cacheselectlimit( ) problems
+<p>MetaColumns() max_length should use precision for types X and C for ms access.
+ Fixed.
+<p>Speedup of odbc non-SELECT sql statements.
+<p>Added support in MetaColumns for Wide Char types for ODBC. We halve max_length
+ if unicode/wide char.
+<p>Added 'B' to types handled by GetUpdateSQL/GetInsertSQL.
+<p>Fixed warning message in oci8 driver with $persist variable when using PConnect.
+<p><b>2.90 11 Dec 2002</b>
+<p>Mssql and mssqlpo and oci8po now support ADODB_ASSOC_CASE.
+<p>Now MetaType() can accept a field object as the first parameter.
+<p>New $arr = $db->ServerInfo( ) function. Returns $arr['description'] which
+ is the string description, and $arr['version'].
+<p>PostgreSQL and MSSQL speedups for insert/updates.
+<p> Implemented new SetFetchMode() that removes the need to use $ADODB_FETCH_MODE.
+ Each connection has independant fetchMode.
+<p>ADODB_ASSOC_CASE now defaults to 2, use native defaults. This is because we
+ would break backward compat for too many applications otherwise.
+<p>Patched encrypted sessions to use replace()
+<p>The qstr function supports quoting of nulls when escape character is \
+<p>Rewrote bits and pieces of session code to check for time synch and improve
+ reliability.
+<p>Added property ADOConnection::hasTransactions = true/false;
+<p>Added CreateSequence and DropSequence functions
+<p>Found misplaced MoveNext() in adodb-postgres.inc.php. Fixed.
+<p>Sybase SelectLimit not reliable because 'set rowcount' not cached - fixed.
+<p>Moved ADOConnection to adodb-connection.inc.php and ADORecordSet to adodb-recordset.inc.php.
+ This allows us to use doxygen to generate documentation. Doxygen doesn't like
+ the classes in the main adodb.inc.php file for some mysterious reason.
+<p><b>2.50, 14 Nov 2002</b>
+<p>Added transOff and transCnt properties for disabling (transOff = true) and
+ tracking transaction status (transCnt>0).
+<p>Added inputarray handling into _adodb_pageexecute_all_rows - "Ross Smith" RossSmith#bnw.com.
+<p>Fixed postgresql inconsistencies in date handling.
+<p>Added support for mssql_fetch_assoc.
+<p>Fixed $ADODB_FETCH_MODE bug in odbc MetaTables() and MetaPrimaryKeys().
+<p>Accidentally declared UnixDate() twice, making adodb incompatible with php
+ 4.3.0. Fixed.
+<p>Fixed pager problems with some databases that returned -1 for _currentRow on
+ MoveLast() by switching to MoveNext() in adodb-lib.inc.php.
+<p>Also fixed uninited $discard in adodb-lib.inc.php.
+<p><b>2.43, 25 Oct 2002</b></p>
+Added ADODB_ASSOC_CASE constant to better support ibase and odbc field names.
+<p>Added support for NConnect() for oracle OCINLogin.
+<p>Fixed NumCols() bug.
+<p>Changed session handler to use Replace() on write.
+<p>Fixed oci8 SelectLimit aggregate function bug again.
+<p>Rewrote pivoting code.
+<p><b>2.42, 4 Oct 2002</b></p>
+<p>Fixed ibase_fetch() problem with nulls. Also interbase now does automatic blob
+ decoding, and is backward compatible. Suggested by Heinz Hombergs heinz#hhombergs.de.
+<p>Fixed postgresql MoveNext() problems when called repeatedly after EOF. Also
+ suggested by Heinz Hombergs.
+<p>PageExecute() does not rewrite queries if SELECT DISTINCT is used. Requested
+ by hans#velum.net
+<p>Added additional fixes to oci8 SelectLimit handling with aggregate functions
+ - thx to Christian Bugge for reporting the problem.
+<p><b>2.41, 2 Oct 2002</b></p>
+<p>Fixed ADODB_COUNTRECS bug in odbc. Thx to Joshua Zoshi jzoshi#hotmail.com.
+<p>Increased buffers for adodb-csvlib.inc.php for extremely long sql from 8192
+ to 32000.
+<p>Revised pivottable.inc.php code. Added better support for aggregate fields.
+<p>Fixed mysql text/blob types problem in MetaTypes base class - thx to horacio
+ degiorgi.
+<p>Added SQLDate($fmt,$date) function, which allows an sql date format string
+ to be generated - useful for group by's.
+<p>Fixed bug in oci8 SelectLimit when offset>100.
+<p><b>2.40 4 Sept 2002</b></p>
+<p>Added new NLS_DATE_FORMAT property to oci8. Suggested by Laurent NAVARRO ln#altidev.com
+<p>Now use bind parameters in oci8 selectlimit for better performance.
+<p>Fixed interbase replaceQuote for dialect != 1. Thx to "BEGUIN Pierre-Henri
+ - INFOCOB" phb#infocob.com.
+<p>Added white-space check to QA.
+<p>Changed unixtimestamp to support fractional seconds (we always round down/floor
+ the seconds). Thanks to beezly#beezly.org.uk.
+<p>Now you can set the trigger_error type your own user-defined type in adodb-errorhandler.inc.php.
+ Suggested by Claudio Bustos clbustos#entelchile.net.
+<p>Added recordset filters with rsfilter.inc.php.
+<p>$conn->_rs2rs does not create a new recordset when it detects it is of type
+ array. Some trickery there as there seems to be a bug in Zend Engine
+<p>Added render_pagelinks to adodb-pager.inc.php. Code by "Pablo Costa" pablo#cbsp.com.br.
+<p>MetaType() speedup in adodb.inc.php by using hashing instead of switch. Best
+ performance if constant arrays are supported, as they are in PHP5.
+<p>adodb-session.php now updates only the expiry date if the crc32 check indicates
+ that the data has not been modified.
+<p><b>2.31 20 Aug 2002</b></p>
+<p>Made changes to pivottable.inc.php due to daniel lucuzaeu's suggestions (we sum the pivottable column if desired).
+<p>Fixed ErrorNo() in postgres so it does not depend on _errorMsg property.
+<p>Robert Tuttle added support for oracle cursors. See ExecuteCursor().
+<p>Fixed Replace() so it works with mysql when updating record where data has not changed. Reported by
+Cal Evans (cal#calevans.com).
+<p><b>2.30 1 Aug 2002</b></p>
+<p>Added pivottable.inc.php. Thanks to daniel.lucazeau#ajornet.com for the original
+ concept.
+<p>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.
+<p>Changed == to === for 'null' comparison. Reported by ericquil#yahoo.com
+<p>Fixed mssql SelectLimit( ) bug when distinct used.
+<p><b>2.30 1 Aug 2002</b></p>
+<p>New GetCol() and CacheGetCol() from ross#bnw.com that returns the first field as a 1 dim array.
+<p>We have an empty recordset, but RecordCount() could return -1. Fixed. Reported by "Jonathan Polansky" jonathan#polansky.com.
+<p>We now check for session variable changes using strlen($sessval).crc32($sessval).
+Formerly we only used crc32().
+<p>Informix SelectLimit() problem with $ADODB_COUNTRECS fixed.
+<p>Fixed informix SELECT FIRST x DISTINCT, and not SELECT DISTINCT FIRST x - reported by F Riosa
+<p>Now default adodb error handlers ignores error if @ used.
+<p>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.
+<p>Changed PageExecute() to use non-greedy preg_match when searching for "FROM" keyword.
+<p><b>2.20 9 July 2002</b></p>
+<p>Added CacheGetOne($secs2cache,$sql), CacheGetRow($secs2cache,$sql), CacheGetAll($secs2cache,$sql).
+<p>Added $conn->OffsetDate($dayFraction,$date=false) to generate sql that calcs
+ date offsets. Useful for scheduling appointments.
+<p>Added connection properties: leftOuter, rightOuter that hold left and right
+ outer join operators.
+<p>Added connection property: ansiOuter to indicate whether ansi outer joins supported.
+<p>New driver <i>mssqlpo</i>, the portable mssql driver, which converts string
+ concat operator from || to +.
+<p>Fixed ms access bug - SelectLimit() did not support ties - fixed.
+<p>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.
+<p>Added new parameter to GetAssoc() to allow returning an array of key-value pairs,
+ignoring any additional columns in the recordset. Off by default.
+<p>Corrected mssql $conn->sysDate to return only date using convert().
+<p>CacheExecute() improved debugging output.
+<p>Changed rs2html() so newlines are converted to BR tags. Also optimized rs2html() based
+on feedback by "Jerry Workman" jerry#mtncad.com.
+<p>Added support for Replace() with Interbase, using DELETE and INSERT.
+<p>Some minor optimizations (mostly removing & references when passing arrays).
+<p>Changed GenID() to allows id's larger than the size of an integer.
+<p>Added force_session property to oci8 for better updateblob() support.
+<p>Fixed PageExecute() which did not work properly with sql containing GROUP BY.
+<p><b>2.12 12 June 2002</b></p>
+<p>Added toexport.inc.php to export recordsets in CSV and tab-delimited format.
+<p>CachePageExecute() does not work - fixed - thx John Huong.
+<p>Interbase aliases not set properly in FetchField() - fixed. Thx Stefan Goethals.
+<p>Added cache property to adodb pager class. The number of secs to cache recordsets.
+<p>SQL rewriting bug in pageexecute() due to skipping of newlines due to missing /s modifier. Fixed.
+<p>Max size of cached recordset due to a bug was 256000 bytes. Fixed.
+<p>Speedup of 1st invocation of CacheExecute() by tuning code.
+<p>We compare $rewritesql with $sql in pageexecute code in case of rewrite failure.
+<p><b>2.11 7 June 2002</b></p>
+<p>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
+<p>DB2 support for CHARACTER type added - thx John Huong huongch#bigfoot.com
+<p>For ado, $argProvider not properly checked. Fixed - kalimero#ngi.it
+<p>Added $conn->Replace() function for update with automatic insert if the record does not exist.
+ Supported by all databases except interbase.
+<p><b>2.10 4 June 2002</b></p>
+<p>Added uniqueSort property to indicate mssql ORDER BY cols must be unique.
+<p>Optimized session handler by crc32 the data. We only write if session data has changed.
+<p>adodb_sess_read in adodb-session.php now returns ''correctly - thanks to Jorma Tuomainen, webmaster#wizactive.com
+<p>Mssql driver did not throw EXECUTE errors correctly because ErrorMsg() and ErrorNo() called in wrong order.
+Pointed out by Alexios Fakos. Fixed.
+<p>Changed ado to use client cursors. This fixes BeginTran() problems with ado.
+<p>Added handling of timestamp type in ado.
+<p>Added to ado_mssql support for insert_id() and affected_rows().
+<p>Added support for mssql.datetimeconvert=0, available since php 4.2.0.
+<p>Made UnixDate() less strict, so that the time is ignored if present.
+<p>Changed quote() so that it checks for magic_quotes_gpc.
+<p>Changed maxblobsize for odbc to default to 64000.
+<p><b>2.00 13 May 2002</b></p>
+<p>Added drivers <i>informix72</i> for pre-7.3 versions, and <i>oci805</i> for
+ oracle 8.0.5, and postgres64 for postgresql 6.4 and earlier. The postgres and postgres7 drivers
+ are now identical.
+<p>Interbase now partially supports ADODB_FETCH_BOTH, by defaulting to ASSOC mode.
+<p>Proper support for blobs in mssql. Also revised blob support code
+is base class. Now UpdateBlobFile() calls UpdateBlob() for consistency.
+<p>Added support for changed odbc_fetch_into api in php 4.2.0
+with $conn->_has_stupid_odbc_fetch_api_change.
+<p>Fixed spelling of tablock locking hint in GenID( ) for mssql.
+<p>Added RowLock( ) to several databases, including oci8, informix, sybase, etc.
+ Fixed where error in mssql RowLock().
+<p>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.
+<p>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).
+<p>Extensive revisions to informix driver - thanks to Samuel CARRIERE samuel_carriere#hotmail.com
+<p>Added $ok parameter to CommitTrans($ok) for easy rollbacks.
+<p>Fixed odbc MetaColumns and MetaTables to save and restore $ADODB_FETCH_MODE.
+<p>Some odbc drivers did not call the base connection class constructor. Fixed.
+<p>Fixed regex for GetUpdateSQL() and GetInsertSQL() to support more legal character combinations.
+
+<p><b>1.99 21 April 2002</b></p>
+<p>Added emulated RecordCount() to all database drivers if $ADODB_COUNTRECS = true
+ (which it is by default). Inspired by Cristiano Duarte (cunha17#uol.com.br).
+<p>Unified stored procedure support for mssql and oci8. Parameter() and PrepareSP()
+ functions implemented.
+<p>Added support for SELECT FIRST in informix, modified hasTop property to support
+ this.
+<p>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.
+<p>Better error checking in oci8 UpdateBlob() and UpdateBlobFile().
+<p>Added TIME type to MySQL - patch by Manfred h9125297#zechine.wu-wien.ac.at
+<p>Prepare/Execute implemented for Interbase/Firebird
+<p>Changed some regular expressions to be anchored by /^ $/ for speed.
+<p>Added UnixTimeStamp() and UnixDate() to ADOConnection(). Now these functions
+ are in both ADOConnection and ADORecordSet classes.
+<p>Empty recordsets were not cached - fixed.
+<p>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!
+<p><b>1.90 6 April 2002</b></p>
+<p>Now all database drivers support fetch modes ADODB_FETCH_NUM and ADODB_FETCH_ASSOC, though
+ still not fully tested. Eg. Frontbase, Sybase, Informix.
+<p>NextRecordSet() support for mssql. Contributed by "Sven Axelsson" sven.axelsson#bokochwebb.se
+<p>Added blob support for SQL Anywhere. Contributed by Wade Johnson wade#wadejohnson.de
+<p>Fixed some security loopholes in server.php. Server.php also supports fetch mode.
+<p>Generalized GenID() to support odbc and mssql drivers. Mssql no longer generates GUID's.
+<p>Experimental RowLock($table,$where) for mssql.
+<p>Properly implemented Prepare() in oci8 and ODBC.
+<p>Added Bind() support to oci8 to support Prepare().
+<p>Improved error handler. Catches CacheExecute() and GenID() errors now.
+<p>Now if you are running php from the command line, debugging messages do not output html formating.
+Not 100% complete, but getting there.
+<p><b>1.81 22 March 2002</b></p>
+<p>Restored default $ADODB_FETCH_MODE = ADODB_FETCH_DEFAULT for backward compatibility.
+<p>SelectLimit for oci8 improved - Our FIRST_ROWS optimization now does not overwrite existing hint.
+<p>New Sybase SQL Anywhere driver. Contributed by Wade Johnson wade#wadejohnson.de
+<p><b>1.80 15 March 2002</b></p>
+<p>Redesigned directory structure of ADOdb files. Added new driver directory where
+all database drivers reside.
+<p>Changed caching algorithm to create subdirectories. Now we scale better.
+<p>Informix driver now supports insert_id(). Contribution by "Andrea Pinnisi" pinnisi#sysnet.it
+<p>Added experimental ISO date and FetchField support for informix.
+<p>Fixed a quoting bug in Execute() with bind parameters, causing problems with blobs.
+<p>Mssql driver speedup by 10-15%.
+<p>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.
+<p>Sybase SQL Anywhere driver (using ODBC) contributed by Wade Johnson wade#wadejohnson.de
+<p><b>1.72 8 March 2002</b></p>
+<p>Added @ when returning Fields() to prevent spurious error - "Michael William Miller" mille562#pilot.msu.edu
+<p>MetaDatabases() for postgres contributed by Phil pamelant#nerim.net
+ <p>Mitchell T. Young (mitch#youngfamily.org) contributed informix driver.
+ <p>Fixed rs2html() problem. I cannot reproduce, so probably a problem with pre PHP 4.1.0 versions,
+ when supporting new ADODB_FETCH_MODEs.
+ <p>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 <a href="http://phplens.com/lens/lensforum/msgs.php?id=1262">this posting</a>
+ for an example of usage.
+ <p>Added UpdateBlobFile() for uploading files to a database.
+ <p>Made UpdateBlob() compatible with oci8po driver.
+ <p>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.
+ <p>Fixed UnixTimeStamp() bug - wasn't setting minutes and seconds properly. Patch from Agusti Fita i Borrell agusti#anglatecnic.com.
+ <p>Toni Tunkkari added patch for sybase dates. Problem with spaces in day part of date fixed.
+ <p><b>1.71 18 Jan 2002</b></p>
+ <p>Sequence start id support. Now $conn->Gen_ID('seqname', 50) to start sequence from 50.
+ <p>CSV driver fix for selectlimit, from Andreas - akaiser#vocote.de.
+<P>Gam3r spotted that a global variable was undefined in the session handler.
+<p>Mssql date regex had error. Fixed - reported by Minh Hoang vb_user#yahoo.com.
+<p>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.
+<p>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.
+<p>Reformated docs slightly based on suggestions by Chris Small.
+ <p><b>1.65 28 Dec 2001</b></p>
+ <p>Fixed borland_ibase class naming bug.
+ <p>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.
+ <p>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).
+ <p>Improved support for postgresql in GetInsertSQL and GetUpdateSQL by
+ "mike" mike#partner2partner.com and "Ryan Bailey" rebel#windriders.com
+ <p><b>1.64 20 Dec 2001</b></p>
+<p>Danny Milosavljevic <danny.milo#gmx.net> added some patches for MySQL error handling
+and displaying default values.
+<p>Fixed some ADODB_FETCH_BOTH inconsistencies in odbc and interbase.
+<p>Added more tests to test suite to cover ADODB_FETCH_* and ADODB_ERROR_HANDLER.
+<p>Added firebird (ibase) driver
+<p>Added borland_ibase driver for interbase 6.5
+<p><b>1.63 13 Dec 2001</b></p>
+Absolute to the adodb-lib.inc.php file not set properly. Fixed.<p>
+
+<p><b>1.62 11 Dec 2001</b></p>
+<p>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.
+<p>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.
+<p>Allow . and # in table definitions in GetInsertSQL and GetUpdateSQL.
+ See ADODB_TABLE_REGEX constant. Thx to Ari Kuorikoski.
+<p>Added ADODB_PREFETCH_ROWS constant, defaulting to 10. This determines the number
+of records to prefetch in a SELECT statement. Only used by oci8.</p>
+<p>Added high portability Oracle class called oci8po. This uses ? for bind variables, and
+lower cases column names.</p>
+<p>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.
+<p><b>1.61 Nov 2001</b></p>
+<p>Added PO_RecordCount() and PO_Insert_ID(). PO stands for portable. Pablo Roca
+ [pabloroca#mvps.org]</p>
+<p>GenID now returns 0 if not available. Safer is that you should check $conn->hasGenID
+ for availability.</p>
+<p>M'soft ADO we now correctly close recordset in _close() peterd#telephonetics.co.uk</p>
+<p>MSSQL now supports GenID(). It generates a 16-byte GUID from mssql newid()
+ function.</p>
+<p>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</p>
+<p>Added $recordset->connection. This is the ADOConnection object for the recordset.
+Works with cached and normal recordsets. Surprisingly, this had no affect on performance!</p>
+<p><b>1.54 15 Nov 2001</b></p>
+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 :(
+<p> More speedups of SelectLimit() for DB2, Oci8, access, vfp, mssql.
+<p>
+
+<p><b>1.53 7 Nov 2001</b></p>
+Added support for ADODB_FETCH_ASSOC for ado and odbc drivers.<p>
+Tuned GetRowAssoc(false) in postgresql and mysql.<p>
+Stephen Van Dyke contributed ADOdb icon, accepted with some minor mods.<p>
+Enabled Affected_Rows() for postgresql<p>
+Speedup for Concat() using implode() - Benjamin Curtis ben_curtis#yahoo.com<p>
+Fixed some more bugs in PageExecute() to prevent infinite loops<p>
+<p><b>1.52 5 Nov 2001</b></p>
+Spelling error in CacheExecute() caused it to fail. $ql should be $sql in line 625!<p>
+Added fixes for parsing [ and ] in GetUpdateSQL().
+<p><b>1.51 5 Nov 2001</b></p>
+<p>Oci8 SelectLimit() speedup by using OCIFetch().
+<p>Oci8 was mistakenly reporting errors when $db->debug = true.
+<p>If a connection failed with ODBC, it was not correctly reported - fixed.
+<p>_connectionID was inited to -1, changed to false.
+<p>Added $rs->FetchRow(), to simplify API, ala PEAR DB
+<p>Added PEAR DB compat mode, which is still faster than PEAR! See adodb-pear.inc.php.
+<p>Removed postgres pconnect debugging statement.
+<p><b>1.50 31 Oct 2001</b></p>
+<p>ADOdbConnection renamed to ADOConnection, and ADOdbFieldObject to ADOFieldObject.
+<p>PageExecute() now checks for empty $rs correctly, and the errors in the docs on this subject have been fixed.
+<p>odbc_error() does not return 6 digit error correctly at times. Implemented workaround.
+<p>Added ADORecordSet_empty class. This will speedup INSERTS/DELETES/UPDATES because the return
+object created is much smaller.
+<p>Added Prepare() to odbc, and oci8 (but doesn't work properly for oci8 still).
+<p>Made pgsql a synonym for postgre7, and changed SELECT LIMIT to use OFFSET for compat with
+postgres 7.2.
+<p>Revised adodb-cryptsession.php thanks to Ari.
+<p>Set resources to false on _close, to force freeing of resources.
+<p>Added adodb-errorhandler.inc.php, adodb-errorpear.inc.php and raiseErrorFn on Freek's urging.
+<p>GetRowAssoc($toUpper=true): $toUpper added as default.
+<p>Errors when connecting to a database were not captured formerly. Now we do it correctly.
+<p><b>1.40 19 September 2001</b></p>
+<p>PageExecute() to implement page scrolling added. Code and idea by Iván Oliva.</p>
+<p>Some minor postgresql fixes.</p>
+<p>Added sequence support using GenID() for postgresql, oci8, mysql, interbase.</p>
+<p>Added UpdateBlob support for interbase (untested).</p>
+<p>Added encrypted sessions (see adodb-cryptsession.php). By Ari Kuorikoski <kuoriari#finebyte.com></p>
+<p><b>1.31 21 August 2001</b></p>
+<p>Many bug fixes thanks to "GaM3R (Cameron)" <gamr#outworld.cx>. Some session changes due to Gam3r.
+<p>Fixed qstr() to quote also.
+<p>rs2html() now pretty printed.
+<p>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).
+<p>"Nicola Fankhauser" <nicola.fankhauser#couniq.com> found some bugs in date handling for mssql.</p>
+<p>Added minimal Oracle support for LOBs. Still under development.</p>
+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.
+<p>PostgreSQL properly closes recordsets now. Reported by several people.
+<p>
+Added UpdateBlob() for Oracle. A hack to make it easier to save blobs.
+<p>
+Oracle timestamps did not display properly. Fixed.
+<p><b>1.20 6 June 2001</b></p>
+<p>Now Oracle can connect using tnsnames.ora or server and service name</p>
+<p>Extensive Oci8 speed optimizations.
+Oci8 code revised to support variable binding, and /*+ FIRST_ROWS */ hint.</p>
+<p>Worked around some 4.0.6 bugs in odbc_fetch_into().</p>
+<p>Paolo S. Asioli paolo.asioli#libero.it suggested GetRowAssoc().</p>
+<p>Escape quotes for oracle wrongly set to '. Now '' is used.</p>
+<p>Variable binding now works in ODBC also.</p>
+<p>Jumped to version 1.20 because I don't like 13 :-)</p>
+<p><b>1.12 6 June 2001</b></p>
+<p>Changed $ADODB_DIR to ADODB_DIR constant to plug a security loophole.</p>
+<p>Changed _close() to close persistent connections also. Prevents connection leaks.</p>
+<p>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.</p>
+<p>Interbase timestamp input format was wrong. Fixed.</p>
+<p><b>1.11 20 May 2001</b></p>
+<p>Improved file locking for Windows.</p>
+<p>Probabilistic flushing of cache to avoid avalanche updates when cache timeouts.</p>
+<p>Cached recordset timestamp not saved in some scenarios. Fixed.</p>
+<p><b>1.10 19 May 2001</b></p>
+<p>Added caching. CacheExecute() and CacheSelectLimit().
+<p>Added csv driver. See <a href="http://php.weblogs.com/adodb_csv">http://php.weblogs.com/ADODB_csv</a>.
+<p>Fixed SelectLimit(), SELECT TOP not working under certain circumstances.
+<p>Added better Frontbase support of MetaTypes() by Frank M. Kromann.
+<p><b>1.01 24 April 2001</b></p>
+<p>Fixed SelectLimit bug. not quoted properly.
+<p>SelectLimit: SELECT TOP -1 * FROM TABLE not support by Microsoft. Fixed.</p>
+<p>GetMenu improved by glen.davies#cce.ac.nz to support multiple hilited items<p>
+<p>FetchNextObject() did not work with only 1 record returned. Fixed bug reported by $tim#orotech.net</p>
+<p>Fixed mysql field max_length problem. Fix suggested by Jim Nicholson (jnich#att.com)</p>
+<p><b>1.00 16 April 2001</b></p>
+<p>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.</p>
+<p>FetchNextObject() added. Suggested by Jakub Marecek. This makes FetchObject() obsolete, as
+this is more flexible and powerful.</p>
+<p>Misc fixes to SelectLimit() to support Access (top must follow distinct) and Fields()
+in the array recordset. From Reinhard Balling.</p>
+<p><b>0.96 27 Mar 2001</b></p>
+<p>ADOConnection Close() did not return a value correctly. Thanks to akul#otamedia.com.</p>
+<p>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().</p>
+<p>Fixed Sybase date problem in UnixDate() thanks to Toni Tunkkari. Also fixed MSSQL problem
+in UnixDate() - thanks to milhouse31#hotmail.com.</p>
+<p>MoveNext() moved to leaf classes for speed in MySQL/PostgreSQL. 10-15% speedup.</p>
+<p>Added null handling in bindInputArray in Execute() -- Ron Baldwin suggestion.</p>
+<p>Fixed some option tags. Thanks to john#jrmstudios.com.</p>
+<p><b>0.95 13 Mar 2001</b></p>
+<p>Added postgres7 database driver which supports LIMIT and other version 7 stuff in the future.</p>
+<p>Added SelectLimit to ADOConnection to simulate PostgreSQL's "select * from table limit 10 offset 3".
+Added helper function GetArrayLimit() to ADORecordSet.</p>
+<p>Fixed mysql metacolumns bug. Thanks to Freek Dijkstra (phpeverywhere#macfreek.com).</p>
+<p>Also many PostgreSQL changes by Freek. He almost rewrote the whole PostgreSQL driver!</p>
+<p>Added fix to input parameters in Execute for non-strings by Ron Baldwin.</p>
+<p>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.</p>
+<p>Fixed $this->GetArray() in GetRows().</p>
+<p>Oracle and OCI8: 1st parameter is always blank -- now warns if it is filled.</p>
+<p>Now <i>hasLimit</i> and <i>hasTop</i> added to indicate whether
+SELECT * FROM TABLE LIMIT 10 or SELECT TOP 10 * FROM TABLE are supported.</p>
+<p><b>0.94 04 Feb 2001</b></p>
+<p>Added ADORecordSet::GetRows() for compatibility with Microsoft ADO. Synonym for GetArray().</p>
+<p>Added new metatype 'R' to represent autoincrement numbers.</p>
+<p>Added ADORecordSet.FetchObject() to return a row as an object.</p>
+<p>Finally got a Linux box to test PostgreSql. Many fixes.</p>
+<p>Fixed copyright misspellings in 0.93.</p>
+<p>Fixed mssql MetaColumns type bug.</p>
+<p>Worked around odbc bug in PHP4 for sessions.</p>
+<p>Fixed many documentation bugs (affected_rows, metadatabases, qstr).</p>
+<p>Fixed MySQL timestamp format (removed comma).</p>
+<p>Interbase driver did not call ibase_pconnect(). Fixed.</p>
+<p><b>0.93 18 Jan 2002</b></p>
+<p>Fixed GetMenu bug.</p>
+<p>Simplified Interbase commit and rollback.</p>
+<p>Default behaviour on closing a connection is now to rollback all active transactions.</p>
+<p>Added field object handling for array recordset for future XML compatibility.</p>
+<p>Added arr2html() to convert array to html table.</p>
+<p><b>0.92 2 Jan 2002</b></p>
+<p>Interbase Commit and Rollback should be working again.</p>
+<p>Changed initialisation of ADORecordSet. This is internal and should not affect users. We
+are doing this to support cached recordsets in the future.</p>
+
+<p>Implemented ADORecordSet_array class. This allows you to simulate a database recordset
+with an array.</p>
+<p>Added UnixDate() and UnixTimeStamp() to ADORecordSet.</p>
+<p><b>0.91 21 Dec 2000</b></p>
+<p>Fixed ODBC so ErrorMsg() is working.</p>
+<p>Worked around ADO unrecognised null (0x1) value problem in COM.</p>
+<p>Added Sybase support for FetchField() type</p>
+<p>Removed debugging code and unneeded html from various files</p>
+<p>Changed to javadoc style comments to adodb.inc.php.</p>
+<p>Added maxsql as synonym for mysqlt</p>
+<p>Now ODBC downloads first 8K of blob by default
+<p><b>0.90 15 Nov 2000</b></p>
+<p>Lots of testing of Microsoft ADO. Should be more stable now.</p>
+<p>Added $ADODB_COUNTREC. Set to false for high speed selects.</p>
+<p>Added Sybase support. Contributed by Toni Tunkkari (toni.tunkkari#finebyte.com). Bug in Sybase
+ API: GetFields is unable to determine date types.</p>
+<p>Changed behaviour of RecordSet.GetMenu() to support size parameter (listbox) properly.</p>
+<p>Added emptyDate and emptyTimeStamp to RecordSet class that defines how to represent
+ empty dates.</p>
+<p>Added MetaColumns($table) that returns an array of ADOFieldObject's listing
+ the columns of a table.</p>
+<p>Added transaction support for PostgresSQL -- thanks to "Eric G. Werk" egw#netguide.dk.</p>
+<p>Added adodb-session.php for session support.</p>
+<p><b>0.80 30 Nov 2000</b></p>
+<p>Added support for charSet for interbase. Implemented MetaTables for most databases.
+ PostgreSQL more extensively tested.</p>
+<p><b>0.71 22 Nov 2000</b></p>
+<p>Switched from using require_once to include/include_once for backward compatability with PHP 4.02 and earlier.</p>
+<p><b>0.70 15 Nov 2000</b></p>
+<p>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.</p>
+<p>PostgreSQL database driver contributed by Alberto Cerezal (acerezalp#dbnet.es).
+</p>
+<p>Oci8 driver for Oracle 8 contributed by George Fourlanos (fou#infomap.gr).</p>
+<p>Added <i>mysqlt</i> database driver to support MySQL 3.23 which has transaction
+ support. </p>
+<p>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.</p>
+<p>Error message checking is now included in test suite.</p>
+<p>MoveNext() did not check EOF properly -- fixed.</p>
+<p><b>0.60 Nov 8 2000</b></p>
+<p>Fixed some constructor bugs in ODBC and ADO. Added ErrorNo function to ADOConnection
+ class. </p>
+<p><b>0.51 Oct 18 2000</b></p>
+<p>Fixed some interbase bugs.</p>
+<p><b>0.50 Oct 16 2000</b></p>
+<p>Interbase commit/rollback changed to be compatible with PHP 4.03. </p>
+<p>CommitTrans( ) will now return true if transactions not supported. </p>
+<p>Conversely RollbackTrans( ) will return false if transactions not supported.
+</p>
+<p><b>0.46 Oct 12</b></p>
+Many Oracle compatibility issues fixed.
+<p><b>0.40 Sept 26</b></p>
+<p>Many bug fixes</p>
+<p>Now Code for BeginTrans, CommitTrans and RollbackTrans is working. So is the Affected_Rows
+and Insert_ID. Added above functions to test.php.</p>
+<p>ADO type handling was busted in 0.30. Fixed.</p>
+<p>Generalised Move( ) so it works will all databases, including ODBC.</p>
+<p><b>0.30 Sept 18</b></p>
+<p>Renamed ADOLoadDB to ADOLoadCode. This is clearer.</p>
+<p>Added BeginTrans, CommitTrans and RollbackTrans functions.</p>
+<p>Added Affected_Rows() and Insert_ID(), _affectedrows() and _insertID(), ListTables(),
+ ListDatabases(), ListColumns().</p>
+<p>Need to add New_ID() and hasInsertID and hasAffectedRows, autoCommit </p>
+<p><b>0.20 Sept 12</b></p>
+<p>Added support for Microsoft's ADO.</p>
+<p>Added new field to ADORecordSet -- canSeek</p>
+<p>Added new parameter to _fetch($ignore_fields = false). Setting to true will
+ not update fields array for faster performance.</p>
+<p>Added new field to ADORecordSet/ADOConnection -- dataProvider to indicate whether
+ a class is derived from odbc or ado.</p>
+<p>Changed class ODBCFieldObject to ADOFieldObject -- not documented currently.</p>
+<p>Added benchmark.php and testdatabases.inc.php to the test suite.</p>
+<p>Added to ADORecordSet FastForward( ) for future high speed scrolling. Not documented.</p>
+<p>Realised that ADO's Move( ) uses relative positioning. ADOdb uses absolute.
+</p>
+<p><b>0.10 Sept 9 2000</b></p>
+<p>First release</p>
+</body></html>
\ No newline at end of file diff --git a/framework/3rdParty/adodb/docs/readme.htm b/framework/3rdParty/adodb/docs/readme.htm new file mode 100644 index 00000000..4780cb78 --- /dev/null +++ b/framework/3rdParty/adodb/docs/readme.htm @@ -0,0 +1,68 @@ +<html>
+<head>
+<title>ADODB Manual</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<XSTYLE
+ body,td {font-family:Arial,Helvetica,sans-serif;font-size:11pt}
+ pre {font-size:9pt}
+ .toplink {font-size:8pt}
+ />
+</head>
+<body bgcolor="#FFFFFF">
+
+<h3>ADOdb Library for PHP</h3>
+<p>ADOdb is a suite of database libraries that allow you to connect to multiple
+ databases in a portable manner. Download from <a href=http://adodb.sourceforge.net/>http://adodb.sourceforge.net/</a>.
+<ul><li>The ADOdb documentation has moved to <a href=docs-adodb.htm>docs-adodb.htm</a>
+ This allows you to query, update and insert records using a portable API.
+<p><li>The ADOdb data dictionary docs are at <a href=docs-datadict.htm>docs-datadict.htm</a>.
+ This allows you to create database tables and indexes in a portable manner.
+<p><li>The ADOdb database performance monitoring docs are at <a href=docs-perf.htm>docs-perf.htm</a>.
+ This allows you to perform health checks, tune and monitor your database.
+<p><li>The ADOdb database-backed session docs are at <a href=docs-session.htm>docs-session.htm</a>.
+</ul>
+<p>
+<h3>Installation</h3>
+Make sure you are running PHP4.0.4 or later. Unpack all the files into a directory accessible by your webserver.
+<p>
+To test, try modifying some of the tutorial examples. Make sure you customize the connection settings correctly. You can debug using:
+<pre>
+<?php
+include('adodb/adodb.inc.php');
+
+$db = <b>ADONewConnection</b>($driver); # eg. 'mysql' or 'oci8'
+$db->debug = true;
+$db-><b>Connect</b>($server, $user, $password, $database);
+$rs = $db-><b>Execute</b>('select * from some_small_table');
+print "<pre>";
+print_r($rs-><b>GetRows</b>());
+print "</pre>";
+?>
+</pre>
+<h3>How are people using ADOdb</h3>
+Here are some examples of how people are using ADOdb:
+<ul>
+ <li> <strong>PhpLens</strong> 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.
+ </li>
+ <li> <strong>PHAkt</strong>: PHP Extension for DreamWeaver Ultradev allows
+ you to script PHP in the popular Web page editor. Database handling provided
+ by ADOdb. </li>
+ <li> <strong>Analysis Console for Intrusion Databases (ACID)</strong>: 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. </li>
+ <li> <strong>PostNuke</strong> 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. </li>
+ <li><strong> EasyPublish CMS</strong> is another free content management system
+ for managing information and integrated modules on your internet, intranet-
+ and extranet-sites. From Norway. </li>
+ <li> <strong>NOLA</strong> is a full featured accounting, inventory, and job
+ tracking application. It is licensed under the GPL, and developed by Noguska.
+ </li>
+</ul>
+</body>
+</html>
diff --git a/framework/3rdParty/adodb/docs/tips_portable_sql.htm b/framework/3rdParty/adodb/docs/tips_portable_sql.htm new file mode 100644 index 00000000..06991740 --- /dev/null +++ b/framework/3rdParty/adodb/docs/tips_portable_sql.htm @@ -0,0 +1,362 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <title>Tips on Writing Portable SQL for Multiple Databases for PHP</title>
+</head>
+
+<body bgcolor=white>
+<table width=100% border=0><tr><td><h2>Tips on Writing Portable SQL </h2></td><td>
+ <div align=right><img src="cute_icons_for_site/adodb.gif"></div></td></tr></table>
+ <p>Updated 18 Sep 2003. Added Portable Native SQL section.
+<p>
+
+ If you are writing an application that is used in multiple environments and
+ operating systems, you need to plan to support multiple databases. This article
+ is based on my experiences with multiple database systems, stretching from 4th
+ Dimension in my Mac days, to the databases I currently use, which are: Oracle,
+ FoxPro, Access, MS SQL Server and MySQL. Although most of the advice here applies
+ to using SQL with Perl, Python and other programming languages, I will focus on PHP and how
+ the <a href="http://adodb.sourceforge.net/">ADOdb</a> database abstraction library
+ offers some solutions.<p></p>
+<p>Most database vendors practice product lock-in. The best or fastest way to
+ do things is often implemented using proprietary extensions to SQL. This makes
+ it extremely hard to write portable SQL code that performs well under all conditions.
+ When the first ANSI committee got together in 1984 to standardize SQL, the database
+ vendors had such different implementations that they could only agree on the
+ core functionality of SQL. Many important application specific requirements
+ were not standardized, and after so many years since the ANSI effort began,
+ it looks as if much useful database functionality will never be standardized.
+ Even though ANSI-92 SQL has codified much more, we still have to implement portability
+ at the application level.</p>
+<h3><b>Selects</b></h3>
+<p>The SELECT statement has been standardized to a great degree. Nearly every
+ database supports the following:</p>
+<p>SELECT [cols] FROM [tables]<br>
+ [WHERE conditions]<br>
+ [GROUP BY cols]<br>
+ [HAVING conditions] <br>
+ [ORDER BY cols]</p>
+<p>But so many useful techniques can only be implemented by using proprietary
+ extensions. For example, when writing SQL to retrieve the first 10 rows for
+ paging, you could write...</p>
+<table width="80%" border="1" cellspacing="0" cellpadding="0" align="center">
+ <tr>
+ <td><b>Database</b></td>
+ <td><b>SQL Syntax</b></td>
+ </tr>
+ <tr>
+ <td>DB2</td>
+ <td>select * from table fetch first 10 rows only</td>
+ </tr>
+ <tr>
+ <td>Informix</td>
+ <td>select first 10 * from table</td>
+ </tr>
+ <tr>
+ <td>Microsoft SQL Server and Access</td>
+ <td>select top 10 * from table</td>
+ </tr>
+ <tr>
+ <td>MySQL and PostgreSQL</td>
+ <td>select * from table limit 10</td>
+ </tr>
+ <tr>
+ <td>Oracle 8i</td>
+ <td>select * from (select * from table) where rownum <= 10</td>
+ </tr>
+</table>
+<p>This feature of getting a subset of data is so useful that in the PHP class
+ library ADOdb, we have a SelectLimit( ) function that allows you to hide the
+ implementation details within a function that will rewrite your SQL for you:</p>
+<pre>$connection->SelectLimit('select * from table', 10);
+</pre>
+<p><b>Selects: Fetch Modes</b></p>
+<p>PHP allows you to retrieve database records as arrays. You can choose to have
+ the arrays indexed by field name or number. However different low-level PHP
+ database drivers are inconsistent in their indexing efforts. ADOdb allows you
+ to determine your prefered mode. You set this by setting the variable $ADODB_FETCH_MODE
+ to either of the constants ADODB_FETCH_NUM (for numeric indexes) or ADODB_FETCH_ASSOC
+ (using field names as an associative index).</p>
+<p>The default behaviour of ADOdb varies depending on the database you are using.
+ For consistency, set the fetch mode to either ADODB_FETCH_NUM (for speed) or
+ ADODB_FETCH_ASSOC (for convenience) at the beginning of your code. </p>
+<p><b>Selects: Counting Records</b></p>
+<p>Another problem with SELECTs is that some databases do not return the number
+ of rows retrieved from a select statement. This is because the highest performance
+ databases will return records to you even before the last record has been found.
+</p>
+<p>In ADOdb, RecordCount( ) returns the number of rows returned, or will emulate
+ it by buffering the rows and returning the count after all rows have been returned.
+ This can be disabled for performance reasons when retrieving large recordsets
+ by setting the global variable $ADODB_COUNTRECS = false. This variable is checked
+ every time a query is executed, so you can selectively choose which recordsets
+ to count.</p>
+<p>If you prefer to set $ADODB_COUNTRECS = false, ADOdb still has the PO_RecordCount(
+ ) function. This will return the number of rows, or if it is not found, it will
+ return an estimate using SELECT COUNT(*):</p>
+<pre>$rs = $db->Execute("select * from table where state=$state");
+$numrows = $rs->PO_RecordCount('table', "state=$state");</pre>
+<p><b>Selects: Locking</b> </p>
+<p>SELECT statements are commonly used to implement row-level locking of tables.
+ Other databases such as Oracle, Interbase, PostgreSQL and MySQL with InnoDB
+ do not require row-level locking because they use versioning to display data
+ consistent with a specific point in time.</p>
+<p>Currently, I recommend encapsulating the row-level locking in a separate function,
+ such as RowLock($table, $where):</p>
+<pre>$connection->BeginTrans( );
+$connection->RowLock($table, $where); </pre>
+<pre><font color=green># some operation</font></pre>
+<pre>if ($ok) $connection->CommitTrans( );
+else $connection->RollbackTrans( );
+</pre>
+<p><b>Selects: Outer Joins</b></p>
+<p>Not all databases support outer joins. Furthermore the syntax for outer joins
+ differs dramatically between database vendors. One portable (and possibly slower)
+ method of implementing outer joins is using UNION.</p>
+<p>For example, an ANSI-92 left outer join between two tables t1 and t2 could
+ look like:</p>
+<pre>SELECT t1.col1, t1.col2, t2.cola <br> FROM t1 <i>LEFT JOIN</i> t2 ON t1.col = t2.col</pre>
+<p>This can be emulated using:</p>
+<pre>SELECT t1.col1, t1.col2, t2.cola FROM t1, t2 <br> WHERE t1.col = t2.col
+ UNION ALL
+SELECT col1, col2, null FROM t1 <br> WHERE t1.col not in (select distinct col from t2)
+</pre>
+<p>Since ADOdb 2.13, we provide some hints in the connection object as to legal
+ join variations. This is still incomplete and sometimes depends on the database
+ version you are using, but is useful as a general guideline:</p>
+<p><font face="Courier New, Courier, mono">$conn->leftOuter</font>: holds the
+ operator used for left outer joins (eg. '*='), or false if not known or not
+ available.<br>
+ <font face="Courier New, Courier, mono">$conn->rightOuter</font>: holds the
+ operator used for right outer joins (eg '=*'), or false if not known or not
+ available.<br>
+ <font face="Courier New, Courier, mono">$conn->ansiOuter</font>: boolean
+ that if true means that ANSI-92 style outer joins are supported, or false if
+ not known.</p>
+<h3><b>Inserts</b> </h3>
+<p>When you create records, you need to generate unique id's for each record.
+ There are two common techniques: (1) auto-incrementing columns and (2) sequences.
+</p>
+<p>Auto-incrementing columns are supported by MySQL, Sybase and Microsoft Access
+ and SQL Server. However most other databases do not support this feature. So
+ for portability, you have little choice but to use sequences. Sequences are
+ special functions that return a unique incrementing number every time you call
+ it, suitable to be used as database keys. In ADOdb, we use the GenID( ) function.
+ It has takes a parameter, the sequence name. Different tables can have different
+ sequences. </p>
+<pre>$id = $connection->GenID('sequence_name');<br>$connection->Execute("insert into table (id, firstname, lastname) <br> values ($id, $firstname, $lastname)");</pre>
+<p>For databases that do not support sequences natively, ADOdb emulates sequences
+ by creating a table for every sequence.</p>
+<h3><b>Binding</b></h3>
+<p>Binding variables in an SQL statement is another tricky feature. Binding is
+ useful because it allows pre-compilation of SQL. When inserting multiple records
+ into a database in a loop, binding can offer a 50% (or greater) speedup. However
+ many databases such as Access and MySQL do not support binding natively and
+ there is some overhead in emulating binding. Furthermore, different databases
+ (specificly Oracle!) implement binding differently. My recommendation is to
+ use binding if your database queries are too slow, but make sure you are using
+ a database that supports it like Oracle. </p>
+<p>ADOdb supports portable Prepare/Execute with:</p>
+<pre>$stmt = $db->Prepare('select * from customers where custid=? and state=?');
+$rs = $db->Execute($stmt, array($id,'New York'));</pre>
+<p>Oracle uses named bind placeholders, not "?", so to support portable binding, we have Param() that generates
+the correct placeholder (available since ADOdb 3.92):
+<pre><font color="#000000">$sql = <font color="#993300">'insert into table (col1,col2) values ('</font>.$DB->Param('a').<font color="#993300">','</font>.$DB->Param('b').<font color="#993300">')'</font>;
+<font color="#006600"># generates 'insert into table (col1,col2) values (?,?)'
+# or 'insert into table (col1,col2) values (:a,:b)</font>'
+$stmt = $DB->Prepare($sql);
+$stmt = $DB->Execute($stmt,array('one','two'));
+</font></pre>
+<a name="native"></a>
+<h2>Portable Native SQL</h2>
+<p>ADOdb provides the following functions for portably generating SQL functions
+ as strings to be merged into your SQL statements (some are only available since
+ ADOdb 3.92): </p>
+<table width="75%" border="1" align=center>
+ <tr>
+ <td width=30%><b>Function</b></td>
+ <td><b>Description</b></td>
+ </tr>
+ <tr>
+ <td>DBDate($date)</td>
+ <td>Pass in a UNIX timestamp or ISO date and it will convert it to a date
+ string formatted for INSERT/UPDATE</td>
+ </tr>
+ <tr>
+ <td>DBTimeStamp($date)</td>
+ <td>Pass in a UNIX timestamp or ISO date and it will convert it to a timestamp
+ string formatted for INSERT/UPDATE</td>
+ </tr>
+ <tr>
+ <td>SQLDate($date, $fmt)</td>
+ <td>Portably generate a date formatted using $fmt mask, for use in SELECT
+ statements.</td>
+ </tr>
+ <tr>
+ <td>OffsetDate($date, $ndays)</td>
+ <td>Portably generate a $date offset by $ndays.</td>
+ </tr>
+ <tr>
+ <td>Concat($s1, $s2, ...)</td>
+ <td>Portably concatenate strings. Alternatively, for mssql use mssqlpo driver,
+ which allows || operator.</td>
+ </tr>
+ <tr>
+ <td>IfNull($fld, $replaceNull)</td>
+ <td>Returns a string that is the equivalent of MySQL IFNULL or Oracle NVL.</td>
+ </tr>
+ <tr>
+ <td>Param($name)</td>
+ <td>Generates bind placeholders, using ? or named conventions as appropriate.</td>
+ </tr>
+ <tr><td>$db->sysDate</td><td>Property that holds the SQL function that returns today's date</td>
+</tr>
+<tr><td>$db->sysTimeStamp</td><td>Property that holds the SQL function that returns the current
+timestamp (date+time).
+</td>
+</tr>
+<tr>
+<td>$db->concat_operator</td><td>Property that holds the concatenation operator
+</td>
+</tr>
+<tr><td>$db->length</td><td>Property that holds the name of the SQL strlen function.
+</td></tr>
+
+<tr><td>$db->upperCase</td><td>Property that holds the name of the SQL strtoupper function.
+</td></tr>
+<tr><td>$db->random</td><td>Property that holds the SQL to generate a random number between 0.00 and 1.00.
+</td>
+</tr>
+<tr><td>$db->substr</td><td>Property that holds the name of the SQL substring function.
+</td></tr>
+</table>
+<p> </p>
+<h2>DDL and Tuning</h2>
+There are database design tools such as ERWin or Dezign that allow you to generate data definition language commands such as ALTER TABLE or CREATE INDEX from Entity-Relationship diagrams.
+<p>
+However if you prefer to use a PHP-based table creation scheme, adodb provides you with this feature. Here is the code to generate the SQL to create a table with:
+<ol>
+ <li> Auto-increment primary key 'ID', </li>
+ <li>The person's 'NAME' VARCHAR(32) NOT NULL and defaults to '', </li>
+ <li>The date and time of record creation 'CREATED', </li>
+ <li> The person's 'AGE', defaulting to 0, type NUMERIC(16). </li>
+</ol>
+<p>
+Also create a compound index consisting of 'NAME' and 'AGE':
+<pre>
+$datadict = <strong>NewDataDictionary</strong>($connection);
+$flds = "
+<font color="#660000"> ID I AUTOINCREMENT PRIMARY,
+ NAME C(32) DEFAULT '' NOTNULL,
+ CREATED T DEFTIMESTAMP,
+ AGE N(16) DEFAULT 0</font>
+";
+$sql1 = $datadict-><strong>CreateTableSQL</strong>('tabname', $flds);
+$sql2 = $datadict-><strong>CreateIndexSQL</strong>('idx_name_age', 'tabname', 'NAME,AGE');
+</pre>
+
+<h3>Data Types</h3>
+<p>Stick to a few data types that are available in most databases. Char, varchar
+ and numeric/number are supported by most databases. Most other data types (including
+ integer, boolean and float) cannot be relied on being available. I recommend
+ using char(1) or number(1) to hold booleans. </p>
+<p>Different databases have different ways of representing dates and timestamps/datetime.
+ ADOdb attempts to display all dates in ISO (YYYY-MM-DD) format. ADOdb also provides
+ DBDate( ) and DBTimeStamp( ) to convert dates to formats that are acceptable
+ to that database. Both functions accept Unix integer timestamps and date strings
+ in ISO format.</p>
+<pre>$date1 = $connection->DBDate(time( ));<br>$date2 = $connection->DBTimeStamp('2002-02-23 13:03:33');</pre>
+<p>We also provide functions to convert database dates to Unix timestamps:</p>
+<pre>$unixts = $recordset->UnixDate('#2002-02-30#'); <font color="green"># MS Access date => unix timestamp</font></pre>
+<p>The maximum length of a char/varchar field is also database specific. You can
+ only assume that field lengths of up to 250 characters are supported. This is
+ normally impractical for web based forum or content management systems. You
+ will need to be familiar with how databases handle large objects (LOBs). ADOdb
+ implements two functions, UpdateBlob( ) and UpdateClob( ) that allow you to
+ update fields holding Binary Large Objects (eg. pictures) and Character Large
+ Objects (eg. HTML articles):</p>
+<pre><font color=green># for oracle </font>
+$conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1,empty_blob())');
+$conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');
+
+<font color=green># non-oracle databases</font>
+$conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');
+$conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');
+</pre>
+<p>Null handling is another area where differences can occur. This is a mine-field,
+ because 3-value logic is tricky.
+<p>In general, I avoid using nulls except for dates and default all my numeric
+ and character fields to 0 or the empty string. This maintains consistency with
+ PHP, where empty strings and zero are treated as equivalent, and avoids SQL
+ ambiguities when you use the ANY and EXISTS operators. However if your database
+ has significant amounts of missing or unknown data, using nulls might be a good
+ idea.
+ <p>
+ ADOdb also supports a portable <a href=http://phplens.com/adodb/reference.functions.concat.html#ifnull>IfNull</a> function, so you can define what to display
+ if the field contains a null.
+<h3><b>Stored Procedures</b></h3>
+<p>Stored procedures are another problem area. Some databases allow recordsets
+ to be returned in a stored procedure (Microsoft SQL Server and Sybase), and
+ others only allow output parameters to be returned. Stored procedures sometimes
+ need to be wrapped in special syntax. For example, Oracle requires such code
+ to be wrapped in an anonymous block with BEGIN and END. Also internal sql operators
+ and functions such as +, ||, TRIM( ), SUBSTR( ) or INSTR( ) vary between vendors.
+</p>
+<p>An example of how to call a stored procedure with 2 parameters and 1 return
+ value follows:</p>
+<pre> switch ($db->databaseType) {
+ case '<font color="#993300">mssql</font>':
+ $sql = <font color="#000000"><font color="#993333">'<font color="#993300">SP_RUNSOMETHING</font>'</font></font>; break;
+ case '<font color="#993300">oci8</font>':
+ $sql =
+<font color="#993300"> </font><font color="#000000"><font color="#993300">"declare RETVAL integer;begin :RETVAL := </font><font color="#000000"><font color="#993333"><font color="#993300">SP_RUNSOMETHING</font></font></font><font color="#993300">(:myid,:group);end;";
+</font> break;</font>
+ default:
+ die('<font color="#993300">Unsupported feature</font>');
+ }
+<font color="#000000"><font color="green"> # @RETVAL = SP_RUNSOMETHING @myid,@group</font>
+ $stmt = $db->PrepareSP($sql); <br> $db->Parameter($stmt,$id,'<font color="#993300">myid</font>');
+ $db->Parameter($stmt,$group,'<font color="#993300">group</font>');
+ <font color="green"># true indicates output parameter<br> </font>$db->Parameter($stmt,$ret,'<font color="#993300">RETVAL</font>',true);
+ $db->Execute($stmt); </font></pre>
+<p>As you can see, the ADOdb API is the same for both databases. But the stored
+ procedure SQL syntax is quite different between databases and is not portable,
+ so be forewarned! However sometimes you have little choice as some systems only
+ allow data to be accessed via stored procedures. This is when the ultimate portability
+ solution might be the only solution: <i>treating portable SQL as a localization
+ exercise...</i></p>
+<h3><b>SQL as a Localization Exercise</b></h3>
+<p> In general to provide real portability, you will have to treat SQL coding
+ as a localization exercise. In PHP, it has become common to define separate
+ language files for English, Russian, Korean, etc. Similarly, I would suggest
+ you have separate Sybase, Intebase, MySQL, etc files, and conditionally include
+ the SQL based on the database. For example, each MySQL SQL statement would be
+ stored in a separate variable, in a file called 'mysql-lang.inc.php'.</p>
+<pre>$sqlGetPassword = '<font color="#993300">select password from users where userid=%s</font>';
+$sqlSearchKeyword = "<font color="#993300">SELECT * FROM articles WHERE match (title,body) against (%s</font>)";</pre>
+<p>In our main PHP file:</p>
+<pre><font color=green># define which database to load...</font>
+<b>$database = '<font color="#993300">mysql</font>';
+include_once("<font color="#993300">$database-lang.inc.php</font>");</b>
+
+$db = &NewADOConnection($database);
+$db->PConnect(...) or die('<font color="#993300">Failed to connect to database</font>');
+
+<font color=green># search for a keyword $word</font>
+$rs = $db->Execute(sprintf($sqlSearchKeyWord,$db->qstr($word)));</pre>
+<p>Note that we quote the $word variable using the qstr( ) function. This is because
+ each database quotes strings using different conventions.</p>
+<p>
+<h3>Final Thoughts</h3>
+<p>The best way to ensure that you have portable SQL is to have your data tables designed using
+sound principles. Learn the theory of normalization and entity-relationship diagrams and model
+your data carefully. Understand how joins and indexes work and how they are used to tune performance.
+<p> Visit the following page for more references on database theory and vendors:
+ <a href="http://php.weblogs.com/sql_tutorial">http://php.weblogs.com/sql_tutorial</a>.
+ Also read this article on <a href=http://phplens.com/lens/php-book/optimizing-debugging-php.php>Optimizing PHP</a>.
+<p>
+<font size=1>(c) 2002-2003 John Lim.</font>
+
+</body>
+</html>
diff --git a/framework/3rdParty/adodb/docs/tute.htm b/framework/3rdParty/adodb/docs/tute.htm new file mode 100644 index 00000000..b060a985 --- /dev/null +++ b/framework/3rdParty/adodb/docs/tute.htm @@ -0,0 +1,290 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <title>Tutorial: Moving from MySQL to ADODB</title>
+</head>
+
+<body bgcolor=white>
+<h1>Tutorial: Moving from MySQL to ADODB</h1>
+
+<pre> You say eether and I say eyether,
+ You say neether and I say nyther;
+ Eether, eyether, neether, nyther -
+ Let's call the whole thing off !
+<br>
+ You like potato and I like po-tah-to,
+ You like tomato and I like to-mah-to;
+ Potato, po-tah-to, tomato, to-mah-to -
+ Let's call the whole thing off !
+</pre>
+<p>I love this song, especially the version with Louis Armstrong and Ella singing
+ duet. It is all about how hard it is for two people in love to be compatible
+ with each other. It's about compromise and finding a common ground, and that's
+ what this article is all about.
+<p>PHP is all about creating dynamic web-sites with the least fuss and the most
+ fun. To create these websites we need to use databases to retrieve login information,
+ to splash dynamic news onto the web page and store forum postings. So let's
+ say we were using the popular MySQL database for this. Your company has done
+ such a fantastic job that the Web site is more popular than your wildest dreams.
+ You find that MySQL cannot scale to handle the workload; time to switch databases.
+<p> Unfortunately in PHP every database is accessed slightly differently. To connect
+ to MySQL, you would use <i>mysql_connect()</i>; when you decide to upgrade to
+ Oracle or Microsoft SQL Server, you would use <i>ocilogon() </i>or <i>mssql_connect()</i>
+ respectively. What is worse is that the parameters you use for the different
+ connect functions are different also.. One database says po-tato, the other
+ database says pota-to. Oh-oh.
+<h3>Let's NOT call the whole thing off</h3>
+<p>A database wrapper library such as ADODB comes in handy when you need to ensure portability. It provides
+ you with a common API to communicate with any supported database so you don't have to call things off. <p>
+
+<p>ADODB stands for Active Data Objects DataBase (sorry computer guys are sometimes
+ not very original). ADODB currently supports MySQL, PostgreSQL, Oracle, Interbase,
+ Microsoft SQL Server, Access, FoxPro, Sybase, ODBC and ADO. You can download
+ ADODB from <a href=http://php.weblogs.com/adodb></a><a href="http://php.weblogs.com/adodb">http://php.weblogs.com/adodb</a>.
+<h3>MySQL Example</h3>
+<p>The most common database used with PHP is MySQL, so I guess you should be familiar
+ with the following code. It connects to a MySQL server at <i>localhost</i>,
+ database <i>mydb</i>, and executes an SQL select statement. The results are
+ printed, one line per row.
+<pre><font color="#666600">$db = <b>mysql_connect</b>("localhost", "root", "password");
+<b>mysql_select_db</b>("mydb",$db);</font>
+<font color="#660000">$result = <b>mysql_query</b>("SELECT * FROM employees",$db)</font><code><font color="#663300">;
+if ($result === false) die("failed");</font></code>
+<font color="#006666"><b>while</b> ($fields =<b> mysql_fetch_row</b>($result)) {
+ <b>for</b> ($i=0, $max=sizeof($fields); $i < $max; $i++) {
+ <b>print</b> $fields[$i].' ';
+ }
+ <b>print</b> "<br>\n";
+}</font>
+</pre>
+<p>The above code has been color-coded by section. The first section is the connection
+ phase. The second is the execution of the SQL, and the last section is displaying
+ the fields. The <i>while</i> loop scans the rows of the result, while the <i>for</i>
+ loop scans the fields in one row.</p>
+<p>Here is the equivalent code in ADODB</p>
+<pre><b><font color="#666600"> include("adodb.inc.php");</font></b><font color="#666600">
+ $db = <b>NewADOConnection</b>('mysql');
+ $db-><b>Connect</b>("localhost", "root", "password", "mydb");</font>
+ <font color="#663300">$result = $db-><b>Execute</b>("SELECT * FROM employees");
+ </font><font color="#663300"></font><code><font color="#663300">if ($result === false) die("failed")</font></code><code><font color="#663300">;</font></code>
+ <font color="#006666"><b>while</b> (!$result->EOF) {
+ <b>for</b> ($i=0, $max=$result-><b>FieldCount</b>(); $i < $max; $i++)
+ <b>print</b> $result->fields[$i].' ';
+ $result-><b>MoveNext</b>();
+ <b>print</b> "<br>\n";
+ }</font> </pre>
+<p></p>
+<p>Now porting to Oracle is as simple as changing the second line to <code>NewADOConnection('oracle')</code>.
+ Let's walk through the code...</p>
+<h3>Connecting to the Database</h3>
+<p></p>
+<pre><b><font color="#666600">include("adodb.inc.php");</font></b><font color="#666600">
+$db = <b>NewADOConnection</b>('mysql');
+$db-><b>Connect</b>("localhost", "root", "password", "mydb");</font></pre>
+<p>The connection code is a bit more sophisticated than MySQL's because our needs
+ are more sophisticated. In ADODB, we use an object-oriented approach to managing
+ the complexity of handling multiple databases. We have different classes to
+ handle different databases. If you aren't familiar with object-oriented programing,
+ don't worry -- the complexity is all hidden away in the<code> NewADOConnection()</code>
+ function.</p>
+<p>To conserve memory, we only load the PHP code specific to the database you
+ are connecting to. We do this by calling <code>NewADOConnection(databasedriver)</code>.
+ Legal database drivers include <i>mysql, mssql, oracle, oci8, postgres, sybase,
+ vfp, access, ibase </i>and many others.</p>
+<p>Then we create a new instance of the connection class by calling <code>NewADOConnection()</code>.
+ Finally we connect to the database using <code>$db->Connect(). </code></p>
+<h3>Executing the SQL</h3>
+<p><code><font color="#663300">$result = $db-><b>Execute</b>("SELECT *
+ FROM employees");<br>
+ if ($result === false) die("failed")</font></code><code><font color="#663300">;</font></code>
+ <br>
+</p>
+<p>Sending the SQL statement to the server is straight forward. Execute() will
+ return a recordset object on successful execution. You should check $result
+ as we do above.
+<p>An issue that confuses beginners is the fact that we have two types of objects
+ in ADODB, the connection object and the recordset object. When do we use each?
+<p>The connection object ($db) is responsible for connecting to the database,
+ formatting your SQL and querying the database server. The recordset object ($result)
+ is responsible for retrieving the results and formatting the reply as text or
+ as an array.
+<p>The only thing I need to add is that ADODB provides several helper functions
+ for making INSERT and UPDATE statements easier, which we will cover in the Advanced
+ section.
+<h3>Retrieving the Data<br>
+</h3>
+<pre><font color="#006666"><b>while</b> (!$result->EOF) {
+ <b>for</b> ($i=0, $max=$result-><b>FieldCount</b>(); $i < $max; $i++)
+ <b>print</b> $result->fields[$i].' ';
+ $result-><b>MoveNext</b>();
+ <b>print</b> "<br>\n";
+}</font></pre>
+<p>The paradigm for getting the data is that it's like reading a file. For every
+ line, we check first whether we have reached the end-of-file (EOF). While not
+ end-of-file, loop through each field in the row. Then move to the next line
+ (MoveNext) and repeat.
+<p>The <code>$result->fields[]</code> array is generated by the PHP database
+ extension. Some database extensions do not index the array by field name.
+ To force indexing by name - that is associative arrays -
+ use the $ADODB_FETCH_MODE global variable.
+<pre>
+ $<b>ADODB_FETCH_MODE</b> = ADODB_FETCH_NUM;
+ $rs1 = $db->Execute('select * from table');
+ $<b>ADODB_FETCH_MODE</b> = ADODB_FETCH_ASSOC;
+ $rs2 = $db->Execute('select * from table');
+ print_r($rs1->fields); // shows <i>array([0]=>'v0',[1] =>'v1')</i>
+ print_r($rs2->fields); // shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i>
+</pre>
+<p>
+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().</p>
+<h2>ADOConnection<a name="ADOConnection"></a></h2>
+<p>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.</p>
+
+<h3>Other Useful Functions</h3>
+<p><code>$recordset->Move($pos)</code> scrolls to that particular row. ADODB supports forward
+ scrolling for all databases. Some databases will not support backwards scrolling.
+ This is normally not a problem as you can always cache records to simulate backwards
+ scrolling.
+<p><code>$recordset->RecordCount()</code> returns the number of records accessed by the
+ SQL statement. Some databases will return -1 because it is not supported.
+<p><code>$recordset->GetArray()</code> returns the result as an array.
+<p><code>rs2html($recordset)</code> is a function that is generates a HTML table based on the
+ $recordset passed to it. An example with the relevant lines in bold:
+<pre> include('adodb.inc.php');
+ <b>include('tohtml.inc.php');</b> /* includes the rs2html function */
+ $conn = &ADONewConnection('mysql');
+ $conn->PConnect('localhost','userid','password','database');
+ $rs = $conn->Execute('select * from table');
+ <b> rs2html($rs)</b>; /* recordset to html table */ </pre>
+<p>There are many other helper functions that are listed in the documentation available at <a href="http://php.weblogs.com/adodb_manual"></a><a href="http://php.weblogs.com/adodb_manual">http://php.weblogs.com/adodb_manual</a>.
+<h2>Advanced Material</h2>
+<h3>Inserts and Updates </h3>
+<p>Let's say you want to insert the following data into a database.
+<p><b>ID</b> = 3<br>
+ <b>TheDate</b>=mktime(0,0,0,8,31,2001) /* 31st August 2001 */<br>
+ <b>Note</b>= sugar why don't we call it off
+<p>When you move to another database, your insert might no longer work.</p>
+<p>The first problem is that each database has a different default date format.
+ MySQL expects YYYY-MM-DD format, while other databases have different defaults.
+ ADODB has a function called DBDate() that addresses this issue by converting
+ converting the date to the correct format.</p>
+<p>The next problem is that the <b>don't</b> in the Note needs to be quoted. In
+ MySQL, we use <b>don\'t</b> but in some other databases (Sybase, Access, Microsoft
+ SQL Server) we use <b>don''t. </b>The qstr() function addresses this issue.</p>
+<p>So how do we use the functions? Like this:</p>
+<pre>$sql = "INSERT INTO table (id, thedate,note) values ("
+ . $<b>ID</b> . ','
+ . $db->DBDate($<b>TheDate</b>) .','
+ . $db->qstr($<b>Note</b>).")";
+$db->Execute($sql);</pre>
+<p>ADODB also supports <code>$connection->Affected_Rows()</code> (returns the
+ number of rows affected by last update or delete) and <code>$recordset->Insert_ID()</code>
+ (returns last autoincrement number generated by an insert statement). Be forewarned
+ that not all databases support the two functions.<br>
+</p>
+<h3>MetaTypes</h3>
+<p>You can find out more information about each of the fields (I use the words
+ fields and columns interchangebly) you are selecting by calling the recordset
+ method <code>FetchField($fieldoffset)</code>. This will return an object with
+ 3 properties: name, type and max_length.
+<pre>For example:</pre>
+<pre>$recordset = $conn->Execute("select adate from table");<br>$f0 = $recordset->FetchField(0);
+</pre>
+<p>Then <code>$f0->name</code> will hold <i>'adata'</i>, <code>$f0->type</code>
+ will be set to '<i>date'</i>. If the max_length is unknown, it will be set to
+ -1.
+<p>One problem with handling different databases is that each database often calls
+ the same type by a different name. For example a <i>timestamp</i> type is called
+ <i>datetime</i> in one database and <i>time</i> in another. So ADODB has a special
+ <code>MetaType($type, $max_length)</code> function that standardises the types
+ to the following:
+<p>C: character and varchar types<br>
+ X: text or long character (eg. more than 255 bytes wide).<br>
+ B: blob or binary image<br>
+ D: date<br>
+ T: timestamp<br>
+ L: logical (boolean)<br>
+ I: integer<br>
+ N: numeric (float, double, money)
+<p>In the above date example,
+<p><code>$recordset = $conn->Execute("select adate from table");<br>
+ $f0 = $recordset->FetchField(0);<br>
+ $type = $recordset->MetaType($f0->type, $f0->max_length);<br>
+ print $type; /* should print 'D'</code> */
+<p>
+<p><b>Select Limit and Top Support</b>
+<p>ADODB has a function called $connection->SelectLimit($sql,$nrows,$offset) that allows
+you to retrieve a subset of the recordset. This will take advantage of native
+SELECT TOP on Microsoft products and SELECT ... LIMIT with PostgreSQL and MySQL, and
+emulated if the database does not support it.
+<p><b>Caching Support</b>
+<p>ADODB allows you to cache recordsets in your file system, and only requery the database
+server after a certain timeout period with $connection->CacheExecute($secs2cache,$sql) and
+$connection->CacheSelectLimit($secs2cache,$sql,$nrows,$offset).
+<p><b>PHP4 Session Handler Support</b>
+<p>ADODB also supports PHP4 session handlers. You can store your session variables
+ in a database for true scalability using ADODB. For further information, visit
+ <a href="http://php.weblogs.com/adodb-sessions"></a><a href="http://php.weblogs.com/adodb-sessions">http://php.weblogs.com/adodb-sessions</a>
+<h3>Commercial Use Encouraged</h3>
+<p>If you plan to write commercial PHP applications that you want to resell, you should consider ADODB. It has been released using the lesser GPL, which means you can legally include it in commercial applications, while keeping your code proprietary. Commercial use of ADODB is strongly encouraged! We are using it internally for this reason.<p>
+
+<h2>Conclusion</h2>
+<p>As a thank you for finishing this article, here are the complete lyrics for
+ <i>let's call the whole thing off</i>.<br>
+ <br>
+<pre>
+ Refrain
+<br>
+ You say eether and I say eyether,
+ You say neether and I say nyther;
+ Eether, eyether, neether, nyther -
+ Let's call the whole thing off !
+<br>
+ You like potato and I like po-tah-to,
+ You like tomato and I like to-mah-to;
+ Potato, po-tah-to, tomato, to-mah-to -
+ Let's call the whole thing off !
+<br>
+But oh, if we call the whole thing off, then we must part.
+And oh, if we ever part, then that might break my heart.
+<br>
+ So, if you like pajamas and I like pa-jah-mas,
+ I'll wear pajamas and give up pa-jah-mas.
+ For we know we
+ Need each other, so we
+ Better call the calling off off.
+ Let's call the whole thing off !
+<br>
+ Second Refrain
+<br>
+ You say laughter and I say lawfter,
+ You say after and I say awfter;
+ Laughter, lawfter, after, awfter -
+ Let's call the whole thing off !
+<br>
+ You like vanilla and I like vanella,
+ You, sa's'parilla and I sa's'parella;
+ Vanilla, vanella, choc'late, strawb'ry -
+ Let's call the whole thing off !
+<br>
+But oh, if we call the whole thing off, then we must part.
+And oh, if we ever part, then that might break my heart.
+<br>
+ So, if you go for oysters and I go for ersters,
+ I'll order oysters and cancel the ersters.
+ For we know we
+ Need each other, so we
+ Better call the calling off off.
+ Let's call the whole thing off !
+ </pre>
+<p><font size=2>Song and lyrics by George and Ira Gershwin, introduced by Fred Astaire and Ginger Rogers
+in the film "Shall We Dance?" </font><p>
+<p>
+(c)2001-2002 John Lim.
+
+</body>
+</html>
|