| blob | b2f2d69bfbf5a36f237a1a1d0ccfb8a2268eb696 |
1 <html>
2 <head>
5 <XSTYLE
6 body,td {font-family:Arial,Helvetica,sans-serif;font-size:11pt}
7 pre {font-size:9pt}
8 .toplink {font-size:8pt}
9 />
10 </head>
16 means you can use it in compiled proprietary and commercial products.</font></p>
17 <p>Useful ADOdb links: <a href=http://php.weblogs.com/adodb>Download</a> <a href=http://php.weblogs.com/adodb_manual>Other Docs</a>
31 <font size="2"><a href=#php5iterators>foreach iterators</a> <a href=#php5exceptions>exceptions</a></font><br>
38 example</a><br>
46 <br>
52 <p> <font size="2">Variables: <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> <a href=#adodb_ansi_padding_off>$ADODB_ANSI_PADDING_OFF</a>
53 <a href="#adodb_cache_dir">$ADODB_CACHE_DIR</a> </font><font size="2"><a href=#adodb_fetch_mode>$ADODB_FETCH_MODE</a>
56 </font><br>
64 <br>
65 <a href="#getone">GetOne</a>
66 <a href="#cachegetone"><i>CacheGetOne</i></a> <a href="#getrow">GetRow</a> <a href="#cachegetrow"><i>CacheGetRow</i></a>
67 <a href="#getall">GetAll</a> <a href="#cachegetall"><i>CacheGetAll</i></a> <a href="#getcol">GetCol</a>
68 <a href="#cachegetcol"><i>CacheGetCol</i></a> <a href="#getassoc1">GetAssoc</a> <a href="#cachegetassoc"><i>CacheGetAssoc</i></a> <a href="#replace">Replace</a>
69 <br>
70 <a href="#executecursor">ExecuteCursor</a>
71 (oci8 only)<br>
72 Generates SQL strings: <a href="#getupdatesql">GetUpdateSQL</a> <a href="#getinsertsql">GetInsertSQL</a>
73 <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>
77 <br>
81 Paging/Scrolling: <a href="#pageexecute">PageExecute</a> <a href="#cachepageexecute">CachePageExecute</a><br>
88 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>
89 Dates: <a href="#dbdate">DBDate</a> <a href="#dbtimestamp">DBTimeStamp</a> <a href="#unixdate">UnixDate</a>
92 Row Management: <a href="#affected_rows">Affected_Rows</a> <a href="#inserted_id">Insert_ID</a> <a href=#rowlock>RowLock</a>
93 <a href="#genid">GenID</a> <a href=#createseq>CreateSequence</a> <a href=#dropseq>DropSequence</a>
94 <br>
97 Data Dictionary (metadata): <a href="#metadatabases">MetaDatabases</a> <a href="#metatables">MetaTables</a>
102 and fnCacheExecute</a><br>
103 </font><font size="2">Deprecated: <a href="#bind">Bind</a> <a href="#blankrecordset">BlankRecordSet</a>
106 ADORecordSet</b></a><br>
115 Scrolling:<a href="#move">Move</a> <a href="#movenext">MoveNext</a> <a href="#movefirst">MoveFirst</a>
116 <a href="#movelast">MoveLast</a> <a href="#abspos">AbsolutePosition</a> <a href="#currentrow">CurrentRow</a>
122 </a>Recordset Info:<a href="#recordcount">RecordCount</a> <a href="#po_recordcount">PO_RecordSet</a>
127 <p><font size="2"><a href="#rs2html"><b>rs2html</b></a> <a href="#exrs2html">example</a></font><br>
131 </p>
133 <p>PHP's database access functions are not standardised. This creates a need for
134 a database class library to hide the differences between the different database
135 API's (encapsulate the differences) so we can easily switch databases. PHP 4.0.5 or later
136 is now required (because we use array-based str_replace).</p>
137 <p>We currently support MySQL, Oracle, Microsoft SQL Server, Sybase, Sybase SQL Anywhere, Informix,
138 PostgreSQL, FrontBase, SQLite, Interbase (Firebird and Borland variants), Foxpro, Access, ADO, DB2, SAP DB and ODBC.
139 We have had successful reports of connecting to Progress and CacheLite via ODBC. We hope more people
140 will contribute drivers to support other databases.</p>
141 <p>PHP4 supports session variables. You can store your session information using
142 ADOdb for true portability and scalability. See adodb-session.php for more information.</p>
143 <p>Also read <a href="http://php.weblogs.com/portable_sql">http://php.weblogs.com/portable_sql</a>
144 (also available as tips_portable_sql.htm in the release) for tips on writing
145 portable SQL.</p>
147 <ul>
149 are similar to Microsoft's ADO.</li>
150 <li>Unlike other PHP database classes which focus only on select statements,
151 <b>we provide support code to handle inserts and updates which can be adapted
152 to multiple databases quickly.</b> Methods are provided for date handling,
153 string concatenation and string quoting characters for differing databases.</li>
155 such as CHAR, TEXT and STRING are equivalent in different databases.</li>
157 stub functions. You do not need to port the core logic of the classes.</li>
158 <li><b>Portable table and index creation</b> with the <a href=docs-datadict.htm>datadict</a> classes.
159 <li><b>Database performance monitoring and SQL tuning</b> with the <a href=docs-perf.htm>performance monitoring</a> classes.
160 <li><b>Database-backed sessions</b> with the <a href=docs-session.htm>session management</a> classes. Supports session expiry notification.
161 </ul>
163 Here are some examples of how people are using ADOdb (for a much longer list,
164 visit <a href="http://php.weblogs.com/adodb-cool-applications">http://php.weblogs.com/adodb-cool-applications</a>):
165 <ul>
166 <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>
168 <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>
170 <li><a href="http://www.andrew.cmu.edu/~rdanyliw/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>
173 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>
175 <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>
177 <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.
178 </ul><p>
181 <p>Feature requests and bug reports can be emailed to <a href="mailto:jlim#natsoft.com.my">jlim#natsoft.com.my</a>
182 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>
185 Unpack all the files into a directory accessible by your webserver.</p>
186 <p>To test, try modifying some of the tutorial examples. Make sure you customize
187 the connection settings correctly. You can debug using <i>$db->debug = true</i> as shown below:</p>
189 include('adodb/adodb.inc.php');
191 $db->debug = true;
200 <p>For developers who want to release a minimal install of ADOdb, you will need:
201 <ul>
202 <li>adodb.inc.php
203 <li>adodb-lib.inc.php
204 <li>adodb-time.inc.php
205 <li>adodb-csvlib.inc.php (if you use cached recordsets - CacheExecute(), etc)
206 <li>adodb-error.inc.php and lang/adodb-$lang.inc.php (if you use MetaError())
207 <li>drivers/adodb-$database.inc.php
208 <li>license.txt (for legal reasons)
209 </ul>
212 <p>When running ADOdb, at least two files are loaded. First is adodb/adodb.inc.php,
213 which contains all functions used by all database classes. The code specific
214 to a particular database is in the adodb/driver/adodb-????.inc.php file.</p>
217 <pre>
218 include('/path/to/set/here/adodb.inc.php');
219 $conn = &ADONewConnection('mysql');
220 </pre>
221 <p>Whenever you need to connect to a database, you create a Connection object
225 <p>At this point, you are not connected to the database. You will first need to decide
226 whether to use <i>persistent</i> or <i>non-persistent</i> connections. The advantage of <i>persistent</i>
227 connections is that they are faster, as the database connection is never closed (even
229 reducing the risk of your database and your web-server becoming overloaded.
230 <p>For persistent connections,
232 or $conn-><a href="reference.functions.connect.html">Connect()</a> for non-persistent connections.
233 Some database drivers also support <a href="reference.functions.nconnect.html">NConnect()</a>, which forces
234 the creation of a new connection.
236 <p><i>Connection Gotcha</i>: If you create two connections, but both use the same userid and password,
237 PHP will share the same connection. This can cause problems if the connections are meant to
238 different databases. The solution is to always use different userid's for different databases,
239 or use NConnect().
243 <p>MySQL connections are very straightforward, and the parameters are identical
244 to mysql_connect:</p>
245 <pre>
246 $conn = &ADONewConnection('mysql');
247 $conn->PConnect('localhost','userid','password','database');
248 </pre>
249 <p> Most other database drivers use a similar convention: Connect($server, $user, $password, $database). Exceptions are listed below.
253 <pre>
254 $conn = &ADONewConnection('postgres7');
257 <pre>
258 $conn->PConnect('localhost','userid','password','database');
259 </pre>
261 You define the database in the $host parameter:
262 <pre>
263 $conn = &ADONewConnection('ibase');
264 $conn->PConnect('localhost:c:\ibase\employee.gdb','sysdba','masterkey');
265 </pre>
267 Sqlite will create database if it does not exist.
268 <pre>
269 $conn = &ADONewConnection('sqlite');
270 $conn->PConnect('c:\path\to\sqlite.db'); # sqlite will create if does not exist
271 </pre>
278 </pre>
287 <p>ODBC DSN's can be created in the ODBC control panel, or you can use a DSN-less
288 connection.To use DSN-less connections with ODBC you need PHP 4.3 or later.
289 </p>
291 <pre>
292 $db =& ADONewConnection('access');
293 $dsn = <strong>"Driver={Microsoft Access Driver (*.mdb)};Dbq=d:\\northwind.mdb;Uid=Admin;Pwd=;";</strong>
294 $db->Connect($dsn);
295 </pre>
296 For Microsoft SQL Server:
297 <pre>
298 $db =& ADONewConnection('odbc_mssql');
300 $db->Connect($dsn,'userid','password');
301 </pre>
303 If you are using versions of PHP earlier than PHP 4.3.0, DSN-less connections
304 only work with Microsoft's ADO, which is Microsoft's COM based API. An example
305 using the ADOdb library and Microsoft's ADO:
306 <pre>
307 <?php
308 include('adodb.inc.php');
309 $db = &ADONewConnection("ado_mssql");
310 print "<h1>Connecting DSN-less $db->databaseType...</h1>";
314 $db->Connect($myDSN);
317 $arr = $rs->GetArray();
318 print_r($arr);
319 ?>
322 <p>ADOdb is a big class library, yet it <a href=http://phplens.com/lens/adodb/>consistently beats</a> all other PHP class
323 libraries in performance. This is because it is designed in a layered fashion,
324 like an onion, with the fastest functions in the innermost layer. Stick to the
325 following functions for best performance:</p>
327 <tr>
329 </tr>
330 <tr>
332 Execute, CacheExecute<br>
333 SelectLimit, SelectLimit<br>
334 MoveNext, Close <br>
335 qstr, Affected_Rows, Insert_ID</p></td>
336 </tr>
337 </table>
340 = ADODB_FETCH_NUM, and (for oci8, ibase/firebird and odbc) <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> = false
342 <p>Consider using bind parameters if your database supports it, as it improves
343 query plan reuse. Use ADOdb's performance tuning system to identify bottlenecks
345 <p>Lastly make sure you have a PHP accelerator cache installed such as APC, Turck
346 MMCache, Zend Accelerator or ionCube.</p>
350 <p>You might want to modify ADOdb for your own purposes. Luckily you can
351 still maintain backward compatibility by sub-classing ADOdb and using the $ADODB_NEWCONNECTION
352 variable. $ADODB_NEWCONNECTION allows you to override the behaviour of ADONewConnection().
353 ADOConnection() checks for this variable and will call
354 the function-name stored in this variable if it is defined.
355 <p>In the following example, new functionality for the connection object
356 is placed in the <i>hack_mysql</i> and <i>hack_postgres7</i> classes. The recordset class naming convention
357 can be controlled using $rsPrefix. Here we set it to 'hack_rs_', which will make ADOdb use
359 If you want to use the default ADOdb drivers return false.
361 <pre>
362 class hack_mysql extends adodb_mysql {
363 var $rsPrefix = 'hack_rs_';
364 /* Your mods here */
365 }
367 class hack_rs_mysql extends ADORecordSet_mysql {
368 /* Your mods here */
369 }
371 class hack_postgres7 extends adodb_postgres7 {
372 var $rsPrefix = 'hack_rs_';
373 /* Your mods here */
374 }
376 class hack_rs_postgres7 extends ADORecordSet_postgres7 {
377 /* Your mods here */
378 }
380 $ADODB_NEWCONNECTION = 'hack_factory';
382 function& hack_factory($driver)
383 {
384 if ($driver !== 'mysql' && $driver !== 'postgres7') return false;
386 $driver = 'hack_'.$driver;
387 $obj = new $driver();
388 return $obj;
389 }
391 include_once('adodb.inc.php');
393 </pre>
394 <p>Don't forget to call the constructor of the parent class.
397 ADOdb 4.02 or later will transparently determine which version of PHP you are using.
398 If PHP5 is detected, the following features become available:
399 <ul>
402 <pre>
403 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
404 $rs = $db->Execute($sql);
405 foreach($rs as $k => $row) {
407 }
408 </pre>
409 <p>
412 catch exceptions on errors as they occur.
413 <pre>
415 include("../adodb.inc.php");
416 try {
417 $db = NewADOConnection("oci8");
418 $db->Connect('','scott','bad-password');
419 } catch (exception $e) {
420 var_dump($e);
421 }
422 </pre>
423 </ul>
433 </tr>
441 </tr>
446 DSN-less connections. For best performance, use an OLEDB provider. This
447 is the base class for all ado drivers.</font></p>
452 </tr>
457 For best performance, use an OLEDB provider.</font></td>
461 </tr>
466 For best performance, use an OLEDB provider.</font></td>
470 </tr>
475 driver.</font></td>
478 <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
479 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>
480 </tr>
488 </tr>
496 </tr>
501 to use this<br>
503 to connect. Lacks Affected_Rows currently.<br>
504 <br>
509 </tr>
517 </tr>
522 the forks differ.</font></td>
526 </tr>
531 SELECT FIRST.</font></td>
535 </tr>
543 </tr>
548 with Microsoft SQL Server 2000 also. Note that date formating is problematic
549 with this driver. For example, the PHP mssql extension does not return
550 the seconds for datetime!</font></p></td>
557 </tr>
562 mssql driver, except that '||', the concatenation operator, is converted
563 to '+'. Useful for porting scripts from most other sql variants that use
564 ||.</font></p></td>
567 <td height="73"> <p><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3"><br>
569 </tr>
574 before connecting.</font></td>
578 </tr>
583 || as the concat operator for best portability. This can be done by running
584 MySQL using: <br>
589 </tr>
594 (eg. Affected_Rows). You might have to putenv('ORACLE_HOME=...') before
596 - with server IP and service name: <br>
598 or using an entry in TNSNAMES.ORA or ONAMES or HOSTNAMES: <br>
605 </tr>
610 SelectLimit is not as efficient as in the oci8 or oci8po drivers.</font></td>
614 </tr>
619 the oci8 driver except (a) bind variables in Prepare() use the ? convention,
620 instead of :bindvar, (b) field names use the more common PHP convention
622 from other databases is important. Otherwise the oci8 driver offers better
623 performance. </font> </td>
627 </tr>
632 use <br>
633 PConnect('DSN','user','pwd'). This is the base class for all odbc derived
634 drivers.</font></td>
637 <td><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3?page=4">Unix
638 hints.</a></font></td>
639 </tr>
647 </tr>
655 </tr>
660 driver if possible for better performance.</font></td>
664 </tr>
669 driver. </font></td>
673 </tr>
678 internally.</font></td>
682 </tr>
686 <td><font size="2">PostgreSQL which supports LIMIT and other version 7 functionality.</font></td>
690 </tr>
698 </tr>
703 driver.</font></td>
707 </tr>
715 </tr>
723 </tr>
724 <p>
725 </table>
728 and used. <br>
729 A = well tested and used by many people<br>
730 B = tested and usable, but some features might not be implemented<br>
731 C = user contributed or experimental driver. Might not fully support all of
732 the latest features of ADOdb. </p>
734 return the number of rows, or returns -1 when a SELECT statement is executed.
735 If this column displays Y/N then the RecordCount() is emulated when the global
736 variable $ADODB_COUNTRECS=true (this is the default). Note that for large recordsets,
737 it might be better to disable RecordCount() emulation because substantial amounts
738 of memory are required to cache the recordset for counting. Also there is a
740 except for PostgreSQL and MySQL. This variable is checked every time a query
741 is executed, so you can selectively choose which recordsets to count.</p>
742 <p>
743 <hr>
747 row.</p>
748 <p>In this example, we create a ADOConnection object, which represents the connection
749 to the database. The connection is initiated with <a href="#pconnect"><font face="Courier New, Courier, mono">PConnect</font></a>,
750 which is a persistent connection. Whenever we want to query the database, we
751 call the <font face="Courier New, Courier, mono">ADOConnection.<a href="#execute">Execute</a>()</font>
752 function. This returns an ADORecordSet object which is actually a cursor that
755 to move from row to row.</p>
756 <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>,
757 which allows us to limit the number of rows shown.
758 <pre>
759 <?
760 <font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb
762 $<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind DSN
763 $<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select * from products');
766 else
768 <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';
774 </font>
775 ?>
776 </pre>
779 array, indexed by column number (starting from zero). We use the <font face="Courier New, Courier, mono"><a href="#movenext">MoveNext</a>()</font>
781 property is set to true when end-of-file is reached. If an error occurs in Execute(),
782 we return false instead of a recordset.</p>
784 extension. Some database extensions only index by number and do not index the
785 array by field name. To force indexing by name - that is associative arrays
786 - use the SetFetchMode function. Each recordset saves and uses whatever fetch
787 mode was set when the recordset was created in Execute() or SelectLimit().
788 <pre>
789 $db->SetFetchMode(ADODB_FETCH_NUM);
790 $rs1 = $db->Execute('select * from table');
791 $db->SetFetchMode(ADODB_FETCH_ASSOC);
792 $rs2 = $db->Execute('select * from table');
795 </pre>
796 <p> </p>
797 <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>.
800 <p>Select a table, display the first two columns. If the second column is a date
801 or timestamp, reformat the date to US format.</p>
802 <pre>
803 <?
804 <font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb
806 $<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn
807 $<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select CustomerID,OrderDate from Orders');
810 else
812 $<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>
813 $<font color="#660000">type</font> = <font color="#336600"><b>$</b><font color="#660000">recordSet</font><b>->MetaType</b></font>($fld->type);
815 <b>if</b> ( $<font color="#660000">type</font> == 'D' || $<font color="#660000">type</font> == 'T')
817 <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>';
819 <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';
825 </font>
826 ?>
827 </pre>
828 <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>
830 <ul>
834 do not return the maximum length of the field correctly. In these cases max_length
836 </ul>
837 <p>We then use <font face="Courier New, Courier, mono"><a href="#metatype">MetaType</a>()</font>
840 <ul>
842 tag.</li>
850 real and integer. </li>
852 for selected databases. </li>
853 </ul>
854 <p>If the metatype is of type date or timestamp, then we print it using the user
855 defined date format with <font face="Courier New, Courier, mono"><a href="#userdate">UserDate</a>(),</font>
856 which converts the PHP SQL date string format to a user defined one. Another
858 is data validation before doing an SQL insert or update.</p>
860 <p>Insert a row to the Orders table containing dates and strings that need to
861 be quoted before they can be accepted by the database, eg: the single-quote
863 <pre>
864 <?
868 $<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn
869 $<font color="#660000">shipto</font> = <font color="#006600"><b>$conn->qstr</b></font>("<i>John's Old Shoppe</i>");
871 $<font color="#660000">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
872 $<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>)";
874 <b>if</b> ($<font color="#660000">conn</font>->Execute($<font color="#660000">sql</font>) <font color="#336600"><b>=== false</b></font>) {
875 <b>print</b> 'error inserting: '.<font color="#336600"><b>$conn->ErrorMsg()</b></font>.'<BR>';
876 }
877 ?>
878 </pre>
879 <p>In this example, we see the advanced date and quote handling facilities of
880 ADOdb. The unix timestamp (which is a long integer) is appropriately formated
885 </p>
886 <p>Observe the error-handling of the Execute statement. False is returned by<font face="Courier New, Courier, mono">
888 for the last error that occurred is displayed in <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font>.
890 be saved.</p>
895 $<font color="#663300">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn
896 <font color="#000000">$<font color="#663300">shipto</font> = <b>$conn->qstr</b>("John's Old Shoppe");
897 $<font color="#663300">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
898 $<font color="#663300">sql</font> .= "values ('ANATR',2,".$<font color="#663300">conn</font>->FormatDate(time()).",$shipto)";
900 <b>if</b> ($<font color="#663300">conn</font>->Execute($sql) <b>=== false</b>) <b>print</b> 'error inserting';</font>
901 ?>
902 </pre>
904 This will display the SQL statement before execution, and also show any error
905 messages. There is no need to call <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font>
906 in this case. For displaying the recordset, see the <font face="Courier New, Courier, mono"><a href="#exrs2html">rs2html</a>()
916 $<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
917 <font color="#000000">$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';
919 <b>print</b> <b><font color="#336600">$<font color="#663300">rs</font>->GetMenu('GetCust','Mary Rosli');
921 <p>Here we define a menu named GetCust, with the menu option 'Mary Rosli' selected.
922 See <a href="#getmenu"><font face="Courier New, Courier, mono">GetMenu</font></a><font face="Courier New, Courier, mono">()</font>.
923 We also have functions that return the recordset as an array: <font face="Courier New, Courier, mono"><a href="#getarray">GetArray</a>()</font>,
924 and as an associative array with the key being the first column: <a href="#getassoc1">GetAssoc</a>().</p>
928 $<font color="#663300">conn1</font> = &ADONewConnection('mysql'); # create a mysql connection
929 $<font color="#663300">conn2</font> = &ADONewConnection('oracle'); # create a oracle connection
931 $conn1->PConnect($server, $userid, $password, $database);
932 $conn2->PConnect(false, $ora_userid, $ora_pwd, $oraname);
934 $conn1->Execute('insert ...');
935 $conn2->Execute('update ...');
937 <p>
939 ADOdb 1.31 and later supports two new recordset functions: GetUpdateSQL( ) and
940 GetInsertSQL( ). This allow you to perform a "SELECT * FROM table query WHERE...",
941 make a copy of the $rs->fields, modify the fields, and then generate the SQL to
942 update or insert into the table automatically.
943 <p> We show how the functions can be used when accessing a table with the following
944 fields: (ID, FirstName, LastName, Created).
945 <p> Before these functions can be called, you need to initialize the recordset
946 by performing a select on the table. Idea and code by Jonathan Younger jyounger#unilab.com.
947 <p>
949 #==============================================
950 # SAMPLE GetUpdateSQL() and GetInsertSQL() code
951 #==============================================
952 include('adodb.inc.php');
953 include('tohtml.inc.php');
955 #==========================
956 # This code tests an insert
958 $sql = "SELECT * FROM ADOXYZ WHERE id = -1";
959 # Select an empty record from the database
961 $conn = &ADONewConnection("mysql"); # create a connection
964 $rs = $conn->Execute($sql); # Execute the query and get the empty recordset
966 $record = array(); # Initialize an array to hold the record data to insert
968 # Set the values for the fields in the record
969 # Note that field names are case-insensitive
972 $record["creaTed"] = time();
974 # Pass the empty recordset and the array containing the data to insert
975 # into the GetInsertSQL function. The function will process the data and return
976 # a fully formatted insert sql statement.
977 $insertSQL = $conn->GetInsertSQL($rs, $record);
979 $conn->Execute($insertSQL); # Insert the record into the database
981 #==========================
982 # This code tests an update
984 $sql = "SELECT * FROM ADOXYZ WHERE id = 1";
985 # Select a record to update
987 $rs = $conn->Execute($sql); # Execute the query and get the existing record to update
989 $record = array(); # Initialize an array to hold the record data to update
991 # Set the values for the fields in the record
992 # Note that field names are case-insensitive
996 # Pass the single record recordset and the array containing the data to update
997 # into the GetUpdateSQL function. The function will process the data and return
998 # a fully formatted update sql statement with the correct WHERE clause.
999 # If the data has not changed, no recordset is returned
1000 $updateSQL = $conn->GetUpdateSQL($rs, $record);
1002 $conn->Execute($updateSQL); # Update the record in the database
1003 $conn->Close();
1004 ?>
1005 </pre>
1007 <p> The following code creates a very simple recordset pager, where you can scroll
1008 from page to page of a recordset.</p>
1009 <pre>
1010 include_once('../adodb.inc.php');
1011 include_once('../adodb-pager.inc.php');
1012 session_start();
1014 $db = NewADOConnection('mysql');
1016 $db->Connect('localhost','root','','xphplens');
1018 $sql = "select * from adoxyz ";
1020 $pager = new ADODB_Pager($db,$sql);
1023 <p>
1025 <tr>
1029 </tr>
1030 <tr>
1036 <TR>
1041 </TR>
1042 <TR>
1047 </TR>
1048 <TR>
1053 </TR>
1054 <TR>
1059 </TR>
1060 <TR>
1065 </TR>
1066 </TABLE></td>
1067 </tr>
1068 <tr>
1070 </tr>
1071 </table>
1072 <p>The number of rows to display at one time is controled by the Render($rows)
1073 method. If you do not pass any value to Render(), ADODB_Pager will default to
1074 10 records per page.
1075 <p>You can control the column titles by modifying your SQL (supported by most
1076 databases):
1078 lastname as "Last Name", created as "Date Created" <br> from adoxyz';</pre>
1081 The ADODB_Pager code can be adapted by a programmer so that the text links can
1082 be replaced by images, and the dull white background be replaced with more interesting
1083 colors.
1086 G. </p>
1088 <p>We provide some helper functions to export in comma-separated-value (CSV) and
1089 tab-delimited formats:</p>
1090 <pre><b>include_once('/path/to/adodb/toexport.inc.php');</b><br>include_once('/path/to/adodb/adodb.inc.php');<br>
1091 $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');
1093 print "<pre>";<br>print <b>rs2csv</b>($rs); # return a string, CSV format<p>print '<hr>';
1094 <br>$rs->MoveFirst(); # note, some databases do not support MoveFirst<br>print <b>rs2tab</b>($rs,<i>false</i>); # return a string, tab-delimited
1095 # 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)
1099 if ($fp) {<br> <b>rs2csvfile</b>($rs, $fp); # write to file (there is also an rs2tabfile function)
1100 fclose($fp);<br>}
1101 </pre>
1102 <p> Carriage-returns or newlines are converted to spaces. Field names are returned
1103 in the first line of text. Strings containing the delimiter character are quoted
1104 with double-quotes. Double-quotes are double-quoted again. This conforms to
1105 Excel import and export guide-lines.
1106 <p>All the above functions take as an optional last parameter, $addtitles which
1108 are suppressed. <br>
1110 <p>Sometimes we want to pre-process all rows in a recordset before we use it.
1111 For example, we want to ucwords all text in recordset.
1112 <pre>
1113 include_once('adodb/rsfilter.inc.php');
1114 include_once('adodb/adodb.inc.php');
1116 // ucwords() every element in the recordset
1117 function do_ucwords(&$arr,$rs)
1118 {
1120 $arr[$k] = ucwords($v);
1121 }
1122 }
1124 $db = NewADOConnection('mysql');
1125 $db->PConnect('server','user','pwd','db');
1127 $rs = $db->Execute('select ... from table');
1129 </pre>
1133 row as an array, and the recordset object. For future compatibility, you should
1134 not use the original recordset object. </p>
1136 The old way of doing transactions required you to use
1137 <pre>
1139 $ok = $conn->Execute($sql);
1140 if ($ok) $ok = $conn->Execute($sql2);
1143 </pre>
1144 This is very complicated for large projects because you have to track the error
1145 status. Smart Transactions is much simpler. You start a smart transaction by calling
1146 StartTrans():
1147 <pre>
1149 $conn->Execute($sql);
1150 $conn->Execute($Sql2);
1152 </pre>
1153 CompleteTrans() detects when an SQL error occurs, and will Rollback/Commit as
1154 appropriate. To specificly force a rollback even if no error occured, use FailTrans().
1155 Note that the rollback is done in CompleteTrans(), and not in FailTrans().
1156 <pre>
1158 $conn->Execute($sql);
1160 $conn->Execute($Sql2);
1162 </pre>
1163 <p>You can also check if a transaction has failed, using HasFailedTrans(), which
1164 returns true if FailTrans() was called, or there was an error in the SQL execution.
1165 Make sure you call HasFailedTrans() before you call CompleteTrans(), as it is
1166 only works between StartTrans/CompleteTrans.
1167 <p>Lastly, StartTrans/CompleteTrans is nestable, and only the outermost block
1168 is executed. In contrast, BeginTrans/CommitTrans/RollbackTrans is NOT nestable.
1169 <pre>
1171 $conn->Execute($sql);
1173 if (!CheckRecords()) $conn->FailTrans();
1175 $conn->Execute($Sql2);
1177 </pre>
1178 <p>Note: Savepoints are currently not supported.
1181 another way of handling errors using ADOdb's custom error handlers.
1182 <p> ADOdb provides two custom handlers which you can modify for your needs. The
1185 to control what error messages types to display, and <a href=http://php.net/trigger_error>trigger_error</a>
1186 which invokes the default PHP error handler.
1188 to be called when<br>
1189 (a) Connect() or PConnect() fails, or <br>
1190 (b) a function that executes SQL statements such as Execute() or SelectLimit()
1191 has an error.<br>
1192 (c) GenID() appears to go into an infinite loop.
1193 <p> The $errorstring is generated by ADOdb and will contain useful debugging information
1194 similar to the error.log data generated below. This file adodb-errorhandler.inc.php
1195 should be included before you create any ADOConnection objects.
1197 If you set error_reporting(E_ALL), all errors will be passed to the error handler.
1199 the display of errors.
1200 <pre>
1201 <?php
1202 <b>error_reporting(E_ALL); # pass any error messages triggered to error handler
1203 include('adodb-errorhandler.inc.php');</b>
1204 include('adodb.inc.php');
1205 include('tohtml.inc.php');
1206 $c = NewADOConnection('mysql');
1207 $c->PConnect('localhost','root','','northwind');
1208 $rs=$c->Execute('select * from productsz'); #invalid table productsz');
1209 if ($rs) rs2html($rs);
1210 ?>
1211 </pre>
1212 <p> If you want to log the error message, you can do so by defining the following
1213 optional constants ADODB_ERROR_LOG_TYPE and ADODB_ERROR_LOG_DEST. ADODB_ERROR_LOG_TYPE
1215 in the PHP manual). In this case we set it to 3, which means log to the file
1216 defined by the constant ADODB_ERROR_LOG_DEST.
1217 <pre>
1218 <?php
1219 <b>error_reporting(E_ALL); # report all errors
1221 define('ADODB_ERROR_LOG_TYPE',3);
1222 define('ADODB_ERROR_LOG_DEST','C:/errors.log');
1223 include('adodb-errorhandler.inc.php');</b>
1224 include('adodb.inc.php');
1225 include('tohtml.inc.php');
1227 $c = NewADOConnection('mysql');
1228 $c->PConnect('localhost','root','','northwind');
1229 $rs=$c->Execute('select * from productsz'); ## invalid table productsz
1230 if ($rs) rs2html($rs);
1231 ?>
1232 </pre>
1233 The following message will be logged in the error.log file:
1234 <pre>
1236 EXECUTE("select * from productsz")
1237 </pre>
1239 PEAR_Error derived object whenever an error occurs. The last PEAR_Error object
1240 created can be retrieved using ADODB_Pear_Error().
1241 <pre>
1242 <?php
1244 include('adodb.inc.php');
1245 include('tohtml.inc.php');
1246 $c = NewADOConnection('mysql');
1247 $c->PConnect('localhost','root','','northwind');
1248 $rs=$c->Execute('select * from productsz'); #invalid table productsz');
1249 if ($rs) rs2html($rs);
1250 else {
1251 <b>$e = ADODB_Pear_Error();
1253 }
1254 ?>
1255 </pre>
1256 <p> You can use a PEAR_Error derived class by defining the constant ADODB_PEAR_ERROR_CLASS
1257 before the adodb-errorpear.inc.php file is included. For easy debugging, you
1258 can set the default error handler in the beginning of the PHP script to PEAR_ERROR_DIE,
1259 which will cause an error message to be printed, then halt script execution:
1260 <pre>
1261 include('PEAR.php');
1262 PEAR::setErrorHandling('PEAR_ERROR_DIE');
1263 </pre>
1264 <p> Note that we do not explicitly return a PEAR_Error object to you when an error
1265 occurs. We return false instead. You have to call ADODB_Pear_Error() to get
1266 the last error or use the PEAR_ERROR_DIE technique.
1268 <p>Error messages are outputted using the static method ADOConnnection::outp($msg,$newline=true).
1269 By default, it sends the messages to the client. You can override this to perform
1270 error-logging.
1272 <p>We now support connecting using PEAR style DSN's. A DSN is a connection string
1273 of the form:</p>
1276 <pre> include_once('../adodb/adodb-pear.inc.php');
1277 $username = 'root';
1278 $password = '';
1279 $hostname = 'localhost';
1280 $databasename = 'xphplens';
1281 $driver = 'mysql';
1283 <pre> $db = DB::Connect($dsn);<br> $rs = $db->Execute('select firstname,lastname from adoxyz');
1284 $cnt = 0;
1285 while ($arr = $rs->FetchRow()) {
1287 }</pre>
1290 <p>ADOdb now supports caching of recordsets using the CacheExecute( ), CachePageExecute(
1291 ) and CacheSelectLimit( ) functions. There are similar to the non-cache functions,
1292 except that they take a new first parameter, $secs2cache.
1293 <p> An example:
1294 <pre>
1296 $ADODB_CACHE_DIR = '/usr/ADODB_cache';
1298 $<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
1299 <font color="#000000">$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';
1300 $<font color="#663300">rs</font> = $<font color="#663300">conn</font>->CacheExecute(15,$sql);</font></pre>
1302 the query. Subsequent calls to that query will used the cached version stored
1303 in $ADODB_CACHE_DIR. To force a query to execute and flush the cache, call CacheExecute()
1304 with the first parameter set to zero. Alternatively, use the CacheFlush($sql)
1305 call. </font></p>
1306 <p><font color="#000000">For the sake of security, we recommend you set <i>register_globals=off</i>
1307 in php.ini if you are using $ADODB_CACHE_DIR.</font></p>
1309 and CacheExecute(). If you leave it out, it will use the $connection->cacheSecs
1310 parameter, which defaults to 60 minutes.
1311 <pre>
1312 $conn->Connect(...);
1314 $rs = $conn->CacheExecute('select * from table');
1315 </pre>
1316 <p>Please note that magic_quotes_runtime should be turned off. <a href=http://phplens.com/lens/lensforum/msgs.php?LeNs#LensBM_forummsg>More
1320 SQL to create pivot tables, also known as cross-tabulations. For further explanation
1322 tutorial. We assume that your database supports the SQL case-when expression. </font></p>
1324 <p>In this example, we will use the Northwind database from Microsoft. In the
1325 database, we have a products table, and we want to analyze this table by <i>suppliers
1326 versus product categories</i>. We will place the suppliers on each row, and
1327 pivot on categories. So from the table on the left, we generate the pivot-table
1328 on the right:</p>
1329 </font>
1331 <tr>
1332 <td>
1334 <tr>
1337 </tr>
1338 <tr>
1341 </tr>
1342 <tr>
1345 </tr>
1346 <tr>
1349 </tr>
1350 </table>
1351 </td>
1353 <td>
1355 <tr>
1360 </tr>
1361 <tr>
1366 </tr>
1367 <tr>
1372 </tr>
1373 </table>
1374 </td>
1375 </tr>
1376 </table>
1378 <p>The following code will generate the SQL for a cross-tabulation:
1379 <pre>
1380 # Query the main "product" table
1381 # Set the rows to CompanyName
1382 # and the columns to the values of Categories
1383 # and define the joins to link to lookup tables
1385 #
1387 $sql = PivotTableSQL(
1388 $gDB, # adodb connection
1389 'products p ,categories c ,suppliers s', # tables
1390 'CompanyName', # rows (multiple fields allowed)
1391 'CategoryName', # column to pivot on
1392 'p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID' # joins/where
1393 );
1394 </pre>
1395 </font>
1399 <br>
1401 <br>
1403 <br>
1407 <br>
1409 <br>
1411 <br>
1413 <br>
1415 FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID
1416 and s.SupplierID= p.SupplierID <br>
1417 GROUP BY CompanyName</font></code></p>
1421 <pre>
1422 $sql = PivotTableSQL(
1423 $gDB, # adodb connection
1424 'products p ,categories c ,suppliers s', # tables
1426 array( # column ranges
1432 ),
1433 ' p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID', # joins/where
1434 'UnitsInStock', # sum this field
1435 'Sum ' # sum label prefix
1436 );
1437 </pre>
1452 FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID
1453 and s.SupplierID= p.SupplierID <br>
1455 </font> </p>
1459 </font>
1462 <p>If the database driver API does not support counting the number of records
1463 returned in a SELECT statement, the function RecordCount() is emulated when
1464 the global variable $ADODB_COUNTRECS is set to true, which is the default.
1465 We emulate this by buffering the records, which can take up large amounts
1466 of memory for big recordsets. Set this variable to false for the best performance.
1467 This variable is checked every time a query is executed, so you can selectively
1468 choose which recordsets to count.</p>
1471 <p>If you are using recordset caching, this is the directory to save your recordsets
1472 in. Define this before you call any caching functions such as CacheExecute(
1474 feature for security reasons.</p>
1475 <p>If you are using Unix and apache, you might need to set your cache directory
1476 permissions to something similar to the following:</p>
1477 </font>
1479 chgrp -R apache /path/to/adodb/cache </p>
1482 <p>Determines whether to right trim CHAR fields (and also VARCHAR for ibase/firebird).
1483 Set to true to trim. Default is false. Currently works for oci8po, ibase and firebird
1484 drivers. Added in ADOdb 4.01.
1486 <p>Determines the language used in MetaErrorMsg(). The default is 'en', for English.
1487 To find out what languages are supported, see the files
1488 in adodb/lang/adodb-$lang.inc.php, where $lang is the supported langauge.
1490 <p>This is a global variable that determines how arrays are retrieved by recordsets.
1491 The recordset saves this value on creation (eg. in Execute( ) or SelectLimit(
1492 )), and any subsequent changes to $ADODB_FETCH_MODE have no affect on existing
1493 recordsets, only on recordsets created in the future.</p>
1495 </font>
1501 <p> An example:
1502 <pre>
1504 $rs1 = $db->Execute('select * from table');
1506 $rs2 = $db->Execute('select * from table');
1509 </pre>
1510 <p> As you can see in the above example, both recordsets store and use different
1511 fetch modes based on the $ADODB_FETCH_MODE setting when the recordset was
1512 created by Execute().</p>
1513 <p>If no fetch mode is predefined, the fetch mode defaults to ADODB_FETCH_DEFAULT.
1514 The behaviour of this default mode varies from driver to driver, so do not
1515 rely on ADODB_FETCH_DEFAULT. For portability, we recommend sticking to ADODB_FETCH_NUM
1516 or ADODB_FETCH_ASSOC. Many drivers do not support ADODB_FETCH_BOTH.</p>
1518 <p>Some programmers prefer to use a more object-oriented solution, where the fetch
1520 Once this function is called for a connection object, that connection object
1521 will ignore the global variable $ADODB_FETCH_MODE and will use the internal
1522 fetchMode property exclusively.</p>
1523 <pre>
1524 $db->SetFetchMode(ADODB_FETCH_NUM);
1525 $rs1 = $db->Execute('select * from table');
1526 $db->SetFetchMode(ADODB_FETCH_ASSOC);
1527 $rs2 = $db->Execute('select * from table');
1531 property, or use the return value of SetFetchMode( ).
1533 <p>You can control the associative fetch case for certain drivers which behave
1534 differently. For the sybase, oci8po, mssql, odbc and ibase drivers and all
1535 drivers derived from them, ADODB_ASSOC_CASE will by default generate recordsets
1536 where the field name keys are lower-cased. Use the constant ADODB_ASSOC_CASE
1544 include('adodb.inc.php'); </p>
1545 <hr>
1547 <p>Object that performs the connection to the database, executes SQL statements
1548 and has a set of utility functions for standardising the format of SQL statements
1549 for issues such as concatenation and date formats.</p>
1557 will hold the ado data provider.</p>
1559 reasons.</p>
1560 <p><b>raiseErrorFn</b>: Allows you to define an error handling function. See adodb-errorhandler.inc.php
1561 for an example.</p>
1566 function to send dates to the database. is '#Y-m-d#' for Microsoft Access,
1567 and ''Y-m-d'' for MySQL.</p>
1569 function to send timestamps to the database. </p>
1571 Microsoft SQL.</p>
1573 for Microsoft SQL.</p>
1577 true.</p>
1579 this.</p>
1581 supports this.</p>
1588 to get the current date. Useful for inserts and updates.</p>
1590 call to get the current timestamp/datetime value.</p>
1592 Otherwise set to false.</p>
1594 Otherwise set to false.</p>
1598 in connects as the SID for the oci8 driver. Defaults to false. Useful for
1601 ) if this is set to true. Default is false.</p>
1602 <hr>
1611 <p>ADO Note: If you are using a Microsoft ADO and not OLEDB, you can set the $database
1612 parameter to the OLEDB data provider you are using.</p>
1613 <p>PostgreSQL: An alternative way of connecting to the database is to pass the
1614 standard PostgreSQL connection string in the first parameter $host, and the
1615 other parameters will be ignored.</p>
1616 <p>For Oracle and Oci8, there are two ways to connect. First is to use the TNS
1617 name defined in your local tnsnames.ora (or ONAMES or HOSTNAMES). Place the
1618 name in the $database field, and set the $host field to false. Alternatively,
1619 set $host to the server, and $database to the database SID, this bypassed
1620 tnsnames.ora.
1621 <p>Examples:
1622 <pre> # $oraname in tnsnames.ora/ONAMES/HOSTNAMES
1623 $conn->Connect(false, 'scott', 'tiger', $oraname);
1625 <p>There are many examples of connecting to a database at <a href="http://php.weblogs.com/adodb">php.weblogs.com/ADOdb</a>,
1626 and in the testdatabases.inc.php file included in the release.</p>
1631 <p>We now perform a rollback on persistent connection for selected databases since
1632 2.21, as advised in the PHP manual. See change log or source code for which
1633 databases are affected.
1636 </font>
1638 $conn->autoRollback = true; # default is false
1640 <p> Then when doing a persistent connection with PConnect( ), ADOdb will
1641 perform a rollback first. This is because it is documented that PHP is
1642 not guaranteed to rollback existing failed transactions when
1643 persistent connections are used. This is implemented in Oracle,
1644 MySQL, PgSQL, MSSQL, ODBC currently.
1646 connections even if PConnect is called by defining the constant
1647 ADODB_NEVER_PERSIST before you call PConnect.
1649 <p>Always force a new connection. In contrast, PHP sometimes reuses connections
1650 when you use Connect() or PConnect(). Currently works only on mysql (PHP 4.3.0
1651 or later), postgresql and oci8-derived drivers. For other drivers, NConnect() works like
1652 Connect().
1656 if successful. Note that a record set is always returned on success, even
1657 if we are executing an insert or update statement. You can also pass in $sql a statement prepared
1659 <p>Returns derived class of ADORecordSet. Eg. if connecting via mysql, then ADORecordSet_mysql
1660 would be returned. False is returned if there was an error in executing the
1661 sql.</p>
1662 <p>The $inputarr parameter can be used for binding variables to parameters. Below
1663 is an Oracle example:</p>
1664 <pre>
1666 </pre>
1668 <pre>
1670 </pre>
1673 Variable binding speeds the compilation and caching of SQL statements, leading
1674 to higher performance. Currently Oracle, Interbase and ODBC supports variable binding.
1675 Interbase/ODBC style ? binding is emulated in databases that do not support binding.
1676 Note that you do not have to quote strings if you use binding.
1677 <p> Variable binding in the odbc, interbase and oci8po drivers.
1678 <pre>
1680 </pre>
1681 Variable binding in the oci8 driver:
1682 <pre>
1683 $rs = $db->Execute('select name from table where val=:key',
1685 </pre>
1688 <p>Since ADOdb 3.80, we support bulk binding in Execute(), in which you pass in a 2-dimensional array to
1689 be bound to an INSERT/UPDATE or DELETE statement.
1690 <pre>
1691 $arr = array(
1692 array('Ahmad',32),
1693 array('Zulkifli', 24),
1694 array('Rosnah', 21)
1695 );
1696 $ok = $db->Execute('insert into table (name,age) values (?,?)',$arr);
1697 </pre>
1698 <p>This provides very high performance as the SQL statement is prepared first.
1699 The prepared statement is executed repeatedly for each array row until all rows are completed,
1700 or until the first error. Very useful for importing data.
1703 <p>Similar to Execute, except that the recordset is cached for $secs2cache seconds
1704 in the $ADODB_CACHE_DIR directory, and $inputarr only accepts 1-dimensional arrays.
1705 If CacheExecute() is called again with the same $sql, $inputarr,
1706 and also the same database, same userid, and the cached recordset
1707 has not expired, the cached recordset is returned.
1708 <pre>
1709 include('adodb.inc.php');
1710 include('tohtml.inc.php');
1712 $conn = &ADONewConnection('mysql');
1713 $conn->PConnect('localhost','userid','password','database');
1715 rs2html($rs); /* recordset to html table */
1716 </pre>
1720 $rs = $conn->CacheExecute('select * from table');
1721 </pre>
1722 If $secs2cache is omitted, we use the value
1724 only with SELECT statements.
1725 <p>Performance note: I have done some benchmarks and found that they vary so greatly
1726 that it's better to talk about when caching is of benefit. When your database
1728 overloaded </i>then ADOdb's caching is good because it reduces the load on
1729 your database server. If your database server is lightly loaded or much faster
1730 than your Web server, then caching could actually reduce performance. </p>
1731 <p><b>ExecuteCursor<a name="executecursor"></a>($sql,$cursorName='rs',$parameters=false)</b></p>
1732 <p>Execute an Oracle stored procedure, and returns an Oracle REF cursor variable as
1733 a regular ADOdb recordset. Does not work with any other database except oci8.
1734 Thanks to Robert Tuttle for the design.
1735 <pre>
1736 $db = ADONewConnection("oci8");
1739 'cursorvar',
1742 <p>ExecuteCursor() is a helper function that does the following internally:
1743 <pre>
1747 <p><b>SelectLimit<a name="selectlimit"></a>($sql,$numrows=-1,$offset=-1,$inputarr=false)</b></p>
1748 <p>Returns a recordset if successful. Returns false otherwise. Performs a select
1749 statement, simulating PostgreSQL's SELECT statement, LIMIT $numrows OFFSET
1750 $offset clause.</p>
1753 This functionality is simulated for databases that do not possess this feature.</p>
1755 after record 2, return 3 rows). The equivalent in ADOdb is <code>$connection->SelectLimit('SELECT
1760 <p>The last parameter $inputarr is for databases that support variable binding
1761 such as Oracle oci8. This substantially reduces SQL compilation overhead.
1762 Below is an Oracle example:</p>
1763 <pre>
1765 </pre>
1766 <p>The oci8po driver (oracle portable driver) uses the more standard bind variable
1767 of ?:
1768 <pre>
1770 </pre>
1771 <p>
1772 <p>Ron Wilson reports that SelectLimit does not work with UNIONs.
1773 <p><b>CacheSelectLimit<a name="cacheselectlimit"></a>([$secs2cache,] $sql, $numrows=-1,$offset=-1,$inputarr=false)</b></p>
1774 <p>Similar to SelectLimit, except that the recordset returned is cached for $secs2cache
1775 seconds in the $ADODB_CACHE_DIR directory. </p>
1778 </font>
1784 <p>Flush (delete) any cached recordsets for the SQL statement $sql in $ADODB_CACHE_DIR.
1785 <p>If no parameter is passed in, then all adodb_*.cache files are deleted.
1786 <p> If you want to flush all cached recordsets manually, execute the following
1787 PHP code (works only under Unix): <br>
1790 <p>For general cleanup of all expired files, you should use <a href="http://www.superscripts.com/tutorial/crontab.html">crontab</a>
1791 on Unix, or at.exe on Windows, and a shell script similar to the following:<font face="Courier New, Courier, mono"><br>
1792 #------------------------------------------------------ <br>
1793 # This particular example deletes files in the TMPPATH <br>
1796 #------------------------------------------------------ <br>
1799 </font> </p>
1801 <p>Returns a virtualized error number, based on PEAR DB's error number system. You might
1802 need to include adodb-error.inc.php before you call this function. The parameter $errno
1803 is the native error number you want to convert. If you do not pass any parameter, MetaError
1804 will call ErrorNo() for you and convert it. If the error number cannot be virtualized, MetaError
1810 <p>Returns the last status or error message. The error message is reset after every
1811 call to Execute().
1812 <p>
1813 This can return a string even if
1814 no error occurs. In general you do not need to call this function unless an
1815 ADOdb function returns false on an error. </p>
1819 <p>Returns the last error number. The error number is reset after every call to Execute().
1820 If 0 is returned, no error occurred.
1821 <p>
1822 Note that old versions of PHP (pre 4.0.6) do
1823 not support error number for ODBC. In general you do not need to call this
1824 function unless an ADOdb function returns false on an error.</p>
1825 </font>
1828 it in $db->fetchMode. Legal modes are ADODB_FETCH_ASSOC and ADODB_FETCH_NUM.
1831 if SetFetchMode( ) has not been called before.</font></p>
1834 <p>Create a sequence. The next time GenID( ) is called, the value returned will
1835 be $startID. Added in 2.60.
1839 <p>Generate a sequence number . Works for interbase,
1840 mysql, postgresql, oci8, oci8po, mssql, ODBC based (access,vfp,db2,etc) drivers
1841 currently. Uses $seqName as the name of the sequence. GenID() will automatically
1842 create the sequence for you if it does not exist (provided the userid has
1843 permission to do so). Otherwise you will have to create the sequence yourself.
1844 <p> If your database driver emulates sequences, the name of the table is the sequence
1845 name. The table has one column, "id" which should be of type integer, or if
1846 you need something larger - numeric(16).
1847 <p> For ODBC and databases that do not support sequences natively (eg mssql, mysql),
1848 we create a table for each sequence. If the sequence has not been defined
1849 earlier, it is created with the starting value set in $startID.</p>
1852 Allows you to store a blob (in $val) into $table into $column in a row at $where.
1853 <p> Usage:
1854 <p>
1855 <pre>
1856 # for oracle
1860 # non oracle databases
1863 </pre>
1864 <p> Returns true if succesful, false otherwise. Supported by MySQL, PostgreSQL,
1865 Oci8, Oci8po and Interbase drivers. Other drivers might work, depending on
1866 the state of development.</p>
1867 <p>Note that when an Interbase blob is retrieved using SELECT, it still needs
1868 to be decoded using $connection->DecodeBlob($blob); to derive the original
1869 value in versions of PHP before 4.1.0.
1870 <p>For PostgreSQL, you can store your blob using blob oid's or as a bytea field.
1871 You can use bytea fields but not blob oid's currently with UpdateBlob( ).
1872 Conversely UpdateBlobFile( ) supports oid's, but not bytea data.<br>
1873 <br>
1874 If you do not pass in an oid, then UpdateBlob() assumes that you are storing
1875 in bytea fields.
1877 Allows you to store a clob (in $val) into $table into $column in a row at $where.
1878 Similar to UpdateBlob (see above), but for Character Large OBjects.
1879 <p> Usage:
1880 <pre>
1881 # for oracle
1885 # non oracle databases
1888 </pre>
1889 <p><b>UpdateBlobFile<a name="updateblobfile"></a>($table,$column,$path,$where,$blobtype='BLOB')</b></p>
1890 <p>Similar to UpdateBlob, except that we pass in a file path to where the blob
1891 resides.
1892 <p>For PostgreSQL, if you are using blob oid's, use this interface. This interface
1893 does not support bytea fields.
1894 <p>Returns true if successful, false otherwise.
1896 <p>Some databases require blob's to be encoded manually before upload. Note if
1897 you use UpdateBlob( ) or UpdateBlobFile( ) the conversion is done automatically
1898 for you and you do not have to call this function. For PostgreSQL, currently,
1899 BlobEncode() can only be used for bytea fields.
1900 <p>Returns the encoded blob value.
1902 has 3 legal values:
1904 'I' - blob encoding required, and returned encoded blob is a numeric value
1905 (no need to quote).<br>
1906 'C' - blob encoding required, and returned encoded blob is a character value
1907 (requires quoting).
1908 <p>This is purely for documentation purposes, so that programs that accept multiple
1909 database drivers know what is the right thing to do when processing blobs.
1911 </font><p><font color="#000000">Some databases require blob's to be decoded manually after doing a select statement.
1912 If the database does not require decoding, then this function will return
1913 the blob unchanged. Currently BlobDecode is only required for one database,
1914 PostgreSQL, and only if you are using blob oid's (if you are using bytea fields,
1919 <p>Try to update a record, and if the record is not found, an insert statement
1921 2 if no record was found and the insert was executed successfully. This differs
1922 from MySQL's replace which deletes the record and inserts a new record. This
1923 also means you cannot update the primary key. The only exception to this is
1924 Interbase and its derivitives, which uses delete and insert because of some
1925 Interbase API limitations.
1926 <p>The parameters are $table which is the table name, the $keyCols which is an
1927 associative array where the keys are the field names, and keyCols is the name
1928 of the primary key, or an array of field names if it is a compound key. If
1929 $autoQuote is set to true, then Replace() will quote all values that are non-numeric;
1930 auto-quoting will not quote nulls. Note that auto-quoting will not work if
1931 you use SQL functions or operators.
1932 <p>Examples:
1933 <pre>
1934 # single field primary key
1935 $ret = $db->Replace('atable',
1937 'id',$autoquote = true);
1938 # generates UPDATE atable SET firstname='Harun',lastname='Al-Rashid' WHERE id=1000
1939 # or INSERT INTO atable (id,firstname,lastname) VALUES (1000,'Harun','Al-Rashid')
1941 # compound key
1942 $ret = $db->Replace('atable2',
1944 array('lastname','firstname'),
1945 $autoquote = true);
1947 # no auto-quoting
1948 $ret = $db->Replace('atable2',
1950 array('lastname','firstname'));
1951 </pre>
1952 <p><b>GetUpdateSQL<a name="getupdatesql"></a>(&$rs, $arrFields, $forceUpdate=false,$magicq=false)</b></p>
1953 <p>Generate SQL to update a table given a recordset $rs, and the modified fields
1954 of the array $arrFields (which must be an associative array holding the column
1955 names and the new values) are compared with the current recordset. If $forceUpdate
1956 is true, then we also generate the SQL even if $arrFields is identical to
1957 $rs->fields. Requires the recordset to be associative. $magicq is used
1958 to indicate whether magic quotes are enabled (see qstr()). The field names in the array
1959 are case-insensitive.</p>
1960 <p>Since 3.61, define('ADODB_FORCE_NULLS',1) and all PHP nulls will be auto-converted to SQL nulls.
1962 <p>Generate SQL to insert into a table given a recordset $rs. Requires the query
1963 to be associative. $magicq is used to indicate whether magic quotes are enabled
1964 (for qstr()). The field names in the array are case-insensitive.</p>
1967 to SQL nulls.
1971 </font>
1973 $sql, $nrows, $page, $inputarr=false)</b> </font></p>
1977 <p></p>
1979 <p>Close the database connection. PHP4 proudly states that we no longer have to
1980 clean up at the end of the connection because the reference counting mechanism
1981 of PHP4 will automatically clean up for us.</p>
1983 <p>Start a monitored transaction. As SQL statements are executed, ADOdb will monitor
1984 for SQL errors, and if any are detected, when CompleteTrans() is called, we auto-rollback.
1985 <p>
1986 <p> To understand why StartTrans() is superior to BeginTrans(),
1987 let us examine a few ways of using BeginTrans().
1988 The following is the wrong way to use transactions:
1989 <pre>
1990 $DB->BeginTrans();
1993 $DB->CommitTrans();
1994 </pre>
1995 <p>because you perform no error checking. It is possible to update table1 and
1996 for the update on table2 to fail. Here is a better way:
1997 <pre>
1998 $DB->BeginTrans();
2001 if ($ok) $DB->CommitTrans();
2002 else $DB->RollbackTrans();
2003 </pre>
2005 <pre>
2006 $DB->BeginTrans();
2009 $DB->CommitTrans($ok);
2010 </pre>
2011 <p> Now it is a headache monitoring $ok all over the place. StartTrans() is an
2012 improvement because it monitors all SQL errors for you. This is particularly
2013 useful if you are calling black-box functions in which SQL queries might be executed.
2014 Also all BeginTrans, CommitTrans and RollbackTrans calls inside a StartTrans block
2015 will be disabled, so even if the black box function does a commit, it will be ignored.
2016 <pre>
2017 $DB->StartTrans();
2018 CallBlackBox();
2021 $DB->CompleteTrans($ok);
2022 </pre>
2023 <p>Note that a StartTrans blocks are nestable, the inner blocks are ignored.
2025 <p>Complete a transaction called with StartTrans(). This function monitors
2026 for SQL errors, and will commit if no errors have occured, otherwise it will rollback.
2027 Returns true on commit, false on rollback. If the parameter $autoComplete is true
2028 monitor sql errors and commit and rollback as appropriate. Set $autoComplete to false
2029 to force rollback even if no SQL error detected.
2031 <p>Fail a transaction started with StartTrans(). The rollback will only occur when
2032 CompleteTrans() is called.
2034 <p>Check whether smart transaction has failed,
2035 eg. returns true if there was an error in SQL execution or FailTrans() was called.
2036 If not within smart transaction, returns false.
2038 <p>Begin a transaction. Turns off autoCommit. Returns true if successful. Some
2039 databases will always return false if transaction support is not available.
2040 Any open transactions will be rolled back when the connection is closed. Among the
2041 databases that support transactions are Oracle, PostgreSQL, Interbase, MSSQL, certain
2042 versions of MySQL, DB2, Informix, Sybase, etc.</p>
2044 handling transactions, available since ADOdb 3.40. For a explanation, see the <a href=#starttrans>StartTrans()</a> documentation.
2047 and rollback your transactions for you transparently. Some buggy database extensions
2048 are known to commit all outstanding tranasactions, so you might want to explicitly
2049 do a $DB->RollbackTrans() in your error handler for safety.
2053 and decremented whenever RollbackTrans() or CommitTrans() is called.
2055 <p>End a transaction successfully. Returns true if successful. If the database
2056 does not support transactions, will return true also as data is always committed.
2057 </p>
2058 <p>If you pass the parameter $ok=false, the data is rolled back. See example in
2059 BeginTrans().</p>
2061 <p>End a transaction, rollback all changes. Returns true if successful. If the
2062 database does not support transactions, will return false as data is never rollbacked.
2063 </p>
2065 <p><b>GetAssoc<a name=getassoc1></a>($sql,$inputarr=false,$force_array=false,$first2cols=false)</b></p>
2066 <p>Returns an associative array for the given query $sql with optional bind parameters
2067 in $inputarr. If the number of columns returned is greater to two, a 2-dimensional
2068 array is returned, with the first column of the recordset becomes the keys
2069 to the rest of the rows. If the columns is equal to two, a 1-dimensional array
2070 is created, where the the keys directly map to the values (unless $force_array
2071 is set to true, when an array is created for each value).
2073 </font>
2076 row2: Cactus, Plant, Inedible<br>
2077 row3: Rose, Flower, Edible</font></p>
2079 array:</font></p>
2085 Fruit<br>
2086 row2: Cactus, Plant<br>
2087 row3: Rose, Flower</font> </font></font></p>
2092 Rose=>Flower <font color="#000000"><font color="#000000"> </font></font><font color="#000000"><font color="#000000"></font></font></p>
2096 <p><b>CacheGetAssoc<a name="cachegetassoc"></a>([$secs2cache,] $sql,$inputarr=false,$force_array=false,$first2cols=false)</b></p>
2100 <p>Executes the SQL and returns the first field of the first row. The recordset
2101 and remaining rows are discarded for you automatically. If an error occur, false
2102 is returned.</p>
2104 <p>Executes the SQL and returns the first row as an array. The recordset and remaining
2105 rows are discarded for you automatically. If an error occurs, false is returned.</p>
2107 </font>
2109 array. The recordset is discarded for you automatically. If an error occurs,
2110 false is returned.</font></p>
2114 1-dimensional array. The recordset is discarded for you automatically. If an error occurs,
2115 false is returned.</font></p>
2117 $sql,$inputarr=false), CacheGetRow<a name="cachegetrow"></a>([$secs2cache,] $sql,$inputarr=false), CacheGetAll<a name="cachegetall"></a>([$secs2cache,]
2119 $sql,$inputarr=false,$trim=false)</b></font></p>
2121 <p>Similar to above Get* functions, except that the recordset is serialized and
2122 cached in the $ADODB_CACHE_DIR directory for $secs2cache seconds. Good for speeding
2123 up queries on rarely changing data. Note that the $secs2cache parameter is optional.
2127 </font>
2128 <p><font color="#000000">Prepares (compiles) an SQL query for repeated execution. Bind parameters
2129 are denoted by ?, except for the oci8 driver, which uses the traditional Oracle :varname
2130 convention.
2131 </font></p>
2133 in the first array element; the remaining elements of the array are driver dependent.
2134 If there is an error, or we are emulating Prepare( ), we return the original
2135 $sql string. This is because all error-handling has been centralized in Execute(
2136 ).</font></p>
2138 query rewriting techniques, e.g. PageExecute( ) and SelectLimit( ).</font></p>
2140 <pre><font color="#000000">$stmt = $DB->Prepare('insert into table (col1,col2) values (?,?)');
2141 for ($i=0; $i < $max; $i++)<br></font> $DB-><font color="#000000">Execute($stmt,array((string) rand(), $i));
2142 </font></pre>
2144 <p>Also see InParameter(), OutParameter() and PrepareSP() below. Only supported internally by interbase,
2145 oci8 and selected ODBC-based drivers, otherwise it is emulated. There is no
2146 performance advantage to using Prepare() with emulation.
2147 <p> Important: Due to limitations or bugs in PHP, if you are getting errors when
2148 you using prepared queries, try setting $ADODB_COUNTRECS = false before preparing.
2149 This behaviour has been observed with ODBC.
2151 <p>Portable IFNULL function (NVL in Oracle). Returns a string that represents
2152 the function that checks whether a $field is null for the given database, and
2153 if null, change the value returned to $nullReplacementValue. Eg.</p>
2154 <pre>$sql = <font color="#993300">'SELECT '</font>.$db->IfNull('name', <font color="#993300">"'- unknown -'"</font>).<font color="#993300"> ' FROM table'</font>;</pre>
2158 as the function to measure the length of a string. To use this property:
2159 <pre>
2160 $sql = <font color="#993300">"SELECT "</font>.$db->length.<font color="#993300">"(field) from table"</font>;
2161 $rs = $db->Execute($sql);
2162 </pre>
2165 <p>This is not a function, but a property. This is a string that holds the sql to
2170 as the function to retrieve a sub-string. To use this property:
2171 <pre>
2172 $sql = <font color="#993300">"SELECT "</font>.$db->substr.<font color="#993300">"(field, $offset, $length) from table"</font>;
2173 $rs = $db->Execute($sql);
2174 </pre>
2176 offset (1-based) to the beginning of the sub-string, and the 3rd is the length of the sub-string.
2180 <p>Generates a bind placeholder portably. For most databases, the bind placeholder
2181 is "?". However some databases use named bind parameters such as Oracle, eg
2182 ":somevar". This allows us to portably define an SQL statement with bind parameters:
2183 <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>;
2185 # or 'insert into table (col1,col2) values (:a,:b)</font>'
2186 $stmt = $DB->Prepare($sql);
2187 $stmt = $DB->Execute($stmt,array('one','two'));
2188 </font></pre>
2190 <p></p>
2192 <p>When calling stored procedures in mssql and oci8 (oracle), and you might want
2193 to directly bind to parameters that return values, or for special LOB handling.
2194 PrepareSP() allows you to do so.
2195 <p>Returns the same array or $sql string as Prepare( ) above. If you do not need
2196 to bind to return values, you should use Prepare( ) instead.</p>
2197 <p>For examples of usage of PrepareSP( ), see InParameter( ) below.
2198 <p>Note: in the mssql driver, preparing stored procedures requires a special function
2199 call, mssql_init( ), which is called by this function. PrepareSP( ) is available
2200 in all other drivers, and is emulated by calling Prepare( ). </p>
2205 is the name of the stored procedure variable. Optional is <i>$maxLen</i>, the maximum length of the
2206 data to bind, and $type which is database dependant.
2207 Consult <a href=http://php.net/mssql_bind>mssql_bind</a> and <a href=http://php.net/ocibindbyname>ocibindbyname</a> docs
2208 at php.net for more info on legal values for $type.
2209 <p>
2210 InParameter() is a wrapper function that calls Parameter() with $isOutput=false.
2211 The advantage of this function is that it is self-documenting, because
2212 the $isOutput parameter is no longer needed. Only for mssql
2213 and oci8 currently.
2214 <p>Here is an example using oci8:
2216 $stmt = $db->PrepareSP(
2218 begin
2219 :RETVAL := </font><font color="#993300">SP_RUNSOMETHING</font><font color="#993300">(:myid,:group);
2221 $db->InParameter($stmt,$id,'myid');
2224 </pre>
2226 </font>
2228 $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>
2229 $db->InParameter($stmt,$id,'myid');
2232 $db->OutParameter($stmt,$ret,'RETVAL');
2236 <p>
2237 If $type parameter is set to false, in mssql, $type will be dynamicly determined
2240 <p>
2241 In oci8, $type can be set to OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File),
2242 OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID). To
2244 $null=null, 'param')</font>.
2248 is the value returned by PrepareSP(), <i>$var</i> is the PHP variable you want to bind, <i>$name</i>
2249 is the name of the stored procedure variable. Optional is <i>$maxLen</i>, the maximum length of the
2251 <p>
2252 OutParameter() is a wrapper function that calls Parameter() with $isOutput=true.
2253 The advantage of this function is that it is self-documenting, because
2254 the $isOutput parameter is no longer needed. Only for mssql
2255 and oci8 currently.
2256 <p>
2261 <p>Note: This function is deprecated, because of the new InParameter() and OutParameter() functions.
2262 These are superior because they are self-documenting, unlike Parameter().
2263 <p>Adds a bind parameter suitable for return values or special data handling (eg.
2264 LOBs) after a statement has been prepared using PrepareSP(). Only for mssql
2265 and oci8 currently. The parameters are:<br>
2266 <br>
2275 more info on legal values for type.</p>
2276 <p>Lastly, in oci8, bind parameters can be reused without calling PrepareSP( )
2277 or Parameters again. This is not possible with mssql. An oci8 example:</p>
2279 $stmt = $db->PrepareSP( <font color="#993300">"update table set val=:i where id=:id"</font>);
2280 $db->Parameter($stmt,$id,'id');
2281 $db->Parameter($stmt,$i, 'i');
2286 </font>
2289 ) function is the recommended way to go with bind variables.</font></p>
2291 statement. This binds a PHP variable to a name defined in an Oracle sql statement
2292 that was previously prepared using Prepare(). Oracle named variables begin with
2294 The first invocation of Bind() will match :0, the second invocation will match
2296 </font></p>
2297 <p>The other variables, $size sets the buffer size for data storage, $type is
2298 the optional descriptor type OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File),
2299 OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID).
2301 own bind-name using $name.
2304 <pre>$stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:0, :1, :2)");
2305 $DB->Bind($stmt, $p1);
2306 $DB->Bind($stmt, $p2);
2307 $DB->Bind($stmt, $p3);
2309 $p1 = ?; $p2 = ?; $p3 = ?;
2310 $DB->Execute($stmt);
2311 }</pre>
2313 <pre>
2314 $stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:name0, :name1, :name2)");
2319 $p1 = ?; $p2 = ?; $p3 = ?;
2320 $DB->Execute($stmt);
2321 }</pre>
2323 Call this method to install a SQL logging and timing function (using fnExecute).
2324 Then all SQL statements are logged into an adodb_logsql table in a database. If
2325 the adodb_logsql table does not exist, ADOdb will create the table if you have
2326 the appropriate permissions. Returns the previous logging value (true for enabled,
2327 false for disabled). Here are samples of the DDL for selected databases:
2328 <p>
2329 <pre>
2331 CREATE TABLE adodb_logsql (
2332 created datetime NOT NULL,
2333 sql0 varchar(250) NOT NULL,
2334 sql1 text NOT NULL,
2335 params text NOT NULL,
2336 tracer text NOT NULL,
2338 )
2341 CREATE TABLE adodb_logsql (
2342 created timestamp NOT NULL,
2343 sql0 varchar(250) NOT NULL,
2344 sql1 text NOT NULL,
2345 params text NOT NULL,
2346 tracer text NOT NULL,
2348 )
2351 CREATE TABLE adodb_logsql (
2352 created datetime NOT NULL,
2353 sql0 varchar(250) NOT NULL,
2354 sql1 varchar(4000) NOT NULL,
2355 params varchar(3000) NOT NULL,
2356 tracer varchar(500) NOT NULL,
2358 )
2361 CREATE TABLE adodb_logsql (
2362 created date NOT NULL,
2363 sql0 varchar(250) NOT NULL,
2364 sql1 varchar(4000) NOT NULL,
2365 params varchar(4000),
2366 tracer varchar(4000),
2368 )
2369 </pre>
2370 Usage:
2371 <pre>
2372 $conn->LogSQL(); // turn on logging
2373 :
2374 $conn->Execute(...);
2375 :
2376 $conn->LogSQL(false); // turn off logging
2378 # output summary of SQL logging results
2379 $perf = NewPerfMonitor($conn);
2380 echo $perf->SuspiciousSQL();
2381 echo $perf->ExpensiveSQL();
2382 </pre>
2383 <p>One limitation of logging is that rollback also prevents SQL from being logged.
2384 <p>
2385 If you prefer to use another name for the table used to store the SQL, you can override it by calling
2386 adodb_perf::table($tablename), where $tablename is the new table name (you will still need to manually
2387 create the table yourself). An example:
2388 <pre>
2389 include('adodb.inc.php');
2390 include('adodb-perf.inc.php');
2391 adodb_perf::table('my_logsql_table');
2392 </pre>
2394 <p><font color="#000000"><b>fnExecute and fnCacheExecute properties<a name="fnexecute" id="fnexecute"></a></b></font></p>
2395 <p>These two properties allow you to define bottleneck functions for all sql statements
2396 processed by ADOdb. This allows you to perform statistical analysis and query-rewriting
2397 of your sql.
2399 <p>Here is an example of using fnExecute, to count all cached queries and non-cached
2400 queries, you can do this:</p>
2402 function CountExecs($db, $sql, $inputarray)
2403 {
2404 global $EXECS;
2406 if (!is_array(inputarray)) $EXECS++;
2408 else if (is_array(reset($inputarray))) $EXECS += sizeof($inputarray);
2409 else $EXECS++;
2410 }
2413 function CountCachedExecs($db, $secs2cache, $sql, $inputarray)
2414 {<br>global $CACHED; $CACHED++;
2415 }
2416 <br>$db = NewADOConnection('mysql');
2417 $db->Connect(...);
2420 :
2422 printf("<p>Total queries=%d; total cached=%d</p>",$EXECS+$CACHED, $CACHED);
2423 </pre>
2424 <p>The fnExecute function is called before the sql is parsed and executed, so
2425 you can perform a query rewrite. If you are passing in a prepared statement,
2428 The function parameters match the Execute and CacheExecute functions respectively,
2429 except that $this (the connection object) is passed as the first parameter.</font></p>
2431 defined function returns a value. If it does not return a value, then the $sql
2432 is executed as before. This is useful for query rewriting or counting sql queries.
2433 <p> On the other hand, you might want to replace the Execute function with one
2434 of your own design. If this is the case, then have your function return a value.
2435 If a value is returned, that value is returned immediately, without any further
2436 processing. This is used internally by ADOdb to implement LogSQL() functionality.
2438 <hr>
2443 <p>Generates the sql string used to concatenate $s1, $s2, etc together. Uses the
2444 string in the concat_operator field to generate the concatenation. Override
2445 this function if a concatenation operator is not used, eg. MySQL.</p>
2451 Y-m-d. Uses the fmtDate field, which holds the format to use. If null or false
2452 or '' is passed in, it will be converted to an SQL null.</p>
2456 be a Unix integer timestamp or an ISO format Y-m-d H:i:s. Uses the fmtTimeStamp
2457 field, which holds the format to use. If null or false or '' is passed in, it
2458 will be converted to an SQL null.</p>
2462 parameter may look funny, but the idea is if you are quoting a string extracted
2463 from a POST/GET variable, then pass get_magic_quotes_gpc() as the second parameter.
2466 <p>Eg.<font face="Courier New, Courier, mono"> $s = $db->qstr(HTTP_GET_VARS['name'],get_magic_quotes_gpc());</font></p>
2469 <p>Quotes the string $s, escaping the database specific quote character as appropriate.
2470 Formerly checked magic quotes setting, but this was disabled since 3.31 for
2471 compatibility with PEAR DB.
2473 <p>Returns the number of rows affected by a update or delete statement. Returns
2474 false if function not supported.</p>
2477 <p>Returns the last autonumbering ID inserted. Returns false if function not supported.
2478 </p>
2479 <p>Only supported by databases that support auto-increment or object id's, such
2480 as PostgreSQL, MySQL and MS SQL Server currently. PostgreSQL returns the OID, which
2481 can change on a database reload.</p>
2483 <p>Lock a table row for the duration of a transaction. For example to lock record $id in table1:
2484 <pre>
2485 $DB->StartTrans();
2487 $DB->Execute($sql1);
2488 $DB->Execute($sql2);
2489 $DB->CompleteTrans();
2490 </pre>
2491 <p>Supported in db2, interbase, informix, mssql, oci8, postgres, sybase.
2493 <p>Returns a list of databases available on the server as an array. You have to
2494 connect to the server first. Only available for ODBC, MySQL and ADO.</p>
2496 $mask=false)</b></p>
2497 <p>Returns an array of tables and views for the current database as an array.
2498 The array should exclude system catalog tables if possible. To only show tables,
2500 The $showSchema parameter currently works only for DB2, and when set to true,
2502 <p>You can define a mask for matching. For example, setting $mask = 'TMP%' will
2503 match all tables that begin with 'TMP'. Currently only mssql, oci8, odbc_mssql
2504 and postgres* support $mask.
2506 <p>Returns an array of ADOFieldObject's, one field object for every column of
2507 $table. A field object is a class instance with (name, type, max_length) defined.
2508 Currently Sybase does not recognise date types, and ADO cannot identify
2509 the correct data type (so we default to varchar).
2510 <p> The $toupper parameter determines whether we uppercase the table name
2511 (required for some databases).
2513 supported for selected databases.
2515 <p>Returns an array of column names for $table.
2517 $owner=false)</b></font></font>
2519 primary keys of $table. Supported by mysql, odbc (including db2, odbc_mssql,
2521 <p>Views (and some tables) have primary keys, but sometimes this information is not available from the
2522 database. You can define a function ADODB_View_PrimaryKeys($databaseType, $database, $view, $owner) that
2523 should return an array containing the fields that make up the primary key. If that function exists,
2524 it will be called when MetaPrimaryKeys() cannot find a primary key for a table or view.
2525 <pre>
2526 // In this example: dbtype = 'oci8', $db = 'mydb', $view = 'dataView', $owner = false
2527 function ADODB_View_PrimaryKeys($dbtype,$db,$view,$owner)
2528 {
2529 switch(strtoupper($view)) {
2530 case 'DATAVIEW': return array('DATAID');
2531 default: return false;
2532 }
2533 }
2535 $db = NewADOConnection('oci8');
2536 $db->Connect('localhost','root','','mydb');
2537 $db->MetaPrimaryKeys('dataView');
2538 </pre>
2539 <p><font color="#000000"><b>ServerInfo<a name="serverinfo" id="serverinfo"></a>($table)</b></font></font>
2541 and 'version'. The 'description' element contains the string description of
2542 the database. The 'version' naturally holds the version number (which is also
2545 <p>Returns an associate array of foreign keys, or false if not supported. For
2546 example, if table employee has a foreign key where employee.deptkey points to
2547 dept_table.deptid, and employee.posn=posn_table.postionid and employee.poscategory=posn_table.category,
2548 then $conn->MetaForeignKeys('employee') will return
2549 <pre>
2550 array(
2551 'dept_table' => array('deptkey=deptid'),
2552 'posn_table' => array('posn=positionid','poscategory=category')
2553 )
2554 </pre>
2555 <p>The optional schema or owner can be defined in $owner. If $upper is true, then
2556 the table names (array keys) are upper-cased.
2557 <hr>
2559 <p>When an SQL statement successfully is executed by <font face="Courier New, Courier, mono">ADOConnection->Execute($sql),</font>an
2560 ADORecordSet object is returned. This object contains a virtual cursor so we
2561 can move from row to row, functions to obtain information about the columns
2562 and column types, and helper functions to deal with formating the results to
2563 show to the user.</p>
2566 is an indexed array from 0 to columns-1. See also the function <b><a href="#fields">Fields</a></b>,
2567 which behaves like an associative array.</p>
2571 is treated as a Blob (Blob's should be shown with textarea's). See the <a href="#metatype">MetaType</a>
2572 function.</p>
2580 <p>Generates an associative array from the recordset. Note that is this function
2582 can be found there.</p>
2583 </font></font><font color="#000000"><font color="#000000"> </font></font><font color="#000000"><font color="#000000">
2587 EOF.</p>
2589 Generate a 2-dimensional array of records from the current cursor position. Synonym
2590 for GetArray() for compatibility with Microsoft ADO.
2594 The first column of the recordset (fields[0]) will hold the string to display
2595 in the option tags. If the recordset has more than 1 column, the second column
2596 (fields[1]) is the value to send back to the web server.. The menu will be given
2600 empty. You can also set the first option strings by setting $blank1stItem =
2607 attributes such as javascript or styles. </p>
2610 <option>
2614 </select>
2617 will generate a menu with both A and B selected: <br>
2622 </select>
2627 <p>Menu Example 3: Given the data in menu example 2, <code>GetMenu2('menu1',array('1','2'),false)</code>
2628 will generate a menu with both A and B selected in menu example 2, but this
2629 time the selection is based on the 2nd column, which holds the values to return
2630 to the Web server.
2637 UserTimeStamp calls UnixTimeStamp to parse $<i>str</i>, and $<i>fmt</i> defaults to Y-m-d H:i:s if not defined.
2638 </p>
2642 be in Y-m-d H:i:s format, except for Sybase and Microsoft SQL Server, where
2643 M d Y is also accepted (the 3 letter month strings are controlled by a global
2644 array, which might need localisation).</p>
2649 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
2650 "M d Y h:i:sA" (Dec 25 1970 00:00:00AM) is also accepted (the 3 letter month strings are controlled by
2651 a global array, which might need localisation).</p>
2652 </font>
2656 $basedate=false)</b></font></p>
2658 native SQL functions to calculate future and past dates based on $basedate in
2659 a portable fashion. If $basedate is not defined, then the current date (at 12
2660 midnight) is used. Returns the SQL string that performs the calculation when
2661 passed to Execute(). </font></p>
2667 $fld = $conn->OffsetDate(2.5, $conn->sysTimeStamp); // returns "(sysdate+2.5)"</font>
2670 <p> This function is available for mysql, mssql, oracle, oci8 and postgresql drivers
2672 they allow performing numeric day arithmetic on dates.</font></p>
2674 <p><font color="#000000"><b>SQLDate<a name="sqldate"></a>($dateFormat, $basedate=false)</b></font></p>
2675 Returns a string which contains the native SQL functions to format a date or date
2676 column $basedate. This is used in SELECT statements. For INSERT/UPDATE statements,
2678 supports:
2679 <pre>
2680 Y: 4-digit Year
2688 A: AM/PM indicator</pre>
2689 <p>All other characters are treated as strings. You can also use \ to escape characters.
2690 Available on selected databases, including mysql, postgresql, mssql, oci8 and
2691 DB2.
2692 <p>This is useful in writing portable sql statements that GROUP BY on dates. For
2693 example to display total cost of goods sold broken by quarter (dates are stored
2694 in a field called postdate):
2695 <pre>
2697 $sql = "SELECT $sqlfn,SUM(cogs) FROM table GROUP BY $sqlfn ORDER BY 1 desc";
2698 </pre>
2701 automatically updated. Returns false if unable to do so (normally because EOF
2702 has been reached), otherwise true.
2708 if ($rs)
2709 while (!$rs->EOF) {
2710 ProcessArray($rs->fields);
2711 $rs->MoveNext();
2712 } </pre>
2716 databases that do not support scrolling internally, ADOdb will simulate forward
2719 for most databases. Some obscure databases using odbc might not behave this
2720 way.</p>
2722 <p>Returns true or false. If false, the internal cursor is not moved in most implementations,
2723 so AbsolutePosition( ) will return the last cursor position before the Move(
2724 ). </p>
2729 this function.</p>
2731 <p>Returns an associative array containing the current row. The keys to the array
2732 are the column names. The column names are upper-cased for easy access. To get
2733 the next row, you will still need to call MoveNext(). </p>
2737 <p>Note: do not use GetRowAssoc() with $ADODB_FETCH_MODE = ADODB_FETCH_ASSOC.
2738 Because they have the same functionality, they will interfere with each other.</p>
2739 </font>
2741 </b></font></p>
2742 <p>Returns the current page. Requires PageExecute()/CachePageExecute() to be called.
2752 <p>Returns the value of the
2753 associated column $<b>colname</b> for the current row. The column name is case-insensitive.</p>
2754 <p>This is a convenience function. For higher performance, use <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a>. </p>
2756 </font>
2758 FetchRow( ) internally moves to the next record after returning the current
2759 row. </font></p>
2763 if ($rs)
2765 # process $arr
2767 <p><font color="#000000"><b>FetchInto</b><a name="fetchinto"></a>(<b>&$array</b>)</font></p>
2769 if EOF, 1 if ok (DB_OK constant). If PEAR is undefined, false is returned when
2771 record after returning the current row. </font></p>
2776 of the associated field. If the max_length cannot be determined reliably, it
2782 <p>Returns the number of rows in the record set. If the number of records returned
2783 cannot be determined from the database driver API, we will buffer all rows and
2784 return a count of the rows after all the records have been retrieved. This buffering
2785 can be disabled (for performance reasons) by setting the global variable $ADODB_COUNTRECS
2786 = false. When disabled, RecordCount( ) will return -1 for certain databases.
2787 See the supported databases list above for more details. </p>
2790 <p>Returns the number of rows in the record set. If the database does not support
2791 this, it will perform a SELECT COUNT(*) on the table $table, with the given
2792 $where condition to return an estimate of the recordset size.</p>
2793 <p>$numrows = $rs->PO_RecordCount("articles_table", "group=$group");</p>
2795 <p>For databases that allow multiple recordsets to be returned in one query, this
2796 function allows you to switch to the next recordset. Currently only supported
2797 by mssql driver.</p>
2798 <pre>
2799 $rs = $db->Execute('execute return_multiple_rs');
2800 $arr1 = $rs->GetArray();
2801 $rs->NextRecordSet();
2804 <p>Returns the current row as an object. If you set $toupper to true, then the
2805 object fields are set to upper-case. Note: The newer FetchNextObject() is the
2806 recommended way of accessing rows as objects. See below.</p>
2808 <p>Gets the current row as an object and moves to the next row automatically.
2809 Returns false if at end-of-file. If you set $toupper to true, then the object
2810 fields are set to upper-case.</p>
2811 <pre>
2812 $rs = $db->Execute('select firstname,lastname from table');
2813 if ($rs) {
2815 print "$o->FIRSTNAME, $o->LASTNAME<BR>";
2816 }
2817 }
2818 </pre>
2819 <p>There is some trade-off in speed in using FetchNextObject(). If performance
2820 is important, you should access rows with the <code>fields[]</code> array. <b>FetchObj<a name="fetchobj" id="fetchobj"></a>()</b>
2821 <p>Returns the current record as an object. Fields are not upper-cased, unlike
2822 FetchObject. </font>
2824 </font></p>
2826 the next record. If EOF, false is returned. Fields are not upper-cased, unlike
2827 FetctNextObject. </font></p>
2836 native type $<b>nativeDBType</b> as a string and the length of the field $<b>field_max_length</b>.
2837 Note that field_max_length can be -1 if it is not known. The field object returned
2838 by FetchField() can be passed in $<b>fieldobj</b> or as the 1st parameter <b>$nativeDBType</b>.
2842 to determine whether the character field is actually a blob.</p>
2843 For example, $db->MetaType('char') will return 'C'.
2845 <ul>
2847 tag. </li>
2854 real. </li>
2858 </ul>
2859 </font>
2861 parameter, instead of $nativeDBType. </font></p>
2864 <p>Closes the recordset, cleaning all memory and resources associated with the recordset.
2865 <p>
2866 If memory management is not an issue, you do not need to call this function as recordsets
2867 are closed for you by PHP at the end of the script.
2868 SQL statements such as INSERT/UPDATE/DELETE do not really return a recordset, so you do not have to call Close()
2869 for such SQL statements.</p>
2870 <hr>
2872 [$col_titles])</h3>
2873 <p>This is a standalone function (rs2html = recordset to html) that is similar
2877 you can replace the database column names with your own column titles with the
2879 not a production table recordset viewer.</p>
2883 include('tohtml.inc.php')</font></b>; # load code common to ADOdb
2886 $<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db
2889 <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>'));
2891 <hr>
2893 <ol>
2894 <li>ADOdb only supports recordsets created by a connection object. Recordsets
2895 cannot be created independently.</li>
2896 <li>ADO properties are implemented as functions in ADOdb. This makes it easier
2897 to implement any enhanced ADO functionality in the future.</li>
2899 uses absolute positioning, not relative. Bookmarks are not supported.</li>
2902 <li>ADO Parameter objects are not supported. Instead we have the ADOConnection::<a href="#parameter">Parameter</a>(
2903 ) function, which provides a simpler interface for calling preparing parameters
2904 and calling stored procedures.</li>
2905 <li>Recordset properties for paging records are available, but implemented as
2907 </ol>
2908 <hr>
2910 <p>This describes how to create a class to connect to a new database. To ensure
2911 there is no duplication of work, kindly email me at jlim#natsoft.com.my if you
2912 decide to create such a class.</p>
2913 <p>First decide on a name in lower case to call the database type. Let's say we
2914 call it xbase. </p>
2915 <p>Then we need to create two classes ADODB_xbase and ADORecordSet_xbase in the
2916 file adodb-xbase.inc.php.</p>
2917 <p>The simplest form of database driver is an adaptation of an existing ODBC driver.
2923 <p>More complicated is a totally new database driver that connects to a new PHP
2924 extension. Then you will need to implement several functions. Fortunately, you
2925 do not have to modify most of the complex code. You only need to override a
2928 should be converted to that format when passing to an ADOdb date function. See
2929 Oracle for an example how we use ALTER SESSION to change the default date format
2930 in _pconnect _connect.</p>
2932 <p>Defining a constructor for your ADOConnection derived function is optional.
2933 There is no need to call the base class constructor.</p>
2940 </p>
2942 </p>
2945 and updates is allowed using ?, eg. as with ODBC.</p>
2955 <p>You will need to define a constructor for your ADORecordSet derived class that
2956 calls the parent class constructor.</p>
2961 array. This is done by _fetch. Returns true or false. Note that some implementations
2962 such as Interbase do not support seek. Set canSeek to false.</p>
2966 to the next row. then Returns true or false.</p>
2969 one, you will have to override this. See adodb-odbc.inc.php for an example.
2970 For databases such as MySQL and MSSQL where an associative array is returned,
2971 there is no need to override this function.</p>
2977 for bridging Windows and Unix databases using http remote procedure calls. For
2979 and read this article on <a href=http://phplens.com/lens/php-book/optimizing-debugging-php.php>Optimizing
2981 </font>
2986 <p>Now numbers accepts function calls or sequences for GetInsertSQL/GetUpdateSQL numeric fields.
2988 <p>Added ServerInfo() for ifx, and putenv trim fix. Thx Fernando Ortiz.
2989 <p>Added addq(), which is analogous to addslashes().
2990 <p>Tested with php5b4. Fix some php5 compat problems with exceptions and sybase.
2991 <P>Carl-Christian Salvesen added patch to mssql _query to support binds greater than 4000 chars.
2992 <p>Mike suggested patch to PHP5 exception handler. $errno must be numeric.
2994 <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.
2995 <p>Now dateHasTime property in connection object renamed to datetime for consistency. This could break bc.
2996 <p>Csongor Halmai reports that db2 SelectLimit with input array is not working. Fixed..
2997 <p><b>4.11 27 Jan 2004</b>
2998 <p>Csongor Halmai reports db2 binding not working. Reverted back to emulated binding.
2999 <p>Dan Cech modifies datadict code. Adds support for DropIndex. Minor cleanups.
3000 <p>Table misspelt in perf-oci8.inc.php. Changed v$conn_cache_advice to v$db_cache_advice. Reported by Steve W.
3001 <p>UserTimeStamp and DBTimeStamp did not handle YYYYMMDDHHMMSS format properly. Reported by Mike Muir. Fixed.
3002 <p>Changed oci8 Prepare(). Does not auto-allocate OCINewCursor automatically, unless 2nd param is set to true.
3003 This will break backward compat, if Prepare/Execute is used instead of ExecuteCursor. Reported by Chris Jones.
3004 <p>Added InParameter() and OutParameter(). Wrapper functions to Parameter(), but nicer because they
3005 are self-documenting.
3006 <p>Added 'R' handling in ActualType() to datadict-mysql.inc.php
3007 <p>Added ADOConnection::SerializableRS($rs). Returns a recordset that can be serialized in a session.
3009 <p>Misc spelling corrections in adodb-mysqli.inc.php, adodb-oci8.inc.php and datadict-oci8.inc.php, from Heinz Hombergs.
3010 <p>MetaIndexes() for ibase contributed by Heinz Hombergs.
3011 <p><b>4.10 12 Jan 2004</b>
3012 <p>Dan Cech contributed extensive changes to data dictionary to support name quoting (with `), and drop table/index.
3013 <p>Informix added cursorType property. Default remains IFX_SCROLL, but you can change to 0 (non-scrollable cursor) for performance.
3014 <p>Added ADODB_View_PrimaryKeys() for returning view primary keys to MetaPrimaryKeys().
3015 <p>Simplified chinese file, adodb-cn.inc.php from cysoft.
3016 <p>Added check for ctype_alnum in adodb-datadict.inc.php. Thx to Jason Judge.
3017 <p>Added connection parameter to ibase Prepare(). Fix by Daniel Hassan.
3018 <p>Added nameQuote for quoting identifiers and names to connection obj. Requested by Jason Judge. Also the
3019 data dictionary parser now detects `field name` and generates column names with spaces correctly.
3020 <p>BOOL type not recognised correctly as L. Fixed.
3021 <p>Fixed paths in ADODB_DIR for session files, and back-ported it to 4.05 (15 Dec 2003)
3022 <p>Added Schema to postgresql MetaTables. Thx to col#gear.hu
3023 <p>Empty postgresql recordsets that had blob fields did not set EOF properly. Fixed.
3024 <p>CacheSelectLimit internal parameters to SelectLimit were wrong. Thx to Nio.
3025 <p>Modified adodb_pr() and adodb_backtrace() to support command-line usage (eg. no html).
3026 <p>Fixed some fr and it lang errors. Thx to Gaetano G.
3027 <p>Added contrib directory, with adodb rs to xmlrpc convertor by Gaetano G.
3028 <p>Fixed array recordset bugs when _skiprow1 is true. Thx to Gaetano G.
3029 <p>Fixed pivot table code when count is false.
3030 <p>
3032 <p><b>4.05 13 Dec 2003 </b>
3033 <p>Added MetaIndexes - thx to Dan Cech.
3034 <p>Rewritten session code by Ross Smith. Moved code to adodb/session directory.
3035 <p>Added function exists check on connecting to most drivers, so we don't crash with the unknown function error.
3036 <p>Smart Transactions failed with GenID() when it no seq table has been created because the sql
3037 statement fails. Fix by Mark Newnham.
3038 <p>Added $db->length, which holds name of function that returns strlen.
3039 <p>Fixed error handling for bad driver in ADONewConnection - passed too few params to error-handler.
3040 <p>Datadict did not handle types like 16.0 properly in _GetSize. Fixed.
3041 <p>Oci8 driver SelectLimit() bug &= instead of =& used. Thx to Swen Thümmler.
3042 <p>Jesse Mullan suggested not flushing outp when output buffering enabled. Due to Apache 2.0 bug. Added.
3043 <p>MetaTables/MetaColumns return ref bug with PHP5 fixed in adodb-datadict.inc.php.
3044 <p>New mysqli driver contributed by Arjen de Rijke. Based on adodb 3.40 driver.
3045 Then jlim added BeginTrans, CommitTrans, RollbackTrans, IfNull, SQLDate. Also fixed return ref bug.
3046 <p>$ADODB_FLUSH added, if true then force flush in debugging outp. Default is false. In earlier
3047 versions, outp defaulted to flush, which is not compat with apache 2.0.
3048 <p>Mysql driver's GenID() function did not work when when sql logging is on. Fixed.
3049 <p>$ADODB_SESSION_TBL not declared as global var. Not available if adodb-session.inc.php included in function. Fixed.
3050 <p>The input array not passed to Execute() in _adodb_getcount(). Fixed.
3051 <p><b>4.04 13 Nov 2003 </b>
3052 <p>Switched back to foreach - faster than list-each.
3053 <p>Fixed bug in ado driver - wiping out $this->fields with date fields.
3054 <p>Performance Monitor, View SQL, Explain Plan did not work if strlen($SQL)>max($_GET length). Fixed.
3055 <p>Performance monitor, oci8 driver added memory sort ratio.
3056 <p>Added random property, returns SQL to generate a floating point number between 0 and 1;
3057 <p><b>4.03 6 Nov 2003 </b>
3058 <p>The path to adodb-php4.inc.php and adodb-iterators.inc.php was not setup properly.
3059 <p>Patched SQLDate in interbase to support hours/mins/secs. Thx to ari kuorikoski.
3060 <p>Force autorollback for pgsql persistent connections -
3061 apparently pgsql did not autorollback properly before 4.3.4. See http://bugs.php.net/bug.php?id=25404
3062 <p><b>4.02 5 Nov 2003 </b>
3063 <p>Some errors in adodb_error_pg() fixed. Thx to Styve.
3064 <p>Spurious Insert_ID() error was generated by LogSQL(). Fixed.
3065 <p>Insert_ID was interfering with Affected_Rows() and Replace() when LogSQL() enabled. Fixed.
3066 <p>More foreach loops optimized with list/each.
3067 <p>Null dates not handled properly in ADO driver (it becomes 31 Dec 1969!).
3068 <p>Heinz Hombergs contributed patches for mysql MetaColumns - adding scale, made
3069 interbase MetaColumns work with firebird/interbase, and added lang/adodb-de.inc.php.
3070 <p>Added INFORMIXSERVER environment variable.
3071 <p>Added $ADODB_ANSI_PADDING_OFF for interbase/firebird.
3072 <p>PHP 5 beta 2 compat check. Foreach (Iterator) support. Exceptions support.
3073 <p><b>4.01 23 Oct 2003 </b>
3074 <p>Fixed bug in rs2html(), tohtml.inc.php, that generated blank table cells.
3075 <p>Fixed insert_id() incorrectly generated when logsql() enabled.
3076 <p>Modified PostgreSQL _fixblobs to use list/each instead of foreach.
3077 <p>Informix ErrorNo() implemented correctly.
3078 <p>Modified several places to use list/each, including GetRowAssoc().
3079 <p>Added UserTimeStamp() to connection class.
3080 <p>Added $ADODB_ANSI_PADDING_OFF for oci8po.
3081 <p><b>4.00 20 Oct 2003 </b>
3082 <p>Upgraded adodb-xmlschema to 1 Oct 2003 snapshot.
3083 <p>Fix to rs2html warning message. Thx to Filo.
3084 <p>Fix for odbc_mssql/mssql SQLDate(), hours was wrong.
3085 <p>Added MetaColumns and MetaPrimaryKeys for sybase. Thx to Chris Phillipson.
3086 <p>Added autoquoting to datadict for MySQL and PostgreSQL. Suggestion by Karsten Dambekalns
3087 <p><b>3.94 11 Oct 2003 </b>
3088 <p>Create trigger in datadict-oci8.inc.php did not work, because all cr/lf's must be removed.
3089 <p>ErrorMsg()/ErrorNo() did not work for many databases when logging enabled. Fixed.
3090 <p>Removed global variable $ADODB_LOGSQL as it does not work properly with multiple connections.
3091 <p>Added SQLDate support for sybase. Thx to Chris Phillipson
3092 <p>Postgresql checking of pgsql resultset resource was incorrect. Fix by Bharat Mediratta bharat#menalto.com.
3093 Same patch applied to _insertid and _affectedrows for adodb-postgres64.inc.php.
3094 <p>Added support for NConnect for postgresql.
3095 <p>Added Sybase data dict support. Thx to Chris Phillipson
3096 <p>Extensive improvements in $perf->UI(), eg. Explain now opens in new window, we show scripts
3097 which call sql, etc.
3098 <p>Perf Monitor UI works with magic quotes enabled.
3099 <p>rsPrefix was declared twice. Removed.
3101 <p>Tiraboschi Massimiliano contributed italian language file.
3102 <p>Fernando Ortiz, fortiz#lacorona.com.mx, contributed informix performance monitor.
3103 <p>Added _varchar (varchar arrays) support for postgresql. Reported by PREVOT Stéphane.
3104 <p><b>3.92 22 Sept 2003</b>
3105 <p>Added GetAssoc and CacheGetAssoc to connection object.
3106 <p>Removed TextMax and CharMax functions from adodb.inc.php.
3107 <p>HasFailedTrans() returned false when trans failed. Fixed.
3108 <p>Moved perf driver classes into adodb/perf/*.php.
3109 <p>Misc improvements to performance monitoring, including UI().
3110 <p>RETVAL in mssql Parameter(), we do not append @ now.
3112 bind parameters portably.
3113 <p>LogSQL traps affected_rows() and saves its value properly now. Also fixed oci8
3114 _stmt and _affectedrows() bugs.
3115 <p>Session code timestamp check for oci8 works now. Formerly default NLS_DATE_FORMAT
3116 stripped off time portion. Thx to Tony Blair (tonanbarbarian#hotmail.com). Also
3117 added new $conn->datetime field to oci8, controls whether MetaType() returns
3118 'D' ($this->datetime==false) or 'T' ($this->datetime == true) for DATE type.
3119 <p>Fixed bugs in adodb-cryptsession.inc.php and adodb-session-clob.inc.php.
3120 <p>Fixed misc bugs in adodb_key_exists, GetInsertSQL() and GetUpdateSQL().
3121 <p>Tuned include_once handling to reduce file-system checking overhead.
3122 <p><b>3.91 9 Sept 2003</b>
3123 <p>Only released to InterAkt
3124 <p>Added LogSQL() for sql logging and $ADODB_NEWCONNECTION to override factory
3125 for driver instantiation.
3126 <p>Added IfNull($field,$ifNull) function, thx to johnwilk#juno.com
3127 <p>Added portable substr support.
3128 <p>Now rs2html() has new parameter, $echo. Set to false to return $html instead
3129 of echoing it.
3130 <p><b>3.90 5 Sept 2003</b>
3131 <p>First beta of performance monitoring released.
3132 <p>MySQL supports MetaTable() masking.
3133 <p>Fixed key_exists() bug in adodb-lib.inc.php
3134 <p>Added sp_executesql Prepare() support to mssql.
3135 <p>Added bind support to db2.
3136 <p>Added swedish language file - Christian Tiberg" christian#commsoft.nu
3137 <p>Bug in drop index for mssql data dict fixed. Thx to Gert-Rainer Bitterlich.
3138 <p>Left join setting for oci8 was wrong. Thx to johnwilk#juno.com
3141 <p>Added matching mask for MetaTables. Only for oci8, mssql and postgres currently.
3143 <p>Added better debugging for Smart Transactions.
3144 <p>Postgres DBTimeStamp() was wrongly using TO_DATE. Changed to TO_TIMESTAMP.
3145 <p>ADODB_FETCH_CASE check pushed to ADONewConnection to allow people to define
3146 it after including adodb.inc.php.
3148 <p>Removed arg3 parameter from Execute/SelectLimit/Cache* functions.
3150 to note change in sql query counting with 2-d arrays.
3151 <p>Added MONEY to MetaType in PostgreSQL.
3152 <p>Added more debugging output to CacheFlush().
3154 <p>Added qmagic($str), which is a qstr($str) that auto-checks for magic quotes
3155 and does the right thing...
3156 <p>Fixed CacheFlush() bug - Thx to martin#gmx.de
3157 <p>Walt Boring contributed MetaForeignKeys for postgres7.
3158 <p>_fetch() called _BlobDecode() wrongly in interbase. Fixed.
3159 <p>adodb_time bug fixed with dates after 2038 fixed by Jason Pell. http://phplens.com/lens/lensforum/msgs.php?id=6980
3161 <p>The oci8 driver, MetaPrimaryKeys() did not check the owner correctly when $owner
3162 == false.
3165 <p>Error handling in oci8 bugfix - if there was an error in Execute(), then when
3166 calling ErrorNo() and/or ErrorMsg(), the 1st call would return the error, but
3167 the 2nd call would return no error.
3168 <p>Error handling in odbc bugfix. ODBC would always return the last error, even
3169 if it happened 5 queries ago. Now we reset the errormsg to '' and errorno to
3170 0 everytime before CacheExecute() and Execute().
3174 <p>The oci8 driver did not identify NUMBER with no defined precision correctly.
3175 <p>Added ADODB_FORCE_NULLS, if set, then PHP nulls are converted to SQL nulls
3176 in GetInsertSQL/GetUpdateSQL.
3177 <p>DBDate() and DBTimeStamp() format for postgresql had problems. Fixed.
3178 <p>Added tableoptions to ChangeTableSQL(). Thx to Mike Benoit.
3179 <p>Added charset support to postgresql. Thx to Julian Tarkhanov.
3180 <p>Changed OS check for MS-Windows to prevent confusion with darWIN (MacOS)
3181 <p>Timestamp format for db2 was wrong. Changed to yyyy-mm-dd-hh.mm.ss.nnnnnn.
3182 <p>adodb-cryptsession.php includes wrong. Fixed.
3183 <p>Added MetaForeignKeys(). Supported by mssql, odbc_mssql and oci8.
3184 <p>Fixed some oci8 MetaColumns/MetaPrimaryKeys bugs. Thx to Walt Boring.
3186 in GetUpdateSQL fixed. Thx to Sebastiaan van Stijn.
3189 <p>NConnect for mysql now returns value. Thx to Dennis Verspuij.
3190 <p>ADODB_FETCH_BOTH support added to interbase/firebird.
3191 <p>Czech language file contributed by Kamil Jakubovic jake#host.sk.
3192 <p>PostgreSQL BlobDecode did not use _connectionID properly. Thx to Juraj Chlebec.
3194 <p>ADODB_ASSOC_CASE constant wrong in sybase _fetch(). Fixed.
3196 <p>We now SET CONCAT_NULL_YIELDS_NULL OFF for odbc_mssql driver to be compat with
3197 mssql driver.
3199 constant (TIMESTAMP_FIRST_YEAR=100). Thx to Sebastiaan van Stijn.
3200 <p>ADOdb speedup optimization - we now return all arrays by reference.
3201 <p>Now DBDate() and DBTimeStamp() now accepts the string 'null' as a parameter.
3202 Suggested by vincent.
3203 <p>Added GetArray() to connection class.
3204 <p>Added not_null check in informix metacolumns().
3205 <p>Connection parameters for postgresql did not work correctly when port was defined.
3207 to odbc driver for DB2, including implementing serverinfo() and SQLDate(), switching
3208 to SQL_CUR_USE_ODBC as the cursor mode, and lastAffectedRows and SelectLimit()
3209 fixes.
3210 <p>The odbc driver's FetchField() field names did not obey ADODB_ASSOC_CASE. Fixed.
3211 <p>Some bugs in adodb_backtrace() fixed.
3213 properly.
3214 <p>MetaColumns() for oci8, mssql, odbc revised to support scale. Also minor revisions
3215 to odbc MetaColumns() for vfp and db2 compat.
3216 <p>Added unsigned support to mysql datadict class. Thx to iamsure.
3217 <p>Infinite loop in mssql MoveNext() fixed when ADODB_FETCH_ASSOC used. Thx to
3218 Josh R, Night_Wulfe#hotmail.com.
3219 <p>ChangeTableSQL contributed by Florian Buzin.
3220 <p>The odbc_mssql driver now sets CONCAT_NULL_YIELDS_NULL OFF for compat with
3221 mssql driver.
3222 <hr>
3225 </strong></h3>
3227 <p> </font>
3228 </body>
3229 </html>