| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 2 | <html><head><title>ADODB Manual</title> |
|---|
| 3 | |
|---|
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
|---|
| 5 | |
|---|
| 6 | |
|---|
| 7 | <style> |
|---|
| 8 | pre { |
|---|
| 9 | background-color: #eee; |
|---|
| 10 | padding: 0.75em 1.5em; |
|---|
| 11 | font-size: 12px; |
|---|
| 12 | border: 1px solid #ddd; |
|---|
| 13 | }f |
|---|
| 14 | </style></head> |
|---|
| 15 | <body bgcolor="#ffffff" text="black"> |
|---|
| 16 | |
|---|
| 17 | <h2>ADOdb Library for PHP</h2> |
|---|
| 18 | <p>v4.991 16 Oct 2008 (c) 2000-2008 John Lim (jlim#natsoft.com)</p> |
|---|
| 19 | <p><font size="1">This software is dual licensed using BSD-Style and LGPL. This |
|---|
| 20 | means you can use it in compiled proprietary and commercial products.</font></p> |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | <p>Useful ADOdb links: <a href="http://adodb.sourceforge.net/#download">Download</a> <a href="http://adodb.sourceforge.net/#docs">Other Docs</a> |
|---|
| 24 | |
|---|
| 25 | </p><p><a href="#intro"><b>Introduction</b></a><b><br> |
|---|
| 26 | <a href="#features">Unique Features</a><br> |
|---|
| 27 | <a href="#users">How People are using ADOdb</a><br> |
|---|
| 28 | <a href="#bugs">Feature Requests and Bug Reports</a><br> |
|---|
| 29 | </b><b><a href="#install">Installation</a><br> |
|---|
| 30 | <a href="#mininstall">Minimum Install</a><br> |
|---|
| 31 | <a href="#coding">Initializing Code and Connectioning to Databases</a><br> |
|---|
| 32 | </b><font size="2"> <a href="#dsnsupport">Data Source Name (DSN) Support</a></font> <a href="#connect_ex">Connection Examples</a> <br> |
|---|
| 33 | <b><a href="#speed">High Speed ADOdb - tuning tips</a></b><br> |
|---|
| 34 | <b><a href="#hack">Hacking and Modifying ADOdb Safely</a><br> |
|---|
| 35 | <a href="#php5">PHP5 Features</a></b><br> |
|---|
| 36 | <font size="2"><a href="#php5iterators">foreach iterators</a> <a href="#php5exceptions">exceptions</a></font><br> |
|---|
| 37 | <b> <a href="#drivers">Supported Databases</a></b><br> |
|---|
| 38 | <b> <a href="#quickstart">Tutorials</a></b><br> |
|---|
| 39 | <a href="#ex1">Example 1: Select</a><br> |
|---|
| 40 | <a href="#ex2">Example 2: Advanced Select</a><br> |
|---|
| 41 | <a href="#ex3">Example 3: Insert</a><br> |
|---|
| 42 | <a href="#ex4">Example 4: Debugging</a> <a href="#exrs2html">rs2html |
|---|
| 43 | example</a><br> |
|---|
| 44 | <a href="#ex5">Example 5: MySQL and Menus</a><br> |
|---|
| 45 | <a href="#ex6">Example 6: Connecting to Multiple Databases at once</a> <br> |
|---|
| 46 | <a href="#ex7">Example 7: Generating Update and Insert SQL</a> <br> |
|---|
| 47 | <a href="#ex8">Example 8: Implementing Scrolling with Next and Previous</a><br> |
|---|
| 48 | <a href="#ex9">Example 9: Exporting in CSV or Tab-Delimited Format</a> <br> |
|---|
| 49 | <a href="#ex10">Example 10: Custom filters</a><br> |
|---|
| 50 | <a href="#ex11">Example 11: Smart Transactions</a><br> |
|---|
| 51 | <br> |
|---|
| 52 | <b> <a href="#errorhandling">Using Custom Error Handlers and PEAR_Error</a><br> |
|---|
| 53 | <a href="#DSN">Data Source Names</a><br> |
|---|
| 54 | <a href="#caching">Caching</a></b><br> |
|---|
| 55 | <a href="#memcache">MemCache</a><br> |
|---|
| 56 | <a href="#cacheapi">Caching API</a><br> |
|---|
| 57 | <b><a href="#pivot">Pivot Tables</a></b> |
|---|
| 58 | </p><p><a href="#ref"><b>REFERENCE</b></a> |
|---|
| 59 | </p><p> <font size="2">Variables: <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> |
|---|
| 60 | <a href="#adodb_ansi_padding_off">$ADODB_ANSI_PADDING_OFF</a> |
|---|
| 61 | <a href="#adodb_cache_dir">$ADODB_CACHE_DIR</a> <br> |
|---|
| 62 | <a href="#force_type">$ADODB_FORCE_TYPE</a> |
|---|
| 63 | <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a> |
|---|
| 64 | <a href="#adodb_lang">$ADODB_LANG</a> <a href=#adodb_auto_quote>ADODB_QUOTE_FIELDNAMES</a> <br> |
|---|
| 65 | Constants: </font><font size="2"><a href="#adodb_assoc_case">ADODB_ASSOC_CASE</a> |
|---|
| 66 | </font><br> |
|---|
| 67 | <a href="#ADOConnection"><b> ADOConnection</b></a><br> |
|---|
| 68 | <font size="2">Connections: <a href="#connect">Connect</a> <a href="#pconnect">PConnect</a> |
|---|
| 69 | <a href="#nconnect">NConnect</a> <a href="#isconnected">IsConnected</a><br> |
|---|
| 70 | Executing SQL: <a href="#execute">Execute</a> <a href="#cacheexecute"><i>CacheExecute</i></a> |
|---|
| 71 | <a href="#selectlimit">SelectLimit</a> <a href="#cacheSelectLimit"><i>CacheSelectLimit</i></a> |
|---|
| 72 | <a href="#param">Param</a> <a href="#prepare">Prepare</a> <a href="#preparesp">PrepareSP</a> |
|---|
| 73 | <a href="#inparameter">InParameter</a> <a href="#outparameter">OutParameter</a> <a href="#autoexecute">AutoExecute</a> |
|---|
| 74 | <br> |
|---|
| 75 | <a href="#getone">GetOne</a> |
|---|
| 76 | <a href="#cachegetone"><i>CacheGetOne</i></a> <a href="#getrow">GetRow</a> <a href="#cachegetrow"><i>CacheGetRow</i></a> |
|---|
| 77 | <a href="#getall">GetAll</a> <a href="#cachegetall"><i>CacheGetAll</i></a> <a href="#getcol">GetCol</a> |
|---|
| 78 | <a href="#cachegetcol"><i>CacheGetCol</i></a> <a href="#getassoc1">GetAssoc</a> <a href="#cachegetassoc"><i>CacheGetAssoc</i></a> <a href="#replace">Replace</a> |
|---|
| 79 | <br> |
|---|
| 80 | <a href="#executecursor">ExecuteCursor</a> |
|---|
| 81 | (oci8 only)<br> |
|---|
| 82 | Generates SQL strings: <a href="#getupdatesql">GetUpdateSQL</a> <a href="#getinsertsql">GetInsertSQL</a> |
|---|
| 83 | <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> |
|---|
| 84 | <a href="#qstr">qstr</a> <a href="#param">Param</a> <a href="#OffsetDate">OffsetDate</a> <a href="#sqldate">SQLDate</a> |
|---|
| 85 | <a href="#dbdate">DBDate</a> <a href="#dbtimestamp">DBTimeStamp</a> |
|---|
| 86 | <a href="#binddate">BindDate</a> <a href="#bindtimestamp">BindTimeStamp</a> |
|---|
| 87 | <br> |
|---|
| 88 | Blobs: <a href="#updateblob">UpdateBlob</a> <a href="#updateclob">UpdateClob</a> |
|---|
| 89 | <a href="#updateblobfile">UpdateBlobFile</a> <a href="#blobencode">BlobEncode</a> |
|---|
| 90 | <a href="#blobdecode">BlobDecode</a><br> |
|---|
| 91 | Paging/Scrolling: <a href="#pageexecute">PageExecute</a> <a href="#cachepageexecute">CachePageExecute</a><br> |
|---|
| 92 | Cleanup: <a href="#cacheflush">CacheFlush</a> <a href="#Close">Close</a><br> |
|---|
| 93 | Transactions: <a href="#starttrans">StartTrans</a> <a href="#completetrans">CompleteTrans</a> |
|---|
| 94 | <a href="#failtrans">FailTrans</a> <a href="#hasfailedtrans">HasFailedTrans</a> |
|---|
| 95 | <a href="#begintrans">BeginTrans</a> <a href="#committrans">CommitTrans</a> |
|---|
| 96 | <a href="#rollbacktrans">RollbackTrans</a> <a href=#SetTransactionMode>SetTransactionMode</a><br> |
|---|
| 97 | Fetching Data: </font> <font size="2"><a href="#setfetchmode">SetFetchMode</a><br> |
|---|
| 98 | 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> |
|---|
| 99 | Dates: <a href="#dbdate">DBDate</a> <a href="#dbtimestamp">DBTimeStamp</a> <a href="#unixdate">UnixDate</a> |
|---|
| 100 | <a href="#binddate">BindDate</a> <a href="#bindtimestamp">BindTimeStamp</a> |
|---|
| 101 | <a href="#unixtimestamp">UnixTimeStamp</a> <a href="#OffsetDate">OffsetDate</a> |
|---|
| 102 | <a href="#SQLDate">SQLDate</a> <br> |
|---|
| 103 | Row Management: <a href="#affected_rows">Affected_Rows</a> <a href="#inserted_id">Insert_ID</a> <a href="#rowlock">RowLock</a> |
|---|
| 104 | <a href="#genid">GenID</a> <a href="#createseq">CreateSequence</a> <a href="#dropseq">DropSequence</a> |
|---|
| 105 | <br> |
|---|
| 106 | Error Handling: <a href="#errormsg">ErrorMsg</a> <a href="#errorno">ErrorNo</a> |
|---|
| 107 | <a href="#metaerror">MetaError</a> <a href="#metaerrormsg">MetaErrorMsg</a> <a href="#ignoreerrors">IgnoreErrors</a><br> |
|---|
| 108 | Data Dictionary (metadata): <a href="#metadatabases">MetaDatabases</a> <a href="#metatables">MetaTables</a> |
|---|
| 109 | <a href="#metacolumns">MetaColumns</a> <a href="#metacolumnames">MetaColumnNames</a> |
|---|
| 110 | <a href="#metaprimarykeys">MetaPrimaryKeys</a> <a href="#metaforeignkeys">MetaForeignKeys</a> |
|---|
| 111 | <a href="#serverinfo">ServerInfo</a> <br> |
|---|
| 112 | Statistics and Query-Rewriting: <a href="#logsql">LogSQL</a> <a href="#fnexecute">fnExecute |
|---|
| 113 | and fnCacheExecute</a><br> |
|---|
| 114 | </font><font size="2">Deprecated: <a href="#bind">Bind</a> <a href="#blankrecordset">BlankRecordSet</a> |
|---|
| 115 | <a href="#parameter">Parameter</a></font> |
|---|
| 116 | <a href="#adorecordSet"><b><br> |
|---|
| 117 | ADORecordSet</b></a><br> |
|---|
| 118 | <font size="2"> |
|---|
| 119 | Returns one field: <a href="#fields">Fields</a><br> |
|---|
| 120 | Returns one row:<a href="#fetchrow">FetchRow</a> <a href="#fetchinto">FetchInto</a> |
|---|
| 121 | <a href="#fetchobject">FetchObject</a> <a href="#fetchnextobject">FetchNextObject</a> |
|---|
| 122 | <a href="#fetchobj">FetchObj</a> <a href="#fetchnextobj">FetchNextObj</a> |
|---|
| 123 | <a href="#getrowassoc">GetRowAssoc</a> <br> |
|---|
| 124 | Returns all rows:<a href="#getarray">GetArray</a> <a href="#getrows">GetRows</a> |
|---|
| 125 | <a href="#getassoc">GetAssoc</a><br> |
|---|
| 126 | Scrolling:<a href="#move">Move</a> <a href="#movenext">MoveNext</a> <a href="#movefirst">MoveFirst</a> |
|---|
| 127 | <a href="#movelast">MoveLast</a> <a href="#abspos">AbsolutePosition</a> <a href="#currentrow">CurrentRow</a> |
|---|
| 128 | <a href="#atfirstpage">AtFirstPage</a> <a href="#atlastpage">AtLastPage</a> |
|---|
| 129 | <a href="#absolutepage">AbsolutePage</a> </font> <font size="2"><br> |
|---|
| 130 | Menu generation:<a href="#getmenu">GetMenu</a> <a href="#getmenu2">GetMenu2</a><br> |
|---|
| 131 | Dates:<a href="#userdate">UserDate</a> <a href="#usertimestamp">UserTimeStamp</a> |
|---|
| 132 | <a href="#unixdate">UnixDate</a> <a href="#unixtimestamp">UnixTimeStamp<br> |
|---|
| 133 | </a>Recordset Info:<a href="#recordcount">RecordCount</a> <a href="#po_recordcount">PO_RecordCount</a> |
|---|
| 134 | <a href="#nextrecordset">NextRecordSet</a><br> |
|---|
| 135 | Field Info:<a href="#fieldcount">FieldCount</a> <a href="#fetchfield">FetchField</a> |
|---|
| 136 | <a href="#metatype">MetaType</a><br> |
|---|
| 137 | Cleanup: <a href="#rsclose">Close</a></font> |
|---|
| 138 | </p> |
|---|
| 139 | <p><font size="2"><a href="#rs2html"><b>rs2html</b></a> <a href="#exrs2html">example</a></font><br> |
|---|
| 140 | <a href="#adodiff">Differences between ADOdb and ADO</a><br> |
|---|
| 141 | <a href="#driverguide"><b>Database Driver Guide<br> |
|---|
| 142 | </b></a><b><a href="#changes">Change Log</a></b><br> |
|---|
| 143 | </p> |
|---|
| 144 | <h2>Introduction<a name="intro"></a></h2> |
|---|
| 145 | <p>PHP's database access functions are not standardised. This creates a need for |
|---|
| 146 | a database class library to hide the differences between the different database |
|---|
| 147 | API's (encapsulate the differences) so we can easily switch databases. PHP 4.0.5 or later |
|---|
| 148 | is now required (because we use array-based str_replace).</p> |
|---|
| 149 | <p>We currently support MySQL, Oracle, Microsoft SQL Server, Sybase, Sybase SQL Anywhere, Informix, |
|---|
| 150 | PostgreSQL, FrontBase, SQLite, Interbase (Firebird and Borland variants), Foxpro, Access, ADO, DB2, SAP DB and ODBC. |
|---|
| 151 | We have had successful reports of connecting to Progress and CacheLite via ODBC. We hope more people |
|---|
| 152 | will contribute drivers to support other databases.</p> |
|---|
| 153 | <p>PHP4 supports session variables. You can store your session information using |
|---|
| 154 | ADOdb for true portability and scalability. See adodb-session.php for more information.</p> |
|---|
| 155 | <p>Also read <a href="http://phplens.com/lens/adodb/tips_portable_sql.htm">tips_portable_sql.htm</a> |
|---|
| 156 | for tips on writing |
|---|
| 157 | portable SQL.</p> |
|---|
| 158 | <h2>Unique Features of ADOdb<a name="features"></a></h2> |
|---|
| 159 | <ul> |
|---|
| 160 | <li><b>Easy for Windows programmers</b> to adapt to because many of the conventions |
|---|
| 161 | are similar to Microsoft's ADO.</li> |
|---|
| 162 | <li>Unlike other PHP database classes which focus only on select statements, |
|---|
| 163 | <b>we provide support code to handle inserts and updates which can be adapted |
|---|
| 164 | to multiple databases quickly.</b> Methods are provided for date handling, |
|---|
| 165 | string concatenation and string quoting characters for differing databases.</li> |
|---|
| 166 | <li>A<b> metatype system </b>is built in so that we can figure out that types |
|---|
| 167 | such as CHAR, TEXT and STRING are equivalent in different databases.</li> |
|---|
| 168 | <li><b>Easy to port</b> because all the database dependant code are stored in |
|---|
| 169 | stub functions. You do not need to port the core logic of the classes.</li> |
|---|
| 170 | <li><b>Portable table and index creation</b> with the <a href="docs-datadict.htm">datadict</a> classes. |
|---|
| 171 | </li><li><b>Database performance monitoring and SQL tuning</b> with the <a href="docs-perf.htm">performance monitoring</a> classes. |
|---|
| 172 | </li><li><b>Database-backed sessions</b> with the <a href="docs-session.htm">session management</a> classes. Supports session expiry notification. |
|---|
| 173 | <li><b>Object-Relational Mapping</b> using <a href="docs-active-record.htm">ADOdb_Active_Record</a> classes. |
|---|
| 174 | </li></ul> |
|---|
| 175 | <h2>How People are using ADOdb<a name="users"></a></h2> |
|---|
| 176 | Here are some examples of how people are using ADOdb (for a much longer list, |
|---|
| 177 | visit <a href="http://phplens.com/phpeverywhere/adodb-cool-apps">adodb-cool-apps</a>): |
|---|
| 178 | <ul> |
|---|
| 179 | <li><a href="http://phplens.com/">PhpLens</a> is a commercial data grid |
|---|
| 180 | component that allows both cool Web designers and serious unshaved |
|---|
| 181 | programmers to develop and maintain databases on the Web easily. |
|---|
| 182 | Developed by the author of ADOdb.<p> |
|---|
| 183 | |
|---|
| 184 | </p></li><li><a href="http://www.interakt.ro/phakt/">PHAkt: PHP Extension for DreamWeaver Ultradev</a> allows you to script PHP in the popular Web page editor. Database handling provided by ADOdb.<p> |
|---|
| 185 | |
|---|
| 186 | </p></li><li><a href="http://www.andrew.cmu.edu/%7Erdanyliw/snort/snortacid.html">Analysis Console for Intrusion Databases</a> |
|---|
| 187 | (ACID): PHP-based analysis engine to search and process a database of |
|---|
| 188 | security incidents generated by security-related software such as IDSes |
|---|
| 189 | and firewalls (e.g. Snort, ipchains). By Roman Danyliw.<p> |
|---|
| 190 | |
|---|
| 191 | </p></li><li><a href="http://www.postnuke.com/">PostNuke</a> is a very |
|---|
| 192 | popular free content management system and weblog system. It offers |
|---|
| 193 | full CSS support, HTML 4.01 transitional compliance throughout, an |
|---|
| 194 | advanced blocks system, and is fully multi-lingual enabled. <p> |
|---|
| 195 | |
|---|
| 196 | </p></li><li><a href="http://www.auto-net.no/easypublish.php?page=index&lang_id=2">EasyPublish CMS</a> |
|---|
| 197 | is another free content management system for managing information and |
|---|
| 198 | integrated modules on your internet, intranet- and extranet-sites. From |
|---|
| 199 | Norway.<p> |
|---|
| 200 | |
|---|
| 201 | </p></li><li><a href="http://nola.noguska.com/">NOLA</a> is a full featured accounting, inventory, and job tracking application. It is licensed under the GPL, and developed by Noguska. |
|---|
| 202 | </li></ul><p> |
|---|
| 203 | |
|---|
| 204 | </p><h2>Feature Requests and Bug Reports<a name="bugs"></a></h2> |
|---|
| 205 | <p>Feature requests and bug reports can be emailed to <a href="mailto:jlim#natsoft.com">jlim#natsoft.com</a> |
|---|
| 206 | 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> |
|---|
| 207 | <h2>Installation Guide<a name="install"></a></h2> |
|---|
| 208 | <p>Make sure you are running PHP 4.0.5 or later. |
|---|
| 209 | Unpack all the files into a directory accessible by your webserver.</p> |
|---|
| 210 | <p>To test, try modifying some of the tutorial examples. Make sure you customize |
|---|
| 211 | the connection settings correctly. You can debug using <i>$db->debug = true</i> as shown below:</p> |
|---|
| 212 | <pre><?php<br> include('adodb/adodb.inc.php');<br> $db = <a href="#adonewconnection">ADONewConnection</a>($dbdriver); # eg 'mysql' or 'postgres'<br> $db->debug = true;<br> $db-><a href="#connect">Connect</a>($server, $user, $password, $database);<br> $rs = $db-><a href="#execute">Execute</a>('select * from some_small_table');<br> print "<pre>";<br> print_r($rs-><a href="#getrows">GetRows</a>());<br> print "</pre>";<br>?></pre> |
|---|
| 213 | |
|---|
| 214 | <h3>Minimum Install<a name="mininstall"></a></h3> |
|---|
| 215 | <p>For developers who want to release a minimal install of ADOdb, you will need: |
|---|
| 216 | </p><ul> |
|---|
| 217 | <li>adodb.inc.php |
|---|
| 218 | </li><li>adodb-lib.inc.php |
|---|
| 219 | </li><li>adodb-time.inc.php |
|---|
| 220 | </li><li>drivers/adodb-$database.inc.php |
|---|
| 221 | </li><li>license.txt (for legal reasons) |
|---|
| 222 | </li><li>adodb-php4.inc.php |
|---|
| 223 | </li><li>adodb-iterator.inc.php (php5 functionality) |
|---|
| 224 | </li></ul> |
|---|
| 225 | Optional: |
|---|
| 226 | <ul> |
|---|
| 227 | <li>adodb-error.inc.php and lang/adodb-$lang.inc.php (if you use MetaError()) |
|---|
| 228 | </li><li>adodb-csvlib.inc.php (if you use cached recordsets - CacheExecute(), etc) |
|---|
| 229 | </li><li>adodb-exceptions.inc.php and adodb-errorhandler.inc.php (if you use adodb error handler or php5 exceptions). |
|---|
| 230 | <li>adodb-active-record.inc.php if you use <a href=docs-active-record.htm>Active Records</a>. |
|---|
| 231 | </li></ul> |
|---|
| 232 | |
|---|
| 233 | <h3>Code Initialization Examples<a name="coding"></a></h3> |
|---|
| 234 | <p>When running ADOdb, at least two files are loaded. First is adodb/adodb.inc.php, |
|---|
| 235 | which contains all functions used by all database classes. The code specific |
|---|
| 236 | to a particular database is in the adodb/driver/adodb-????.inc.php file.</p> |
|---|
| 237 | <a name="adonewconnection"></a> |
|---|
| 238 | <p>For example, to connect to a mysql database:</p> |
|---|
| 239 | <pre>include('/path/to/set/here/adodb.inc.php');<br>$conn = &ADONewConnection('mysql');<br></pre> |
|---|
| 240 | <p>Whenever you need to connect to a database, you create a Connection object |
|---|
| 241 | using the <b>ADONewConnection</b>($driver) function. |
|---|
| 242 | <b>NewADOConnection</b>($driver) is an alternative name for the same function.</p> |
|---|
| 243 | |
|---|
| 244 | <p>At this point, you are not connected to the database (no longer true if you pass in a <a href="#dsnsupport">dsn</a>). You will first need to decide |
|---|
| 245 | whether to use <i>persistent</i> or <i>non-persistent</i> connections. The advantage of <i>persistent</i> |
|---|
| 246 | connections is that they are faster, as the database connection is never closed (even |
|---|
| 247 | when you call Close()). <i>Non-persistent </i>connections take up much fewer resources though, |
|---|
| 248 | reducing the risk of your database and your web-server becoming overloaded. |
|---|
| 249 | </p><p>For persistent connections, |
|---|
| 250 | use $conn-><a href="#pconnect">PConnect()</a>, |
|---|
| 251 | or $conn-><a href="#connect">Connect()</a> for non-persistent connections. |
|---|
| 252 | Some database drivers also support <a href="#nconnect">NConnect()</a>, which forces |
|---|
| 253 | the creation of a new connection. |
|---|
| 254 | |
|---|
| 255 | <a name="connection_gotcha"></a> |
|---|
| 256 | </p><p><b>Connection Gotcha</b>: If you create two connections, but both use the same userid and password, |
|---|
| 257 | PHP will share the same connection. This can cause problems if the connections are meant to |
|---|
| 258 | different databases. The solution is to always use different userid's for different databases, |
|---|
| 259 | or use NConnect(). |
|---|
| 260 | |
|---|
| 261 | <a name="dsnsupport"></a> |
|---|
| 262 | </p><h3>Data Source Name (DSN) Support</h3> |
|---|
| 263 | <p> Since ADOdb 4.51, you can connect to a database by passing a dsn to NewADOConnection() (or ADONewConnection, which is |
|---|
| 264 | the same function). The dsn format is: |
|---|
| 265 | </p><pre> $driver://$username:$password@hostname/$database?options[=value]<br></pre><p> |
|---|
| 266 | NewADOConnection() calls Connect() or PConnect() internally for you. If the connection fails, false is returned. |
|---|
| 267 | </p><pre> <font color="#008000"># non-persistent connection</font> |
|---|
| 268 | $dsn = 'mysql://root:pwd@localhost/mydb'; |
|---|
| 269 | $db = NewADOConnection($dsn); |
|---|
| 270 | if (!$db) die("Connection failed"); |
|---|
| 271 | |
|---|
| 272 | <font color="#008000"># no need to call connect/pconnect!</font> |
|---|
| 273 | $arr = $db->GetArray("select * from table"); |
|---|
| 274 | |
|---|
| 275 | <font color="#008000"># persistent connection</font> |
|---|
| 276 | $dsn2 = 'mysql://root:pwd@localhost/mydb?persist'; |
|---|
| 277 | </pre> |
|---|
| 278 | <p> |
|---|
| 279 | If you have special characters such as /:?_ in your dsn, then you need to rawurlencode them first: |
|---|
| 280 | </p><pre> $pwd = rawurlencode($pwd);<br> $dsn = "mysql://root:$pwd@localhost/mydb"; |
|---|
| 281 | $dsn2=rawurlencode("sybase_ase")."://user:pass@host/path?query";<br></pre> |
|---|
| 282 | <p> |
|---|
| 283 | Legal options are: |
|---|
| 284 | </p><p> |
|---|
| 285 | <table align="center" border="1"><tbody><tr><td>For all drivers</td><td> |
|---|
| 286 | 'persist', 'persistent', 'debug', 'fetchmode', 'new' |
|---|
| 287 | </td></tr><tr><td>Interbase/Firebird |
|---|
| 288 | </td><td> |
|---|
| 289 | 'dialect','charset','buffers','role' |
|---|
| 290 | </td></tr><tr><td>M'soft ADO</td><td> |
|---|
| 291 | 'charpage' |
|---|
| 292 | |
|---|
| 293 | </td></tr><tr><td>MySQL</td><td> |
|---|
| 294 | 'clientflags' |
|---|
| 295 | </td></tr><tr><td>MySQLi</td><td> |
|---|
| 296 | 'port', 'socket', 'clientflags' |
|---|
| 297 | </td></tr><tr><td>Oci8</td><td> |
|---|
| 298 | 'nls_date_format','charset' |
|---|
| 299 | </td></tr></tbody></table> |
|---|
| 300 | </p><p> |
|---|
| 301 | For all drivers, when the options <i>persist</i> or <i>persistent</i> are set, a persistent connection is forced; similarly, when <i>new</i> is set, then |
|---|
| 302 | a new connection will be created using NConnect if the underlying driver supports it. |
|---|
| 303 | The <i>debug</i> option enables debugging. The <i>fetchmode</i> calls <a href="#setfetchmode">SetFetchMode()</a>. |
|---|
| 304 | If no value is defined for an option, then the value is set to 1. |
|---|
| 305 | </p><p> |
|---|
| 306 | ADOdb DSN's are compatible with version 1.0 of PEAR DB's DSN format. |
|---|
| 307 | <a name="connect_ex"> |
|---|
| 308 | </a></p><h3><a name="connect_ex">Examples of Connecting to Databases</a></h3> |
|---|
| 309 | <h4><a name="connect_ex">MySQL and Most Other Database Drivers</a></h4> |
|---|
| 310 | <p><a name="connect_ex">MySQL connections are very straightforward, and the parameters are identical |
|---|
| 311 | to mysql_connect:</a></p> |
|---|
| 312 | <pre><a name="connect_ex"> $conn = &ADONewConnection('mysql'); <br> $conn->PConnect('localhost','userid','password','database');<br> <br> <font color="#008000"># or dsn </font> |
|---|
| 313 | $dsn = 'mysql://user:pwd@localhost/mydb'; |
|---|
| 314 | $conn = ADONewConnection($dsn); # no need for Connect() |
|---|
| 315 | |
|---|
| 316 | <font color="#008000"># or persistent dsn</font> |
|---|
| 317 | $dsn = 'mysql://user:pwd@localhost/mydb?persist'; |
|---|
| 318 | $conn = ADONewConnection($dsn); # no need for PConnect() |
|---|
| 319 | |
|---|
| 320 | <font color="#008000"># a more complex example:</font> |
|---|
| 321 | $pwd = urlencode($pwd); |
|---|
| 322 | $flags = MYSQL_CLIENT_COMPRESS; |
|---|
| 323 | $dsn = "mysql://user:$pwd@localhost/mydb?persist&clientflags=$flags"; |
|---|
| 324 | $conn = ADONewConnection($dsn); # no need for PConnect() |
|---|
| 325 | </a></pre> |
|---|
| 326 | <p><a name="connect_ex"> For most drivers, you can use the standard function: Connect($server, $user, $password, $database), or |
|---|
| 327 | a </a><a href="dsnsupport">DSN</a> since ADOdb 4.51. Exceptions to this are listed below. |
|---|
| 328 | </p> |
|---|
| 329 | <a name=pdo> |
|---|
| 330 | <h4>PDO</h4> |
|---|
| 331 | <p>PDO, which only works with PHP5, accepts a driver specific connection string: |
|---|
| 332 | <pre> |
|---|
| 333 | $conn =& NewADConnection('pdo'); |
|---|
| 334 | $conn->Connect('mysql:host=localhost',$user,$pwd,$mydb); |
|---|
| 335 | $conn->Connect('mysql:host=localhost;dbname=mydb',$user,$pwd); |
|---|
| 336 | $conn->Connect("mysql:host=localhost;dbname=mydb;username=$user;password=$pwd"); |
|---|
| 337 | </pre> |
|---|
| 338 | <p>The DSN mechanism is also supported: |
|---|
| 339 | <pre> |
|---|
| 340 | $conn =& NewADConnection("pdo_mysql://user:pwd@localhost/mydb?persist"); # persist is optional |
|---|
| 341 | </pre> |
|---|
| 342 | <h4>PostgreSQL</h4> |
|---|
| 343 | <p>PostgreSQL 7 and 8 accepts connections using: </p> |
|---|
| 344 | <p>a. the standard connection string:</p> |
|---|
| 345 | <pre> $conn = &ADONewConnection('postgres'); <br> $conn->PConnect('host=localhost port=5432 dbname=mary');</pre> |
|---|
| 346 | <p> b. the classical 4 parameters:</p> |
|---|
| 347 | <pre> $conn->PConnect('localhost','userid','password','database');<br> </pre> |
|---|
| 348 | <p>c. dsn: |
|---|
| 349 | </p><pre> $dsn = 'postgres://user:pwd@localhost/mydb?persist'; # persist is optional |
|---|
| 350 | $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> |
|---|
| 351 | <a name="ldap"></a> |
|---|
| 352 | |
|---|
| 353 | <h4>LDAP</h4> |
|---|
| 354 | <p>Here is an example of querying a LDAP server. Thanks to Josh Eldridge for the driver and this example: |
|---|
| 355 | </p><pre> |
|---|
| 356 | require('/path/to/adodb.inc.php'); |
|---|
| 357 | |
|---|
| 358 | /* Make sure to set this BEFORE calling Connect() */ |
|---|
| 359 | $LDAP_CONNECT_OPTIONS = Array( |
|---|
| 360 | Array ("OPTION_NAME"=>LDAP_OPT_DEREF, "OPTION_VALUE"=>2), |
|---|
| 361 | Array ("OPTION_NAME"=>LDAP_OPT_SIZELIMIT,"OPTION_VALUE"=>100), |
|---|
| 362 | Array ("OPTION_NAME"=>LDAP_OPT_TIMELIMIT,"OPTION_VALUE"=>30), |
|---|
| 363 | Array ("OPTION_NAME"=>LDAP_OPT_PROTOCOL_VERSION,"OPTION_VALUE"=>3), |
|---|
| 364 | Array ("OPTION_NAME"=>LDAP_OPT_ERROR_NUMBER,"OPTION_VALUE"=>13), |
|---|
| 365 | Array ("OPTION_NAME"=>LDAP_OPT_REFERRALS,"OPTION_VALUE"=>FALSE), |
|---|
| 366 | Array ("OPTION_NAME"=>LDAP_OPT_RESTART,"OPTION_VALUE"=>FALSE) |
|---|
| 367 | ); |
|---|
| 368 | $host = 'ldap.baylor.edu'; |
|---|
| 369 | $ldapbase = 'ou=People,o=Baylor University,c=US'; |
|---|
| 370 | |
|---|
| 371 | $ldap = NewADOConnection( 'ldap' ); |
|---|
| 372 | $ldap->Connect( $host, $user_name='', $password='', $ldapbase ); |
|---|
| 373 | |
|---|
| 374 | echo "<pre>"; |
|---|
| 375 | |
|---|
| 376 | print_r( $ldap->ServerInfo() ); |
|---|
| 377 | $ldap->SetFetchMode(ADODB_FETCH_ASSOC); |
|---|
| 378 | $userName = 'eldridge'; |
|---|
| 379 | $filter="(|(CN=$userName*)(sn=$userName*)(givenname=$userName*)(uid=$userName*))"; |
|---|
| 380 | |
|---|
| 381 | $rs = $ldap->Execute( $filter ); |
|---|
| 382 | if ($rs) |
|---|
| 383 | while ($arr = $rs->FetchRow()) { |
|---|
| 384 | print_r($arr); |
|---|
| 385 | } |
|---|
| 386 | |
|---|
| 387 | $rs = $ldap->Execute( $filter ); |
|---|
| 388 | if ($rs) |
|---|
| 389 | while (!$rs->EOF) { |
|---|
| 390 | print_r($rs->fields); |
|---|
| 391 | $rs->MoveNext(); |
|---|
| 392 | } |
|---|
| 393 | |
|---|
| 394 | print_r( $ldap->GetArray( $filter ) ); |
|---|
| 395 | print_r( $ldap->GetRow( $filter ) ); |
|---|
| 396 | |
|---|
| 397 | $ldap->Close(); |
|---|
| 398 | echo "</pre>"; |
|---|
| 399 | </pre> |
|---|
| 400 | <p>Using DSN: |
|---|
| 401 | <pre> |
|---|
| 402 | $dsn = "ldap://ldap.baylor.edu/ou=People,o=Baylor University,c=US"; |
|---|
| 403 | $db = NewADOConnection($dsn); |
|---|
| 404 | </pre> |
|---|
| 405 | <h4>Interbase/Firebird</h4> |
|---|
| 406 | You define the database in the $host parameter: |
|---|
| 407 | <pre> $conn = &ADONewConnection('ibase'); <br> $conn->PConnect('localhost:c:\ibase\employee.gdb','sysdba','masterkey');<br></pre> |
|---|
| 408 | <p>Or dsn: |
|---|
| 409 | </p><pre> $dsn = 'firebird://user:pwd@localhost/mydb?persist&dialect=3'; # persist is optional<br> $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> |
|---|
| 410 | <h4>SQLite</h4> |
|---|
| 411 | Sqlite will create the database file if it does not exist. |
|---|
| 412 | <pre> $conn = &ADONewConnection('sqlite'); |
|---|
| 413 | $conn->PConnect('c:\path\to\sqlite.db'); # sqlite will create if does not exist<br></pre> |
|---|
| 414 | <p>Or dsn: |
|---|
| 415 | </p><pre> $path = urlencode('c:\path\to\sqlite.db'); |
|---|
| 416 | $dsn = "sqlite://$path/?persist"; # persist is optional |
|---|
| 417 | $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br></pre> |
|---|
| 418 | <h4>Oracle (oci8)</h4> |
|---|
| 419 | <p>With oci8, you can connect in multiple ways. Note that oci8 works fine with |
|---|
| 420 | newer versions of the Oracle, eg. 9i and 10g.</p> |
|---|
| 421 | <p>a. PHP and Oracle reside on the same machine, use default SID.</p> |
|---|
| 422 | <pre> $conn->Connect(false, 'scott', 'tiger');</pre> |
|---|
| 423 | <p>b. TNS Name defined in tnsnames.ora (or ONAMES or HOSTNAMES), eg. 'myTNS'</p> |
|---|
| 424 | <pre> $conn->PConnect(false, 'scott', 'tiger', 'myTNS');</pre> |
|---|
| 425 | <p>or</p> |
|---|
| 426 | <pre> $conn->PConnect('myTNS', 'scott', 'tiger');</pre> |
|---|
| 427 | <p>c. Host Address and SID</p> |
|---|
| 428 | <pre> |
|---|
| 429 | $conn->connectSID = true; |
|---|
| 430 | $conn->Connect('192.168.0.1', 'scott', 'tiger', 'SID');</pre> |
|---|
| 431 | <p>d. Host Address and Service Name</p> |
|---|
| 432 | <pre> $conn->Connect('192.168.0.1', 'scott', 'tiger', 'servicename');</pre> |
|---|
| 433 | <p>e. Oracle connection string: |
|---|
| 434 | </p><pre> $cstr = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=$host)(PORT=$port))<br> (CONNECT_DATA=(SID=$sid)))";<br> $conn->Connect($cstr, 'scott', 'tiger');<br></pre> |
|---|
| 435 | <p>f. ADOdb dsn: |
|---|
| 436 | </p><pre> $dsn = 'oci8://user:pwd@tnsname/?persist'; # persist is optional<br> $conn = ADONewConnection($dsn); # no need for Connect/PConnect<br> <br> $dsn = 'oci8://user:pwd@host/sid';<br> $conn = ADONewConnection($dsn);<br> <br> $dsn = 'oci8://user:pwd@/'; # oracle on local machine<br> $conn = ADONewConnection($dsn);<br></pre> |
|---|
| 437 | <p>You can also set the charSet for Oracle 9.2 and later, supported since PHP 4.3.2, ADOdb 4.54: |
|---|
| 438 | </p><pre> $conn->charSet = 'we8iso8859p1';<br> $conn->Connect(...);<br> <br> # or<br> $dsn = 'oci8://user:pwd@tnsname/?charset=WE8MSWIN1252';<br> $db = ADONewConnection($dsn);<br></pre> |
|---|
| 439 | <a name="dsnless"></a> |
|---|
| 440 | <h4>DSN-less ODBC ( Access, MSSQL and DB2 examples)</h4> |
|---|
| 441 | <p>ODBC DSN's can be created in the ODBC control panel, or you can use a DSN-less |
|---|
| 442 | connection.To use DSN-less connections with ODBC you need PHP 4.3 or later. |
|---|
| 443 | </p> |
|---|
| 444 | <p>For Microsoft Access:</p> |
|---|
| 445 | <pre> $db =& ADONewConnection('access');<br> $dsn = <strong>"Driver={Microsoft Access Driver (*.mdb)};Dbq=d:\\northwind.mdb;Uid=Admin;Pwd=;";</strong> |
|---|
| 446 | $db->Connect($dsn); |
|---|
| 447 | </pre> |
|---|
| 448 | For Microsoft SQL Server: |
|---|
| 449 | <pre> $db =& ADONewConnection('odbc_mssql');<br> $dsn = <strong>"Driver={SQL Server};Server=localhost;Database=northwind;"</strong>;<br> $db->Connect($dsn,'userid','password');<br></pre> |
|---|
| 450 | or if you prefer to use the mssql extension (which is limited to mssql 6.5 functionality): |
|---|
| 451 | <pre> $db =& ADONewConnection('mssql');<br> $db->Execute('localhost', 'userid', 'password', 'northwind');<br></pre> |
|---|
| 452 | For DB2: |
|---|
| 453 | <pre> |
|---|
| 454 | $dbms = 'db2'; # or 'odbc_db2' if db2 extension not available |
|---|
| 455 | $db =& ADONewConnection($dbms); |
|---|
| 456 | $dsn = "driver={IBM db2 odbc DRIVER};Database=sample;hostname=localhost;port=50000;protocol=TCPIP;". |
|---|
| 457 | "uid=root; pwd=secret";<br> $db->Connect($dsn); |
|---|
| 458 | </pre> |
|---|
| 459 | <b>DSN-less Connections with ADO</b><br> |
|---|
| 460 | If you are using versions of PHP earlier than PHP 4.3.0, DSN-less connections |
|---|
| 461 | only work with Microsoft's ADO, which is Microsoft's COM based API. An example |
|---|
| 462 | using the ADOdb library and Microsoft's ADO: |
|---|
| 463 | <pre><?php<br> include('adodb.inc.php'); <br> $db = &ADONewConnection("ado_mssql");<br> print "<h1>Connecting DSN-less $db->databaseType...</h1>";<br> <br> <b>$myDSN="PROVIDER=MSDASQL;DRIVER={SQL Server};"<br> . "SERVER=flipper;DATABASE=ai;UID=sa;PWD=;" ;</b> |
|---|
| 464 | $db->Connect($myDSN); |
|---|
| 465 | |
|---|
| 466 | $rs = $db->Execute("select * from table"); |
|---|
| 467 | $arr = $rs->GetArray(); |
|---|
| 468 | print_r($arr); |
|---|
| 469 | ?> |
|---|
| 470 | </pre><a name="speed"></a> |
|---|
| 471 | <h2>High Speed ADOdb - tuning tips</h2> |
|---|
| 472 | <p>ADOdb is a big class library, yet it <a href="http://phplens.com/lens/adodb/">consistently beats</a> all other PHP class |
|---|
| 473 | libraries in performance. This is because it is designed in a layered fashion, |
|---|
| 474 | like an onion, with the fastest functions in the innermost layer. Stick to the |
|---|
| 475 | following functions for best performance:</p> |
|---|
| 476 | <table align="center" border="1" width="40%"> |
|---|
| 477 | <tbody><tr> |
|---|
| 478 | <td><div align="center"><b>Innermost Layer</b></div></td> |
|---|
| 479 | </tr> |
|---|
| 480 | <tr> |
|---|
| 481 | <td><p align="center">Connect, PConnect, NConnect<br> |
|---|
| 482 | Execute, CacheExecute<br> |
|---|
| 483 | SelectLimit, CacheSelectLimit<br> |
|---|
| 484 | MoveNext, Close <br> |
|---|
| 485 | qstr, Affected_Rows, Insert_ID</p></td> |
|---|
| 486 | </tr> |
|---|
| 487 | </tbody></table> |
|---|
| 488 | <p>The fastest way to access the field data is by accessing the array $recordset->fields |
|---|
| 489 | directly. Also set the global variables <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a> |
|---|
| 490 | = ADODB_FETCH_NUM, and (for oci8, ibase/firebird and odbc) <a href="#adodb_countrecs">$ADODB_COUNTRECS</a> = false |
|---|
| 491 | before you connect to your database.</p> |
|---|
| 492 | <p>Consider using bind parameters if your database supports it, as it improves |
|---|
| 493 | query plan reuse. Use ADOdb's performance tuning system to identify bottlenecks |
|---|
| 494 | quickly. At the time of writing (Dec 2003), this means oci8 and odbc drivers.</p> |
|---|
| 495 | <p>Lastly make sure you have a PHP accelerator cache installed such as APC, Turck |
|---|
| 496 | MMCache, Zend Accelerator or ionCube.</p> |
|---|
| 497 | <p>Some examples:</p> |
|---|
| 498 | <table align="center" border="1"><tbody><tr><td><b>Fastest data retrieval using PHP</b></td><td><b>Fastest data retrieval using ADOdb extension</b></td></tr> |
|---|
| 499 | <tr><td> |
|---|
| 500 | <pre>$rs =& $rs->Execute($sql);<br>while (!$rs->EOF) {<br> var_dump($rs->fields);<br> $rs->MoveNext();<br>}</pre></td><td> |
|---|
| 501 | <pre>$rs =& $rs->Execute($sql);<br>$array = adodb_getall($rs);<br>var_dump($array);<br><br><br></pre></td></tr></tbody></table> |
|---|
| 502 | <p><b>Advanced Tips</b> |
|---|
| 503 | </p><p>If you have the <a href="http://adodb.sourceforge.net/#extension">ADOdb C extension</a> installed, |
|---|
| 504 | you can replace your calls to $rs->MoveNext() with adodb_movenext($rs). |
|---|
| 505 | This doubles the speed of this operation. For retrieving entire recordsets at once, |
|---|
| 506 | use GetArray(), which uses the high speed extension function adodb_getall($rs) internally. |
|---|
| 507 | </p><p>Execute() is the default way to run queries. You can use the low-level functions _Execute() and _query() |
|---|
| 508 | to reduce query overhead. Both these functions share the same parameters as Execute(). |
|---|
| 509 | </p><p>If you do not have any bind parameters or your database supports |
|---|
| 510 | binding (without emulation), |
|---|
| 511 | then you can call _Execute() directly. Calling this function bypasses |
|---|
| 512 | bind emulation. Debugging is still supported in _Execute(). |
|---|
| 513 | </p><p>If you do not require debugging facilities nor emulated |
|---|
| 514 | binding, and do not require a recordset to be returned, then you can |
|---|
| 515 | call _query. This is great for inserts, updates and deletes. Calling |
|---|
| 516 | this function |
|---|
| 517 | bypasses emulated binding, debugging, and recordset handling. Either |
|---|
| 518 | the resultid, true or false are returned by _query(). </p><p>For Informix, you can disable scrollable cursors with $db->cursorType = 0. |
|---|
| 519 | </p><p><a name="hack"></a> </p> |
|---|
| 520 | <h2>Hacking ADOdb Safely</h2> |
|---|
| 521 | <p>You might want to modify ADOdb for your own purposes. Luckily you can |
|---|
| 522 | still maintain backward compatibility by sub-classing ADOdb and using the $ADODB_NEWCONNECTION |
|---|
| 523 | variable. $ADODB_NEWCONNECTION allows you to override the behaviour of ADONewConnection(). |
|---|
| 524 | ADOConnection() checks for this variable and will call |
|---|
| 525 | the function-name stored in this variable if it is defined. |
|---|
| 526 | </p><p>In the following example, new functionality for the connection object |
|---|
| 527 | is placed in the <i>hack_mysql</i> and <i>hack_postgres7</i> classes. The recordset class naming convention |
|---|
| 528 | can be controlled using $rsPrefix. Here we set it to 'hack_rs_', which will make ADOdb use |
|---|
| 529 | <i>hack_rs_mysql</i> and <i>hack_rs_postgres7</i> as the recordset classes. |
|---|
| 530 | |
|---|
| 531 | |
|---|
| 532 | </p><pre>class hack_mysql extends adodb_mysql {<br>var $rsPrefix = 'hack_rs_';<br> /* Your mods here */<br>}<br><br>class hack_rs_mysql extends ADORecordSet_mysql {<br> /* Your mods here */<br>}<br><br>class hack_postgres7 extends adodb_postgres7 {<br>var $rsPrefix = 'hack_rs_';<br> /* Your mods here */<br>}<br><br>class hack_rs_postgres7 extends ADORecordSet_postgres7 {<br> /* Your mods here */<br>}<br><br>$ADODB_NEWCONNECTION = 'hack_factory';<br><br>function& hack_factory($driver)<br>{<br> if ($driver !== 'mysql' && $driver !== 'postgres7') return false;<br> <br> $driver = 'hack_'.$driver;<br> $obj = new $driver();<br> return $obj;<br>}<br><br>include_once('adodb.inc.php');<br></pre> |
|---|
| 533 | <p></p><p>Don't forget to call the constructor of the parent class in |
|---|
| 534 | your constructor. If you want to use the default ADOdb drivers return |
|---|
| 535 | false in the above hack_factory() function. |
|---|
| 536 | Also you can define your own ADORecordSet_empty() class, by defining a class $$this->rsPrefix.'empty' since 4.96/5.02. |
|---|
| 537 | <a name="php5"></a> |
|---|
| 538 | </p><h2>PHP5 Features</h2> |
|---|
| 539 | ADOdb 4.02 or later will transparently determine which version of PHP you are using. |
|---|
| 540 | If PHP5 is detected, the following features become available: |
|---|
| 541 | <ul> |
|---|
| 542 | |
|---|
| 543 | <li><b>PDO</b>: PDO drivers are available. See the <a href=#pdo>connection examples</a>. Currently PDO drivers are |
|---|
| 544 | not as powerful as native drivers, and should be treated as experimental.<br><br> |
|---|
| 545 | <a name="php5iterators"></a> |
|---|
| 546 | <li><b>Foreach iterators</b>: This is a very natural way of going through a recordset: |
|---|
| 547 | <pre> $ADODB_FETCH_MODE = ADODB_FETCH_NUM;<br> $rs = $db->Execute($sql);<br> foreach($rs as $k => $row) {<br> echo "r1=".$row[0]." r2=".$row[1]."<br>";<br> }<br></pre> |
|---|
| 548 | <p> |
|---|
| 549 | <a name="php5exceptions"></a> |
|---|
| 550 | </p></li><li><b>Exceptions</b>: Just include <i>adodb-exceptions.inc.php</i> and you can now |
|---|
| 551 | catch exceptions on errors as they occur. |
|---|
| 552 | <pre> <b>include("../adodb-exceptions.inc.php");</b> <br> include("../adodb.inc.php"); <br> try { <br> $db = NewADOConnection("oci8"); <br> $db->Connect('','scott','bad-password'); <br> } catch (exception $e) { <br> var_dump($e); <br> adodb_backtrace($e->gettrace());<br> } <br></pre> |
|---|
| 553 | <p>Note that reaching EOF is <b>not</b> considered an error nor an exception. |
|---|
| 554 | </p></li></ul> |
|---|
| 555 | <h3><a name="drivers"></a>Databases Supported</h3> |
|---|
| 556 | The <i>name</i> below is the value you pass to NewADOConnection($name) to create a connection object for that database. |
|---|
| 557 | <p> |
|---|
| 558 | </p><p> |
|---|
| 559 | </p><table border="1" width="100%"> |
|---|
| 560 | <tbody><tr valign="top"> |
|---|
| 561 | <td><b>Name</b></td> |
|---|
| 562 | <td><b>Tested</b></td> |
|---|
| 563 | <td><b>Database</b></td> |
|---|
| 564 | <td><b><font size="2">RecordCount() usable</font></b></td> |
|---|
| 565 | <td><b>Prerequisites</b></td> |
|---|
| 566 | <td><b>Operating Systems</b></td> |
|---|
| 567 | </tr> |
|---|
| 568 | <tr valign="top"> |
|---|
| 569 | <td><b><font size="2">access</font></b></td> |
|---|
| 570 | <td><font size="2">B</font></td> |
|---|
| 571 | <td><font size="2">Microsoft Access/Jet. You need to create an ODBC DSN.</font></td> |
|---|
| 572 | <td><font size="2">Y/N</font></td> |
|---|
| 573 | <td><font size="2">ODBC </font></td> |
|---|
| 574 | <td><font size="2">Windows only</font></td> |
|---|
| 575 | </tr> |
|---|
| 576 | <tr valign="top"> |
|---|
| 577 | <td><b><font size="2">ado</font></b></td> |
|---|
| 578 | <td><font size="2">B</font></td> |
|---|
| 579 | <td><p><font size="2">Generic ADO, not tuned for specific databases. Allows |
|---|
| 580 | DSN-less connections. For best performance, use an OLEDB provider. This |
|---|
| 581 | is the base class for all ado drivers.</font></p> |
|---|
| 582 | <p><font size="2">You can set $db->codePage before connecting.</font></p></td> |
|---|
| 583 | <td><font size="2">? depends on database</font></td> |
|---|
| 584 | <td><font size="2">ADO or OLEDB provider</font></td> |
|---|
| 585 | <td><font size="2">Windows only</font></td> |
|---|
| 586 | </tr> |
|---|
| 587 | <tr valign="top"> |
|---|
| 588 | <td><b><font size="2">ado_access</font></b></td> |
|---|
| 589 | <td><font size="2">B</font></td> |
|---|
| 590 | <td><font size="2">Microsoft Access/Jet using ADO. Allows DSN-less connections. |
|---|
| 591 | For best performance, use an OLEDB provider.</font></td> |
|---|
| 592 | <td><font size="2">Y/N</font></td> |
|---|
| 593 | <td><font size="2">ADO or OLEDB provider</font></td> |
|---|
| 594 | <td><font size="2">Windows only</font></td> |
|---|
| 595 | </tr> |
|---|
| 596 | <tr valign="top"> |
|---|
| 597 | <td><b><font size="2">ado_mssql</font></b></td> |
|---|
| 598 | <td><font size="2">B</font></td> |
|---|
| 599 | <td><font size="2">Microsoft SQL Server using ADO. Allows DSN-less connections. |
|---|
| 600 | For best performance, use an OLEDB provider.</font></td> |
|---|
| 601 | <td><font size="2">Y/N</font></td> |
|---|
| 602 | <td><font size="2">ADO or OLEDB provider</font></td> |
|---|
| 603 | <td><font size="2">Windows only</font></td> |
|---|
| 604 | </tr> |
|---|
| 605 | <tr valign="top"> |
|---|
| 606 | <td height="54"><b><font size="2">db2</font></b></td> |
|---|
| 607 | <td height="54"><font size="2">C</font></td> |
|---|
| 608 | <td height="54"><font size="2">Uses PHP's db2-specific extension for better performance.</font></td> |
|---|
| 609 | <td height="54"><font size="2">Y/N</font></td> |
|---|
| 610 | <td height="54"><font size="2">DB2 CLI/ODBC interface</font></td> |
|---|
| 611 | <td height="54"> <p><font size="2">Unix and Windows. Requires IBM DB2 Universal Database client.</font></p></td> |
|---|
| 612 | </tr> |
|---|
| 613 | <tr valign="top"> |
|---|
| 614 | <td height="54"><b><font size="2">odbc_db2</font></b></td> |
|---|
| 615 | <td height="54"><font size="2">C</font></td> |
|---|
| 616 | <td height="54"><font size="2">Connects to DB2 using generic ODBC extension.</font></td> |
|---|
| 617 | <td height="54"><font size="2">Y/N</font></td> |
|---|
| 618 | <td height="54"><font size="2">DB2 CLI/ODBC interface</font></td> |
|---|
| 619 | <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 |
|---|
| 620 | 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> |
|---|
| 621 | </tr> |
|---|
| 622 | <tr valign="top"> |
|---|
| 623 | <td><b><font size="2">vfp</font></b></td> |
|---|
| 624 | <td><font size="2">A</font></td> |
|---|
| 625 | <td><font size="2">Microsoft Visual FoxPro. You need to create an ODBC DSN.</font></td> |
|---|
| 626 | <td><font size="2">Y/N</font></td> |
|---|
| 627 | <td><font size="2">ODBC</font></td> |
|---|
| 628 | <td><font size="2">Windows only</font></td> |
|---|
| 629 | </tr> |
|---|
| 630 | <tr valign="top"> |
|---|
| 631 | <td><b><font size="2">fbsql</font></b></td> |
|---|
| 632 | <td><font size="2">C</font></td> |
|---|
| 633 | <td><font size="2">FrontBase. </font></td> |
|---|
| 634 | <td><font size="2">Y</font></td> |
|---|
| 635 | <td><font size="2">?</font></td> |
|---|
| 636 | <td> <p><font size="2">Unix and Windows</font></p></td> |
|---|
| 637 | </tr> |
|---|
| 638 | <tr valign="top"> |
|---|
| 639 | <td><b><font size="2">ibase</font></b></td> |
|---|
| 640 | <td><font size="2">B</font></td> |
|---|
| 641 | <td><font size="2">Interbase 6 or earlier. Some users report you might need |
|---|
| 642 | to use this<br> |
|---|
| 643 | $db->PConnect('localhost:c:/ibase/employee.gdb', "sysdba", "masterkey") |
|---|
| 644 | to connect. Lacks Affected_Rows currently.<br> |
|---|
| 645 | <br> |
|---|
| 646 | You can set $db->role, $db->dialect, $db->buffers and $db->charSet before connecting.</font></td> |
|---|
| 647 | <td><font size="2">Y/N</font></td> |
|---|
| 648 | <td><font size="2">Interbase client</font></td> |
|---|
| 649 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 650 | </tr> |
|---|
| 651 | <tr valign="top"> |
|---|
| 652 | <td><b><i><font size="2">firebird</font></i></b></td> |
|---|
| 653 | <td><font size="2">C</font></td> |
|---|
| 654 | <td><font size="2">Firebird version of interbase.</font></td> |
|---|
| 655 | <td><font size="2">Y/N</font></td> |
|---|
| 656 | <td><font size="2">Interbase client</font></td> |
|---|
| 657 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 658 | </tr> |
|---|
| 659 | <tr valign="top"> |
|---|
| 660 | <td><b><i><font size="2">borland_ibase</font></i></b></td> |
|---|
| 661 | <td><font size="2">C</font></td> |
|---|
| 662 | <td><font size="2">Borland version of Interbase 6.5 or later. Very sad that |
|---|
| 663 | the forks differ.</font></td> |
|---|
| 664 | <td><font size="2">Y/N</font></td> |
|---|
| 665 | <td><font size="2">Interbase client</font></td> |
|---|
| 666 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 667 | </tr> |
|---|
| 668 | |
|---|
| 669 | <tr valign="top"> |
|---|
| 670 | <td><b><font size="2">informix</font></b></td> |
|---|
| 671 | <td><font size="2">C</font></td> |
|---|
| 672 | <td><font size="2">Generic informix driver. Use this if you are using Informix 7.3 or later.</font></td> |
|---|
| 673 | <td><font size="2">Y/N</font></td> |
|---|
| 674 | <td><font size="2">Informix client</font></td> |
|---|
| 675 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 676 | </tr> |
|---|
| 677 | <tr valign="top"> |
|---|
| 678 | <td><b><font size="2">informix72</font></b></td> |
|---|
| 679 | <td><font size="2">C</font></td> |
|---|
| 680 | <td><font size="2"> Informix databases before Informix 7.3 that do no support |
|---|
| 681 | SELECT FIRST.</font></td> |
|---|
| 682 | <td><font size="2">Y/N</font></td> |
|---|
| 683 | <td><font size="2">Informix client</font></td> |
|---|
| 684 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 685 | </tr> |
|---|
| 686 | <tr valign="top"> |
|---|
| 687 | <td><b><font size="2">ldap</font></b></td> |
|---|
| 688 | <td><font size="2">C</font></td> |
|---|
| 689 | <td><font size="2">LDAP driver. See this example for usage information.</font></td> |
|---|
| 690 | <td> </td> |
|---|
| 691 | <td><font size="2">LDAP extension</font></td> |
|---|
| 692 | <td><font size="2">?</font></td> |
|---|
| 693 | </tr> |
|---|
| 694 | <tr valign="top"> |
|---|
| 695 | <td height="73"><b><font size="2">mssql</font></b></td> |
|---|
| 696 | <td height="73"><font size="2">A</font></td> |
|---|
| 697 | <td height="73"> <p><font size="2">Microsoft SQL Server 7 and later. Works |
|---|
| 698 | with Microsoft SQL Server 2000 also. Note that date formating is problematic |
|---|
| 699 | with this driver. For example, the PHP mssql extension does not return |
|---|
| 700 | the seconds for datetime!</font></p></td> |
|---|
| 701 | <td height="73"><font size="2">Y/N</font></td> |
|---|
| 702 | <td height="73"><font size="2">Mssql client</font></td> |
|---|
| 703 | <td height="73"> <p><font size="2">Unix and Windows. <br> |
|---|
| 704 | <a href="http://phpbuilder.com/columns/alberto20000919.php3">Unix install |
|---|
| 705 | howto</a> and <a href="http://linuxjournal.com/article.php?sid=6636&mode=thread&order=0">another |
|---|
| 706 | one</a>. </font></p></td> |
|---|
| 707 | </tr> |
|---|
| 708 | <tr valign="top"> |
|---|
| 709 | <td height="73"><b><font size="2">mssqlpo</font></b></td> |
|---|
| 710 | <td height="73"><font size="2">A</font></td> |
|---|
| 711 | <td height="73"> <p><font size="2">Portable mssql driver. Identical to above |
|---|
| 712 | mssql driver, except that '||', the concatenation operator, is converted |
|---|
| 713 | to '+'. Useful for porting scripts from most other sql variants that use |
|---|
| 714 | ||.</font></p></td> |
|---|
| 715 | <td height="73"><font size="2">Y/N</font></td> |
|---|
| 716 | <td height="73"><font size="2">Mssql client</font></td> |
|---|
| 717 | <td height="73"> <p><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3"><br> |
|---|
| 718 | Unix install howto</a>.</font></p></td> |
|---|
| 719 | </tr> |
|---|
| 720 | <tr valign="top"> |
|---|
| 721 | <td><b><font size="2">mysql</font></b></td> |
|---|
| 722 | <td><font size="2">A</font></td> |
|---|
| 723 | <td><font size="2">MySQL without transaction support. You can also set $db->clientFlags |
|---|
| 724 | before connecting.</font></td> |
|---|
| 725 | <td><font size="2">Y</font></td> |
|---|
| 726 | <td><font size="2">MySQL client</font></td> |
|---|
| 727 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 728 | </tr> |
|---|
| 729 | <tr valign="top"> |
|---|
| 730 | <td><font size="2"><b>mysqlt</b> or <b>maxsql</b></font></td> |
|---|
| 731 | <td><font size="2">A</font></td> |
|---|
| 732 | <td> <p><font size="2">MySQL with transaction support. We recommend using |
|---|
| 733 | || as the concat operator for best portability. This can be done by running |
|---|
| 734 | MySQL using: <br> |
|---|
| 735 | <i>mysqld --ansi</i> or <i>mysqld --sql-mode=PIPES_AS_CONCAT</i></font></p></td> |
|---|
| 736 | <td><font size="2">Y/N</font></td> |
|---|
| 737 | <td><font size="2">MySQL client</font></td> |
|---|
| 738 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 739 | </tr> |
|---|
| 740 | <tr valign="top"> |
|---|
| 741 | <td><b><font size="2">oci8</font></b></td> |
|---|
| 742 | <td><font size="2">A</font></td> |
|---|
| 743 | <td><font size="2">Oracle 8/9. Has more functionality than <i>oracle</i> driver |
|---|
| 744 | (eg. Affected_Rows). You might have to putenv('ORACLE_HOME=...') before |
|---|
| 745 | Connect/PConnect. </font> <p><font size="2"> There are 2 ways of connecting |
|---|
| 746 | - with server IP and service name: <br> |
|---|
| 747 | <i>PConnect('serverip:1521','scott','tiger','service'</i>)<br> |
|---|
| 748 | or using an entry in TNSNAMES.ORA or ONAMES or HOSTNAMES: <br> |
|---|
| 749 | <i>PConnect(false, 'scott', 'tiger', $oraname)</i>. </font> |
|---|
| 750 | </p><p><font size="2">Since 2.31, we support Oracle REF cursor variables directly |
|---|
| 751 | (see <a href="#executecursor">ExecuteCursor</a>).</font> </p></td> |
|---|
| 752 | <td><font size="2">Y/N</font></td> |
|---|
| 753 | <td><font size="2">Oracle client</font></td> |
|---|
| 754 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 755 | </tr> |
|---|
| 756 | <tr valign="top"> |
|---|
| 757 | <td><b><font size="2">oci805</font></b></td> |
|---|
| 758 | <td><font size="2">C</font></td> |
|---|
| 759 | <td><font size="2">Supports reduced Oracle functionality for Oracle 8.0.5. |
|---|
| 760 | SelectLimit is not as efficient as in the oci8 or oci8po drivers.</font></td> |
|---|
| 761 | <td><font size="2">Y/N</font></td> |
|---|
| 762 | <td><font size="2">Oracle client</font></td> |
|---|
| 763 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 764 | </tr> |
|---|
| 765 | <tr valign="top"> |
|---|
| 766 | <td><b><font size="2">oci8po</font></b></td> |
|---|
| 767 | <td><font size="2">A</font></td> |
|---|
| 768 | <td><font size="2">Oracle 8/9 portable driver. This is nearly identical with |
|---|
| 769 | the oci8 driver except (a) bind variables in Prepare() use the ? convention, |
|---|
| 770 | instead of :bindvar, (b) field names use the more common PHP convention |
|---|
| 771 | of lowercase names. </font> <p><font size="2">Use this driver if porting |
|---|
| 772 | from other databases is important. Otherwise the oci8 driver offers better |
|---|
| 773 | performance. </font> </p></td> |
|---|
| 774 | <td><font size="2">Y/N</font></td> |
|---|
| 775 | <td><font size="2">Oracle client</font></td> |
|---|
| 776 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 777 | </tr> |
|---|
| 778 | <tr valign="top"> |
|---|
| 779 | <td><b><font size="2">odbc</font></b></td> |
|---|
| 780 | <td><font size="2">A</font></td> |
|---|
| 781 | <td><font size="2">Generic ODBC, not tuned for specific databases. To connect, |
|---|
| 782 | use <br> |
|---|
| 783 | PConnect('DSN','user','pwd'). This is the base class for all odbc derived |
|---|
| 784 | drivers.</font></td> |
|---|
| 785 | <td><font size="2">? depends on database</font></td> |
|---|
| 786 | <td><font size="2">ODBC</font></td> |
|---|
| 787 | <td><font size="2">Unix and Windows. <a href="http://phpbuilder.com/columns/alberto20000919.php3?page=4">Unix |
|---|
| 788 | hints.</a></font></td> |
|---|
| 789 | </tr> |
|---|
| 790 | <tr valign="top"> |
|---|
| 791 | <td><b><font size="2">odbc_mssql</font></b></td> |
|---|
| 792 | <td><font size="2">C</font></td> |
|---|
| 793 | <td><font size="2">Uses ODBC to connect to MSSQL</font></td> |
|---|
| 794 | <td><font size="2">Y/N</font></td> |
|---|
| 795 | <td><font size="2">ODBC</font></td> |
|---|
| 796 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 797 | </tr> |
|---|
| 798 | <tr valign="top"> |
|---|
| 799 | <td><b><font size="2">odbc_oracle</font></b></td> |
|---|
| 800 | <td><font size="2">C</font></td> |
|---|
| 801 | <td><font size="2">Uses ODBC to connect to Oracle</font></td> |
|---|
| 802 | <td><font size="2">Y/N</font></td> |
|---|
| 803 | <td><font size="2">ODBC</font></td> |
|---|
| 804 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 805 | </tr> |
|---|
| 806 | |
|---|
| 807 | <tr valign="top"> |
|---|
| 808 | <td><b><font size="2">odbtp</font></b></td> |
|---|
| 809 | <td><font size="2">C</font></td> |
|---|
| 810 | <td><font size="2">Generic odbtp driver. <a href="http://odbtp.sourceforge.net/">Odbtp</a> is a software for |
|---|
| 811 | accessing Windows ODBC data sources from other operating systems.</font></td> |
|---|
| 812 | <td><font size="2">Y/N</font></td> |
|---|
| 813 | <td><font size="2">odbtp</font></td> |
|---|
| 814 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 815 | </tr> |
|---|
| 816 | <tr valign="top"> |
|---|
| 817 | <td><b><font size="2">odbtp_unicode</font></b></td> |
|---|
| 818 | <td><font size="2">C</font></td> |
|---|
| 819 | <td><font size="2">Odtbp with unicode support</font></td> |
|---|
| 820 | <td><font size="2">Y/N</font></td> |
|---|
| 821 | <td><font size="2">odbtp</font></td> |
|---|
| 822 | <td><font size="2">Unix and Windows</font></td> |
|---|
| 823 | </tr> |
|---|
| 824 | <tr valign="top"> |
|---|
| 825 | <td height="34"><b><font size="2">oracle</font></b></td> |
|---|
| 826 | <td height="34"><font size="2">C</font></td> |
|---|
| 827 | <td height="34"><font size="2">Implements old Oracle 7 client API. Use oci8 |
|---|
| 828 | driver if possible for better performance.</font></td> |
|---|
| 829 | <td height="34"><font size="2">Y/N</font></td> |
|---|
| 830 | <td height="34"><font size="2">Oracle client</font></td> |
|---|
| 831 | <td height="34"><font size="2">Unix and Windows</font></td> |
|---|
| 832 | </tr> |
|---|
| 833 | <tr valign="top"> |
|---|
| 834 | <td height="34"><b><font size="2">netezza</font></b></td> |
|---|
| 835 | <td height="34"><font size="2">C</font></td> |
|---|
| 836 | <td height="34"><font size="2">Netezza driver. Netezza is based on postgres code-base.</font></td> |
|---|
| 837 | <td height="34"><font size="2">Y</font></td> |
|---|
| 838 | <td height="34"><font size="2">?</font></td> |
|---|
| 839 | <td height="34"><font size="2">?</font></td> |
|---|
| 840 | </tr> |
|---|
| 841 | <tr valign="top"> |
|---|
| 842 | <td><b><font size="2">pdo</font></b></td> |
|---|
| 843 | <td><font size="2">C</font></td> |
|---|
| 844 | <td><font size="2">Generic PDO driver for PHP5. </font></td> |
|---|
| 845 | <td><font size="2">Y</font></td> |
|---|
| 846 | <td><font size="2">PDO extension and database specific drivers</font></td> |
|---|
| 847 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 848 | </tr> |
|---|
| 849 | <tr valign="top"> |
|---|
| 850 | <td><b><font size="2">postgres</font></b></td> |
|---|
| 851 | <td><font size="2">A</font></td> |
|---|
| 852 | <td><font size="2">Generic PostgreSQL driver. Currently identical to postgres7 |
|---|
| 853 | driver.</font></td> |
|---|
| 854 | <td><font size="2">Y</font></td> |
|---|
| 855 | <td><font size="2">PostgreSQL client</font></td> |
|---|
| 856 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 857 | </tr> |
|---|
| 858 | <tr valign="top"> |
|---|
| 859 | <td><b><font size="2">postgres64</font></b></td> |
|---|
| 860 | <td><font size="2">A</font></td> |
|---|
| 861 | <td><font size="2">For PostgreSQL 6.4 and earlier which does not support LIMIT |
|---|
| 862 | internally.</font></td> |
|---|
| 863 | <td><font size="2">Y</font></td> |
|---|
| 864 | <td><font size="2">PostgreSQL client</font></td> |
|---|
| 865 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 866 | </tr> |
|---|
| 867 | <tr valign="top"> |
|---|
| 868 | <td><b><font size="2">postgres7</font></b></td> |
|---|
| 869 | <td><font size="2">A</font></td> |
|---|
| 870 | <td><font size="2">PostgreSQL which supports LIMIT and other version 7 functionality.</font></td> |
|---|
| 871 | <td><font size="2">Y</font></td> |
|---|
| 872 | <td><font size="2">PostgreSQL client</font></td> |
|---|
| 873 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 874 | </tr> |
|---|
| 875 | <tr valign="top"> |
|---|
| 876 | <td><b><font size="2">postgres8</font></b></td> |
|---|
| 877 | <td><font size="2">A</font></td> |
|---|
| 878 | <td><font size="2">PostgreSQL which supports version 8 functionality.</font></td> |
|---|
| 879 | <td><font size="2">Y</font></td> |
|---|
| 880 | <td><font size="2">PostgreSQL client</font></td> |
|---|
| 881 | <td><font size="2">Unix and Windows. </font></td> |
|---|
| 882 | </tr> |
|---|
| 883 | <tr valign="top"> |
|---|
| 884 | <td><b><font size="2">sapdb</font></b></td> |
|---|
| 885 | <td><font size="2">C</font></td> |
|---|
| 886 | <td><font size="2">SAP DB. Should work reliably as based on ODBC driver.</font></td> |
|---|
| 887 | <td><font size="2">Y/N</font></td> |
|---|
| 888 | <td><font size="2">SAP ODBC client</font></td> |
|---|
| 889 | <td> <p><font size="2">?</font></p></td> |
|---|
| 890 | </tr> |
|---|
| 891 | <tr valign="top"> |
|---|
| 892 | <td><b><font size="2">sqlanywhere</font></b></td> |
|---|
| 893 | <td><font size="2">C</font></td> |
|---|
| 894 | <td><font size="2">Sybase SQL Anywhere. Should work reliably as based on ODBC |
|---|
| 895 | driver.</font></td> |
|---|
| 896 | <td><font size="2">Y/N</font></td> |
|---|
| 897 | <td><font size="2">SQL Anywhere ODBC client</font></td> |
|---|
| 898 | <td> <p><font size="2">?</font></p></td> |
|---|
| 899 | </tr> |
|---|
| 900 | <tr valign="top"> |
|---|
| 901 | <td height="54"><b><font size="2">sqlite</font></b></td> |
|---|
| 902 | <td height="54"><font size="2">B</font></td> |
|---|
| 903 | <td height="54"><font size="2">SQLite.</font></td> |
|---|
| 904 | <td height="54"><font size="2">Y</font></td> |
|---|
| 905 | <td height="54"><font size="2">-</font></td> |
|---|
| 906 | <td height="54"> <p><font size="2">Unix and Windows.</font></p></td> |
|---|
| 907 | </tr> |
|---|
| 908 | <tr valign="top"> |
|---|
| 909 | <td height="54"><b><font size="2">sqlitepo</font></b></td> |
|---|
| 910 | <td height="54"><font size="2">B</font></td> |
|---|
| 911 | <td height="54"><font size="2">Portable SQLite driver. This is because assoc mode does not work like other drivers in sqlite. |
|---|
| 912 | Namely, when selecting (joining) multiple tables, the table |
|---|
| 913 | names are included in the assoc keys in the "sqlite" driver.</font><p> |
|---|
| 914 | <font size="2"> In "sqlitepo" driver, the table names are stripped from the returned column names. |
|---|
| 915 | When this results in a conflict, the first field get preference. |
|---|
| 916 | </font></p></td> |
|---|
| 917 | <td height="54"><font size="2">Y</font></td> |
|---|
| 918 | <td height="54"><font size="2">-</font></td> |
|---|
| 919 | <td height="54"> <p><font size="2">Unix and Windows.</font></p></td> |
|---|
| 920 | </tr> |
|---|
| 921 | |
|---|
| 922 | |
|---|
| 923 | <tr valign="top"> |
|---|
| 924 | <td><b><font size="2">sybase</font></b></td> |
|---|
| 925 | <td><font size="2">C</font></td> |
|---|
| 926 | <td><font size="2">Sybase. </font></td> |
|---|
| 927 | <td><font size="2">Y/N</font></td> |
|---|
| 928 | <td><font size="2">Sybase client</font></td> |
|---|
| 929 | <td> <p><font size="2">Unix and Windows.</font></p></td> |
|---|
| 930 | </tr> |
|---|
| 931 | |
|---|
| 932 | <tr valign="top"> |
|---|
| 933 | <td><b><font size="2">sybase_ase</font></b></td> |
|---|
| 934 | <td><font size="2">C</font></td> |
|---|
| 935 | <td><font size="2">Sybase ASE. </font></td> |
|---|
| 936 | <td><font size="2">Y/N</font></td> |
|---|
| 937 | <td><font size="2">Sybase client</font></td> |
|---|
| 938 | <td> <p><font size="2">Unix and Windows.</font></p></td> |
|---|
| 939 | </tr> |
|---|
| 940 | </tbody></table> |
|---|
| 941 | |
|---|
| 942 | <p></p><p>The "Tested" column indicates how extensively the code has been tested |
|---|
| 943 | and used. <br> |
|---|
| 944 | A = well tested and used by many people<br> |
|---|
| 945 | B = tested and usable, but some features might not be implemented<br> |
|---|
| 946 | C = user contributed or experimental driver. Might not fully support all of |
|---|
| 947 | the latest features of ADOdb. </p> |
|---|
| 948 | <p>The column "RecordCount() usable" indicates whether RecordCount() |
|---|
| 949 | return the number of rows, or returns -1 when a SELECT statement is executed. |
|---|
| 950 | If this column displays Y/N then the RecordCount() is emulated when the global |
|---|
| 951 | variable $ADODB_COUNTRECS=true (this is the default). Note that for large recordsets, |
|---|
| 952 | it might be better to disable RecordCount() emulation because substantial amounts |
|---|
| 953 | of memory are required to cache the recordset for counting. Also there is a |
|---|
| 954 | speed penalty of 40-50% if emulation is required. This is emulated in most databases |
|---|
| 955 | except for PostgreSQL and MySQL. This variable is checked every time a query |
|---|
| 956 | is executed, so you can selectively choose which recordsets to count.</p> |
|---|
| 957 | <p> |
|---|
| 958 | </p><hr /> |
|---|
| 959 | <h1>Tutorials<a name="quickstart"></a></h1> |
|---|
| 960 | <h3>Example 1: Select Statement<a name="ex1"></a></h3> |
|---|
| 961 | <p>Task: Connect to the Access Northwind DSN, display the first 2 columns of each |
|---|
| 962 | row.</p> |
|---|
| 963 | <p>In this example, we create a ADOConnection object, which represents the connection |
|---|
| 964 | to the database. The connection is initiated with <a href="#pconnect"><font face="Courier New, Courier, mono">PConnect</font></a>, |
|---|
| 965 | which is a persistent connection. Whenever we want to query the database, we |
|---|
| 966 | call the <font face="Courier New, Courier, mono">ADOConnection.<a href="#execute">Execute</a>()</font> |
|---|
| 967 | function. This returns an ADORecordSet object which is actually a cursor that |
|---|
| 968 | holds the current row in the array <font face="Courier New, Courier, mono">fields[]</font>. |
|---|
| 969 | We use <font face="Courier New, Courier, mono"><a href="#movenext">MoveNext</a>()</font> |
|---|
| 970 | to move from row to row.</p> |
|---|
| 971 | <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>, |
|---|
| 972 | which allows us to limit the number of rows shown. |
|---|
| 973 | </p><pre><?<br><font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind DSN<br>$<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select * from products');<br>if (!$<font color="#660000">recordSet</font>) <br> print $<font color="#660000">conn</font>->ErrorMsg();<br>else<br><b>while</b> (!$<font color="#660000">recordSet</font>->EOF) {<br> <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';<br> $<font color="#660000">recordSet</font>->MoveNext();<br>}</font><font face="Courier New, Courier, mono"> |
|---|
| 974 | |
|---|
| 975 | $<font color="#660000">recordSet</font>->Close(); # optional<br>$<font color="#660000">conn</font>->Close(); # optional<br></font> |
|---|
| 976 | ?> |
|---|
| 977 | </pre> |
|---|
| 978 | <p>The $<font face="Courier New, Courier, mono">recordSet</font> returned stores |
|---|
| 979 | the current row in the <font face="Courier New, Courier, mono">$recordSet->fields</font> |
|---|
| 980 | array, indexed by column number (starting from zero). We use the <font face="Courier New, Courier, mono"><a href="#movenext">MoveNext</a>()</font> |
|---|
| 981 | function to move to the next row. The <font face="Courier New, Courier, mono">EOF</font> |
|---|
| 982 | property is set to true when end-of-file is reached. If an error occurs in Execute(), |
|---|
| 983 | we return false instead of a recordset.</p> |
|---|
| 984 | <p>The <code>$recordSet->fields[]</code> array is generated by the PHP database |
|---|
| 985 | extension. Some database extensions only index by number and do not index the |
|---|
| 986 | array by field name. To force indexing by name - that is associative arrays |
|---|
| 987 | - use the SetFetchMode function. Each recordset saves and uses whatever fetch |
|---|
| 988 | mode was set when the recordset was created in Execute() or SelectLimit(). |
|---|
| 989 | </p><pre> $db->SetFetchMode(ADODB_FETCH_NUM);<br> $rs1 = $db->Execute('select * from table');<br> $db->SetFetchMode(ADODB_FETCH_ASSOC);<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> |
|---|
| 990 | print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i> |
|---|
| 991 | </pre> |
|---|
| 992 | <p> </p> |
|---|
| 993 | <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>. |
|---|
| 994 | Note that it can return -1 if the number of rows returned cannot be determined.</p> |
|---|
| 995 | <h3>Example 2: Advanced Select with Field Objects<a name="ex2"></a></h3> |
|---|
| 996 | <p>Select a table, display the first two columns. If the second column is a date |
|---|
| 997 | or timestamp, reformat the date to US format.</p> |
|---|
| 998 | <pre><?<br><font face="Courier New, Courier, mono"><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br>$<font color="#660000">recordSet</font> = &$<font color="#660000">conn</font>->Execute('select CustomerID,OrderDate from Orders');<br>if (!$<font color="#660000">recordSet</font>) <br> print $<font color="#660000">conn</font>->ErrorMsg();<br>else<br><b>while</b> (!$<font color="#660000">recordSet</font>->EOF) {<br> $<font color="#660000">fld</font> = <font color="#336600"><b>$</b><font color="#660000">recordSet</font><b>->FetchField</b></font><font color="#006600">(</font>1<font color="#006600">);</font> |
|---|
| 999 | $<font color="#660000">type</font> = <font color="#336600"><b>$</b><font color="#660000">recordSet</font><b>->MetaType</b></font>($fld->type);<br><br> <b>if</b> ( $<font color="#660000">type</font> == 'D' || $<font color="#660000">type</font> == 'T') <br> <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.<br> <b><font color="#336600">$</font></b><font color="#660000">recordSet</font><b><font color="#336600">->UserDate</font></b>($<font color="#660000">recordSet</font>->fields[1],'<b>m/d/Y</b>').'<BR>';<br> <b>else </b> |
|---|
| 1000 | <b>print</b> $<font color="#660000">recordSet</font>->fields[0].' '.$<font color="#660000">recordSet</font>->fields[1].'<BR>';<br><br> $<font color="#660000">recordSet</font>->MoveNext();<br>}</font><font face="Courier New, Courier, mono"> |
|---|
| 1001 | $<font color="#660000">recordSet</font>->Close(); # optional<br>$<font color="#660000">conn</font>->Close(); # optional<br></font> |
|---|
| 1002 | ?> |
|---|
| 1003 | </pre> |
|---|
| 1004 | <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> |
|---|
| 1005 | This returns an object with at least 3 fields.</p> |
|---|
| 1006 | <ul> |
|---|
| 1007 | <li><b>name</b>: name of column</li> |
|---|
| 1008 | <li> <b>type</b>: native field type of column</li> |
|---|
| 1009 | <li> <b>max_length</b>: maximum length of field. Some databases such as MySQL |
|---|
| 1010 | do not return the maximum length of the field correctly. In these cases max_length |
|---|
| 1011 | will be set to -1.</li> |
|---|
| 1012 | </ul> |
|---|
| 1013 | <p>We then use <font face="Courier New, Courier, mono"><a href="#metatype">MetaType</a>()</font> |
|---|
| 1014 | to translate the native type to a <i>generic</i> type. Currently the following |
|---|
| 1015 | <i>generic</i> types are defined:</p> |
|---|
| 1016 | <ul> |
|---|
| 1017 | <li><b>C</b>: character fields that should be shown in a <input type="text"> |
|---|
| 1018 | tag.</li> |
|---|
| 1019 | <li><b>X</b>: TeXt, large text fields that should be shown in a <textarea></li> |
|---|
| 1020 | <li><b>B</b>: Blobs, or Binary Large Objects. Typically images. |
|---|
| 1021 | </li><li><b>D</b>: Date field</li> |
|---|
| 1022 | <li><b>T</b>: Timestamp field</li> |
|---|
| 1023 | <li><b>L</b>: Logical field (boolean or bit-field)</li> |
|---|
| 1024 | <li><b>I</b>: Integer field</li> |
|---|
| 1025 | <li><b>N</b>: Numeric field. Includes autoincrement, numeric, floating point, |
|---|
| 1026 | real and integer. </li> |
|---|
| 1027 | <li><b>R</b>: Serial field. Includes serial, autoincrement integers. This works |
|---|
| 1028 | for selected databases. </li> |
|---|
| 1029 | </ul> |
|---|
| 1030 | <p>If the metatype is of type date or timestamp, then we print it using the user |
|---|
| 1031 | defined date format with <font face="Courier New, Courier, mono"><a href="#userdate">UserDate</a>(),</font> |
|---|
| 1032 | which converts the PHP SQL date string format to a user defined one. Another |
|---|
| 1033 | use for <font face="Courier New, Courier, mono"><a href="#metatype">MetaType</a>()</font> |
|---|
| 1034 | is data validation before doing an SQL insert or update.</p> |
|---|
| 1035 | <h3>Example 3: Inserting<a name="ex3"></a></h3> |
|---|
| 1036 | <p>Insert a row to the Orders table containing dates and strings that need to |
|---|
| 1037 | be quoted before they can be accepted by the database, eg: the single-quote |
|---|
| 1038 | in the word <i>John's</i>.</p> |
|---|
| 1039 | <pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#660000">conn</font> = &ADONewConnection('access'); # create a connection<br><br>$<font color="#660000">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br>$<font color="#660000">shipto</font> = <font color="#006600"><b>$conn->qstr</b></font>("<i>John's Old Shoppe</i>");<br><br>$<font color="#660000">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";<br>$<font color="#660000">sql</font> .= "values ('ANATR',2,".<b><font color="#006600">$conn->DBDate(</font>time()<font color="#006600">)</font></b><font color="#006600">.</font>",$<font color="#660000">shipto</font>)";<br><br><b>if</b> ($<font color="#660000">conn</font>->Execute($<font color="#660000">sql</font>) <font color="#336600"><b>=== false</b></font>) {<br> <b>print</b> 'error inserting: '.<font color="#336600"><b>$conn->ErrorMsg()</b></font>.'<BR>';<br>}<br>?><br></pre> |
|---|
| 1040 | <p>In this example, we see the advanced date and quote handling facilities of |
|---|
| 1041 | ADOdb. The unix timestamp (which is a long integer) is appropriately formated |
|---|
| 1042 | for Access with <font face="Courier New, Courier, mono"><a href="#dbdate">DBDate</a>()</font>, |
|---|
| 1043 | and the right escape character is used for quoting the <i>John's Old Shoppe</i>, |
|---|
| 1044 | which is<b> </b><i>John'<b>'</b>s Old Shoppe</i> and not PHP's default <i>John<b>'</b>s |
|---|
| 1045 | Old Shoppe</i> with <font face="Courier New, Courier, mono"><a href="#qstr">qstr</a>()</font>. |
|---|
| 1046 | </p> |
|---|
| 1047 | <p>Observe the error-handling of the Execute statement. False is returned by<font face="Courier New, Courier, mono"> |
|---|
| 1048 | <a href="#execute">Execute</a>() </font>if an error occured. The error message |
|---|
| 1049 | for the last error that occurred is displayed in <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font>. |
|---|
| 1050 | Note: <i>php_track_errors</i> might have to be enabled for error messages to |
|---|
| 1051 | be saved.</p> |
|---|
| 1052 | <h3> Example 4: Debugging<a name="ex4"></a></h3> |
|---|
| 1053 | <pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn</font> = &ADONewConnection('access'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('northwind'); # connect to MS-Access, northwind dsn<br><font>$<font color="#663300">shipto</font> = <b>$conn->qstr</b>("John's Old Shoppe");<br>$<font color="#663300">sql</font> = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";<br>$<font color="#663300">sql</font> .= "values ('ANATR',2,".$<font color="#663300">conn</font>->FormatDate(time()).",$shipto)";<br><b><font color="#336600">$<font color="#663300">conn</font>->debug = true;</font></b> |
|---|
| 1054 | <b>if</b> ($<font color="#663300">conn</font>->Execute($sql) <b>=== false</b>) <b>print</b> 'error inserting';</font> |
|---|
| 1055 | ?> |
|---|
| 1056 | </pre> |
|---|
| 1057 | <p>In the above example, we have turned on debugging by setting <b>debug = true</b>. |
|---|
| 1058 | This will display the SQL statement before execution, and also show any error |
|---|
| 1059 | messages. There is no need to call <font face="Courier New, Courier, mono"><a href="#errormsg">ErrorMsg</a>()</font> |
|---|
| 1060 | in this case. For displaying the recordset, see the <font face="Courier New, Courier, mono"><a href="#exrs2html">rs2html</a>() |
|---|
| 1061 | </font>example.</p> |
|---|
| 1062 | <p>Also see the section on <a href="#errorhandling">Custom Error Handlers</a>.</p> |
|---|
| 1063 | <h3>Example 5: MySQL and Menus<a name="ex5"></a></h3> |
|---|
| 1064 | <p>Connect to MySQL database <i>agora</i>, and generate a <select> menu |
|---|
| 1065 | from an SQL statement where the <option> captions are in the 1st column, |
|---|
| 1066 | and the value to send back to the server is in the 2nd column.</p> |
|---|
| 1067 | <pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br><font>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';<br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->Execute($sql);<br><b>print</b> <b><font color="#336600">$<font color="#663300">rs</font>->GetMenu('GetCust','Mary Rosli');<br>?></font></b></font></pre> |
|---|
| 1068 | <p>Here we define a menu named GetCust, with the menu option 'Mary Rosli' selected. |
|---|
| 1069 | See <a href="#getmenu"><font face="Courier New, Courier, mono">GetMenu</font></a><font face="Courier New, Courier, mono">()</font>. |
|---|
| 1070 | We also have functions that return the recordset as an array: <font face="Courier New, Courier, mono"><a href="#getarray">GetArray</a>()</font>, |
|---|
| 1071 | and as an associative array with the key being the first column: <a href="#getassoc1">GetAssoc</a>().</p> |
|---|
| 1072 | <h3>Example 6: Connecting to 2 Databases At Once<a name="ex6"></a></h3> |
|---|
| 1073 | <pre><?<br><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$<font color="#663300">conn1</font> = &ADONewConnection('mysql'); # create a mysql connection<br>$<font color="#663300">conn2</font> = &ADONewConnection('oracle'); # create a oracle connection<br><br>$conn1->PConnect($server, $userid, $password, $database);<br>$conn2->PConnect(false, $ora_userid, $ora_pwd, $oraname);<br><br>$conn1->Execute('insert ...');<br>$conn2->Execute('update ...');<br>?></pre> |
|---|
| 1074 | <p> |
|---|
| 1075 | </p><h3>Example 7: Generating Update and Insert SQL<a name="ex7"></a></h3> |
|---|
| 1076 | <p>Since ADOdb 4.56, we support <a href="reference.functions.getupdatesql.html#autoexecute">AutoExecute()</a>, |
|---|
| 1077 | which simplifies things by providing an advanced wrapper for GetInsertSQL() and GetUpdateSQL(). For example, |
|---|
| 1078 | an INSERT can be carried out with: |
|---|
| 1079 | |
|---|
| 1080 | <pre> |
|---|
| 1081 | $record["firstname"] = "Bob"; |
|---|
| 1082 | $record["lastname"] = "Smith"; |
|---|
| 1083 | $record["created"] = time(); |
|---|
| 1084 | $insertSQL = $conn->AutoExecute($rs, $record, 'INSERT'); |
|---|
| 1085 | </pre> |
|---|
| 1086 | |
|---|
| 1087 | and an UPDATE with: |
|---|
| 1088 | <pre> |
|---|
| 1089 | $record["firstname"] = "Caroline"; |
|---|
| 1090 | $record["lastname"] = "Smith"; # Update Caroline's lastname from Miranda to Smith |
|---|
| 1091 | $insertSQL = $conn->AutoExecute($rs, $record, 'UPDATE', 'id = 1'); |
|---|
| 1092 | </pre> |
|---|
| 1093 | <p> |
|---|
| 1094 | The rest of this section is out-of-date: |
|---|
| 1095 | <p>ADOdb 1.31 and later supports two new recordset functions: GetUpdateSQL( ) and |
|---|
| 1096 | GetInsertSQL( ). This allow you to perform a "SELECT * FROM table query WHERE...", |
|---|
| 1097 | make a copy of the $rs->fields, modify the fields, and then generate the SQL to |
|---|
| 1098 | update or insert into the table automatically. |
|---|
| 1099 | <p> We show how the functions can be used when accessing a table with the following |
|---|
| 1100 | fields: (ID, FirstName, LastName, Created). |
|---|
| 1101 | </p><p> Before these functions can be called, you need to initialize the recordset |
|---|
| 1102 | by performing a select on the table. Idea and code by Jonathan Younger jyounger#unilab.com. |
|---|
| 1103 | Since ADOdb 2.42, you can pass a table name instead of a recordset into |
|---|
| 1104 | GetInsertSQL (in $rs), and it will generate an insert statement for that table. |
|---|
| 1105 | </p><p> |
|---|
| 1106 | </p><pre><?<br>#==============================================<br># SAMPLE GetUpdateSQL() and GetInsertSQL() code<br>#==============================================<br>include('adodb.inc.php');<br>include('tohtml.inc.php');<br><br>#==========================<br># This code tests an insert<br><br>$sql = "SELECT * FROM ADOXYZ WHERE id = -1"; <br># Select an empty record from the database<br><br>$conn = &ADONewConnection("mysql"); # create a connection<br>$conn->debug=1;<br>$conn->PConnect("localhost", "admin", "", "test"); # connect to MySQL, testdb<br>$rs = $conn->Execute($sql); # Execute the query and get the empty recordset<br><br>$record = array(); # Initialize an array to hold the record data to insert<br><br># Set the values for the fields in the record<br># Note that field names are case-insensitive<br>$record["firstname"] = "Bob";<br>$record["lastNamE"] = "Smith";<br>$record["creaTed"] = time();<br><br># Pass the empty recordset and the array containing the data to insert<br># into the GetInsertSQL function. The function will process the data and return<br># a fully formatted insert sql statement.<br>$insertSQL = $conn->GetInsertSQL($rs, $record);<br><br>$conn->Execute($insertSQL); # Insert the record into the database<br><br>#==========================<br># This code tests an update<br><br>$sql = "SELECT * FROM ADOXYZ WHERE id = 1"; <br># Select a record to update<br><br>$rs = $conn->Execute($sql); # Execute the query and get the existing record to update<br><br>$record = array(); # Initialize an array to hold the record data to update<br><br># Set the values for the fields in the record<br># Note that field names are case-insensitive<br>$record["firstname"] = "Caroline";<br>$record["LasTnAme"] = "Smith"; # Update Caroline's lastname from Miranda to Smith<br><br># Pass the single record recordset and the array containing the data to update<br># into the GetUpdateSQL function. The function will process the data and return<br># a fully formatted update sql statement with the correct WHERE clause.<br># If the data has not changed, no recordset is returned<br>$updateSQL = $conn->GetUpdateSQL($rs, $record);<br><br>$conn->Execute($updateSQL); # Update the record in the database<br>$conn->Close();<br>?><br></pre> |
|---|
| 1107 | <a name="ADODB_FORCE_TYPE"></a> |
|---|
| 1108 | <b>$ADODB_FORCE_TYPE</b><p> |
|---|
| 1109 | The behaviour of AutoExecute(), GetUpdateSQL() and GetInsertSQL() |
|---|
| 1110 | when converting empty or null PHP variables to SQL is controlled by the |
|---|
| 1111 | global $ADODB_FORCE_TYPE variable. Set it to one of the values below. Default |
|---|
| 1112 | is ADODB_FORCE_VALUE (3): |
|---|
| 1113 | </p><pre>0 = ignore empty fields. All empty fields in array are ignored.<br>1 = force null. All empty, php null and string 'null' fields are changed to sql NULL values.<br>2 = force empty. All empty, php null and string 'null' fields are changed to sql empty '' or 0 values.<br>3 = force value. Value is left as it is. Php null and string 'null' are set to sql NULL values and <br> empty fields '' are set to empty '' sql values.<br><br>define('ADODB_FORCE_IGNORE',0);<br>define('ADODB_FORCE_NULL',1);<br>define('ADODB_FORCE_EMPTY',2);<br>define('ADODB_FORCE_VALUE',3);<br></pre> |
|---|
| 1114 | <p> |
|---|
| 1115 | Thanks to Niko (nuko#mbnet.fi) for the $ADODB_FORCE_TYPE code. |
|---|
| 1116 | </p><p> |
|---|
| 1117 | Note: the constant ADODB_FORCE_NULLS is obsolete since 4.52 and is ignored. Set $ADODB_FORCE_TYPE = ADODB_FORCE_NULL |
|---|
| 1118 | for equivalent behaviour. |
|---|
| 1119 | <p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. |
|---|
| 1120 | </p><h3>Example 8: Implementing Scrolling with Next and Previous<a name="ex8"></a></h3> |
|---|
| 1121 | <p> The following code creates a very simple recordset pager, where you can scroll |
|---|
| 1122 | from page to page of a recordset.</p> |
|---|
| 1123 | <pre>include_once('../adodb.inc.php');<br>include_once('../adodb-pager.inc.php');<br>session_start();<br><br>$db = NewADOConnection('mysql');<br><br>$db->Connect('localhost','root','','xphplens');<br><br>$sql = "select * from adoxyz ";<br><br>$pager = new ADODB_Pager($db,$sql);<br>$pager->Render($rows_per_page=5);</pre> |
|---|
| 1124 | <p>This will create a basic record pager that looks like this: <a name="scr"></a> |
|---|
| 1125 | </p><p> |
|---|
| 1126 | <table bgcolor="beige" border="1"> |
|---|
| 1127 | <tbody><tr> |
|---|
| 1128 | <td> <a href="#scr"><code>|<</code></a> <a href="#scr"><code><<</code></a> |
|---|
| 1129 | <a href="#scr"><code>>></code></a> <a href="#scr"><code>>|</code></a> |
|---|
| 1130 | </td> |
|---|
| 1131 | </tr> |
|---|
| 1132 | <tr> |
|---|
| 1133 | <td><table bgcolor="white" border="1" cols="4" width="100%"> |
|---|
| 1134 | <tbody><tr><th>ID</th> |
|---|
| 1135 | <th>First Name</th> |
|---|
| 1136 | <th>Last Name</th> |
|---|
| 1137 | <th>Date Created</th> |
|---|
| 1138 | </tr><tr> |
|---|
| 1139 | <td align="right">36 </td> |
|---|
| 1140 | <td>Alan </td> |
|---|
| 1141 | <td>Turing </td> |
|---|
| 1142 | <td>Sat 06, Oct 2001 </td> |
|---|
| 1143 | </tr> |
|---|
| 1144 | <tr> |
|---|
| 1145 | <td align="right">37 </td> |
|---|
| 1146 | <td>Serena </td> |
|---|
| 1147 | <td>Williams </td> |
|---|
| 1148 | <td>Sat 06, Oct 2001 </td> |
|---|
| 1149 | </tr> |
|---|
| 1150 | <tr> |
|---|
| 1151 | <td align="right">38 </td> |
|---|
| 1152 | <td>Yat Sun </td> |
|---|
| 1153 | <td>Sun </td> |
|---|
| 1154 | <td>Sat 06, Oct 2001 </td> |
|---|
| 1155 | </tr> |
|---|
| 1156 | <tr> |
|---|
| 1157 | <td align="right">39 </td> |
|---|
| 1158 | <td>Wai Hun </td> |
|---|
| 1159 | <td>See </td> |
|---|
| 1160 | <td>Sat 06, Oct 2001 </td> |
|---|
| 1161 | </tr> |
|---|
| 1162 | <tr> |
|---|
| 1163 | <td align="right">40 </td> |
|---|
| 1164 | <td>Steven </td> |
|---|
| 1165 | <td>Oey </td> |
|---|
| 1166 | <td>Sat 06, Oct 2001 </td> |
|---|
| 1167 | </tr> |
|---|
| 1168 | </tbody></table></td> |
|---|
| 1169 | </tr> |
|---|
| 1170 | <tr> |
|---|
| 1171 | <td><font size="-1">Page 8/10</font></td> |
|---|
| 1172 | </tr> |
|---|
| 1173 | </tbody></table> |
|---|
| 1174 | </p><p>The number of rows to display at one time is controled by the Render($rows) |
|---|
| 1175 | method. If you do not pass any value to Render(), ADODB_Pager will default to |
|---|
| 1176 | 10 records per page. |
|---|
| 1177 | </p><p>You can control the column titles by modifying your SQL (supported by most |
|---|
| 1178 | databases): |
|---|
| 1179 | </p><pre>$sql = 'select id as "ID", firstname as "First Name", <br> lastname as "Last Name", created as "Date Created" <br> from adoxyz';</pre> |
|---|
| 1180 | <p>The above code can be found in the <i>adodb/tests/testpaging.php</i> example |
|---|
| 1181 | included with this release, and the class ADODB_Pager in <i>adodb/adodb-pager.inc.php</i>. |
|---|
| 1182 | The ADODB_Pager code can be adapted by a programmer so that the text links can |
|---|
| 1183 | be replaced by images, and the dull white background be replaced with more interesting |
|---|
| 1184 | colors. |
|---|
| 1185 | </p><p>You can also allow display of html by setting $pager->htmlSpecialChars = false. |
|---|
| 1186 | </p><p>Some of the code used here was contributed by Iván Oliva and Cornel |
|---|
| 1187 | G. </p> |
|---|
| 1188 | <h3><a name="ex9"></a>Example 9: Exporting in CSV or Tab-Delimited Format</h3> |
|---|
| 1189 | <p>We provide some helper functions to export in comma-separated-value (CSV) and |
|---|
| 1190 | tab-delimited formats:</p> |
|---|
| 1191 | <pre><b>include_once('/path/to/adodb/toexport.inc.php');</b><br>include_once('/path/to/adodb/adodb.inc.php');<br> |
|---|
| 1192 | $db = &NewADOConnection('mysql');<br>$db->Connect($server, $userid, $password, $database);<br><br>$rs = $db->Execute('select fname as "First Name", surname as "Surname" from table');<br><br>print "<pre>";<br>print <b>rs2csv</b>($rs); # return a string, CSV format<p>print '<hr>';<br><br>$rs->MoveFirst(); # note, some databases do not support MoveFirst<br>print <b>rs2tab</b>($rs,<i>false</i>); # return a string, tab-delimited<br> # false == suppress field names in first line</p>print '<hr>';<br>$rs->MoveFirst();<br><b>rs2tabout</b>($rs); # send to stdout directly (there is also an rs2csvout function)<br>print "</pre>";<br><br>$rs->MoveFirst();<br>$fp = fopen($path, "w");<br>if ($fp) {<br> <b>rs2csvfile</b>($rs, $fp); # write to file (there is also an rs2tabfile function)<br> fclose($fp);<br>}<br></pre> |
|---|
| 1193 | <p> Carriage-returns or newlines are converted to spaces. Field names are returned |
|---|
| 1194 | in the first line of text. Strings containing the delimiter character are quoted |
|---|
| 1195 | with double-quotes. Double-quotes are double-quoted again. This conforms to |
|---|
| 1196 | Excel import and export guide-lines. |
|---|
| 1197 | </p><p>All the above functions take as an optional last parameter, $addtitles which |
|---|
| 1198 | defaults to <i>true</i>. When set to <i>false</i> field names in the first line |
|---|
| 1199 | are suppressed. <br> |
|---|
| 1200 | </p><h3>Example 10: Recordset Filters<a name="ex10"></a></h3> |
|---|
| 1201 | <p>Sometimes we want to pre-process all rows in a recordset before we use it. |
|---|
| 1202 | For example, we want to ucwords all text in recordset. |
|---|
| 1203 | </p><pre>include_once('adodb/rsfilter.inc.php');<br>include_once('adodb/adodb.inc.php');<br><br>// ucwords() every element in the recordset<br>function do_ucwords(&$arr,$rs)<br>{<br> foreach($arr as $k => $v) {<br> $arr[$k] = ucwords($v);<br> }<br>}<br><br>$db = NewADOConnection('mysql');<br>$db->PConnect('server','user','pwd','db');<br><br>$rs = $db->Execute('select ... from table');<br>$rs = <b>RSFilter</b>($rs,'do_ucwords');<br></pre> |
|---|
| 1204 | <p>The <i>RSFilter</i> function takes 2 parameters, the recordset, and the name |
|---|
| 1205 | of the <i>filter</i> function. It returns the processed recordset scrolled to |
|---|
| 1206 | the first record. The <i>filter</i> function takes two parameters, the current |
|---|
| 1207 | row as an array, and the recordset object. For future compatibility, you should |
|---|
| 1208 | not use the original recordset object. </p> |
|---|
| 1209 | <h3>Example 11:<a name="ex11"></a> Smart Transactions</h3> |
|---|
| 1210 | The old way of doing transactions required you to use |
|---|
| 1211 | <pre>$conn-><b>BeginTrans</b>();<br>$ok = $conn->Execute($sql);<br>if ($ok) $ok = $conn->Execute($sql2);<br>if (!$ok) $conn-><b>RollbackTrans</b>();<br>else $conn-><b>CommitTrans</b>();<br></pre> |
|---|
| 1212 | This is very complicated for large projects because you have to track the error |
|---|
| 1213 | status. Smart Transactions is much simpler. You start a smart transaction by calling |
|---|
| 1214 | StartTrans(): |
|---|
| 1215 | <pre>$conn-><b>StartTrans</b>();<br>$conn->Execute($sql);<br>$conn->Execute($Sql2);<br>$conn-><b>CompleteTrans</b>();<br></pre> |
|---|
| 1216 | CompleteTrans() detects when an SQL error occurs, and will Rollback/Commit as |
|---|
| 1217 | appropriate. To specificly force a rollback even if no error occured, use FailTrans(). |
|---|
| 1218 | Note that the rollback is done in CompleteTrans(), and not in FailTrans(). |
|---|
| 1219 | <pre>$conn-><b>StartTrans</b>();<br>$conn->Execute($sql);<br>if (!CheckRecords()) $conn-><strong>FailTrans</strong>();<br>$conn->Execute($Sql2);<br>$conn-><b>CompleteTrans</b>();<br></pre> |
|---|
| 1220 | <p>You can also check if a transaction has failed, using HasFailedTrans(), which |
|---|
| 1221 | returns true if FailTrans() was called, or there was an error in the SQL execution. |
|---|
| 1222 | Make sure you call HasFailedTrans() before you call CompleteTrans(), as it is |
|---|
| 1223 | only works between StartTrans/CompleteTrans. |
|---|
| 1224 | </p><p>Lastly, StartTrans/CompleteTrans is nestable, and only the outermost block |
|---|
| 1225 | is executed. In contrast, BeginTrans/CommitTrans/RollbackTrans is NOT nestable. |
|---|
| 1226 | </p><pre>$conn-><strong>StartTrans</strong>();<br>$conn->Execute($sql);<br> $conn-><strong>StartTrans</strong>(); <font color="#006600"># ignored</font> |
|---|
| 1227 | if (!CheckRecords()) $conn->FailTrans(); |
|---|
| 1228 | $conn-><strong>CompleteTrans</strong>(); <font color="#006600"># ignored</font> |
|---|
| 1229 | $conn->Execute($Sql2); |
|---|
| 1230 | $conn-><strong>CompleteTrans</strong>();<br></pre> |
|---|
| 1231 | <p>Note: Savepoints are currently not supported. |
|---|
| 1232 | </p><h2><a name="errorhandling"></a>Using Custom Error Handlers and PEAR_Error</h2> |
|---|
| 1233 | <p>ADOdb supports PHP5 exceptions. Just include <i>adodb-exceptions.inc.php</i> and you can now |
|---|
| 1234 | catch exceptions on errors as they occur. |
|---|
| 1235 | </p><pre> <b>include("../adodb-exceptions.inc.php");</b> <br> include("../adodb.inc.php"); <br> try { <br> $db = NewADOConnection("oci8://scott:bad-password@mytns/"); <br> } catch (exception $e) { <br> var_dump($e); <br> adodb_backtrace($e->gettrace());<br> } <br></pre> |
|---|
| 1236 | <p> ADOdb also provides two custom handlers which you can modify for your needs. The |
|---|
| 1237 | first one is in the <b>adodb-errorhandler.inc.php</b> file. This makes use of |
|---|
| 1238 | the standard PHP functions <a href="http://php.net/error_reporting">error_reporting</a> |
|---|
| 1239 | to control what error messages types to display, and <a href="http://php.net/trigger_error">trigger_error</a> |
|---|
| 1240 | which invokes the default PHP error handler. |
|---|
| 1241 | </p><p> Including the above file will cause <i>trigger_error($errorstring,E_USER_ERROR)</i> |
|---|
| 1242 | to be called when<br> |
|---|
| 1243 | (a) Connect() or PConnect() fails, or <br> |
|---|
| 1244 | (b) a function that executes SQL statements such as Execute() or SelectLimit() |
|---|
| 1245 | has an error.<br> |
|---|
| 1246 | (c) GenID() appears to go into an infinite loop. |
|---|
| 1247 | </p><p> The $errorstring is generated by ADOdb and will contain useful debugging information |
|---|
| 1248 | similar to the error.log data generated below. This file adodb-errorhandler.inc.php |
|---|
| 1249 | should be included before you create any ADOConnection objects. |
|---|
| 1250 | </p><p> If you define error_reporting(0), no errors will be passed to the error handler. |
|---|
| 1251 | If you set error_reporting(E_ALL), all errors will be passed to the error handler. |
|---|
| 1252 | You still need to use <b>ini_set("display_errors", "0" or "1")</b> to control |
|---|
| 1253 | the display of errors. |
|---|
| 1254 | </p><pre><?php<br><b>error_reporting(E_ALL); # pass any error messages triggered to error handler<br>include('adodb-errorhandler.inc.php');</b> |
|---|
| 1255 | include('adodb.inc.php'); |
|---|
| 1256 | include('tohtml.inc.php'); |
|---|
| 1257 | $c = NewADOConnection('mysql'); |
|---|
| 1258 | $c->PConnect('localhost','root','','northwind'); |
|---|
| 1259 | $rs=$c->Execute('select * from productsz'); #invalid table productsz'); |
|---|
| 1260 | if ($rs) rs2html($rs); |
|---|
| 1261 | ?> |
|---|
| 1262 | </pre> |
|---|
| 1263 | <p> If you want to log the error message, you can do so by defining the following |
|---|
| 1264 | optional constants ADODB_ERROR_LOG_TYPE and ADODB_ERROR_LOG_DEST. ADODB_ERROR_LOG_TYPE |
|---|
| 1265 | is the error log message type (see <a href="http://php.net/error_log">error_log</a> |
|---|
| 1266 | in the PHP manual). In this case we set it to 3, which means log to the file |
|---|
| 1267 | defined by the constant ADODB_ERROR_LOG_DEST. |
|---|
| 1268 | </p><pre><?php<br><b>error_reporting(E_ALL); # report all errors<br>ini_set("display_errors", "0"); # but do not echo the errors<br>define('ADODB_ERROR_LOG_TYPE',3);<br>define('ADODB_ERROR_LOG_DEST','C:/errors.log');<br>include('adodb-errorhandler.inc.php');</b> |
|---|
| 1269 | include('adodb.inc.php'); |
|---|
| 1270 | include('tohtml.inc.php'); |
|---|
| 1271 | |
|---|
| 1272 | $c = NewADOConnection('mysql'); |
|---|
| 1273 | $c->PConnect('localhost','root','','northwind'); |
|---|
| 1274 | $rs=$c->Execute('select * from productsz'); ## invalid table productsz |
|---|
| 1275 | if ($rs) rs2html($rs); |
|---|
| 1276 | ?> |
|---|
| 1277 | </pre> |
|---|
| 1278 | The following message will be logged in the error.log file: |
|---|
| 1279 | <pre>(2001-10-28 14:20:38) mysql error: [1146: Table 'northwind.productsz' doesn't exist] in<br> EXECUTE("select * from productsz")<br></pre> |
|---|
| 1280 | <h3>PEAR_ERROR</h3> |
|---|
| 1281 | The second error handler is <b>adodb-errorpear.inc.php</b>. This will create a |
|---|
| 1282 | PEAR_Error derived object whenever an error occurs. The last PEAR_Error object |
|---|
| 1283 | created can be retrieved using ADODB_Pear_Error(). |
|---|
| 1284 | <pre><?php<br><b>include('adodb-errorpear.inc.php');</b> |
|---|
| 1285 | include('adodb.inc.php'); |
|---|
| 1286 | include('tohtml.inc.php'); |
|---|
| 1287 | $c = NewADOConnection('mysql'); |
|---|
| 1288 | $c->PConnect('localhost','root','','northwind'); |
|---|
| 1289 | $rs=$c->Execute('select * from productsz'); #invalid table productsz'); |
|---|
| 1290 | if ($rs) rs2html($rs); |
|---|
| 1291 | else { |
|---|
| 1292 | <b>$e = ADODB_Pear_Error();<br> echo '<p>',$e->message,'</p>';</b> |
|---|
| 1293 | } |
|---|
| 1294 | ?> |
|---|
| 1295 | </pre> |
|---|
| 1296 | <p> You can use a PEAR_Error derived class by defining the constant ADODB_PEAR_ERROR_CLASS |
|---|
| 1297 | before the adodb-errorpear.inc.php file is included. For easy debugging, you |
|---|
| 1298 | can set the default error handler in the beginning of the PHP script to PEAR_ERROR_DIE, |
|---|
| 1299 | which will cause an error message to be printed, then halt script execution: |
|---|
| 1300 | </p><pre>include('PEAR.php');<br>PEAR::setErrorHandling('PEAR_ERROR_DIE');<br></pre> |
|---|
| 1301 | <p> Note that we do not explicitly return a PEAR_Error object to you when an error |
|---|
| 1302 | occurs. We return false instead. You have to call ADODB_Pear_Error() to get |
|---|
| 1303 | the last error or use the PEAR_ERROR_DIE technique. |
|---|
| 1304 | </p> |
|---|
| 1305 | <h3>MetaError and MetaErrMsg</h3> |
|---|
| 1306 | <p>If you need error messages that work across multiple databases, then use <a href="#metaerror">MetaError()</a>, which returns a virtualized error number, based on PEAR DB's error number system, and <a href=<a href="#metaerrmsg">MetaErrMsg()</a>. |
|---|
| 1307 | |
|---|
| 1308 | <h4>Error Messages</h4> |
|---|
| 1309 | <p>Error messages are outputted using the static method ADOConnnection::outp($msg,$newline=true). |
|---|
| 1310 | By default, it sends the messages to the client. You can override this to perform |
|---|
| 1311 | error-logging. |
|---|
| 1312 | </p><h2><a name="dsn"></a> Data Source Names</h2> |
|---|
| 1313 | <p>We now support connecting using PEAR style DSN's. A DSN is a connection string |
|---|
| 1314 | of the form:</p> |
|---|
| 1315 | <p>$dsn = <i>"$driver://$username:$password@$hostname/$databasename"</i>;</p> |
|---|
| 1316 | <p>An example:</p> |
|---|
| 1317 | <pre> $username = 'root';<br> $password = '';<br> $hostname = 'localhost';<br> $databasename = 'xphplens';<br> $driver = 'mysql';<br> $dsn = "$driver://$username:$password@$hostname/$databasename"<br> $db = NewADOConnection(); <br> # DB::Connect($dsn) also works if you include 'adodb/adodb-pear.inc.php' at the top<br> $rs = $db->query('select firstname,lastname from adoxyz');<br> $cnt = 0;<br> while ($arr = $rs->fetchRow()) {<br> print_r($arr); print "<br>";<br> }</pre> |
|---|
| 1318 | <p></p> |
|---|
| 1319 | <p> <a href="#dsnsupport">More info and connection examples</a> on the DSN format. |
|---|
| 1320 | |
|---|
| 1321 | </p><h2><a name="pear"></a>PEAR Compatibility</h2> |
|---|
| 1322 | We support DSN's (see above), and the following functions: |
|---|
| 1323 | <pre><b> DB_Common</b> |
|---|
| 1324 | query - returns PEAR_Error on error |
|---|
| 1325 | limitQuery - return PEAR_Error on error |
|---|
| 1326 | prepare - does not return PEAR_Error on error |
|---|
| 1327 | execute - does not return PEAR_Error on error |
|---|
| 1328 | setFetchMode - supports ASSOC and ORDERED |
|---|
| 1329 | errorNative |
|---|
| 1330 | quote |
|---|
| 1331 | nextID |
|---|
| 1332 | disconnect |
|---|
| 1333 | |
|---|
| 1334 | getOne |
|---|
| 1335 | getAssoc |
|---|
| 1336 | getRow |
|---|
| 1337 | getCol |
|---|
| 1338 | |
|---|
| 1339 | <b> DB_Result</b> |
|---|
| 1340 | numRows - returns -1 if not supported |
|---|
| 1341 | numCols |
|---|
| 1342 | fetchInto - does not support passing of fetchmode |
|---|
| 1343 | fetchRows - does not support passing of fetchmode |
|---|
| 1344 | free |
|---|
| 1345 | </pre> |
|---|
| 1346 | <h2><a name="caching"></a>Caching of Recordsets</h2> |
|---|
| 1347 | <p>ADOdb now supports caching of recordsets in the file system using the CacheExecute( ), CachePageExecute( |
|---|
| 1348 | ) and CacheSelectLimit( ) functions. There are similar to the non-cache functions, |
|---|
| 1349 | except that they take a new first parameter, $secs2cache. |
|---|
| 1350 | </p><p> An example: |
|---|
| 1351 | </p><pre><b>include</b>('adodb.inc.php'); # load code common to ADOdb<br>$ADODB_CACHE_DIR = '/usr/ADODB_cache';<br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection<br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br><font>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers';<br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->CacheExecute(15,$sql);</font></pre> |
|---|
| 1352 | <p><font> The first parameter is the number of seconds to cache |
|---|
| 1353 | the query. Subsequent calls to that query will used the cached version stored |
|---|
| 1354 | in $ADODB_CACHE_DIR. To force a query to execute and flush the cache, call CacheExecute() |
|---|
| 1355 | with the first parameter set to zero. Alternatively, use the CacheFlush($sql) |
|---|
| 1356 | call. </font></p> |
|---|
| 1357 | <p><font>For the sake of security, we recommend you set <i>register_globals=off</i> |
|---|
| 1358 | in php.ini if you are using $ADODB_CACHE_DIR.</font></p> |
|---|
| 1359 | <p>In ADOdb 1.80 onwards, the secs2cache parameter is optional in CacheSelectLimit() |
|---|
| 1360 | and CacheExecute(). If you leave it out, it will use the $connection->cacheSecs |
|---|
| 1361 | parameter, which defaults to 60 minutes. The following are equivalent: |
|---|
| 1362 | <pre> |
|---|
| 1363 | # (1) |
|---|
| 1364 | $rs = $db->SelectLimit(30, 'select * from table', 10); |
|---|
| 1365 | |
|---|
| 1366 | # (2) |
|---|
| 1367 | $db->cacheSsecs = 30; |
|---|
| 1368 | $rs = $db->SelectLimit('select * from table', 10); |
|---|
| 1369 | </pre> |
|---|
| 1370 | </p><pre> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; # cache 24 hours<br> $rs = $conn->CacheExecute('select * from table');<br></pre> |
|---|
| 1371 | <p>Please note that magic_quotes_runtime should be turned off. Do not change $ADODB_FETCH_MODE (or SetFetchMode) |
|---|
| 1372 | as the cached recordset will use the $ADODB_FETCH_MODE set when the query was executed. <font> |
|---|
| 1373 | |
|---|
| 1374 | <a name="memcache"> |
|---|
| 1375 | <h3>MemCache support</h3> |
|---|
| 1376 | <p>You can also share cached recordsets on a memcache server. The memcache API supports one or more pooled hosts. Only if none of the pooled servers can be contacted will a connect error be generated. |
|---|
| 1377 | Example below: |
|---|
| 1378 | <pre> |
|---|
| 1379 | $db = NewADOConnection($driver); |
|---|
| 1380 | $db->memCache = true; |
|---|
| 1381 | $db->memCacheHost = array($ip1, $ip2, $ip3); /// $db->memCacheHost = $ip1; will work too |
|---|
| 1382 | $db->memCachePort = 11211; /// this is default memCache port |
|---|
| 1383 | $db->memCacheCompress = false; /// Use 'true' to store the item compressed (uses zlib) |
|---|
| 1384 | |
|---|
| 1385 | $db->Connect(...); |
|---|
| 1386 | $db->CacheExecute($sql); |
|---|
| 1387 | </pre> |
|---|
| 1388 | <p>More info on memcache can be found at <a href=http://www.danga.com/memcached/>http://www.danga.com/memcached/</a>. |
|---|
| 1389 | |
|---|
| 1390 | <a name="cacheapi"> |
|---|
| 1391 | <h3>Caching API</h3> |
|---|
| 1392 | <p> There is also a caching API since 4.99/5.05. Two implementations of the API are already available providing file and memcache support. |
|---|
| 1393 | <p>The new API for creating your custom caching class uses 2 globals: |
|---|
| 1394 | <ul><li>$ADODB_CACHE_CLASS: name of caching class |
|---|
| 1395 | <li>$ADODB_CACHE: instance of $ADODB_CACHE_CLASS |
|---|
| 1396 | </ul> |
|---|
| 1397 | |
|---|
| 1398 | <pre> |
|---|
| 1399 | include "/path/to/adodb.inc.php"; |
|---|
| 1400 | $ADODB_CACHE_CLASS = 'MyCacheClass'; |
|---|
| 1401 | |
|---|
| 1402 | class MyCacheClass extends ADODB_Cache_File |
|---|
| 1403 | { |
|---|
| 1404 | var $createdir = false; // do not set this to true unless you use temp directories in cache path |
|---|
| 1405 | function writecache($filename, $contents,$debug=false){...} |
|---|
| 1406 | function &readcache($filename, &$err, $secs2cache, $rsClass){ ...} |
|---|
| 1407 | : |
|---|
| 1408 | } |
|---|
| 1409 | |
|---|
| 1410 | $DB = NewADOConnection($driver); |
|---|
| 1411 | $DB->Connect(...); ## MyCacheClass created here and stored in $ADODB_CACHE global variable. |
|---|
| 1412 | |
|---|
| 1413 | $data = $rs->CacheGetOne($sql); ## MyCacheClass is used here for caching... |
|---|
| 1414 | </pre> |
|---|
| 1415 | <p> |
|---|
| 1416 | |
|---|
| 1417 | |
|---|
| 1418 | <h2><a name="pivot"></a>Pivot Tables</h2> |
|---|
| 1419 | </font> </p><p><font>Since ADOdb 2.30, we support the generation of |
|---|
| 1420 | SQL to create pivot tables, also known as cross-tabulations. For further explanation |
|---|
| 1421 | read this DevShed <a href="http://www.devshed.com/Server_Side/MySQL/MySQLWiz/">Cross-Tabulation |
|---|
| 1422 | tutorial</a>. We assume that your database supports the SQL case-when expression. </font></p> |
|---|
| 1423 | <font> |
|---|
| 1424 | <p>In this example, we will use the Northwind database from Microsoft. In the |
|---|
| 1425 | database, we have a products table, and we want to analyze this table by <i>suppliers |
|---|
| 1426 | versus product categories</i>. We will place the suppliers on each row, and |
|---|
| 1427 | pivot on categories. So from the table on the left, we generate the pivot-table |
|---|
| 1428 | on the right:</p> |
|---|
| 1429 | </font> |
|---|
| 1430 | <table align="center" border="0" cellpadding="2" cellspacing="2"> |
|---|
| 1431 | <tbody><tr> |
|---|
| 1432 | <td> |
|---|
| 1433 | <table align="center" border="1" cellpadding="2" cellspacing="2" width="142"> |
|---|
| 1434 | <tbody><tr> |
|---|
| 1435 | <td><i>Supplier</i></td> |
|---|
| 1436 | <td><i>Category</i></td> |
|---|
| 1437 | </tr> |
|---|
| 1438 | <tr> |
|---|
| 1439 | <td>supplier1</td> |
|---|
| 1440 | <td>category1</td> |
|---|
| 1441 | </tr> |
|---|
| 1442 | <tr> |
|---|
| 1443 | <td>supplier2</td> |
|---|
| 1444 | <td>category1</td> |
|---|
| 1445 | </tr> |
|---|
| 1446 | <tr> |
|---|
| 1447 | <td>supplier2</td> |
|---|
| 1448 | <td>category2</td> |
|---|
| 1449 | </tr> |
|---|
| 1450 | </tbody></table> |
|---|
| 1451 | </td> |
|---|
| 1452 | <td> <font face="Courier New, Courier, mono">--></font></td> |
|---|
| 1453 | <td> |
|---|
| 1454 | <table align="center" border="1" cellpadding="2" cellspacing="2"> |
|---|
| 1455 | <tbody><tr> |
|---|
| 1456 | <td> </td> |
|---|
| 1457 | <td><i>category1</i></td> |
|---|
| 1458 | <td><i>category2</i></td> |
|---|
| 1459 | <td><i>total</i></td> |
|---|
| 1460 | </tr> |
|---|
| 1461 | <tr> |
|---|
| 1462 | <td><i>supplier1</i></td> |
|---|
| 1463 | <td align="right">1</td> |
|---|
| 1464 | <td align="right">0</td> |
|---|
| 1465 | <td align="right">1</td> |
|---|
| 1466 | </tr> |
|---|
| 1467 | <tr> |
|---|
| 1468 | <td><i>supplier2</i></td> |
|---|
| 1469 | <td align="right">1</td> |
|---|
| 1470 | <td align="right">1</td> |
|---|
| 1471 | <td align="right">2</td> |
|---|
| 1472 | </tr> |
|---|
| 1473 | </tbody></table> |
|---|
| 1474 | </td> |
|---|
| 1475 | </tr> |
|---|
| 1476 | </tbody></table> |
|---|
| 1477 | <font> |
|---|
| 1478 | </font><p><font>The following code will generate the SQL for a cross-tabulation: |
|---|
| 1479 | </font></p><pre><font># Query the main "product" table<br># Set the rows to SupplierName<br># and the columns to the values of Categories<br># and define the joins to link to lookup tables <br># "categories" and "suppliers"<br>#<br> include "adodb/pivottable.inc.php";<br> $sql = PivotTableSQL(<br> $gDB, # adodb connection<br> 'products p ,categories c ,suppliers s', # tables<br> 'SupplierName', # rows (multiple fields allowed)<br> 'CategoryName', # column to pivot on <br> 'p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID' # joins/where<br>);<br></font></pre> |
|---|
| 1480 | |
|---|
| 1481 | <p><font> This will generate the following SQL:</font></p> |
|---|
| 1482 | <p><code><font size="2">SELECT SupplierName, <br> |
|---|
| 1483 | SUM(CASE WHEN CategoryName='Beverages' THEN 1 ELSE 0 END) AS "Beverages", |
|---|
| 1484 | <br> |
|---|
| 1485 | SUM(CASE WHEN CategoryName='Condiments' THEN 1 ELSE 0 END) AS "Condiments", |
|---|
| 1486 | <br> |
|---|
| 1487 | SUM(CASE WHEN CategoryName='Confections' THEN 1 ELSE 0 END) AS "Confections", |
|---|
| 1488 | <br> |
|---|
| 1489 | SUM(CASE WHEN CategoryName='Dairy Products' THEN 1 ELSE 0 END) AS "Dairy |
|---|
| 1490 | Products", <br> |
|---|
| 1491 | SUM(CASE WHEN CategoryName='Grains/Cereals' THEN 1 ELSE 0 END) AS "Grains/Cereals", |
|---|
| 1492 | <br> |
|---|
| 1493 | SUM(CASE WHEN CategoryName='Meat/Poultry' THEN 1 ELSE 0 END) AS "Meat/Poultry", |
|---|
| 1494 | <br> |
|---|
| 1495 | SUM(CASE WHEN CategoryName='Produce' THEN 1 ELSE 0 END) AS "Produce", |
|---|
| 1496 | <br> |
|---|
| 1497 | SUM(CASE WHEN CategoryName='Seafood' THEN 1 ELSE 0 END) AS "Seafood", |
|---|
| 1498 | <br> |
|---|
| 1499 | SUM(1) as Total <br> |
|---|
| 1500 | FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID |
|---|
| 1501 | and s.SupplierID= p.SupplierID <br> |
|---|
| 1502 | GROUP BY SupplierName</font></code></p> |
|---|
| 1503 | <p> You can also pivot on <i>numerical columns</i> and <i>generate totals</i> |
|---|
| 1504 | by using ranges. <font>This code was revised in ADODB 2.41 |
|---|
| 1505 | and is not backward compatible.</font> The second example shows this:</p> |
|---|
| 1506 | <pre> $sql = PivotTableSQL(<br> $gDB, # adodb connection<br> 'products p ,categories c ,suppliers s', # tables<br> 'SupplierName', #<font> rows (multiple fields allowed)</font> |
|---|
| 1507 | array( # column ranges |
|---|
| 1508 | ' 0 ' => 'UnitsInStock <= 0', |
|---|
| 1509 | "1 to 5" => '0 < UnitsInStock and UnitsInStock <= 5', |
|---|
| 1510 | "6 to 10" => '5 < UnitsInStock and UnitsInStock <= 10', |
|---|
| 1511 | "11 to 15" => '10 < UnitsInStock and UnitsInStock <= 15', |
|---|
| 1512 | "16+" => '15 < UnitsInStock' |
|---|
| 1513 | ), |
|---|
| 1514 | ' p.CategoryID = c.CategoryID and s.SupplierID= p.SupplierID', # joins/where |
|---|
| 1515 | 'UnitsInStock', # sum this field |
|---|
| 1516 | 'Sum ' # sum label prefix |
|---|
| 1517 | ); |
|---|
| 1518 | </pre> |
|---|
| 1519 | <p>Which generates: </p> |
|---|
| 1520 | <p> <code> <font size="2">SELECT SupplierName, <br> |
|---|
| 1521 | SUM(CASE WHEN UnitsInStock <= 0 THEN UnitsInStock ELSE 0 END) AS "Sum |
|---|
| 1522 | 0 ", <br> |
|---|
| 1523 | SUM(CASE WHEN 0 < UnitsInStock and UnitsInStock <= 5 THEN UnitsInStock |
|---|
| 1524 | ELSE 0 END) AS "Sum 1 to 5",<br> |
|---|
| 1525 | SUM(CASE WHEN 5 < UnitsInStock and UnitsInStock <= 10 THEN UnitsInStock |
|---|
| 1526 | ELSE 0 END) AS "Sum 6 to 10",<br> |
|---|
| 1527 | SUM(CASE WHEN 10 < UnitsInStock and UnitsInStock <= 15 THEN UnitsInStock |
|---|
| 1528 | ELSE 0 END) AS "Sum 11 to 15", <br> |
|---|
| 1529 | SUM(CASE WHEN 15 < UnitsInStock THEN UnitsInStock ELSE 0 END) AS "Sum |
|---|
| 1530 | 16+", <br> |
|---|
| 1531 | SUM(UnitsInStock) AS "Sum UnitsInStock", <br> |
|---|
| 1532 | SUM(1) as Total,<br> |
|---|
| 1533 | FROM products p ,categories c ,suppliers s WHERE p.CategoryID = c.CategoryID |
|---|
| 1534 | and s.SupplierID= p.SupplierID <br> |
|---|
| 1535 | GROUP BY SupplierName</font></code><font size="2"><br> |
|---|
| 1536 | </font> </p> |
|---|
| 1537 | <font><hr /> |
|---|
| 1538 | <h1>Class Reference<a name="ref"></a></h1> |
|---|
| 1539 | <p>Function parameters with [ ] around them are optional.</p> |
|---|
| 1540 | </font> |
|---|
| 1541 | <h2>Global Variables</h2> |
|---|
| 1542 | <h3><font><a name="adodb_countrecs"></a></font>$ADODB_COUNTRECS</h3> |
|---|
| 1543 | <p>If the database driver API does not support counting the number of records |
|---|
| 1544 | returned in a SELECT statement, the function RecordCount() is emulated when |
|---|
| 1545 | the global variable $ADODB_COUNTRECS is set to true, which is the default. |
|---|
| 1546 | We emulate this by buffering the records, which can take up large amounts |
|---|
| 1547 | of memory for big recordsets. Set this variable to false for the best performance. |
|---|
| 1548 | This variable is checked every time a query is executed, so you can selectively |
|---|
| 1549 | choose which recordsets to count.</p> |
|---|
| 1550 | <h3><font><a name="adodb_cache_dir"></a>$ADODB_CACHE_DIR</font></h3> |
|---|
| 1551 | <font> |
|---|
| 1552 | <p>If you are using recordset caching, this is the directory to save your recordsets |
|---|
| 1553 | in. Define this before you call any caching functions such as CacheExecute( |
|---|
| 1554 | ). We recommend setting <i>register_globals=off</i> in php.ini if you use this |
|---|
| 1555 | feature for security reasons.</p> |
|---|
| 1556 | <p>If you are using Unix and apache, you might need to set your cache directory |
|---|
| 1557 | permissions to something similar to the following:</p> |
|---|
| 1558 | </font> |
|---|
| 1559 | <p>chown -R apache /path/to/adodb/cache<br> |
|---|
| 1560 | chgrp -R apache /path/to/adodb/cache </p> |
|---|
| 1561 | <h3><font><a name="adodb_ansi_padding_off"></a>$ADODB_ANSI_PADDING_OFF</font></h3> |
|---|
| 1562 | <p><font>Determines whether to right trim CHAR fields (and also VARCHAR for ibase/firebird). |
|---|
| 1563 | Set to true to trim. Default is false. Currently works for oci8po, ibase and firebird |
|---|
| 1564 | drivers. Added in ADOdb 4.01. |
|---|
| 1565 | </font></p><h3><font><a name="adodb_lang"></a>$ADODB_LANG</font></h3> |
|---|
| 1566 | <p><font>Determines the language used in MetaErrorMsg(). The default is 'en', for English. |
|---|
| 1567 | To find out what languages are supported, see the files |
|---|
| 1568 | in adodb/lang/adodb-$lang.inc.php, where $lang is the supported langauge. |
|---|
| 1569 | </font></p><h3><font><a name="adodb_fetch_mode"></a>$ADODB_FETCH_MODE</font></h3> |
|---|
| 1570 | <p><font>This is a global variable that determines how arrays are retrieved by recordsets. |
|---|
| 1571 | The recordset saves this value on creation (eg. in Execute( ) or SelectLimit( |
|---|
| 1572 | )), and any subsequent changes to $ADODB_FETCH_MODE have no affect on existing |
|---|
| 1573 | recordsets, only on recordsets created in the future.</font></p> |
|---|
| 1574 | <p><font>The following constants are defined:</font></p> |
|---|
| 1575 | <p><font>define('ADODB_FETCH_DEFAULT',0);<br> |
|---|
| 1576 | define('ADODB_FETCH_NUM',1);<br> |
|---|
| 1577 | define('ADODB_FETCH_ASSOC',2);<br> |
|---|
| 1578 | define('ADODB_FETCH_BOTH',3); </font></p> |
|---|
| 1579 | <font> |
|---|
| 1580 | </font><p><font> An example: |
|---|
| 1581 | </font></p><pre><font> $ADODB_<b>FETCH_MODE</b> = ADODB_FETCH_NUM;<br> $rs1 = $db->Execute('select * from table');<br> $ADODB_<b>FETCH_MODE</b> = ADODB_FETCH_ASSOC;<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> |
|---|
| 1582 | print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i> |
|---|
| 1583 | </font></pre> |
|---|
| 1584 | <p><font> As you can see in the above example, both recordsets store and use different |
|---|
| 1585 | fetch modes based on the $ADODB_FETCH_MODE setting when the recordset was |
|---|
| 1586 | created by Execute().</font></p> |
|---|
| 1587 | <p><font>If no fetch mode is predefined, the fetch mode defaults to ADODB_FETCH_DEFAULT. |
|---|
| 1588 | The behaviour of this default mode varies from driver to driver, so do not |
|---|
| 1589 | rely on ADODB_FETCH_DEFAULT. For portability, we recommend sticking to ADODB_FETCH_NUM |
|---|
| 1590 | or ADODB_FETCH_ASSOC. Many drivers do not support ADODB_FETCH_BOTH.</font></p> |
|---|
| 1591 | <p><font><strong>SetFetchMode Function</strong></font></p> |
|---|
| 1592 | <p><font>If you have multiple connection objects, and want to have different fetch modes for each |
|---|
| 1593 | connection, then use <a href="#setfetchmode">SetFetchMode</a>. |
|---|
| 1594 | Once this function is called for a connection object, that connection object |
|---|
| 1595 | will ignore the global variable $ADODB_FETCH_MODE and will use the internal |
|---|
| 1596 | fetchMode property exclusively.</font></p> |
|---|
| 1597 | <pre><font> $db->SetFetchMode(ADODB_FETCH_NUM);<br> $rs1 = $db->Execute('select * from table');<br> $db->SetFetchMode(ADODB_FETCH_ASSOC);<br> $rs2 = $db->Execute('select * from table');<br> print_r($rs1->fields); # shows <i>array([0]=>'v0',[1] =>'v1')</i> |
|---|
| 1598 | print_r($rs2->fields); # shows <i>array(['col1']=>'v0',['col2'] =>'v1')</i></font></pre> |
|---|
| 1599 | <p><font>To retrieve the previous fetch mode, you can use check the $db->fetchMode |
|---|
| 1600 | property, or use the return value of SetFetchMode( ). |
|---|
| 1601 | </font></p><p><font><strong><a name="adodb_assoc_case"></a>ADODB_ASSOC_CASE</strong></font></p> |
|---|
| 1602 | <p><font>You can control the associative fetch case for certain drivers which behave |
|---|
| 1603 | differently. For the sybase, oci8po, mssql, odbc and ibase drivers and all |
|---|
| 1604 | drivers derived from them, ADODB_ASSOC_CASE will by default generate recordsets |
|---|
| 1605 | where the field name keys are lower-cased. Use the constant ADODB_ASSOC_CASE |
|---|
| 1606 | to change the case of the keys. There are 3 possible values:</font></p> |
|---|
| 1607 | <p><font>0 = assoc lowercase field names. $rs->fields['orderid']<br> |
|---|
| 1608 | 1 = assoc uppercase field names. $rs->fields['ORDERID']<br> |
|---|
| 1609 | 2 = use native-case field names. $rs->fields['OrderID'] -- this is the |
|---|
| 1610 | default since ADOdb 2.90</font></p> |
|---|
| 1611 | <p><font>To use it, declare it before you incldue adodb.inc.php.</font></p> |
|---|
| 1612 | <p><font>define('ADODB_ASSOC_CASE', 2); # use native-case for ADODB_FETCH_ASSOC<br> |
|---|
| 1613 | include('adodb.inc.php'); </font></p> |
|---|
| 1614 | <h3><font><a name="force_type"></a>$ADODB_FORCE_TYPE</font></h3> |
|---|
| 1615 | <p><font>See the <a href="#ADODB_FORCE_TYPE">GetUpdateSQL tutorial</a>. |
|---|
| 1616 | </font></p> |
|---|
| 1617 | <h3><font><a name="adodb_auto_quote"></a>$ADODB_QUOTE_FIELDNAMES</font></h3> |
|---|
| 1618 | <p><font>Auto-quotes field names when using AutoExecute() when set to true. </font> |
|---|
| 1619 | <p> </p> |
|---|
| 1620 | <hr /> |
|---|
| 1621 | <h2><font>ADOConnection<a name="adoconnection"></a></font></h2> |
|---|
| 1622 | <p><font>Object that performs the connection to the database, executes SQL statements |
|---|
| 1623 | and has a set of utility functions for standardising the format of SQL statements |
|---|
| 1624 | for issues such as concatenation and date formats.</font></p> |
|---|
| 1625 | <h3><font>ADOConnection Fields</font></h3> |
|---|
| 1626 | <p><font><b>databaseType</b>: Name of the database system we are connecting to. Eg. |
|---|
| 1627 | <b>odbc</b> or <b>mssql</b> or <b>mysql</b>.</font></p> |
|---|
| 1628 | <p><font><b>dataProvider</b>: The underlying mechanism used to connect to the database. |
|---|
| 1629 | Normally set to <b>native</b>, unless using <b>odbc</b> or <b>ado</b>.</font></p> |
|---|
| 1630 | <p><font><b>host: </b>Name of server or data source name (DSN) to connect to.</font></p> |
|---|
| 1631 | <p><font><b>database</b>: Name of the database or to connect to. If ado is used, it |
|---|
| 1632 | will hold the ado data provider.</font></p> |
|---|
| 1633 | <p><font><b>user</b>: Login id to connect to database. Password is not saved for security |
|---|
| 1634 | reasons.</font></p> |
|---|
| 1635 | <p><font><b>raiseErrorFn</b>: Allows you to define an error handling function. See adodb-errorhandler.inc.php |
|---|
| 1636 | for an example.</font></p> |
|---|
| 1637 | <p><font><b>debug</b>: Set to <i>true</i> to make debug statements to appear.</font></p> |
|---|
| 1638 | <p><font><b>concat_operator</b>: Set to '+' or '||' normally. The operator used to concatenate |
|---|
| 1639 | strings in SQL. Used by the <b><a href="#concat">Concat</a></b> function.</font></p> |
|---|
| 1640 | <p><font><b>fmtDate</b>: The format used by the <b><a href="#dbdate">DBDate</a></b> |
|---|
| 1641 | function to send dates to the database. is '#Y-m-d#' for Microsoft Access, |
|---|
| 1642 | and ''Y-m-d'' for MySQL.</font></p> |
|---|
| 1643 | <p><font><b>fmtTimeStamp: </b>The format used by the <b><a href="#dbtimestamp">DBTimeStamp</a></b> |
|---|
| 1644 | function to send timestamps to the database. </font></p> |
|---|
| 1645 | <p><font><b>true</b>: The value used to represent true.Eg. '.T.'. for Foxpro, '1' for |
|---|
| 1646 | Microsoft SQL.</font></p> |
|---|
| 1647 | <p><font><b>false: </b> The value used to represent false. Eg. '.F.'. for Foxpro, '0' |
|---|
| 1648 | for Microsoft SQL.</font></p> |
|---|
| 1649 | <p><font><b>replaceQuote</b>: The string used to escape quotes. Eg. double single-quotes |
|---|
| 1650 | for Microsoft SQL, and backslash-quote for MySQL. Used by <a href="#qstr">qstr</a>.</font></p> |
|---|
| 1651 | <p><font><b>autoCommit</b>: indicates whether automatic commit is enabled. Default is |
|---|
| 1652 | true.</font></p> |
|---|
| 1653 | <p><font><b>charSet</b>: set the default charset to use. Currently only interbase/firebird supports |
|---|
| 1654 | this.</font></p> |
|---|
| 1655 | <p><font><b>dialect</b>: set the default sql dialect to use. Currently only interbase/firebird |
|---|
| 1656 | supports this.</font></p> |
|---|
| 1657 | <p><font><b>role</b>: set the role. Currently only interbase/firebird |
|---|
| 1658 | supports this.</font></p> |
|---|
| 1659 | <p><font><b>metaTablesSQL</b>: SQL statement to return a list of available tables. Eg. |
|---|
| 1660 | <i>SHOW TABLES</i> in MySQL.</font></p> |
|---|
| 1661 | <p><font><b>genID</b>: The latest id generated by GenID() if supported by the database.</font></p> |
|---|
| 1662 | <p><font><b>cacheSecs</b>: The number of seconds to cache recordsets if CacheExecute() |
|---|
| 1663 | or CacheSelectLimit() omit the $secs2cache parameter. Defaults to 60 minutes.</font></p> |
|---|
| 1664 | <p><font><b>sysDate</b>: String that holds the name of the database function to call |
|---|
| 1665 | to get the current date. Useful for inserts and updates.</font></p> |
|---|
| 1666 | <p><font><b>sysTimeStamp</b>: String that holds the name of the database function to |
|---|
| 1667 | call to get the current timestamp/datetime value.</font></p> |
|---|
| 1668 | <p><font><b>leftOuter</b>: String that holds operator for left outer join, if known. |
|---|
| 1669 | Otherwise set to false.</font></p> |
|---|
| 1670 | <p><font><b>rightOuter</b>: String that holds operator for left outer join, if known. |
|---|
| 1671 | Otherwise set to false.</font></p> |
|---|
| 1672 | <p><font><b>ansiOuter</b>: Boolean that if true indicates that ANSI style outer joins |
|---|
| 1673 | are permitted. Eg. <i>select * from table1 left join table2 on p1=p2.</i></font></p> |
|---|
| 1674 | <p><font><b>connectSID</b>: Boolean that indicates whether to treat the $database parameter |
|---|
| 1675 | in connects as the SID for the oci8 driver. Defaults to false. Useful for |
|---|
| 1676 | Oracle 8.0.5 and earlier.</font></p> |
|---|
| 1677 | <p><font><b>autoRollback</b>: Persistent connections are auto-rollbacked in PConnect( |
|---|
| 1678 | ) if this is set to true. Default is false.</font></p> |
|---|
| 1679 | <hr /> |
|---|
| 1680 | <h3><font>ADOConnection Main Functions</font></h3> |
|---|
| 1681 | <p><font><b>ADOConnection( )</b></font></p> |
|---|
| 1682 | <p><font>Constructor function. Do not call this directly. Use ADONewConnection( ) instead.</font></p> |
|---|
| 1683 | <p><font><b>Connect<a name="connect"></a>($host,[$user],[$password],[$database])</b></font></p> |
|---|
| 1684 | <p><font>Non-persistent connect to data source or server $<b>host</b>, using userid |
|---|
| 1685 | $<b>user </b>and password $<b>password</b>. If the server supports multiple |
|---|
| 1686 | databases, connect to database $<b>database</b>. </font></p> |
|---|
| 1687 | <p><font>Returns true/false depending on connection success. Since 4.23, null is returned if the extension is not loaded.</font></p> |
|---|
| 1688 | <p><font>ADO Note: If you are using a Microsoft ADO and not OLEDB, you can set the $database |
|---|
| 1689 | parameter to the OLEDB data provider you are using.</font></p> |
|---|
| 1690 | <p><font>PostgreSQL: An alternative way of connecting to the database is to pass the |
|---|
| 1691 | standard PostgreSQL connection string in the first parameter $host, and the |
|---|
| 1692 | other parameters will be ignored.</font></p> |
|---|
| 1693 | <p><font>For Oracle and Oci8, there are two ways to connect. First is to use the TNS |
|---|
| 1694 | name defined in your local tnsnames.ora (or ONAMES or HOSTNAMES). Place the |
|---|
| 1695 | name in the $database field, and set the $host field to false. Alternatively, |
|---|
| 1696 | set $host to the server, and $database to the database SID, this bypassed |
|---|
| 1697 | tnsnames.ora. |
|---|
| 1698 | </font></p><p><font>Examples: |
|---|
| 1699 | </font></p><pre><font> # $oraname in tnsnames.ora/ONAMES/HOSTNAMES<br> $conn->Connect(false, 'scott', 'tiger', $oraname); <br> $conn->Connect('server:1521', 'scott', 'tiger', 'ServiceName'); # bypass tnsnames.ora</font></pre> |
|---|
| 1700 | <p><font>There are many examples of connecting to a database. |
|---|
| 1701 | See <a href="#connect_ex">Connection Examples</a> for many examples. |
|---|
| 1702 | |
|---|
| 1703 | </font></p><p><font><b>PConnect<a name="pconnect"></a>($host,[$user],[$password],[$database])</b></font></p> |
|---|
| 1704 | <p><font>Persistent connect to data source or server $<b>host</b>, using userid $<b>user</b> |
|---|
| 1705 | and password $<b>password</b>. If the server supports multiple databases, |
|---|
| 1706 | connect to database $<b>database</b>.</font></p> |
|---|
| 1707 | <p><font>We now perform a rollback on persistent connection for selected databases since |
|---|
| 1708 | 2.21, as advised in the PHP manual. See change log or source code for which |
|---|
| 1709 | databases are affected. |
|---|
| 1710 | </font></p><p><font>Returns true/false depending on connection. Since 4.23, 0 is returned if the extension is not loaded. |
|---|
| 1711 | See Connect( ) above for more info.</font></p> |
|---|
| 1712 | <p><font>Since ADOdb 2.21, we also support autoRollback. If you set:</font></p> |
|---|
| 1713 | |
|---|
| 1714 | <pre> $conn = &NewADOConnection('mysql');<br> $conn->autoRollback = true; # default is false<br> $conn->PConnect(...); # rollback here</pre> |
|---|
| 1715 | <p> Then when doing a persistent connection with PConnect( ), ADOdb will |
|---|
| 1716 | perform a rollback first. This is because it is documented that PHP is |
|---|
| 1717 | not guaranteed to rollback existing failed transactions when |
|---|
| 1718 | persistent connections are used. This is implemented in Oracle, |
|---|
| 1719 | MySQL, PgSQL, MSSQL, ODBC currently. |
|---|
| 1720 | </p><p>Since ADOdb 3.11, you can force non-persistent |
|---|
| 1721 | connections even if PConnect is called by defining the constant |
|---|
| 1722 | ADODB_NEVER_PERSIST before you call PConnect. |
|---|
| 1723 | </p><p> |
|---|
| 1724 | Since 4.23, null is returned if the extension is not loaded. |
|---|
| 1725 | </p><p><b>NConnect<a name="nconnect"></a>($host,[$user],[$password],[$database])</b></p> |
|---|
| 1726 | <p>Always force a new connection. In contrast, PHP sometimes reuses connections |
|---|
| 1727 | when you use Connect() or PConnect(). Currently works only on mysql (PHP 4.3.0 |
|---|
| 1728 | or later), postgresql and oci8-derived drivers. For other drivers, NConnect() works like |
|---|
| 1729 | Connect().</p> |
|---|
| 1730 | <p><font><b>IsConnected( )<a name="isconnected"></a></b></font></p> |
|---|
| 1731 | <p> |
|---|
| 1732 | <font>Returns true if connected to database. Added in 4.53. |
|---|
| 1733 | |
|---|
| 1734 | </font></p><p><font><b>Execute<a name="execute"></a>($sql,$inputarr=false)</b></font></p> |
|---|
| 1735 | <p><font>Execute SQL statement $<b>sql</b> and return derived class of ADORecordSet |
|---|
| 1736 | if successful. Note that a record set is always returned on success, even |
|---|
| 1737 | if we are executing an insert or update statement. You can also pass in $sql a statement prepared |
|---|
| 1738 | in <a href="#prepare">Prepare()</a>.</font></p> |
|---|
| 1739 | <p><font>Returns derived class of ADORecordSet. Eg. if connecting via mysql, then ADORecordSet_mysql |
|---|
| 1740 | would be returned. False is returned if there was an error in executing the |
|---|
| 1741 | sql.</font></p> |
|---|
| 1742 | <p><font>The $inputarr parameter can be used for binding variables to parameters. Below |
|---|
| 1743 | is an Oracle example:</font></p> |
|---|
| 1744 | <pre><font> $conn->Execute("SELECT * FROM TABLE WHERE COND=:val", array('val'=> $val));<br> </font></pre> |
|---|
| 1745 | <p><font>Another example, using ODBC,which uses the ? convention:</font></p> |
|---|
| 1746 | <pre><font> $conn->Execute("SELECT * FROM TABLE WHERE COND=?", array($val));<br></font></pre> |
|---|
| 1747 | <font><a name="binding"></a> |
|---|
| 1748 | <i>Binding variables</i></font><p> |
|---|
| 1749 | <font>Variable binding speeds the compilation and caching of SQL statements, leading |
|---|
| 1750 | to higher performance. Currently Oracle, Interbase and ODBC supports variable binding. |
|---|
| 1751 | Interbase/ODBC style ? binding is emulated in databases that do not support binding. |
|---|
| 1752 | Note that you do not have to quote strings if you use binding. |
|---|
| 1753 | </font></p><p><font> Variable binding in the odbc, interbase and oci8po drivers. |
|---|
| 1754 | </font></p><pre><font>$rs = $db->Execute('select * from table where val=?', array('10'));<br></font></pre> |
|---|
| 1755 | <font>Variable binding in the oci8 driver: |
|---|
| 1756 | </font><pre><font>$rs = $db->Execute('select name from table where val=:key', <br> array('key' => 10));<br></font></pre> |
|---|
| 1757 | <font><a name="bulkbind"></a> |
|---|
| 1758 | <i>Bulk binding</i> |
|---|
| 1759 | </font><p><font>Since ADOdb 3.80, we support bulk binding in Execute(), in which you pass in a 2-dimensional array to |
|---|
| 1760 | be bound to an INSERT/UPDATE or DELETE statement. |
|---|
| 1761 | </font></p><pre><font>$arr = array(<br> array('Ahmad',32),<br> array('Zulkifli', 24),<br> array('Rosnah', 21)<br> );<br>$ok = $db->Execute('insert into table (name,age) values (?,?)',$arr);<br></font></pre> |
|---|
| 1762 | <p><font>This provides very high performance as the SQL statement is prepared first. |
|---|
| 1763 | The prepared statement is executed repeatedly for each array row until all rows are completed, |
|---|
| 1764 | or until the first error. Very useful for importing data. |
|---|
| 1765 | |
|---|
| 1766 | </font></p><p><font><b>CacheExecute<a name="cacheexecute"></a>([$secs2cache,]$sql,$inputarr=false)</b></font></p> |
|---|
| 1767 | <p><font>Similar to Execute, except that the recordset is cached for $secs2cache seconds |
|---|
| 1768 | in the $ADODB_CACHE_DIR directory, and $inputarr only accepts 1-dimensional arrays. |
|---|
| 1769 | If CacheExecute() is called again with the same $sql, $inputarr, |
|---|
| 1770 | and also the same database, same userid, and the cached recordset |
|---|
| 1771 | has not expired, the cached recordset is returned. |
|---|
| 1772 | </font></p><pre><font> include('adodb.inc.php'); <br> include('tohtml.inc.php');<br> $ADODB_<b>CACHE_DIR</b> = '/usr/local/ADOdbcache';<br> $conn = &ADONewConnection('mysql'); <br> $conn->PConnect('localhost','userid','password','database');<br> $rs = $conn-><b>CacheExecute</b>(15, 'select * from table'); # cache 15 secs<br> rs2html($rs); /* recordset to html table */ <br></font></pre> |
|---|
| 1773 | <p><font> Alternatively, since ADOdb 1.80, the $secs2cache parameter is optional:</font></p> |
|---|
| 1774 | <pre><font> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; // cache 24 hours<br> $rs = $conn->CacheExecute('select * from table');<br></font></pre> |
|---|
| 1775 | <font>If $secs2cache is omitted, we use the value |
|---|
| 1776 | in $connection->cacheSecs (default is 3600 seconds, or 1 hour). Use CacheExecute() |
|---|
| 1777 | only with SELECT statements. |
|---|
| 1778 | </font><p><font>Performance note: I have done some benchmarks and found that they vary so greatly |
|---|
| 1779 | that it's better to talk about when caching is of benefit. When your database |
|---|
| 1780 | server is <i>much slower </i>than your Web server or the database is <i>very |
|---|
| 1781 | overloaded </i>then ADOdb's caching is good because it reduces the load on |
|---|
| 1782 | your database server. If your database server is lightly loaded or much faster |
|---|
| 1783 | than your Web server, then caching could actually reduce performance. </font></p> |
|---|
| 1784 | <p><font><b>ExecuteCursor<a name="executecursor"></a>($sql,$cursorName='rs',$parameters=false)</b></font></p> |
|---|
| 1785 | <p><font>Execute an Oracle stored procedure, and returns an Oracle REF cursor variable as |
|---|
| 1786 | a regular ADOdb recordset. Does not work with any other database except oci8. |
|---|
| 1787 | Thanks to Robert Tuttle for the design. |
|---|
| 1788 | </font></p><pre><font> $db = ADONewConnection("oci8"); <br> $db->Connect("foo.com:1521", "uid", "pwd", "FOO"); <br> $rs = $db->ExecuteCursor("begin :cursorvar := getdata(:param1); end;", <br> 'cursorvar',<br> array('param1'=>10)); <br> # $rs is now just like any other ADOdb recordset object<br> rs2html($rs);</font></pre> |
|---|
| 1789 | <p><font>ExecuteCursor() is a helper function that does the following internally: |
|---|
| 1790 | </font></p><pre><font> $stmt = $db->Prepare("begin :cursorvar := getdata(:param1); end;", true); <br> $db->Parameter($stmt, $cur, 'cursorvar', false, -1, OCI_B_CURSOR);<br> $rs = $db->Execute($stmt,$bindarr);<br></font></pre> |
|---|
| 1791 | <p><font>ExecuteCursor only accepts 1 out parameter. So if you have 2 out parameters, use: |
|---|
| 1792 | </font></p><pre><font> $vv = 'A%';<br> $stmt = $db->PrepareSP("BEGIN list_tabs(:crsr,:tt); END;");<br> $db->OutParameter($stmt, $cur, 'crsr', -1, OCI_B_CURSOR);<br> $db->OutParameter($stmt, $vv, 'tt', 32); # return varchar(32)<br> $arr = $db->GetArray($stmt);<br> print_r($arr);<br> echo " val = $vv"; ## outputs 'TEST'<br></font></pre> |
|---|
| 1793 | <font>for the following PL/SQL: |
|---|
| 1794 | </font><pre><font> TYPE TabType IS REF CURSOR RETURN TAB%ROWTYPE;<br><br> PROCEDURE list_tabs(tabcursor IN OUT TabType,tablenames IN OUT VARCHAR) IS<br> BEGIN<br> OPEN tabcursor FOR SELECT * FROM TAB WHERE tname LIKE tablenames;<br> tablenames := 'TEST';<br> END list_tabs;<br></font></pre> |
|---|
| 1795 | <p><font><b>SelectLimit<a name="selectlimit"></a>($sql,$numrows=-1,$offset=-1,$inputarr=false)</b></font></p> |
|---|
| 1796 | <p><font>Returns a recordset if successful. Returns false otherwise. Performs a select |
|---|
| 1797 | statement, simulating PostgreSQL's SELECT statement, LIMIT $numrows OFFSET |
|---|
| 1798 | $offset clause.</font></p> |
|---|
| 1799 | <p><font>In PostgreSQL, SELECT * FROM TABLE LIMIT 3 will return the first 3 records |
|---|
| 1800 | only. The equivalent is <code>$connection->SelectLimit('SELECT * FROM TABLE',3)</code>. |
|---|
| 1801 | This functionality is simulated for databases that do not possess this feature.</font></p> |
|---|
| 1802 | <p><font>And SELECT * FROM TABLE LIMIT 3 OFFSET 2 will return records 3, 4 and 5 (eg. |
|---|
| 1803 | after record 2, return 3 rows). The equivalent in ADOdb is <code>$connection->SelectLimit('SELECT |
|---|
| 1804 | * FROM TABLE',3,2)</code>.</font></p> |
|---|
| 1805 | <p><font>Note that this is the <i>opposite</i> of MySQL's LIMIT clause. You can also |
|---|
| 1806 | set <code>$connection->SelectLimit('SELECT * FROM TABLE',-1,10)</code> to |
|---|
| 1807 | get rows 11 to the last row.</font></p> |
|---|
| 1808 | <p><font>The last parameter $inputarr is for databases that support variable binding |
|---|
| 1809 | such as Oracle oci8. This substantially reduces SQL compilation overhead. |
|---|
| 1810 | Below is an Oracle example:</font></p> |
|---|
| 1811 | <pre><font> $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=:val", 100,-1,array('val'=> $val));<br> </font></pre> |
|---|
| 1812 | <p><font>The oci8po driver (oracle portable driver) uses the more standard bind variable |
|---|
| 1813 | of ?: |
|---|
| 1814 | </font></p><pre><font> $conn->SelectLimit("SELECT * FROM TABLE WHERE COND=?", 100,-1,array('val'=> $val));<br></font></pre> |
|---|
| 1815 | <p><font> |
|---|
| 1816 | </font></p><p><font>Ron Wilson reports that SelectLimit does not work with UNIONs. |
|---|
| 1817 | </font></p><p><font><b>CacheSelectLimit<a name="cacheselectlimit"></a>([$secs2cache,] $sql, $numrows=-1,$offset=-1,$inputarr=false)</b></font></p> |
|---|
| 1818 | <p><font>Similar to SelectLimit, except that the recordset returned is cached for $secs2cache |
|---|
| 1819 | seconds in the $ADODB_CACHE_DIR directory. </font></p> |
|---|
| 1820 | <p><font>Since 1.80, $secs2cache has been optional, and you can define the caching time |
|---|
| 1821 | in $connection->cacheSecs.</font></p> |
|---|
| 1822 | |
|---|
| 1823 | <pre><font> $conn->Connect(...);<br> $conn->cacheSecs = 3600*24; // cache 24 hours<br> $rs = $conn->CacheSelectLimit('select * from table',10);</font></pre> |
|---|
| 1824 | <font> |
|---|
| 1825 | </font><p><font><b>CacheFlush<a name="cacheflush"></a>($sql=false,$inputarr=false)</b></font></p> |
|---|
| 1826 | <p><font>Flush (delete) any cached recordsets for the SQL statement $sql in $ADODB_CACHE_DIR. |
|---|
| 1827 | </font></p><p><font>If no parameter is passed in, then all adodb_*.cache files are deleted. |
|---|
| 1828 | </font></p> |
|---|
| 1829 | <p>CacheSelectLimit() rewrites the SQL query, so you won't be able to pass the SQL to CacheFlush. In this case, |
|---|
| 1830 | to flush the cached SQL recordset returned by CacheSelectLimit(), set $secs2cache to -1: |
|---|
| 1831 | <pre> |
|---|
| 1832 | $db->CacheSelectLimit(-1, $sql, $nrows); |
|---|
| 1833 | </pre> |
|---|
| 1834 | <p><font> If you want to flush all cached recordsets manually, execute the following |
|---|
| 1835 | PHP code (works only under Unix): <br> |
|---|
| 1836 | <code> system("rm -f `find ".$ADODB_CACHE_DIR." -name |
|---|
| 1837 | adodb_*.cache`");</code></font></p> |
|---|
| 1838 | <p><font>For general cleanup of all expired files, you should use <a href="http://www.superscripts.com/tutorial/crontab.html">crontab</a> |
|---|
| 1839 | on Unix, or at.exe on Windows, and a shell script similar to the following:<font face="Courier New, Courier, mono"><br> |
|---|
| 1840 | #------------------------------------------------------ <br> |
|---|
| 1841 | # This particular example deletes files in the TMPPATH <br> |
|---|
| 1842 | # directory with the string ".cache" in their name that <br> |
|---|
| 1843 | # are more than 7 days old. <br> |
|---|
| 1844 | #------------------------------------------------------ <br> |
|---|
| 1845 | AGED=7 <br> |
|---|
| 1846 | find ${TMPPATH} -mtime +$AGED | grep "\.cache" | xargs rm -f <br> |
|---|
| 1847 | </font> </font></p> |
|---|
| 1848 | <p><font><b>MetaError<a name="metaerror"></a>($errno=false)</b></font></p> |
|---|
| 1849 | <p><font>Returns a virtualized error number, based on PEAR DB's error number system. You might |
|---|
| 1850 | need to include adodb-error.inc.php before you call this function. The parameter $errno |
|---|
| 1851 | is the native error number you want to convert. If you do not pass any parameter, MetaError |
|---|
| 1852 | will call ErrorNo() for you and convert it. If the error number cannot be virtualized, MetaError |
|---|
| 1853 | will return -1 (DB_ERROR).</font></p> |
|---|
| 1854 | |
|---|
| 1855 | <p><font><b>MetaErrorMsg<a name="metaerrormsg"></a>($errno)</b></font></p> |
|---|
| 1856 | <p><font>Pass the error number returned by MetaError() for the equivalent textual error message.</font></p> |
|---|
| 1857 | <p><font><b>ErrorMsg<a name="errormsg"></a>()</b></font></p> |
|---|
| 1858 | <p><font>Returns the last status or error message. The error message is reset after every |
|---|
| 1859 | call to Execute(). |
|---|
| 1860 | </font></p><p> |
|---|
| 1861 | <font>This can return a string even if |
|---|
| 1862 | no error occurs. In general you do not need to call this function unless an |
|---|
| 1863 | ADOdb function returns false on an error. </font></p> |
|---|
| 1864 | <p><font>Note: If <b>debug</b> is enabled, the SQL error message is always displayed |
|---|
| 1865 | when the <b>Execute</b> function is called.</font></p> |
|---|
| 1866 | <p><font><b>ErrorNo<a name="errorno"></a>()</b></font></p> |
|---|
| 1867 | <p><font>Returns the last error number. The error number is reset after every call to Execute(). |
|---|
| 1868 | If 0 is returned, no error occurred. |
|---|
| 1869 | </font></p><p> |
|---|
| 1870 | <font>Note that old versions of PHP (pre 4.0.6) do |
|---|
| 1871 | not support error number for ODBC. In general you do not need to call this |
|---|
| 1872 | function unless an ADOdb function returns false on an error.</font></p> |
|---|
| 1873 | <p><font><b>IgnoreErrors<a name="ignoreerrors"></a>($saveErrHandlers)</b></font></p> |
|---|
| 1874 | <p>Allows you to ignore errors so that StartTrans()/CompleteTrans() is not affected, nor is the default error handler called if an error occurs. |
|---|
| 1875 | Useful when you want to check if a field or table exists in a database without invoking an error if it does not exist. |
|---|
| 1876 | <p>Usage: |
|---|
| 1877 | <pre> |
|---|
| 1878 | $saveErrHandlers = $conn->IgnoreErrors(); |
|---|
| 1879 | $rs = $conn->Execute("select field from some_table_that_might_not_exist"); |
|---|
| 1880 | $conn->IgnoreErrors($saveErrHandlers); |
|---|
| 1881 | </pre> |
|---|
| 1882 | <p>Warning: do not call StartTrans()/CompleteTrans() inside a code block that is using IgnoreErrors(). |
|---|
| 1883 | <p><font><b>SetFetchMode<a name="setfetchmode"></a>($mode)</b></font></p> |
|---|
| 1884 | <p><font>Sets the current fetch mode for the connection and stores |
|---|
| 1885 | it in $db->fetchMode. Legal modes are ADODB_FETCH_ASSOC and ADODB_FETCH_NUM. |
|---|
| 1886 | For more info, see <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a>.</font></p> |
|---|
| 1887 | <p><font>Returns the previous fetch mode, which could be false |
|---|
| 1888 | if SetFetchMode( ) has not been called before.</font></p> |
|---|
| 1889 | <font> |
|---|
| 1890 | </font><p><font><b>CreateSequence<a name="createseq"></a>($seqName = 'adodbseq',$startID=1)</b></font></p> |
|---|
| 1891 | <p><font>Create a sequence. The next time GenID( ) is called, the value returned will |
|---|
| 1892 | be $startID. Added in 2.60. |
|---|
| 1893 | </font></p><p><font><b>DropSequence<a name="dropseq"></a>($seqName = 'adodbseq')</b></font></p> |
|---|
| 1894 | <p><font>Delete a sequence. Added in 2.60. |
|---|
| 1895 | </font></p><p><font><b>GenID<a name="genid"></a>($seqName = 'adodbseq',$startID=1)</b></font></p> |
|---|
| 1896 | <p><font>Generate a sequence number . Works for interbase, |
|---|
| 1897 | mysql, postgresql, oci8, oci8po, mssql, ODBC based (access,vfp,db2,etc) drivers |
|---|
| 1898 | currently. Uses $seqName as the name of the sequence. GenID() will automatically |
|---|
| 1899 | create the sequence for you if it does not exist (provided the userid has |
|---|
| 1900 | permission to do so). Otherwise you will have to create the sequence yourself. |
|---|
| 1901 | </font></p><p><font> If your database driver emulates sequences, the name of the table is the sequence |
|---|
| 1902 | name. The table has one column, "id" which should be of type integer, or if |
|---|
| 1903 | you need something larger - numeric(16). |
|---|
| 1904 | </font></p><p><font> For ODBC and databases that do not support sequences natively (eg mssql, mysql), |
|---|
| 1905 | we create a table for each sequence. If the sequence has not been defined |
|---|
| 1906 | earlier, it is created with the starting value set in $startID.</font></p> |
|---|
| 1907 | <p><font>Note that the mssql driver's GenID() before 1.90 used to generate 16 byte GUID's.</font></p> |
|---|
| 1908 | <p><font><b>UpdateBlob<a name="updateblob"></a>($table,$column,$val,$where)</b></font></p> |
|---|
| 1909 | <font>Allows you to store a blob (in $val) into $table into $column in a row at $where. |
|---|
| 1910 | </font><p><font> Usage: |
|---|
| 1911 | </font></p><p><font> |
|---|
| 1912 | </font></p><pre><font> # for oracle<br> $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, empty_blob())');<br> $conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');<br> <br> # non oracle databases<br> $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');<br> $conn->UpdateBlob('blobtable','blobcol',$blobvalue,'id=1');<br></font></pre> |
|---|
| 1913 | <p><font> Returns true if succesful, false otherwise. Supported by MySQL, PostgreSQL, |
|---|
| 1914 | Oci8, Oci8po and Interbase drivers. Other drivers might work, depending on |
|---|
| 1915 | the state of development.</font></p> |
|---|
| 1916 | <p><font>Note that when an Interbase blob is retrieved using SELECT, it still needs |
|---|
| 1917 | to be decoded using $connection->DecodeBlob($blob); to derive the original |
|---|
| 1918 | value in versions of PHP before 4.1.0. |
|---|
| 1919 | </font></p><p><font>For PostgreSQL, you can store your blob using blob oid's or as a bytea field. |
|---|
| 1920 | You can use bytea fields but not blob oid's currently with UpdateBlob( ). |
|---|
| 1921 | Conversely UpdateBlobFile( ) supports oid's, but not bytea data.<br> |
|---|
| 1922 | <br> |
|---|
| 1923 | If you do not pass in an oid, then UpdateBlob() assumes that you are storing |
|---|
| 1924 | in bytea fields. |
|---|
| 1925 | <p>If you do not have any blob fields, you can improve you can improve general SQL query performance by disabling blob handling with $connection->disableBlobs = true. |
|---|
| 1926 | </p></font><p><font><b>UpdateClob<a name="updateclob"></a>($table,$column,$val,$where)</b></font></p> |
|---|
| 1927 | <font>Allows you to store a clob (in $val) into $table into $column in a row at $where. |
|---|
| 1928 | Similar to UpdateBlob (see above), but for Character Large OBjects. |
|---|
| 1929 | </font><p><font> Usage: |
|---|
| 1930 | </font></p><pre><font> # for oracle<br> $conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, empty_clob())');<br> $conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');<br> <br> # non oracle databases<br> $conn->Execute('INSERT INTO clobtable (id, clobcol) VALUES (1, null)');<br> $conn->UpdateBlob('clobtable','clobcol',$clobvalue,'id=1');<br></font></pre> |
|---|
| 1931 | <p><font><b>UpdateBlobFile<a name="updateblobfile"></a>($table,$column,$path,$where,$blobtype='BLOB')</b></font></p> |
|---|
| 1932 | <p><font>Similar to UpdateBlob, except that we pass in a file path to where the blob |
|---|
| 1933 | resides. |
|---|
| 1934 | </font></p><p><font>For PostgreSQL, if you are using blob oid's, use this interface. This interface |
|---|
| 1935 | does not support bytea fields. |
|---|
| 1936 | </font></p><p><font>Returns true if successful, false otherwise. |
|---|
| 1937 | </font></p><p><font><b>BlobEncode<a name="blobencode" id="blobencode"></a>($blob)</b> |
|---|
| 1938 | </font></p><p><font>Some databases require blob's to be encoded manually before upload. Note if |
|---|
| 1939 | you use UpdateBlob( ) or UpdateBlobFile( ) the conversion is done automatically |
|---|
| 1940 | for you and you do not have to call this function. For PostgreSQL, currently, |
|---|
| 1941 | BlobEncode() can only be used for bytea fields. |
|---|
| 1942 | </font></p><p><font>Returns the encoded blob value. |
|---|
| 1943 | </font></p><p><font>Note that there is a connection property called <em>blobEncodeType</em> which |
|---|
| 1944 | has 3 legal values: |
|---|
| 1945 | </font></p><p><font>false - no need to perform encoding or decoding.<br> |
|---|
| 1946 | 'I' - blob encoding required, and returned encoded blob is a numeric value |
|---|
| 1947 | (no need to quote).<br> |
|---|
| 1948 | 'C' - blob encoding required, and returned encoded blob is a character value |
|---|
| 1949 | (requires quoting). |
|---|
| 1950 | </font></p><p><font>This is purely for documentation purposes, so that programs that accept multiple |
|---|
| 1951 | database drivers know what is the right thing to do when processing blobs. |
|---|
| 1952 | </font></p><p><font><strong>BlobDecode<a name="blobdecode"></a>($blob, $maxblobsize = false)</strong> |
|---|
| 1953 | </font></p><p><font>Some databases require blob's to be decoded manually after doing a select statement. |
|---|
| 1954 | If the database does not require decoding, then this function will return |
|---|
| 1955 | the blob unchanged. Currently BlobDecode is only required for one database, |
|---|
| 1956 | PostgreSQL, and only if you are using blob oid's (if you are using bytea fields, |
|---|
| 1957 | we auto-decode for you).</font> The default maxblobsize is set in $connection->maxblobsize, which |
|---|
| 1958 | is set to 256K in adodb 4.54. </p><p> |
|---|
| 1959 | In ADOdb 4.54 and later, the blob is the return value. In earlier versions, the blob data is sent to stdout.</p><font> |
|---|
| 1960 | </font><p></p><pre><font>$rs = $db->Execute("select bloboid from postgres_table where id=$key");<br>$blob = $db->BlobDecode( reset($rs->fields) );</font></pre> |
|---|
| 1961 | <p><font><b>Replace<a name="replace"></a>($table, $arrFields, $keyCols,$autoQuote=false)</b></font></p> |
|---|
| 1962 | <p><font>Try to update a record, and if the record is not found, an insert statement |
|---|
| 1963 | is generated and executed. Returns 0 on failure, 1 if update statement worked, |
|---|
| 1964 | 2 if no record was found and the insert was executed successfully. This differs |
|---|
| 1965 | from MySQL's replace which deletes the record and inserts a new record. This |
|---|
| 1966 | also means you cannot update the primary key. The only exception to this is |
|---|
| 1967 | Interbase and its derivitives, which uses delete and insert because of some |
|---|
| 1968 | Interbase API limitations. |
|---|
| 1969 | </font></p><p><font>The parameters are $table which is the table name, the $arrFields which is an |
|---|
| 1970 | associative array where the keys are the field names, and $keyCols is the name |
|---|
| 1971 | of the primary key, or an array of field names if it is a compound key. If |
|---|
| 1972 | $autoQuote is set to true, then Replace() will quote all values that are non-numeric; |
|---|
| 1973 | auto-quoting will not quote nulls. Note that auto-quoting will not work if |
|---|
| 1974 | you use SQL functions or operators. |
|---|
| 1975 | </font></p><p><font>Examples: |
|---|
| 1976 | </font></p><pre><font># single field primary key<br>$ret = $db->Replace('atable', <br> array('id'=>1000,'firstname'=>'Harun','lastname'=>'Al-Rashid'),<br> 'id',$autoquote = true); <br># generates UPDATE atable SET firstname='Harun',lastname='Al-Rashid' WHERE id=1000<br># or INSERT INTO atable (id,firstname,lastname) VALUES (1000,'Harun','Al-Rashid')<br><br># compound key<br>$ret = $db->Replace('atable2', <br> array('firstname'=>'Harun','lastname'=>'Al-Rashid', 'age' => 33, 'birthday' => 'null'),<br> array('lastname','firstname'),<br> $autoquote = true);<br><br># no auto-quoting<br>$ret = $db->Replace('atable2', <br> array('firstname'=>"'Harun'",'lastname'=>"'Al-Rashid'", 'age' => 'null'),<br> array('lastname','firstname')); <br></font></pre> |
|---|
| 1977 | <p><font><b>AutoExecute<a name="autoexecute"></a>($table, $arrFields, $mode, $where=false, $forceUpdate=true,$magicq=false)</b></font></p> |
|---|
| 1978 | <p>Since ADOdb 4.56, you can automatically generate and execute INSERTs and UPDATEs on a given table with this |
|---|
| 1979 | function, which is a wrapper for GetInsertSQL() and GetUpdateSQL(). |
|---|
| 1980 | <p>AutoExecute() inserts or updates $table given an array of $arrFields, where the keys are the field names and the array values are the |
|---|
| 1981 | field values to store. Note that there is some overhead because the table is first queried to extract key information |
|---|
| 1982 | before the SQL is generated. We generate an INSERT or UPDATE based on $mode (see below). |
|---|
| 1983 | <p> |
|---|
| 1984 | Legal values for $mode are |
|---|
| 1985 | <ul> |
|---|
| 1986 | <li>'INSERT' or 1 or DB_AUTOQUERY_INSERT |
|---|
| 1987 | <li>'UPDATE' or 2 or DB_AUTOQUERY_UPDATE |
|---|
| 1988 | </ul> |
|---|
| 1989 | <p>You have to define the constants DB_AUTOQUERY_UPDATE and DB_AUTOQUERY_INSERT yourself or include adodb-pear.inc.php. |
|---|
| 1990 | <p>The $where clause is required if $mode == 'UPDATE'. If $forceUpdate=false then we will query the |
|---|
| 1991 | database first and check if the field value returned by the query matches the current field value; only if they differ do we update that field. |
|---|
| 1992 | <p>Returns true on success, false on error. |
|---|
| 1993 | <p>An example of its use is: |
|---|
| 1994 | <pre> |
|---|
| 1995 | $record["firstName"] = "Carol"; |
|---|
| 1996 | $record["lasTname"] = "Smith"; |
|---|
| 1997 | $conn->AutoExecute($table,$record,'INSERT'); |
|---|
| 1998 | # executes <i>"INSERT INTO $table (firstName,lasTname) values ('Carol',Smith')"</i>; |
|---|
| 1999 | |
|---|
| 2000 | $record["firstName"] = "Carol"; |
|---|
| 2001 | $record["lasTname"] = "Jones"; |
|---|
| 2002 | $conn->AutoExecute($table,$record,'UPDATE', "lastname like 'Sm%'"); |
|---|
| 2003 | # executes <i>"UPDATE $table SET firstName='Carol',lasTname='Jones' WHERE lastname like 'Sm%'"</i>; |
|---|
| 2004 | </pre> |
|---|
| 2005 | <p>Note: One of the strengths of ADOdb's AutoExecute() is that only valid field names for $table are updated. If $arrFields |
|---|
| 2006 | contains keys that are invalid field names for $table, they are ignored. There is some overhead in doing this as we have to |
|---|
| 2007 | query the database to get the field names, but given that you are not directly coding the SQL yourself, you probably aren't interested in |
|---|
| 2008 | speed at all, but convenience. |
|---|
| 2009 | <p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. |
|---|
| 2010 | <p>Since 4.94, setting the global variable $ADODB_QUOTE_FIELDNAMES to true will force field names to be auto-quoted in AutoExecute(), GetInsertSQL() and GetUpdateSQL(). </p> |
|---|
| 2011 | <p><font><b>GetUpdateSQL<a name="getupdatesql"></a>(&$rs, $arrFields, $forceUpdate=false,$magicq=false, $force=null)</b></font></p> |
|---|
| 2012 | <p><font>Generate SQL to update a table given a recordset $rs, and the modified fields |
|---|
| 2013 | of the array $arrFields (which must be an associative array holding the column |
|---|
| 2014 | names and the new values) are compared with the current recordset. If $forceUpdate |
|---|
| 2015 | is true, then we also generate the SQL even if $arrFields is identical to |
|---|
| 2016 | $rs->fields. Requires the recordset to be associative. $magicq is used |
|---|
| 2017 | to indicate whether magic quotes are enabled (see qstr()). The field names in the array |
|---|
| 2018 | are case-insensitive.</font></p> |
|---|
| 2019 | <font> </font><p><font>Since 4.52, we allow you to pass the $force type parameter, and this overrides the <a href="#ADODB_FORCE_TYPE">$ADODB_FORCE_TYPE</a> |
|---|
| 2020 | global variable. |
|---|
| 2021 | <p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. |
|---|
| 2022 | </p></font><p><font><b>GetInsertSQL<a name="getinsertsql"></a>(&$rs, $arrFields,$magicq=false,$force_type=false)</b></font></p> |
|---|
| 2023 | <p><font>Generate SQL to insert into a table given a recordset $rs. Requires the query |
|---|
| 2024 | to be associative. $magicq is used to indicate whether magic quotes are enabled |
|---|
| 2025 | (for qstr()). The field names in the array are case-insensitive.</font></p> |
|---|
| 2026 | <p> |
|---|
| 2027 | <font> Since 2.42, you can pass a table name instead of a recordset into |
|---|
| 2028 | GetInsertSQL (in $rs), and it will generate an insert statement for that table. |
|---|
| 2029 | </font></p><p><font>Since 4.52, we allow you to pass the $force_type parameter, and this overrides the <a href="#ADODB_FORCE_TYPE">$ADODB_FORCE_TYPE</a> |
|---|
| 2030 | global variable. |
|---|
| 2031 | <p>Since 4.62, the table name to be used can be overridden by setting $rs->tableName before AutoExecute(), GetInsertSQL() or GetUpdateSQL() is called. |
|---|
| 2032 | </p></font><p><font><b>PageExecute<a name="pageexecute"></a>($sql, $nrows, $page, $inputarr=false)</b> |
|---|
| 2033 | </font></p><p><font>Used for pagination of recordset. $page is 1-based. See <a href="#ex8">Example |
|---|
| 2034 | 8</a>.</font></p> |
|---|
| 2035 | |
|---|
| 2036 | <p><font><b>CachePageExecute<a name="cachepageexecute"></a>($secs2cache, |
|---|
| 2037 | $sql, $nrows, $page, $inputarr=false)</b> </font></p> |
|---|
| 2038 | <p><font>Used for pagination of recordset. $page is 1-based. See |
|---|
| 2039 | <a href="#ex8">Example 8</a>. Caching version of PageExecute.</font></p> |
|---|
| 2040 | <font> |
|---|
| 2041 | </font><p></p> |
|---|
| 2042 | <p><font><b>Close<a name="close"></a>( )</b></font></p> |
|---|
| 2043 | <p><font>Close the database connection. PHP4 proudly states that we no longer have to |
|---|
| 2044 | clean up at the end of the connection because the reference counting mechanism |
|---|
| 2045 | of PHP4 will automatically clean up for us.</font></p> |
|---|
| 2046 | <font> </font><p><font><b>StartTrans<a name="starttrans"></a>( )</b></font></p> |
|---|
| 2047 | <font> </font><p><font>Start a monitored transaction. As SQL statements are executed, ADOdb will monitor |
|---|
| 2048 | for SQL errors, and if any are detected, when CompleteTrans() is called, we auto-rollback. |
|---|
| 2049 | </font></p><p> |
|---|
| 2050 | <font> </font></p><p><font> To understand why StartTrans() is superior to BeginTrans(), |
|---|
| 2051 | let us examine a few ways of using BeginTrans(). |
|---|
| 2052 | The following is the wrong way to use transactions: |
|---|
| 2053 | </font></p><pre><font>$DB->BeginTrans();<br>$DB->Execute("update table1 set val=$val1 where id=$id");<br>$DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CommitTrans();<br></font></pre> |
|---|
| 2054 | <p><font>because you perform no error checking. It is possible to update table1 and |
|---|
| 2055 | for the update on table2 to fail. Here is a better way: |
|---|
| 2056 | </font></p><pre><font>$DB->BeginTrans();<br>$ok = $DB->Execute("update table1 set val=$val1 where id=$id");<br>if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");<br>if ($ok) $DB->CommitTrans();<br>else $DB->RollbackTrans();<br></font></pre> |
|---|
| 2057 | <p><font>Another way is (since ADOdb 2.0): |
|---|
| 2058 | </font></p><pre><font>$DB->BeginTrans();<br>$ok = $DB->Execute("update table1 set val=$val1 where id=$id");<br>if ($ok) $ok = $DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CommitTrans($ok);<br></font></pre> |
|---|
| 2059 | <p><font> Now it is a headache monitoring $ok all over the place. StartTrans() is an |
|---|
| 2060 | improvement because it monitors all SQL errors for you. This is particularly |
|---|
| 2061 | useful if you are calling black-box functions in which SQL queries might be executed. |
|---|
| 2062 | Also all BeginTrans, CommitTrans and RollbackTrans calls inside a StartTrans block |
|---|
| 2063 | will be disabled, so even if the black box function does a commit, it will be ignored. |
|---|
| 2064 | </font></p><pre><font>$DB->StartTrans();<br>CallBlackBox();<br>$DB->Execute("update table1 set val=$val1 where id=$id");<br>$DB->Execute("update table2 set val=$val2 where id=$id");<br>$DB->CompleteTrans();<br></font></pre> |
|---|
| 2065 | <p><font>Note that a StartTrans blocks are nestable, the inner blocks are ignored. |
|---|
| 2066 | </font></p><p><font><b>CompleteTrans<a name="completetrans"></a>($autoComplete=true)</b></font></p> |
|---|
| 2067 | <font> </font><p><font>Complete a transaction called with StartTrans(). This function monitors |
|---|
| 2068 | for SQL errors, and will commit if no errors have occured, otherwise it will rollback. |
|---|
| 2069 | Returns true on commit, false on rollback. If the parameter $autoComplete is true |
|---|
| 2070 | monitor sql errors and commit and rollback as appropriate. Set $autoComplete to false |
|---|
| 2071 | to force rollback even if no SQL error detected. |
|---|
| 2072 | </font></p><p><font><b>FailTrans<a name="failtrans"></a>( )</b></font></p> |
|---|
| 2073 | <font> </font><p><font>Fail a transaction started with StartTrans(). The rollback will only occur when |
|---|
| 2074 | CompleteTrans() is called. |
|---|
| 2075 | </font></p><p><font><b>HasFailedTrans<a name="hasfailedtrans"></a>( )</b></font></p> |
|---|
| 2076 | <font> </font><p><font>Check whether smart transaction has failed, |
|---|
| 2077 | eg. returns true if there was an error in SQL execution or FailTrans() was called. |
|---|
| 2078 | If not within smart transaction, returns false. |
|---|
| 2079 | </font></p><p><font><b>BeginTrans<a name="begintrans"></a>( )</b></font></p> |
|---|
| 2080 | <p><font>Begin a transaction. Turns off autoCommit. Returns true if successful. Some |
|---|
| 2081 | databases will always return false if transaction support is not available. |
|---|
| 2082 | Any open transactions will be rolled back when the connection is closed. Among the |
|---|
| 2083 | databases that support transactions are Oracle, PostgreSQL, Interbase, MSSQL, certain |
|---|
| 2084 | versions of MySQL, DB2, Informix, Sybase, etc.</font></p> |
|---|
| 2085 | <font> </font><p><font>Note that <a href="#starttrans">StartTrans()</a> and CompleteTrans() is a superior method of |
|---|
| 2086 | handling transactions, available since ADOdb 3.40. For a explanation, see the <a href="#starttrans">StartTrans()</a> documentation. |
|---|
| 2087 | |
|---|
| 2088 | </font></p><p><font>You can also use the ADOdb <a href="#errorhandling">error handler</a> to die |
|---|
| 2089 | and rollback your transactions for you transparently. Some buggy database extensions |
|---|
| 2090 | are known to commit all outstanding tranasactions, so you might want to explicitly |
|---|
| 2091 | do a $DB->RollbackTrans() in your error handler for safety. |
|---|
| 2092 | </font></p><h4><font>Detecting Transactions</font></h4> |
|---|
| 2093 | <font> </font><p><font>Since ADOdb 2.50, you are able to detect when you are inside a transaction. Check |
|---|
| 2094 | that $connection->transCnt > 0. This variable is incremented whenever BeginTrans() is called, |
|---|
| 2095 | and decremented whenever RollbackTrans() or CommitTrans() is called. |
|---|
| 2096 | </font></p><p><font><b>CommitTrans<a name="committrans"></a>($ok=true)</b></font></p> |
|---|
| 2097 | <p><font>End a transaction successfully. Returns true if successful. If the database |
|---|
| 2098 | does not support transactions, will return true also as data is always committed. |
|---|
| 2099 | </font></p> |
|---|
| 2100 | <p><font>If you pass the parameter $ok=false, the data is rolled back. See example in |
|---|
| 2101 | BeginTrans().</font></p> |
|---|
| 2102 | <p><font><b>RollbackTrans<a name="rollbacktrans"></a>( )</b></font></p> |
|---|
| 2103 | <p><font>End a transaction, rollback all changes. Returns true if successful. If the |
|---|
| 2104 | database does not support transactions, will return false as data is never rollbacked. |
|---|
| 2105 | </font></p> |
|---|
| 2106 | |
|---|
| 2107 | <p><font><b>SetTransactionMode<a name="SetTransactionMode"></a>($mode )</b></font></p> |
|---|
| 2108 | <p>SetTransactionMode allows you to pass in the transaction mode to use for all subsequent transactions. |
|---|
| 2109 | Note: if you have persistent connections and using mssql or mysql, you might have to explicitly reset your transaction mode at the beginning of each page request. |
|---|
| 2110 | This is only supported in postgresql, mssql, mysql with InnoDB and oci8 currently. For example: |
|---|
| 2111 | <pre> |
|---|
| 2112 | $db->SetTransactionMode("SERIALIZABLE"); |
|---|
| 2113 | $db->BeginTrans(); |
|---|
| 2114 | $db->Execute(...); $db->Execute(...); |
|---|
| 2115 | $db->CommiTrans(); |
|---|
| 2116 | |
|---|
| 2117 | $db->SetTransactionMode(""); // restore to default |
|---|
| 2118 | $db->StartTrans(); |
|---|
| 2119 | $db->Execute(...); $db->Execute(...); |
|---|
| 2120 | $db->CompleteTrans(); |
|---|
| 2121 | </pre> |
|---|
| 2122 | |
|---|
| 2123 | <p>Supported values to pass in: |
|---|
| 2124 | <ul> |
|---|
| 2125 | <li>READ UNCOMMITTED (allows dirty reads, but fastest) |
|---|
| 2126 | <li>READ COMMITTED (default postgres, mssql and oci8) |
|---|
| 2127 | <li>REPEATABLE READ (default mysql) |
|---|
| 2128 | <li>SERIALIZABLE (slowest and most restrictive) |
|---|
| 2129 | </ul> |
|---|
| 2130 | <p>You can also pass in database specific values such as 'SNAPSHOT' for mssql or 'READ ONLY' for oci8/postgres. |
|---|
| 2131 | <p>See transaction levels for <a href=http://www.postgresql.org/docs/8.1/interactive/sql-set-transaction.html>PostgreSQL</a>, |
|---|
| 2132 | <a href=http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_10005.htm>Oracle</a>, |
|---|
| 2133 | <a href=http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html>MySQL</a>, and |
|---|
| 2134 | <a href=http://msdn2.microsoft.com/en-US/ms173763.aspx>MS SQL Server</a>. |
|---|
| 2135 | <p><font><b>GetAssoc<a name="getassoc1"></a>($sql,$inputarr=false,$force_array=false,$first2cols=false)</b></font></p> |
|---|
| 2136 | <p><font>Returns an associative array for the given query $sql with optional bind parameters |
|---|
| 2137 | in $inputarr. If the number of columns returned is greater to two, a 2-dimensional |
|---|
| 2138 | array is returned, with the first column of the recordset becomes the keys |
|---|
| 2139 | to the rest of the rows. If the columns is equal to two, a 1-dimensional array |
|---|
| 2140 | is created, where the the keys directly map to the values (unless $force_array |
|---|
| 2141 | is set to true, when an array is created for each value). |
|---|
| 2142 | </font></p><p><font> Examples:<a name="getassocex"></a></font></p> |
|---|
| 2143 | |
|---|
| 2144 | <p><font>We have the following data in a recordset:</font></p> |
|---|
| 2145 | <p><font>row1: Apple, Fruit, Edible<br> |
|---|
| 2146 | row2: Cactus, Plant, Inedible<br> |
|---|
| 2147 | row3: Rose, Flower, Edible</font></p> |
|---|
| 2148 | <p><font>GetAssoc will generate the following 2-dimensional associative |
|---|
| 2149 | array:</font></p> |
|---|
| 2150 | <p><font>Apple => array[Fruit, Edible]<br> |
|---|
| 2151 | Cactus => array[Plant, Inedible]<br> |
|---|
| 2152 | Rose => array[Flower,Edible]</font></p> |
|---|
| 2153 | <p><font>If the dataset is:</font></p> |
|---|
| 2154 | <p><font>row1: Apple, Fruit<br> |
|---|
| 2155 | row2: Cactus, Plant<br> |
|---|
| 2156 | row3: Rose, Flower </font></p> |
|---|
| 2157 | <p><font>GetAssoc will generate the following 1-dimensional associative |
|---|
| 2158 | array (with $force_array==false):</font></p> |
|---|
| 2159 | <p><font>Apple => Fruit</font><br> |
|---|
| 2160 | Cactus=>Plant<br> |
|---|
| 2161 | Rose=>Flower </p> |
|---|
| 2162 | <p><font>The function returns:</font></p> |
|---|
| 2163 | <p><font>The associative array, or false if an error occurs.</font></p> |
|---|
| 2164 | <font> |
|---|
| 2165 | <p><b>CacheGetAssoc<a name="cachegetassoc"></a>([$secs2cache,] $sql,$inputarr=false,$force_array=false,$first2cols=false)</b></p> |
|---|
| 2166 | </font> |
|---|
| 2167 | <p><font>Caching version of <a href="#getassoc1">GetAssoc</a> function above. |
|---|
| 2168 | </font></p><p><font><b>GetOne<a name="getone"></a>($sql,$inputarr=false)</b></font></p> |
|---|
| 2169 | <p><font>Executes the SQL and returns the first field of the first row. The recordset |
|---|
| 2170 | and remaining rows are discarded for you automatically. If an error occur, false |
|---|
| 2171 | is returned; use ErrorNo() or ErrorMsg() to get the error details. |
|---|
| 2172 | Since 4.96/5.00, we return null if no records were found. And since 4.991/5.06, you can have change the return value if no records are found using the global variable $ADODB_GETONE_EOF: $ADODB_GETONE_EOF = false; </font></p> |
|---|
| 2173 | <p><font><b>GetRow<a name="getrow"></a>($sql,$inputarr=false)</b></font></p> |
|---|
| 2174 | <p><font>Executes the SQL and returns the first row as an array. The recordset and remaining |
|---|
| 2175 | rows are discarded for you automatically. If no records are returned, an empty array is returned. If an error occurs, false is returned.</font></p> |
|---|
| 2176 | <p><font><b>GetAll<a name="getall"></a>($sql,$inputarr=false)</b></font></p> |
|---|
| 2177 | |
|---|
| 2178 | <p>Executes the SQL and returns the all the rows as a 2-dimensional |
|---|
| 2179 | array. The recordset is discarded for you automatically. If an error occurs, |
|---|
| 2180 | false is returned. <i>GetArray</i> is a synonym for <i>GetAll</i>.</p> |
|---|
| 2181 | <p><b>GetCol<a name="getcol"></a>($sql,$inputarr=false,$trim=false)</b></p> |
|---|
| 2182 | |
|---|
| 2183 | <p><font>Executes the SQL and returns all elements of the first column as a |
|---|
| 2184 | 1-dimensional array. The recordset is discarded for you automatically. If an error occurs, |
|---|
| 2185 | false is returned.</font></p> |
|---|
| 2186 | <p><font><b>CacheGetOne<a name="cachegetone"></a>([$secs2cache,] |
|---|
| 2187 | $sql,$inputarr=false), CacheGetRow<a name="cachegetrow"></a>([$secs2cache,] $sql,$inputarr=false), CacheGetAll<a name="cachegetall"></a>([$secs2cache,] |
|---|
| 2188 | $sql,$inputarr=false), CacheGetCol<a name="cachegetcol"></a>([$secs2cache,] |
|---|
| 2189 | $sql,$inputarr=false,$trim=false)</b></font></p> |
|---|
| 2190 | <font> |
|---|
| 2191 | </font><p><font>Similar to above Get* functions, except that the recordset is serialized and |
|---|
| 2192 | cached in the $ADODB_CACHE_DIR directory for $secs2cache seconds. Good for speeding |
|---|
| 2193 | up queries on rarely changing data. Note that the $secs2cache parameter is optional. |
|---|
| 2194 | If omitted, we use the value in $connection->cacheSecs (default is 3600 seconds, |
|---|
| 2195 | or 1 hour).</font> |
|---|
| 2196 | </p> |
|---|
| 2197 | <p><font><b>Prepare<a name="prepare"></a>($sql )</b></font></p> |
|---|
| 2198 | |
|---|
| 2199 | <p><font>Prepares (compiles) an SQL query for repeated execution. Bind parameters |
|---|
| 2200 | are denoted by ?, except for the oci8 driver, which uses the traditional Oracle :varname |
|---|
| 2201 | convention. |
|---|
| 2202 | </font></p> |
|---|
| 2203 | <p><font>Returns an array containing the original sql statement |
|---|
| 2204 | in the first array element; the remaining elements of the array are driver dependent. |
|---|
| 2205 | If there is an error, or we are emulating Prepare( ), we return the original |
|---|
| 2206 | $sql string. This is because all error-handling has been centralized in Execute( |
|---|
| 2207 | ).</font></p> |
|---|
| 2208 | <p><font>Prepare( ) cannot be used with functions that use SQL |
|---|
| 2209 | query rewriting techniques, e.g. PageExecute( ) and SelectLimit( ).</font></p> |
|---|
| 2210 | <p>Example:</p> |
|---|
| 2211 | <pre><font>$stmt = $DB->Prepare('insert into table (col1,col2) values (?,?)');<br>for ($i=0; $i < $max; $i++)<br></font> $DB-><font>Execute($stmt,array((string) rand(), $i));<br></font></pre> |
|---|
| 2212 | <font> |
|---|
| 2213 | </font><p><font>Also see InParameter(), OutParameter() and PrepareSP() below. Only supported internally by interbase, |
|---|
| 2214 | oci8 and selected ODBC-based drivers, otherwise it is emulated. There is no |
|---|
| 2215 | performance advantage to using Prepare() with emulation. |
|---|
| 2216 | </font></p><p><font> Important: Due to limitations or bugs in PHP, if you are getting errors when |
|---|
| 2217 | you using prepared queries, try setting $ADODB_COUNTRECS = false before preparing. |
|---|
| 2218 | This behaviour has been observed with ODBC. |
|---|
| 2219 | </font></p><p><font><b>IfNull<a name="ifnull"></a>($field, $nullReplacementValue)</b></font></p> |
|---|
| 2220 | <p><font>Portable IFNULL function (NVL in Oracle). Returns a string that represents |
|---|
| 2221 | the function that checks whether a $field is null for the given database, and |
|---|
| 2222 | if null, change the value returned to $nullReplacementValue. Eg.</font></p> |
|---|
| 2223 | <pre><font>$sql = <font color="#993300">'SELECT '</font>.$db->IfNull('name', <font color="#993300">"'- unknown -'"</font>).<font color="#993300"> ' FROM table'</font>;</font></pre> |
|---|
| 2224 | |
|---|
| 2225 | <p><font><b>length<a name="length"></a></b></font></p> |
|---|
| 2226 | <p><font>This is not a function, but a property. Some databases have "length" and others "len" |
|---|
| 2227 | as the function to measure the length of a string. To use this property: |
|---|
| 2228 | </font></p><pre><font> $sql = <font color="#993300">"SELECT "</font>.$db->length.<font color="#993300">"(field) from table"</font>;<br> $rs = $db->Execute($sql);<br></font></pre> |
|---|
| 2229 | |
|---|
| 2230 | <p><font><b>random<a name="random"></a></b></font></p> |
|---|
| 2231 | <p><font>This is not a function, but a property. This is a string that holds the sql to |
|---|
| 2232 | generate a random number between 0.0 and 1.0 inclusive. |
|---|
| 2233 | |
|---|
| 2234 | </font></p><p><font><b>substr<a name="substr"></a></b></font></p> |
|---|
| 2235 | <p><font>This is not a function, but a property. Some databases have "substr" and others "substring" |
|---|
| 2236 | as the function to retrieve a sub-string. To use this property: |
|---|
| 2237 | </font></p><pre><font> $sql = <font color="#993300">"SELECT "</font>.$db->substr.<font color="#993300">"(field, $offset, $length) from table"</font>;<br> $rs = $db->Execute($sql);<br></font></pre> |
|---|
| 2238 | <p><font>For all databases, the 1st parameter of <i>substr</i> is the field, the 2nd is the |
|---|
| 2239 | offset (1-based) to the beginning of the sub-string, and the 3rd is the length of the sub-string. |
|---|
| 2240 | |
|---|
| 2241 | |
|---|
| 2242 | </font></p><p><font><b>Param<a name="param"></a>($name)</b></font></p> |
|---|
| 2243 | <p><font>Generates a bind placeholder portably. For most databases, the bind placeholder |
|---|
| 2244 | is "?". However some databases use named bind parameters such as Oracle, eg |
|---|
| 2245 | ":somevar". This allows us to portably define an SQL statement with bind parameters: |
|---|
| 2246 | </font></p><pre><font>$sql = <font color="#993300">'insert into table (col1,col2) values ('</font>.$DB->Param('a').<font color="#993300">','</font>.$DB->Param('b').<font color="#993300">')'</font>;<br><font color="#006600"># generates 'insert into table (col1,col2) values (?,?)'<br># or 'insert into table (col1,col2) values (:a,:b)</font>'<br>$stmt = $DB->Prepare($sql);<br>$stmt = $DB->Execute($stmt,array('one','two'));<br></font></pre> |
|---|
| 2247 | <font> </font> |
|---|
| 2248 | <p></p> |
|---|
| 2249 | <p><font><b>PrepareSP</b><b><a name="preparesp"></a></b><b>($sql, |
|---|
| 2250 | $cursor=false )</b></font></p> |
|---|
| 2251 | <p><font>When calling stored procedures in mssql and oci8 (oracle), |
|---|
| 2252 | and you might want to directly bind to parameters that return values, or |
|---|
| 2253 | for special LOB handling. PrepareSP() allows you to do so. </font></p> |
|---|
| 2254 | <p><font>Returns the same array or $sql string as Prepare( ) |
|---|
| 2255 | above. If you do not need to bind to return values, you should use Prepare( |
|---|
| 2256 | ) instead.</font></p> |
|---|
| 2257 | <p><font>The 2nd parameter, $cursor is not used except with oci8. |
|---|
| 2258 | Setting it to true will force OCINewCursor to be called; this is to support |
|---|
| 2259 | output REF CURSORs. </font></p> |
|---|
| 2260 | <p><font>For examples of usage of PrepareSP( ), see InParameter( |
|---|
| 2261 | ) below. </font></p> |
|---|
| 2262 | <p><font>Note: in the mssql driver, preparing stored procedures |
|---|
| 2263 | requires a special function call, mssql_init( ), which is called by this |
|---|
| 2264 | function. PrepareSP( ) is available in all other drivers, and is emulated |
|---|
| 2265 | by calling Prepare( ). </font></p> |
|---|
| 2266 | <p><font><b> InParameter<a name="inparameter"></a>($stmt, $var, |
|---|
| 2267 | $name, $maxLen = 4000, $type = false )</b></font></p> |
|---|
| 2268 | <font>Binds a PHP variable as input to a stored procedure variable. |
|---|
| 2269 | The parameter <i>$stmt</i> is the value returned by PrepareSP(), <i>$var</i> is |
|---|
| 2270 | the PHP variable you want to bind, $name is the name of the stored procedure |
|---|
| 2271 | variable. Optional is <i>$maxLen</i>, the maximum length of the data to bind, |
|---|
| 2272 | and $type which is database dependant. Consult <a href="http://php.net/mssql_bind">mssql_bind</a> and <a href="http://php.net/ocibindbyname">ocibindbyname</a> docs |
|---|
| 2273 | at php.net for more info on legal values for $type. </font> |
|---|
| 2274 | <p> |
|---|
| 2275 | <font>InParameter() is a wrapper function that calls Parameter() |
|---|
| 2276 | with $isOutput=false. The advantage of this function is that it is self-documenting, |
|---|
| 2277 | because the $isOutput parameter is no longer needed. Only for mssql and oci8 |
|---|
| 2278 | currently. </font></p> |
|---|
| 2279 | <p><font>Here is an example using oci8: </font></p> |
|---|
| 2280 | <pre><font><font color="green"># For oracle, Prepare and PrepareSP are identical</font> |
|---|
| 2281 | $stmt = $db->PrepareSP( |
|---|
| 2282 | <font color="#993300">"declare RETVAL integer; <br> begin<br> :RETVAL := </font><font color="#993300">SP_RUNSOMETHING</font><font color="#993300">(:myid,:group);<br> end;"</font>);<br>$db->InParameter($stmt,$id,'myid');<br>$db->InParameter($stmt,$group,'group',64);<br>$db->OutParameter($stmt,$ret,'RETVAL');<br>$db->Execute($stmt);<br></font></pre> |
|---|
| 2283 | <p><font> The same example using mssql:</font></p> |
|---|
| 2284 | <font> |
|---|
| 2285 | </font><pre><font><font color="green"># @RETVAL = SP_RUNSOMETHING @myid,@group</font> |
|---|
| 2286 | $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> |
|---|
| 2287 | $db->InParameter($stmt,$id,'myid'); |
|---|
| 2288 | $db->InParameter($stmt,$group,'group',64); |
|---|
| 2289 | <font color="green"># return value in mssql - RETVAL is hard-coded name</font> <br>$db->OutParameter($stmt,$ret,'RETVAL');<br>$db->Execute($stmt); </font></pre> |
|---|
| 2290 | |
|---|
| 2291 | <p><font>Note that the only difference between the oci8 and mssql implementations is $sql.</font></p> |
|---|
| 2292 | <p> |
|---|
| 2293 | <font> If $type parameter is set to false, in mssql, $type will be dynamicly determined |
|---|
| 2294 | based on the type of the PHP variable passed <font face="Courier New, Courier, mono">(string |
|---|
| 2295 | => SQLCHAR, boolean =>SQLINT1, integer =>SQLINT4 or float/double=>SQLFLT8)</font>. |
|---|
| 2296 | </font></p><p><font> |
|---|
| 2297 | In oci8, $type can be set to OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File), |
|---|
| 2298 | OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID). To |
|---|
| 2299 | pass in a null, use<font face="Courier New, Courier, mono"> $db->Parameter($stmt, |
|---|
| 2300 | $null=null, 'param')</font>. |
|---|
| 2301 | </font></p><p><font><b> OutParameter<a name="outparameter"></a>($stmt, $var, $name, |
|---|
| 2302 | $maxLen = 4000, $type = false )</b></font></p> |
|---|
| 2303 | <font> Binds a PHP variable as output from a stored procedure variable. The parameter <i>$stmt</i> |
|---|
| 2304 | is the value returned by PrepareSP(), <i>$var</i> is the PHP variable you want to bind, <i>$name</i> |
|---|
| 2305 | is the name of the stored procedure variable. Optional is <i>$maxLen</i>, the maximum length of the |
|---|
| 2306 | data to bind, and <i>$type</i> which is database dependant. |
|---|
| 2307 | </font><p> |
|---|
| 2308 | <font> OutParameter() is a wrapper function that calls Parameter() with $isOutput=true. |
|---|
| 2309 | The advantage of this function is that it is self-documenting, because |
|---|
| 2310 | the $isOutput parameter is no longer needed. Only for mssql |
|---|
| 2311 | and oci8 currently. |
|---|
| 2312 | </font></p><p> |
|---|
| 2313 | <font>For an example, see <a href="#inparameter">InParameter</a>. |
|---|
| 2314 | |
|---|
| 2315 | </font></p><p><font><b> Parameter<a name="parameter"></a>($stmt, $var, $name, $isOutput=false, |
|---|
| 2316 | $maxLen = 4000, $type = false )</b></font></p> |
|---|
| 2317 | <p><font>Note: This function is deprecated, because of the new InParameter() and OutParameter() functions. |
|---|
| 2318 | These are superior because they are self-documenting, unlike Parameter(). |
|---|
| 2319 | </font></p><p><font>Adds a bind parameter suitable for return values or special data handling (eg. |
|---|
| 2320 | LOBs) after a statement has been prepared using PrepareSP(). Only for mssql |
|---|
| 2321 | and oci8 currently. The parameters are:<br> |
|---|
| 2322 | <br> |
|---|
| 2323 | $<i><b>stmt</b></i> Statement returned by Prepare() or PrepareSP().<br> |
|---|
| 2324 | $<i><b>var</b></i> PHP variable to bind to. Make sure you pre-initialize it!<br> |
|---|
| 2325 | $<i><b>name</b></i> Name of stored procedure variable name to bind to.<br> |
|---|
| 2326 | [$<i><b>isOutput</b></i>] Indicates direction of parameter 0/false=IN 1=OUT |
|---|
| 2327 | 2= IN/OUT. This is ignored in oci8 as this driver auto-detects the direction.<br> |
|---|
| 2328 | [$<b>maxLen</b>] Maximum length of the parameter variable.<br> |
|---|
| 2329 | [$<b>type</b>] Consult <a href="http://php.net/mssql_bind">mssql_bind</a> and |
|---|
| 2330 | <a href="http://php.net/ocibindbyname">ocibindbyname</a> docs at php.net for |
|---|
| 2331 | more info on legal values for type.</font></p> |
|---|
| 2332 | <p><font>Lastly, in oci8, bind parameters can be reused without calling PrepareSP( ) |
|---|
| 2333 | or Parameters again. This is not possible with mssql. An oci8 example:</font></p> |
|---|
| 2334 | <pre><font>$id = 0; $i = 0;<br>$stmt = $db->PrepareSP( <font color="#993300">"update table set val=:i where id=:id"</font>);<br>$db->Parameter($stmt,$id,'id');<br>$db->Parameter($stmt,$i, 'i');<br>for ($cnt=0; $cnt < 1000; $cnt++) {<br> $id = $cnt; <br> $i = $cnt * $cnt; <font color="green"># works with oci8!</font> |
|---|
| 2335 | $db->Execute($stmt); <br>}</font></pre> |
|---|
| 2336 | <p><font><b>Bind<a name="bind"></a>($stmt, $var, $size=4001, $type=false, $name=false)</b></font></p> |
|---|
| 2337 | |
|---|
| 2338 | <p><font>This is a low-level function supported only by the oci8 |
|---|
| 2339 | driver. <b>Avoid using</b> unless you only want to support Oracle. The Parameter( |
|---|
| 2340 | ) function is the recommended way to go with bind variables.</font></p> |
|---|
| 2341 | <p><font>Bind( ) allows you to use bind variables in your sql |
|---|
| 2342 | statement. This binds a PHP variable to a name defined in an Oracle sql statement |
|---|
| 2343 | that was previously prepared using Prepare(). Oracle named variables begin with |
|---|
| 2344 | a colon, and ADOdb requires the named variables be called :0, :1, :2, :3, etc. |
|---|
| 2345 | The first invocation of Bind() will match :0, the second invocation will match |
|---|
| 2346 | :1, etc. Binding can provide 100% speedups for insert, select and update statements. |
|---|
| 2347 | </font></p> |
|---|
| 2348 | <p>The other variables, $size sets the buffer size for data storage, $type is |
|---|
| 2349 | the optional descriptor type OCI_B_FILE (Binary-File), OCI_B_CFILE (Character-File), |
|---|
| 2350 | OCI_B_CLOB (Character-LOB), OCI_B_BLOB (Binary-LOB) and OCI_B_ROWID (ROWID). |
|---|
| 2351 | Lastly, instead of using the default :0, :1, etc names, you can define your |
|---|
| 2352 | own bind-name using $name. |
|---|
| 2353 | </p><p><font>The following example shows 3 bind variables being used: |
|---|
| 2354 | p1, p2 and p3. These variables are bound to :0, :1 and :2.</font></p> |
|---|
| 2355 | <pre>$stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:0, :1, :2)");<br>$DB->Bind($stmt, $p1);<br>$DB->Bind($stmt, $p2);<br>$DB->Bind($stmt, $p3);<br>for ($i = 0; $i < $max; $i++) { <br> $p1 = ?; $p2 = ?; $p3 = ?;<br> $DB->Execute($stmt);<br>}</pre> |
|---|
| 2356 | <p>You can also use named variables:</p> |
|---|
| 2357 | <pre>$stmt = $DB->Prepare("insert into table (col0, col1, col2) values (:name0, :name1, :name2)");<br>$DB->Bind($stmt, $p1, "name0");<br>$DB->Bind($stmt, $p2, "name1");<br>$DB->Bind($stmt, $p3, "name2");<br>for ($i = 0; $i < $max; $i++) { <br> $p1 = ?; $p2 = ?; $p3 = ?;<br> $DB->Execute($stmt);<br>}</pre> |
|---|
| 2358 | <p><b>LogSQL($enable=true)<a name="logsql"></a></b></p> |
|---|
| 2359 | Call this method to install a SQL logging and timing function (using fnExecute). |
|---|
| 2360 | Then all SQL statements are logged into an adodb_logsql table in a database. If |
|---|
| 2361 | the adodb_logsql table does not exist, ADOdb will create the table if you have |
|---|
| 2362 | the appropriate permissions. Returns the previous logging value (true for enabled, |
|---|
| 2363 | false for disabled). Here are samples of the DDL for selected databases: |
|---|
| 2364 | <p> |
|---|
| 2365 | </p><pre> <b>mysql:</b> |
|---|
| 2366 | CREATE TABLE adodb_logsql ( |
|---|
| 2367 | created datetime NOT NULL, |
|---|
| 2368 | sql0 varchar(250) NOT NULL, |
|---|
| 2369 | sql1 text NOT NULL, |
|---|
| 2370 | params text NOT NULL, |
|---|
| 2371 | tracer text NOT NULL, |
|---|
| 2372 | timer decimal(16,6) NOT NULL |
|---|
| 2373 | ) |
|---|
| 2374 | |
|---|
| 2375 | <b>postgres:</b> |
|---|
| 2376 | CREATE TABLE adodb_logsql ( |
|---|
| 2377 | created timestamp NOT NULL, |
|---|
| 2378 | sql0 varchar(250) NOT NULL, |
|---|
| 2379 | sql1 text NOT NULL, |
|---|
| 2380 | params text NOT NULL, |
|---|
| 2381 | tracer text NOT NULL, |
|---|
| 2382 | timer decimal(16,6) NOT NULL |
|---|
| 2383 | ) |
|---|
| 2384 | |
|---|
| 2385 | <b>mssql:</b> |
|---|
| 2386 | CREATE TABLE adodb_logsql ( |
|---|
| 2387 | created datetime NOT NULL, |
|---|
| 2388 | sql0 varchar(250) NOT NULL, |
|---|
| 2389 | sql1 varchar(4000) NOT NULL, |
|---|
| 2390 | params varchar(3000) NOT NULL, |
|---|
| 2391 | tracer varchar(500) NOT NULL, |
|---|
| 2392 | timer decimal(16,6) NOT NULL |
|---|
| 2393 | ) |
|---|
| 2394 | |
|---|
| 2395 | <b>oci8:</b> |
|---|
| 2396 | CREATE TABLE adodb_logsql ( |
|---|
| 2397 | created date NOT NULL, |
|---|
| 2398 | sql0 varchar(250) NOT NULL, |
|---|
| 2399 | sql1 varchar(4000) NOT NULL, |
|---|
| 2400 | params varchar(4000), |
|---|
| 2401 | tracer varchar(4000), |
|---|
| 2402 | timer decimal(16,6) NOT NULL |
|---|
| 2403 | ) |
|---|
| 2404 | </pre> |
|---|
| 2405 | Usage: |
|---|
| 2406 | <pre> $conn->LogSQL(); // turn on logging<br> :<br> $conn->Execute(...);<br> :<br> $conn->LogSQL(false); // turn off logging<br> <br> # output summary of SQL logging results<br> $perf = NewPerfMonitor($conn);<br> echo $perf->SuspiciousSQL();<br> echo $perf->ExpensiveSQL();<br></pre> |
|---|
| 2407 | <p>One limitation of logging is that rollback also prevents SQL from being logged. |
|---|
| 2408 | </p><p> |
|---|
| 2409 | If you prefer to use another name for the table used to store the SQL, you can override it by calling |
|---|
| 2410 | adodb_perf::table($tablename), where $tablename is the new table name (you will still need to manually |
|---|
| 2411 | create the table yourself). An example: |
|---|
| 2412 | </p><pre> include('adodb.inc.php');<br> include('adodb-perf.inc.php');<br> adodb_perf::table('my_logsql_table');<br></pre> |
|---|
| 2413 | Also see <a href="docs-perf.htm">Performance Monitor</a>. |
|---|
| 2414 | <p><font><b>fnExecute and fnCacheExecute properties<a name="fnexecute" id="fnexecute"></a></b></font></p> |
|---|
| 2415 | <p>These two properties allow you to define bottleneck functions for all sql statements |
|---|
| 2416 | processed by ADOdb. This allows you to perform statistical analysis and query-rewriting |
|---|
| 2417 | of your sql. |
|---|
| 2418 | </p><p><b>Examples of fnExecute</b></p> |
|---|
| 2419 | <p>Here is an example of using fnExecute, to count all cached queries and non-cached |
|---|
| 2420 | queries, you can do this:</p> |
|---|
| 2421 | <pre><font color="#006600"># $db is the connection object</font> |
|---|
| 2422 | function &CountExecs($db, $sql, $inputarray) |
|---|
| 2423 | { |
|---|
| 2424 | global $EXECS; |
|---|
| 2425 | |
|---|
| 2426 | if (!is_array(inputarray)) $EXECS++; |
|---|
| 2427 | <font color="#006600"># handle 2-dimensional input arrays</font> |
|---|
| 2428 | else if (is_array(reset($inputarray))) $EXECS += sizeof($inputarray); |
|---|
| 2429 | else $EXECS++; |
|---|
| 2430 | |
|---|
| 2431 | <font color="#006600"># in PHP4.4 and PHP5, we need to return a value by reference</font> |
|---|
| 2432 | $null = null; |
|---|
| 2433 | return $null; |
|---|
| 2434 | } |
|---|
| 2435 | |
|---|
| 2436 | <font color="#006600"># $db is the connection object</font> |
|---|
| 2437 | function CountCachedExecs($db, $secs2cache, $sql, $inputarray) |
|---|
| 2438 | {<br>global $CACHED; $CACHED++;<br>}<br><br>$db = NewADOConnection('mysql');<br>$db->Connect(...);<br>$db-><strong>fnExecute</strong> = 'CountExecs';<br>$db-><strong>fnCacheExecute</strong> = 'CountCachedExecs';<br> :<br> :<br><font color="#006600"># After many sql statements:</font>`<br>printf("<p>Total queries=%d; total cached=%d</p>",$EXECS+$CACHED, $CACHED);<br></pre> |
|---|
| 2439 | <p>The fnExecute function is called before the sql is parsed and executed, so |
|---|
| 2440 | you can perform a query rewrite. If you are passing in a prepared statement, |
|---|
| 2441 | then $sql is an array (see <a href="#prepare">Prepare</a>). The fnCacheExecute |
|---|
| 2442 | function is only called if the recordset returned was cached.<font> |
|---|
| 2443 | The function parameters match the Execute and CacheExecute functions respectively, |
|---|
| 2444 | except that $this (the connection object) is passed as the first parameter.</font></p> |
|---|
| 2445 | <p>Since ADOdb 3.91, the behaviour of fnExecute varies depending on whether the |
|---|
| 2446 | defined function returns a value. If it does not return a value, then the $sql |
|---|
| 2447 | is executed as before. This is useful for query rewriting or counting sql queries. |
|---|
| 2448 | </p><p> On the other hand, you might want to replace the Execute function with one |
|---|
| 2449 | of your own design. If this is the case, then have your function return a value. |
|---|
| 2450 | If a value is returned, that value is returned immediately, without any further |
|---|
| 2451 | processing. This is used internally by ADOdb to implement LogSQL() functionality. |
|---|
| 2452 | </p> |
|---|
| 2453 | <p> |
|---|
| 2454 | </p><hr /> |
|---|
| 2455 | <h3><font>ADOConnection Utility Functions</font></h3> |
|---|
| 2456 | <p><font><b>BlankRecordSet<a name="blankrecordset"></a>([$queryid])</b></font></p> |
|---|
| 2457 | <p><font>No longer available - removed since 1.99.</font></p> |
|---|
| 2458 | <p><font><b>Concat<a name="concat"></a>($s1,$s2,....)</b></font></p> |
|---|
| 2459 | <p><font>Generates the sql string used to concatenate $s1, $s2, etc together. Uses the |
|---|
| 2460 | string in the concat_operator field to generate the concatenation. Override |
|---|
| 2461 | this function if a concatenation operator is not used, eg. MySQL.</font></p> |
|---|
| 2462 | <p><font>Returns the concatenated string.</font></p> |
|---|
| 2463 | <p><font><b>DBDate<a name="dbdate"></a>($date)</b></font></p> |
|---|
| 2464 | <p><font>Format the $<b>date</b> in the format the database accepts - the return string is also quoted. This is used |
|---|
| 2465 | when you are sending dates to the database (eg INSERT, UPDATE or where clause of SELECT statement). |
|---|
| 2466 | The $<b>date</b> parameter can be a Unix integer timestamp or an ISO format |
|---|
| 2467 | Y-m-d. Uses the fmtDate field, which holds the format to use. If null or false |
|---|
| 2468 | or '' is passed in, it will be converted to an SQL null.</font></p> |
|---|
| 2469 | <p><font>Returns the date as a quoted string.</font></p> |
|---|
| 2470 | <pre> |
|---|
| 2471 | $sql = "select * from atable where created > ".$db->DBDate("$year-$month-$day"); |
|---|
| 2472 | $db->Execute($sql); |
|---|
| 2473 | </pre> |
|---|
| 2474 | <p>Note to retrieve a date column in a specific format, use <a href="#sqldate">SQLDate</a>. </p> |
|---|
| 2475 | <p><font><b>BindDate<a name="binddate"></a>($date)</b></font></p> |
|---|
| 2476 | <p><font>Format the $<b>date</b> in the bind format the database accepts. Normally |
|---|
| 2477 | this means that the date string is not quoted, unlike DBDate, which quotes the string. |
|---|
| 2478 | <pre> |
|---|
| 2479 | $sql = "select * from atable where created > ".$db->Param('0'); |
|---|
| 2480 | // or |
|---|
| 2481 | $sql = "select * from atable where created > ?"; |
|---|
| 2482 | $db->Execute($sql,array($db->BindDate("$year-$month-$day")); |
|---|
| 2483 | </pre> |
|---|
| 2484 | <p><font><b>DBTimeStamp<a name="dbtimestamp"></a>($ts)</b></font></p> |
|---|
| 2485 | <p><font>Format the timestamp $<b>ts</b> in the format the database accepts; this can |
|---|
| 2486 | be a Unix integer timestamp or an ISO format Y-m-d H:i:s. Uses the fmtTimeStamp |
|---|
| 2487 | field, which holds the format to use. If null or false or '' is passed in, it |
|---|
| 2488 | will be converted to an SQL null.</font></p> |
|---|
| 2489 | <p><font>Returns the timestamp as a quoted string.</font></p> |
|---|
| 2490 | <pre> |
|---|
| 2491 | $sql = "select * from atable where created > ".$db->DBTimeStamp("$year-$month-$day $hr:$min:$secs"); |
|---|
| 2492 | $db->Execute($sql); |
|---|
| 2493 | </pre> |
|---|
| 2494 | <p><font><b>BindTimeStamp<a name="bindtimestamp"></a>($ts)</b></font></p> |
|---|
| 2495 | <p><font>Format the timestamp $<b>ts</b> in the bind format the database accepts. Normally |
|---|
| 2496 | this means that the timestamp string is not quoted, unlike DBTimeStamp, which quotes the string. |
|---|
| 2497 | <pre> |
|---|
| 2498 | $sql = "select * from atable where created > ".$db->Param('0'); |
|---|
| 2499 | // or |
|---|
| 2500 | $sql = "select * from atable where created > ?"; |
|---|
| 2501 | $db->Execute($sql,array($db->BindTimeStamp("$year-$month-$day $hr:$min:$secs")); |
|---|
| 2502 | </pre> |
|---|
| 2503 | <p><font><b>qstr<a name="qstr"></a>($s,[$magic_quotes_enabled</b>=false]<b>)</b></font></p> |
|---|
| 2504 | <p><font>Quotes a string to be sent to the database. The $<b>magic_quotes_enabled</b> |
|---|
| 2505 | parameter may look funny, but the idea is if you are quoting a string extracted |
|---|
| 2506 | from a POST/GET variable, then pass get_magic_quotes_gpc() as the second parameter. |
|---|
| 2507 | This will ensure that the variable is not quoted twice, once by <i>qstr</i> |
|---|
| 2508 | and once by the <i>magic_quotes_gpc</i>.</font></p> |
|---|
| 2509 | <p><font>Eg.<font face="Courier New, Courier, mono"> $s = $db->qstr(HTTP_GET_VARS['name'],get_magic_quotes_gpc());</font></font></p> |
|---|
| 2510 | <p><font>Returns the quoted string.</font></p> |
|---|
| 2511 | <p><font><b>Quote<a name="quote"></a>($s)</b></font></p> |
|---|
| 2512 | <p><font>Quotes the string $s, escaping the database specific quote character as appropriate. |
|---|
| 2513 | Formerly checked magic quotes setting, but this was disabled since 3.31 for |
|---|
| 2514 | compatibility with PEAR DB. |
|---|
| 2515 | </font></p><p><font><b>Affected_Rows<a name="affected_rows"></a>( )</b></font></p> |
|---|
| 2516 | <p><font>Returns the number of rows affected by a update or delete statement. Returns |
|---|
| 2517 | false if function not supported.</font></p> |
|---|
| 2518 | <p><font>Not supported by interbase/firebird currently. </font></p> |
|---|
| 2519 | <p><font><b>Insert_ID<a name="inserted_id"></a>( )</b></font></p> |
|---|
| 2520 | <p><font>Returns the last autonumbering ID inserted. Returns false if function not supported. |
|---|
| 2521 | </font></p> |
|---|
| 2522 | <p><font>Only supported by databases that support auto-increment or object id's, such |
|---|
| 2523 | as PostgreSQL, MySQL and MS SQL Server currently. PostgreSQL returns the OID, which |
|---|
| 2524 | can change on a database reload.</font></p> |
|---|
| 2525 | <p><font><b>RowLock<a name="rowlock"></a>($table,$where)</b></font></p> |
|---|
| 2526 | <p><font>Lock a table row for the duration of a transaction. For example to lock record $id in table1: |
|---|
| 2527 | </font></p><pre><font> $DB->StartTrans();<br> $DB->RowLock("table1","rowid=$id");<br> $DB->Execute($sql1);<br> $DB->Execute($sql2);<br> $DB->CompleteTrans();<br></font></pre> |
|---|
| 2528 | <p><font>Supported in db2, interbase, informix, mssql, oci8, postgres, sybase. |
|---|
| 2529 | </font></p><p><font><b>MetaDatabases<a name="metadatabases"></a>()</b></font></p> |
|---|
| 2530 | <p><font>Returns a list of databases available on the server as an array. You have to |
|---|
| 2531 | connect to the server first. Only available for ODBC, MySQL and ADO.</font></p> |
|---|
| 2532 | <p><font><b>MetaTables<a name="metatables"></a>($ttype = false, $showSchema = false, |
|---|
| 2533 | $mask=false)</b></font></p> |
|---|
| 2534 | <p><font>Returns an array of tables and views for the current database as an array. |
|---|
| 2535 | The array should exclude system catalog tables if possible. To only show tables, |
|---|
| 2536 | use $db->MetaTables('TABLES'). To show only views, use $db->MetaTables('VIEWS'). |
|---|
| 2537 | The $showSchema parameter currently works only for DB2, and when set to true, |
|---|
| 2538 | will add the schema name to the table, eg. "SCHEMA.TABLE". </font></p> |
|---|
| 2539 | <p><font>You can define a mask for matching. For example, setting $mask = 'TMP%' will |
|---|
| 2540 | match all tables that begin with 'TMP'. Currently only mssql, oci8, odbc_mssql |
|---|
| 2541 | and postgres* support $mask. |
|---|
| 2542 | </font></p><p><font><b>MetaColumns<a name="metacolumns"></a>($table,$notcasesensitive=true)</b></font></p> |
|---|
| 2543 | <p><font>Returns an array of ADOFieldObject's, one field object for every column of |
|---|
| 2544 | $table. A field object is a class instance with (name, type, max_length) defined. |
|---|
| 2545 | Currently Sybase does not recognise date types, and ADO cannot identify |
|---|
| 2546 | the correct data type (so we default to varchar). |
|---|
| 2547 | </font></p><p><font> The $notcasesensitive parameter determines whether we uppercase or lowercase the table name to normalize it |
|---|
| 2548 | (required for some databases). Does not work with MySQL ISAM tables. |
|---|
| 2549 | </font></p><p><font>For schema support, pass in the $table parameter, "$schema.$tablename". This is only |
|---|
| 2550 | supported for selected databases. |
|---|
| 2551 | </font></p><p><font><b>MetaColumnNames<a name="metacolumnames"></a>($table,$numericIndex=false)</b></font></p> |
|---|
| 2552 | <p><font>Returns an array of column names for $table. Since ADOdb 4.22, this is an associative array, with the |
|---|
| 2553 | keys in uppercase. Set $numericIndex=true if you want the old behaviour of numeric indexes (since 4.23). |
|---|
| 2554 | </font></p><p> |
|---|
| 2555 | <font>e.g. array('FIELD1' => 'Field1', 'FIELD2'=>'Field2') |
|---|
| 2556 | </font></p><p> |
|---|
| 2557 | </p><p><font><b>MetaPrimaryKeys<a name="metaprimarykeys"></a>($table, |
|---|
| 2558 | $owner=false)</b></font> |
|---|
| 2559 | </p> |
|---|
| 2560 | <p><font>Returns an array containing column names that are the |
|---|
| 2561 | primary keys of $table. Supported by mysql, odbc (including db2, odbc_mssql, |
|---|
| 2562 | etc), mssql, postgres, interbase/firebird, oci8 currently. </font></p> |
|---|
| 2563 | <p><font>Views (and some tables) have primary keys, but sometimes this information is not available from the |
|---|
| 2564 | database. You can define a function ADODB_View_PrimaryKeys($databaseType, $database, $view, $owner) that |
|---|
| 2565 | should return an array containing the fields that make up the primary key. If that function exists, |
|---|
| 2566 | it will be called when MetaPrimaryKeys() cannot find a primary key for a table or view. |
|---|
| 2567 | </font></p><pre><font>// In this example: dbtype = 'oci8', $db = 'mydb', $view = 'dataView', $owner = false <br>function ADODB_View_PrimaryKeys($dbtype,$db,$view,$owner)<br>{<br> switch(strtoupper($view)) {<br> case 'DATAVIEW': return array('DATAID');<br> default: return false;<br> }<br>}<br><br>$db = NewADOConnection('oci8');<br>$db->Connect('localhost','root','','mydb'); <br>$db->MetaPrimaryKeys('dataView');<br></font></pre> |
|---|
| 2568 | <p><font><b>ServerInfo<a name="serverinfo" id="serverinfo"></a>()</b></font> |
|---|
| 2569 | </p> |
|---|
| 2570 | <p><font>Returns an array of containing two elements 'description' |
|---|
| 2571 | and 'version'. The 'description' element contains the string description of |
|---|
| 2572 | the database. The 'version' naturally holds the version number (which is also |
|---|
| 2573 | a string).</font></p> |
|---|
| 2574 | <p><font><b>MetaForeignKeys<a name="metaforeignkeys"></a>($table, $owner=false, $upper=false)</b> |
|---|
| 2575 | </font></p><p><font>Returns an associate array of foreign keys, or false if not supported. For |
|---|
| 2576 | example, if table employee has a foreign key where employee.deptkey points to |
|---|
| 2577 | dept_table.deptid, and employee.posn=posn_table.postionid and employee.poscategory=posn_table.category, |
|---|
| 2578 | then $conn->MetaForeignKeys('employee') will return |
|---|
| 2579 | </font></p><pre><font> array(<br> 'dept_table' => array('deptkey=deptid'),<br> 'posn_table' => array('posn=positionid','poscategory=category')<br> )<br></font></pre> |
|---|
| 2580 | <p><font>The optional schema or owner can be defined in $owner. If $upper is true, then |
|---|
| 2581 | the table names (array keys) are upper-cased. |
|---|
| 2582 | </font></p><hr /> |
|---|
| 2583 | <h2><font>ADORecordSet<a name="adorecordset"></a></font></h2> |
|---|
| 2584 | <p><font>When an SQL statement successfully is executed by <font face="Courier New, Courier, mono">ADOConnection->Execute($sql),</font>an |
|---|
| 2585 | ADORecordSet object is returned. This object contains a virtual cursor so we |
|---|
| 2586 | can move from row to row, functions to obtain information about the columns |
|---|
| 2587 | and column types, and helper functions to deal with formating the results to |
|---|
| 2588 | show to the user.</font></p> |
|---|
| 2589 | <h3><font>ADORecordSet Fields</font></h3> |
|---|
| 2590 | <p><font><b>fields: </b>Array containing the current row. This is not associative, but |
|---|
| 2591 | is an indexed array from 0 to columns-1. See also the function <b><a href="#fields">Fields</a></b>, |
|---|
| 2592 | which behaves like an associative array.</font></p> |
|---|
| 2593 | <p><font><b>dataProvider</b>: The underlying mechanism used to connect to the database. |
|---|
| 2594 | Normally set to <b>native</b>, unless using <b>odbc</b> or <b>ado</b>.</font></p> |
|---|
| 2595 | <p><font><b>blobSize</b>: Maximum size of a char, string or varchar object before it |
|---|
| 2596 | is treated as a Blob (Blob's should be shown with textarea's). See the <a href="#metatype">MetaType</a> |
|---|
| 2597 | function.</font></p> |
|---|
| 2598 | <p><font><b>sql</b>: Holds the sql statement used to generate this record set.</font></p> |
|---|
| 2599 | <p><font><b>canSeek</b>: Set to true if Move( ) function works.</font></p> |
|---|
| 2600 | <p><font><b>EOF</b>: True if we have scrolled the cursor past the last record.</font></p> |
|---|
| 2601 | <h3><font>ADORecordSet Functions</font></h3> |
|---|
| 2602 | <p><font><b>ADORecordSet( )</b></font></p> |
|---|
| 2603 | <p><font>Constructer. Normally you never call this function yourself.</font></p> |
|---|
| 2604 | <p><font><b>GetAssoc<a name="getassoc"></a>([$force_array])</b></font></p> |
|---|
| 2605 | <p><font>Generates an associative array from the recordset. Note that is this function |
|---|
| 2606 | is also <a href="#getassoc1">available</a> in the connection object. More details |
|---|
| 2607 | can be found there.</font></p> |
|---|
| 2608 | <font> </font> |
|---|
| 2609 | <p><font><b>GetArray<a name="getarray"></a>([$number_of_rows])</b></font></p> |
|---|
| 2610 | <p><font>Generate a 2-dimensional array of records from the current |
|---|
| 2611 | cursor position, indexed from 0 to $number_of_rows - 1. If $number_of_rows |
|---|
| 2612 | is undefined, till EOF.</font></p> |
|---|
| 2613 | <p><font><b>GetRows<a name="getrows"></a>([$number_of_rows])</b></font></p> |
|---|
| 2614 | <font>Generate a 2-dimensional array of records from the current |
|---|
| 2615 | cursor position. Synonym for GetArray() for compatibility with Microsoft ADO. </font> |
|---|
| 2616 | <p><font> <b>GetMenu<a name="getmenu"></a>($name, [$default_str=''], |
|---|
| 2617 | [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])</b></font></p> |
|---|
| 2618 | <p><font>Generate a HTML menu (<select><option><option></select>). |
|---|
| 2619 | The first column of the recordset (fields[0]) will hold the string to display |
|---|
| 2620 | in the option tags. If the recordset has more than 1 column, the second column |
|---|
| 2621 | (fields[1]) is the value to send back to the web server.. The menu will be |
|---|
| 2622 | given the name $<i>name</i>. </font></p> |
|---|
| 2623 | <p><font> If $<i>default_str</i> is defined, then if $<i>default_str</i> == |
|---|
| 2624 | fields[0], that field is selected. If $<i>blank1stItem</i> is true, the first |
|---|
| 2625 | option is empty. You can also set the first option strings by setting $blank1stItem |
|---|
| 2626 | = "$value:$text".</font></p> |
|---|
| 2627 | <p><font>$<i>Default_str</i> can be array for a multiple select |
|---|
| 2628 | listbox.</font></p> |
|---|
| 2629 | <p><font>To get a listbox, set the $<i>size</i> to a non-zero |
|---|
| 2630 | value (or pass $default_str as an array). If $<i>multiple_select</i> is true |
|---|
| 2631 | then a listbox will be generated with $<i>size</i> items (or if $size==0, |
|---|
| 2632 | then 5 items) visible, and we will return an array to a server. Lastly use |
|---|
| 2633 | $<i>moreAttr </i> to add additional attributes such as javascript or styles. </font></p> |
|---|
| 2634 | <p><font>Menu Example 1: <code>GetMenu('menu1','A',true)</code> will |
|---|
| 2635 | generate a menu: |
|---|
| 2636 | <select name="menu1"><option> </option><option value="1" selected="selected">A </option><option value="2">B </option><option value="3">C </option></select> |
|---|
| 2637 | for the data (A,1), (B,2), (C,3). Also see <a href="#ex5">example 5</a>.</font></p> |
|---|
| 2638 | <p><font>Menu Example 2: For the same data, <code>GetMenu('menu1',array('A','B'),false)</code> will |
|---|
| 2639 | generate a menu with both A and B selected: <br> |
|---|
| 2640 | <select name="menu1" multiple="multiple" size="3"><option value="1" selected="selected">A </option><option value="2" selected="selected">B </option><option value="3">C </option></select> |
|---|
| 2641 | </font></p> |
|---|
| 2642 | <p><font> <b>GetMenu2<a name="getmenu2"></a>($name, [$default_str=''], |
|---|
| 2643 | [$blank1stItem=true], [$multiple_select=false], [$size=0], [$moreAttr=''])</b></font></p> |
|---|
| 2644 | <p><font>This is nearly identical to GetMenu, except that the |
|---|
| 2645 | $<i>default_str</i> is matched to fields[1] (the option values).</font></p> |
|---|
| 2646 | <p><font>Menu Example 3: Given the data in menu example 2, <code>GetMenu2('menu1',array('1','2'),false)</code> will |
|---|
| 2647 | generate a menu with both A and B selected in menu example 2, but this time |
|---|
| 2648 | the selection is based on the 2nd column, which holds the values to return |
|---|
| 2649 | to the Web server. </font></p> |
|---|
| 2650 | <p><font><b>UserDate<a name="userdate"></a>($str, [$fmt])</b></font></p> |
|---|
| 2651 | <p><font>Converts the date string $<i>str</i> to another format. |
|---|
| 2652 | The date format is Y-m-d, or Unix timestamp format. The default $<i>fmt</i> is |
|---|
| 2653 | Y-m-d.</font></p> |
|---|
| 2654 | <p><font><b>UserTimeStamp<a name="usertimestamp"></a>($str, [$fmt])</b></font></p> |
|---|
| 2655 | <p><font>Converts the timestamp string $<b>str</b> to another |
|---|
| 2656 | format. The timestamp format is Y-m-d H:i:s, as in '2002-02-28 23:00:12', |
|---|
| 2657 | or Unix timestamp format. UserTimeStamp calls UnixTimeStamp to parse $<i>str</i>, |
|---|
| 2658 | and $<i>fmt</i> defaults to Y-m-d H:i:s if not defined. </font></p> |
|---|
| 2659 | <p><font><b>UnixDate<a name="unixdate"></a>($str)</b></font></p> |
|---|
| 2660 | <p><font>Parses the date string $<b>str</b> and returns it in |
|---|
| 2661 | unix mktime format (eg. a number indicating the seconds after January 1st, |
|---|
| 2662 | 1970). Expects the date to be in Y-m-d H:i:s format, except for Sybase and |
|---|
| 2663 | Microsoft SQL Server, where M d Y is also accepted (the 3 letter month strings |
|---|
| 2664 | are controlled by a global array, which might need localisation).</font></p> |
|---|
| 2665 | <p><font>This function is available in both ADORecordSet and |
|---|
| 2666 | ADOConnection since 1.91.</font></p> |
|---|
| 2667 | <p><font><b>UnixTimeStamp<a name="unixtimestamp"></a>($str)</b></font></p> |
|---|
| 2668 | <p><font>Parses the timestamp string $<b>str</b> and returns |
|---|
| 2669 | it in unix mktime format (eg. a number indicating the seconds after January |
|---|
| 2670 | 1st, 1970). Expects the date to be in "Y-m-d, H:i:s" (1970-12-24, 00:00:00) |
|---|
| 2671 | or "Y-m-d H:i:s" (1970-12-24 00:00:00) or "YmdHis" (19701225000000) format, |
|---|
| 2672 | except for Sybase and Microsoft SQL Server, where "M d Y h:i:sA" (Dec 25 |
|---|
| 2673 | 1970 00:00:00AM) is also accepted (the 3 letter month strings are controlled |
|---|
| 2674 | by a global array, which might need localisation).</font></p> |
|---|
| 2675 | <font> |
|---|
| 2676 | </font><p><font>This function is available in both ADORecordSet |
|---|
| 2677 | and ADOConnection since 1.91. </font></p> |
|---|
| 2678 | <p><font><b>OffsetDate<a name="OffsetDate"></a>($dayFraction, |
|---|
| 2679 | $basedate=false)</b></font></p> |
|---|
| 2680 | <p><font>Returns a string with the native SQL functions to calculate |
|---|
| 2681 | future and past dates based on $basedate in a portable fashion. If $basedate |
|---|
| 2682 | is not defined, then the current date (at 12 midnight) is used. Returns the |
|---|
| 2683 | SQL string that performs the calculation when passed to Execute(). </font></p> |
|---|
| 2684 | <p><font>For example, in Oracle, to find the date and time that |
|---|
| 2685 | is 2.5 days from today, you can use:</font></p> |
|---|
| 2686 | <pre><font># get date one week from now<br>$fld = $conn->OffsetDate(7); // returns "(trunc(sysdate)+7")</font></pre> |
|---|
| 2687 | <pre><font># get date and time that is 60 hours from current date and time<br>$fld = $conn->OffsetDate(2.5, $conn->sysTimeStamp); // returns "(sysdate+2.5)"<br><br>$conn->Execute("UPDATE TABLE SET dodate=$fld WHERE ID=$id");</font></pre> |
|---|
| 2688 | <p><font> This function is available for mysql, mssql, oracle, oci8 and postgresql drivers |
|---|
| 2689 | since 2.13. It might work with other drivers provided they allow performing |
|---|
| 2690 | numeric day arithmetic on dates.</font></p> |
|---|
| 2691 | <font> </font> |
|---|
| 2692 | <p><font><b>SQLDate<a name="sqldate"></a>($dateFormat, $basedate=false)</b></font></p> |
|---|
| 2693 | <font>Returns a string which contains the native SQL functions |
|---|
| 2694 | to format a date or date column $basedate. This is used when retrieving date columns in SELECT statements. |
|---|
| 2695 | For sending dates to the database (eg. in UPDATE, INSERT or the where clause of SELECT statements) |
|---|
| 2696 | use <a href="#dbdate">DBDate</a>. It uses a case-sensitive |
|---|
| 2697 | $dateFormat, which supports: </font> |
|---|
| 2698 | <pre><font> |
|---|
| 2699 | Y: 4-digit Year |
|---|
| 2700 | Q: Quarter (1-4) |
|---|
| 2701 | M: Month (Jan-Dec) |
|---|
| 2702 | m: Month (01-12) |
|---|
| 2703 | d: Day (01-31) |
|---|
| 2704 | H: Hour (00-23) |
|---|
| 2705 | h: Hour (1-12) |
|---|
| 2706 | i: Minute (00-59) |
|---|
| 2707 | s: Second (00-60) |
|---|
| 2708 | A: AM/PM indicator |
|---|
| 2709 | w: day of week (0-6 or 1-7 depending on DB) |
|---|
| 2710 | l: day of week (as string - lowercase L) |
|---|
| 2711 | W: week in year (0..53 for MySQL, 1..53 for PostgreSQL and Oracle) |
|---|
| 2712 | </font></pre> |
|---|
| 2713 | <p><font>All other characters are treated as strings. You can |
|---|
| 2714 | also use \ to escape characters. Available on selected databases, including |
|---|
| 2715 | mysql, postgresql, mssql, oci8 and DB2. </font></p> |
|---|
| 2716 | <p><font>This is useful in writing portable sql statements that |
|---|
| 2717 | GROUP BY on dates. For example to display total cost of goods sold broken |
|---|
| 2718 | by quarter (dates are stored in a field called postdate): </font></p> |
|---|
| 2719 | <pre><font> $sqlfn = $db->SQLDate('Y-\QQ','postdate'); # get sql that formats postdate to output 2002-Q1<br> $sql = "SELECT $sqlfn,SUM(cogs) FROM table GROUP BY $sqlfn ORDER BY 1 desc";<br> </font></pre> |
|---|
| 2720 | <p><font><b>MoveNext<a name="movenext"></a>( )</b></font></p> |
|---|
| 2721 | <p><font>Move the internal cursor to the next row. The <i>$this->fields</i> array |
|---|
| 2722 | is automatically updated. Returns false if unable to do so (normally because |
|---|
| 2723 | EOF has been reached), otherwise true. </font></p> |
|---|
| 2724 | <p><font> If EOF is reached, then the $this->fields array |
|---|
| 2725 | is set to false (this was only implemented consistently in ADOdb 3.30). For |
|---|
| 2726 | the pre-3.30 behaviour of $this->fields (at EOF), set the global variable |
|---|
| 2727 | $ADODB_COMPAT_FETCH = true.</font></p> |
|---|
| 2728 | <p><font>Example:</font></p> |
|---|
| 2729 | <pre><font>$rs = $db->Execute($sql);<br>if ($rs) <br> while (!$rs->EOF) {<br> ProcessArray($rs->fields); <br> $rs->MoveNext();<br> } </font></pre> |
|---|
| 2730 | <p><font><b>Move<a name="move"></a>($to)</b></font></p> |
|---|
| 2731 | <p><font>Moves the internal cursor to a specific row $<b>to</b>. |
|---|
| 2732 | Rows are zero-based eg. 0 is the first row. The <b>fields</b> array is automatically |
|---|
| 2733 | updated. For databases that do not support scrolling internally, ADOdb will |
|---|
| 2734 | simulate forward scrolling. Some databases do not support backward scrolling. |
|---|
| 2735 | If the $<b>to</b> position is after the EOF, $<b>to</b> will move to the |
|---|
| 2736 | end of the RecordSet for most databases. Some obscure databases using odbc |
|---|
| 2737 | might not behave this way.</font></p> |
|---|
| 2738 | <p><font>Note: This function uses <i>absolute positioning</i>, |
|---|
| 2739 | unlike Microsoft's ADO.</font></p> |
|---|
| 2740 | <p><font>Returns true or false. If false, the internal cursor |
|---|
| 2741 | is not moved in most implementations, so AbsolutePosition( ) will return |
|---|
| 2742 | the last cursor position before the Move( ). </font></p> |
|---|
| 2743 | <p><font><b>MoveFirst<a name="movefirst"></a>()</b></font></p> |
|---|
| 2744 | <p><font>Internally calls Move(0). Note that some databases do |
|---|
| 2745 | not support this function.</font></p> |
|---|
| 2746 | <p><font><b>MoveLast<a name="movelast"></a>()</b></font></p> |
|---|
| 2747 | <p><font>Internally calls Move(RecordCount()-1). Note that some |
|---|
| 2748 | databases do not support this function.</font></p> |
|---|
| 2749 | <p><font><b>GetRowAssoc</b><a name="getrowassoc"></a>($toUpper=true)</font></p> |
|---|
| 2750 | <p><font>Returns an associative array containing the current |
|---|
| 2751 | row. The keys to the array are the column names. The column names are upper-cased |
|---|
| 2752 | for easy access. To get the next row, you will still need to call MoveNext(). </font></p> |
|---|
| 2753 | <p><font>For example:<br> |
|---|
| 2754 | Array ( [ID] => 1 [FIRSTNAME] => Caroline [LASTNAME] => Miranda [CREATED] |
|---|
| 2755 | => 2001-07-05 ) </font></p> |
|---|
| 2756 | <p><font>Note: do not use GetRowAssoc() with $ADODB_FETCH_MODE |
|---|
| 2757 | = ADODB_FETCH_ASSOC. Because they have the same functionality, they will |
|---|
| 2758 | interfere with each other.</font></p> |
|---|
| 2759 | <font> |
|---|
| 2760 | </font><p><font><b>AbsolutePage<a name="absolutepage"></a>($page=-1) </b></font></p> |
|---|
| 2761 | <p><font>Returns the current page. Requires PageExecute()/CachePageExecute() to be called. |
|---|
| 2762 | See <a href="#ex8">Example 8</a>.</font></p> |
|---|
| 2763 | <font> |
|---|
| 2764 | <p><b>AtFirstPage<a name="atfirstpage">($status='')</a></b></p> |
|---|
| 2765 | <p>Returns true if at first page (1-based). Requires PageExecute()/CachePageExecute() |
|---|
| 2766 | to be called. See <a href="#ex8">Example 8</a>.</p> |
|---|
| 2767 | <p><b>AtLastPage<a name="atlastpage">($status='')</a></b></p> |
|---|
| 2768 | <p>Returns true if at last page (1-based). Requires PageExecute()/CachePageExecute() |
|---|
| 2769 | to be called. See <a href="#ex8">Example 8</a>.</p> |
|---|
| 2770 | <p><b>Fields</b><a name="fields"></a>(<b>$colname</b>)</p> |
|---|
| 2771 | <p>Returns the value of the associated column $<b>colname</b> for the current |
|---|
| 2772 | row. The column name is case-insensitive.</p> |
|---|
| 2773 | <p>This is a convenience function. For higher performance, use <a href="#adodb_fetch_mode">$ADODB_FETCH_MODE</a>. </p> |
|---|
| 2774 | <p><b>FetchRow</b><a name="fetchrow"></a>()</p> |
|---|
| 2775 | </font><p><font>Returns array containing current row, or false |
|---|
| 2776 | if EOF. FetchRow( ) internally moves to the next record after returning the |
|---|
| 2777 | current row. </font></p> |
|---|
| 2778 | <p><font>Warning: Do not mix using FetchRow() with MoveNext().</font></p> |
|---|
| 2779 | <p><font>Usage:</font></p> |
|---|
| 2780 | <pre><font>$rs = $db->Execute($sql);<br>if ($rs)<br> while ($arr = $rs->FetchRow()) {<br> # process $arr <br> }</font></pre> |
|---|
| 2781 | <p><font><b>FetchInto</b><a name="fetchinto"></a>(<b>&$array</b>)</font></p> |
|---|
| 2782 | <p><font> Sets $array to the current row. Returns PEAR_Error |
|---|
| 2783 | object if EOF, 1 if ok (DB_OK constant). If PEAR is undefined, false is returned |
|---|
| 2784 | when EOF. FetchInto( ) internally moves to the next record after returning |
|---|
| 2785 | the current row. </font></p> |
|---|
| 2786 | <p><font> FetchRow() is easier to use. See above.</font></p> |
|---|
| 2787 | <font> </font> |
|---|
| 2788 | <p><font><b>FetchField<a name="fetchfield"></a>($column_number)</b></font></p> |
|---|
| 2789 | <p><font>Returns an object containing the <b>name</b>, <b>type</b> and <b>max_length</b> of |
|---|
| 2790 | the associated field. If the max_length cannot be determined reliably, it |
|---|
| 2791 | will be set to -1. The column numbers are zero-based. See <a href="#ex2">example |
|---|
| 2792 | 2.</a></font></p> |
|---|
| 2793 | <p><font><b>FieldCount<a name="fieldcount"></a>( )</b></font></p> |
|---|
| 2794 | <p><font>Returns the number of fields (columns) in the record |
|---|
| 2795 | set.</font></p> |
|---|
| 2796 | <p><font><b>RecordCount<a name="recordcount"></a>( )</b></font></p> |
|---|
| 2797 | <p><font>Returns the number of rows in the record set. If the |
|---|
| 2798 | number of records returned cannot be determined from the database driver |
|---|
| 2799 | API, we will buffer all rows and return a count of the rows after all the |
|---|
| 2800 | records have been retrieved. This buffering can be disabled (for performance |
|---|
| 2801 | reasons) by setting the global variable $ADODB_COUNTRECS = false. When disabled, |
|---|
| 2802 | RecordCount( ) will return -1 for certain databases. See the supported databases |
|---|
| 2803 | list above for more details. </font></p> |
|---|
| 2804 | <p><font> RowCount is a synonym for RecordCount.</font></p> |
|---|
| 2805 | <p><font><b>PO_RecordCount<a name="po_recordcount"></a>($table, |
|---|
| 2806 | $where)</b></font></p> |
|---|
| 2807 | <p><font>Returns the number of rows in the record set. If the |
|---|
| 2808 | database does not support this, it will perform a SELECT COUNT(*) on the |
|---|
| 2809 | table $table, with the given $where condition to return an estimate of the |
|---|
| 2810 | recordset size.</font></p> |
|---|
| 2811 | <p><font>$numrows = $rs->PO_RecordCount("articles_table", "group=$group");</font></p> |
|---|
| 2812 | <font><b> NextRecordSet<a name="nextrecordset" id="nextrecordset"></a>()</b> </font> |
|---|
| 2813 | <p><font>For databases that allow multiple recordsets to be returned |
|---|
| 2814 | in one query, this function allows you to switch to the next recordset. Currently |
|---|
| 2815 | only supported by mssql driver.</font></p> |
|---|
| 2816 | <pre><font>$rs = $db->Execute('execute return_multiple_rs');<br>$arr1 = $rs->GetArray();<br>$rs->NextRecordSet();<br>$arr2 = $rs->GetArray();</font></pre> |
|---|
| 2817 | <p><font><b>FetchObject<a name="fetchobject"></a>($toupper=true)</b></font></p> |
|---|
| 2818 | <p><font>Returns the current row as an object. If you set $toupper |
|---|
| 2819 | to true, then the object fields are set to upper-case. Note: The newer FetchNextObject() |
|---|
| 2820 | is the recommended way of accessing rows as objects. See below.</font></p> |
|---|
| 2821 | <p><font><b>FetchNextObject<a name="fetchnextobject"></a>($toupper=true)</b></font></p> |
|---|
| 2822 | <p><font>Gets the current row as an object and moves to the next |
|---|
| 2823 | row automatically. Returns false if at end-of-file. If you set $toupper to |
|---|
| 2824 | true, then the object fields are set to upper-case. Note that for some drivers such as mssql, you need to SetFetchMode(ADODB_FETCH_ASSOC) or SetFetchMode(ADODB_FETCH_BOTH).</font></p> |
|---|
| 2825 | <pre><font>$rs = $db->Execute('select firstname,lastname from table');<br>if ($rs) {<br> while ($o = $rs->FetchNextObject()) {<br> print "$o->FIRSTNAME, $o->LASTNAME<BR>";<br> }<br>}<br></font></pre> |
|---|
| 2826 | <p><font>There is some trade-off in speed in using FetchNextObject(). |
|---|
| 2827 | If performance is important, you should access rows with the <code>fields[]</code> array. <b>FetchObj<a name="fetchobj" id="fetchobj"></a>()</b> </font></p> |
|---|
| 2828 | <p><font>Returns the current record as an object. Fields are |
|---|
| 2829 | not upper-cased, unlike FetchObject. |
|---|
| 2830 | </font></p> |
|---|
| 2831 | <p><font><b>FetchNextObj<a name="fetchnextobj" id="fetchnextobj"></a>()</b> </font></p> |
|---|
| 2832 | <p><font>Returns the current record as an object and moves to |
|---|
| 2833 | the next record. If EOF, false is returned. Fields are not upper-cased, unlike |
|---|
| 2834 | FetctNextObject. </font></p> |
|---|
| 2835 | <font> |
|---|
| 2836 | <p><b>CurrentRow<a name="currentrow"></a>( )</b></p> |
|---|
| 2837 | <p>Returns the current row of the record set. 0 is the first row.</p> |
|---|
| 2838 | <p><b>AbsolutePosition<a name="abspos"></a>( )</b></p> |
|---|
| 2839 | <p>Synonym for <b>CurrentRow</b> for compatibility with ADO. Returns the current |
|---|
| 2840 | row of the record set. 0 is the first row.</p> |
|---|
| 2841 | <p><b>MetaType<a name="metatype"></a>($nativeDBType[,$field_max_length],[$fieldobj])</b></p> |
|---|
| 2842 | <p>Determine what <i>generic</i> meta type a database field type is given its |
|---|
| 2843 | native type $<b>nativeDBType</b> as a string and the length of the field $<b>field_max_length</b>. |
|---|
| 2844 | Note that field_max_length can be -1 if it is not known. The field object returned |
|---|
| 2845 | by FetchField() can be passed in $<b>fieldobj</b> or as the 1st parameter <b>$nativeDBType</b>. |
|---|
| 2846 | This is useful for databases such as <i>mysql</i> which has additional properties |
|---|
| 2847 | in the field object such as <i>primary_key</i>. </p> |
|---|
| 2848 | <p>Uses the field <b>blobSize</b> and compares it with $<b>field_max_length</b> to |
|---|
| 2849 | determine whether the character field is actually a blob.</p> |
|---|
| 2850 | For example, $db->MetaType('char') will return 'C'. |
|---|
| 2851 | <p>Returns:</p> |
|---|
| 2852 | <ul> |
|---|
| 2853 | <li><b>C</b>: Character fields that should be shown in a <input type="text"> tag. </li> |
|---|
| 2854 | <li><b>X</b>: Clob (character large objects), or large text fields that should |
|---|
| 2855 | be shown in a <textarea></li> |
|---|
| 2856 | <li><b>D</b>: Date field</li> |
|---|
| 2857 | <li><b>T</b>: Timestamp field</li> |
|---|
| 2858 | <li><b>L</b>: Logical field (boolean or bit-field)</li> |
|---|
| 2859 | <li><b>N</b>: Numeric field. Includes decimal, numeric, floating point, and |
|---|
| 2860 | real. </li> |
|---|
| 2861 | <li><b>I</b>: Integer field. </li> |
|---|
| 2862 | <li><b>R</b>: Counter or Autoincrement field. Must be numeric.</li> |
|---|
| 2863 | <li><b>B</b>: Blob, or binary large objects. </li> |
|---|
| 2864 | </ul> |
|---|
| 2865 | </font><p><font> Since ADOdb 3.0, MetaType accepts $fieldobj |
|---|
| 2866 | as the first parameter, instead of $nativeDBType. </font></p> |
|---|
| 2867 | <font> </font> |
|---|
| 2868 | <p><font><b>Close( )<a name="rsclose"></a></b></font></p> |
|---|
| 2869 | <p><font>Closes the recordset, cleaning all memory and resources |
|---|
| 2870 | associated with the recordset. </font></p> |
|---|
| 2871 | <p> |
|---|
| 2872 | <font>If memory management is not an issue, you do not need to |
|---|
| 2873 | call this function as recordsets are closed for you by PHP at the end of the |
|---|
| 2874 | script. SQL statements such as INSERT/UPDATE/DELETE do not really return a recordset, |
|---|
| 2875 | so you do not have to call Close() for such SQL statements.</font></p> |
|---|
| 2876 | <hr /> |
|---|
| 2877 | <h3><font>function rs2html<a name="rs2html"></a>($adorecordset,[$tableheader_attributes], |
|---|
| 2878 | [$col_titles])</font></h3> |
|---|
| 2879 | <p><font>This is a standalone function (rs2html = recordset to |
|---|
| 2880 | html) that is similar to PHP's <i>odbc_result_all</i> function, it prints |
|---|
| 2881 | a ADORecordSet, $<b>adorecordset</b> as a HTML table. $<b>tableheader_attributes</b> allow |
|---|
| 2882 | you to control the table <i>cellpadding</i>, <i>cellspacing</i> and <i>border</i> attributes. |
|---|
| 2883 | Lastly you can replace the database column names with your own column titles |
|---|
| 2884 | with the array $<b>col_titles</b>. This is designed more as a quick debugging |
|---|
| 2885 | mechanism, not a production table recordset viewer.</font></p> |
|---|
| 2886 | <p><font>You will need to include the file <i>tohtml.inc.php</i>.</font></p> |
|---|
| 2887 | <p><font>Example of rs2html:<b><font color="#336600"><a name="exrs2html"></a></font></b></font></p> |
|---|
| 2888 | <pre><font><b><font color="#336600"><?<br>include('tohtml.inc.php')</font></b>; # load code common to ADOdb <br><b>include</b>('adodb.inc.php'); # load code common to ADOdb <br>$<font color="#663300">conn</font> = &ADONewConnection('mysql'); # create a connection <br>$<font color="#663300">conn</font>->PConnect('localhost','userid','','agora');# connect to MySQL, agora db<br>$<font color="#663300">sql</font> = 'select CustomerName, CustomerID from customers'; <br>$<font color="#663300">rs</font> = $<font color="#663300">conn</font>->Execute($sql); <br><font color="#336600"><b>rs2html</b></font><b>($<font color="#663300">rs</font>,'<i>border=2 cellpadding=3</i>',array('<i>Customer Name','Customer ID</i>'));<br>?></b></font></pre> |
|---|
| 2889 | <hr /> |
|---|
| 2890 | <h3><font>Differences between this ADOdb library and Microsoft |
|---|
| 2891 | ADO<a name="adodiff"></a></font></h3> |
|---|
| 2892 | <ol> |
|---|
| 2893 | <font> |
|---|
| 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> |
|---|
| 2898 | <li>ADOdb's <font face="Courier New, Courier, mono">ADORecordSet->Move()</font> uses |
|---|
| 2899 | absolute positioning, not relative. Bookmarks are not supported.</li> |
|---|
| 2900 | <li><font face="Courier New, Courier, mono">ADORecordSet->AbsolutePosition() </font>cannot |
|---|
| 2901 | be used to move the record cursor.</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 |
|---|
| 2906 | in <a href="#ex8">Example 8</a>.</li> |
|---|
| 2907 | </font></ol> |
|---|
| 2908 | <hr /> |
|---|
| 2909 | <h1><font>Database Driver Guide<a name="driverguide"></a></font></h1> |
|---|
| 2910 | <p><font>This describes how to create a class to connect to a |
|---|
| 2911 | new database. To ensure there is no duplication of work, kindly email me |
|---|
| 2912 | at jlim#natsoft.com if you decide to create such a class.</font></p> |
|---|
| 2913 | <p><font>First decide on a name in lower case to call the database |
|---|
| 2914 | type. Let's say we call it xbase. </font></p> |
|---|
| 2915 | <p><font>Then we need to create two classes ADODB_xbase and ADORecordSet_xbase |
|---|
| 2916 | in the file adodb-xbase.inc.php.</font></p> |
|---|
| 2917 | <p><font>The simplest form of database driver is an adaptation |
|---|
| 2918 | of an existing ODBC driver. Then we just need to create the class <i>ADODB_xbase |
|---|
| 2919 | extends ADODB_odbc</i> to support the new <b>date</b> and <b>timestamp</b> formats, |
|---|
| 2920 | the <b>concatenation</b> operator used, <b>true</b> and <b>false</b>. For |
|---|
| 2921 | the<i> ADORecordSet_xbase extends ADORecordSet_odbc </i>we need to change |
|---|
| 2922 | the <b>MetaType</b> function. See<b> adodb-vfp.inc.php</b> as an example.</font></p> |
|---|
| 2923 | <p><font>More complicated is a totally new database driver that |
|---|
| 2924 | connects to a new PHP extension. Then you will need to implement several |
|---|
| 2925 | functions. Fortunately, you do not have to modify most of the complex code. |
|---|
| 2926 | You only need to override a few stub functions. See <b>adodb-mysql.inc.php</b> for |
|---|
| 2927 | example.</font></p> |
|---|
| 2928 | <p><font>The default date format of ADOdb internally is YYYY-MM-DD |
|---|
| 2929 | (Ansi-92). All dates should be converted to that format when passing to an |
|---|
| 2930 | ADOdb date function. See Oracle for an example how we use ALTER SESSION to |
|---|
| 2931 | change the default date format in _pconnect _connect.</font></p> |
|---|
| 2932 | <p><font><b>ADOConnection Functions to Override</b></font></p> |
|---|
| 2933 | <p><font>Defining a constructor for your ADOConnection derived |
|---|
| 2934 | function is optional. There is no need to call the base class constructor.</font></p> |
|---|
| 2935 | <p><font>_<b>connect</b>: Low level implementation of Connect. |
|---|
| 2936 | Returns true or false. Should set the _<b>connectionID</b>.</font></p> |
|---|
| 2937 | <p><font>_<b>pconnect:</b> Low level implemention of PConnect. |
|---|
| 2938 | Returns true or false. Should set the _<b>connectionID</b>.</font></p> |
|---|
| 2939 | <p><font>_<b>query</b>: Execute a query. Returns the queryID, |
|---|
| 2940 | or false.</font></p> |
|---|
| 2941 | <p><font>_<b>close: </b>Close the connection -- PHP should clean |
|---|
| 2942 | up all recordsets. </font></p> |
|---|
| 2943 | <p><font><b>ErrorMsg</b>: Stores the error message in the private |
|---|
| 2944 | variable _errorMsg. </font></p> |
|---|
| 2945 | <p><font><b>ADOConnection Fields to Set</b></font></p> |
|---|
| 2946 | <p><font>_<b>bindInputArray</b>: Set to true if binding of parameters |
|---|
| 2947 | for SQL inserts and updates is allowed using ?, eg. as with ODBC.</font></p> |
|---|
| 2948 | <p><font><b>fmtDate</b></font></p> |
|---|
| 2949 | <p><font><b>fmtTimeStamp</b></font></p> |
|---|
| 2950 | <p><font><b>true</b></font></p> |
|---|
| 2951 | <p><font><b>false</b></font></p> |
|---|
| 2952 | <p><font><b>concat_operator</b></font></p> |
|---|
| 2953 | <p><font><b>replaceQuote</b></font></p> |
|---|
| 2954 | <p><font><b>hasLimit</b> support SELECT * FROM TABLE LIMIT 10 |
|---|
| 2955 | of MySQL.</font></p> |
|---|
| 2956 | <p><font><b>hasTop</b> support Microsoft style SELECT TOP 10 |
|---|
| 2957 | * FROM TABLE.</font></p> |
|---|
| 2958 | <p><font><b>ADORecordSet Functions to Override</b></font></p> |
|---|
| 2959 | <p><font>You will need to define a constructor for your ADORecordSet |
|---|
| 2960 | derived class that calls the parent class constructor.</font></p> |
|---|
| 2961 | <p><font><b>FetchField: </b> as documented above in ADORecordSet</font></p> |
|---|
| 2962 | <p><font>_<b>initrs</b>: low level initialization of the recordset: |
|---|
| 2963 | setup the _<b>numOfRows</b> and _<b>numOfFields</b> fields -- called by the |
|---|
| 2964 | constructor.</font></p> |
|---|
| 2965 | <p><font>_<b>seek</b>: seek to a particular row. Do not load |
|---|
| 2966 | the data into the fields array. This is done by _fetch. Returns true or false. |
|---|
| 2967 | Note that some implementations such as Interbase do not support seek. Set |
|---|
| 2968 | canSeek to false.</font></p> |
|---|
| 2969 | <p><font>_<b>fetch</b>: fetch a row using the database extension |
|---|
| 2970 | function and then move to the next row. Sets the <b>fields</b> array. If |
|---|
| 2971 | the parameter $ignore_fields is true then there is no need to populate the <b>fields</b> array, |
|---|
| 2972 | just move to the next row. then Returns true or false.</font></p> |
|---|
| 2973 | <p><font>_<b>close</b>: close the recordset</font></p> |
|---|
| 2974 | <p><font><b>Fields</b>: If the array row returned by the PHP |
|---|
| 2975 | extension is not an associative one, you will have to override this. See |
|---|
| 2976 | adodb-odbc.inc.php for an example. For databases such as MySQL and MSSQL |
|---|
| 2977 | where an associative array is returned, there is no need to override this |
|---|
| 2978 | function.</font></p> |
|---|
| 2979 | <p><font><b>ADOConnection Fields to Set</b></font></p> |
|---|
| 2980 | <p><font>canSeek: Set to true if the _seek function works.</font></p> |
|---|
| 2981 | <h2><font>Optimizing PHP</font></h2> |
|---|
| 2982 | For info on tuning PHP, read this article on <a href="http://phplens.com/lens/php-book/optimizing-debugging-php.php">Optimizing |
|---|
| 2983 | PHP</a>. </font></p> |
|---|
| 2984 | |
|---|
| 2985 | <h2><font>Change Log<a name="Changes"></a><a name="changes"></a><a name="changelog"></a></font></h2> |
|---|
| 2986 | <p><a name="4.992"></a><b>4.992 ?? Nov 2009</b> |
|---|
| 2987 | <p>Fixed memcache compat issues. |
|---|
| 2988 | <p>Added some security fixes to addq() and qstr(). |
|---|
| 2989 | <p><a name="4.991"></a><b>4.991 16 Oct 2008</b> |
|---|
| 2990 | <p>Added BINARY type to mysql.inc.php (also in 4.991). |
|---|
| 2991 | <p>Added support for SelectLimit($sql,-1,100) in oci8. (also in 4.991). |
|---|
| 2992 | <p>New $conn->GetMedian($table, $field, $where='') to get median account no. (also in 4.991) |
|---|
| 2993 | <p>Fixed bugs in memcache support. |
|---|
| 2994 | <p>The rs2html() function in tohtml.inc.php did not handle dates with ':' in it properly. Fixed. (also in 4.991) |
|---|
| 2995 | <p>Added support for connecting to oci8 using $DB->Connect($ip, $user, $pwd, "SID=$sid"); (also in 4.991) |
|---|
| 2996 | <p>Added mysql type 'VAR_STRING' to MetaType(). (also in 4.991) |
|---|
| 2997 | <p>The session and session2 code supports setfetchmode assoc properly now (also in 4.991). |
|---|
| 2998 | <p><a name="4.990"></a><b>4.990/5.05 11 July 2008</b> |
|---|
| 2999 | <p>Added support for multiple recordsets in mysqli "Geisel Sierote" geisel#4up.com.br. See http://phplens.com/lens/lensforum/msgs.php?id=15917 |
|---|
| 3000 | <p>Malcolm Cook added new Reload() function to Active Record. See http://phplens.com/lens/lensforum/msgs.php?id=17474 |
|---|
| 3001 | <p>Thanks Zoltan Monori [monzol#fotoprizma.hu] for bug fixes in iterator, SelectLimit, GetRandRow, etc. |
|---|
| 3002 | <p>Under heavy loads, the performance monitor for oci8 disables Ixora views. |
|---|
| 3003 | <p> Fixed sybase driver SQLDate to use str_replace(). Also for adodb5, changed sybase driver UnixDate and UnixTimeStamp calls to static. |
|---|
| 3004 | <p>Changed oci8 lob handler to use & reference $this->_refLOBs[$numlob]['VAR'] = &$var. |
|---|
| 3005 | <p>We now strtolower the get_class() function in PEAR::isError() for php5 compat. |
|---|
| 3006 | <p>CacheExecute did not retrieve cache recordsets properly for 5.04 (worked in 4.98). Fixed. |
|---|
| 3007 | <p>New ADODB_Cache_File class for file caching defined in adodb.inc.php. |
|---|
| 3008 | <p>Farsi language file contribution by Peyman Hooshmandi Raad (phooshmand#gmail.com) |
|---|
| 3009 | <p>New API for creating your custom caching class which is stored in $ADODB_CACHE: |
|---|
| 3010 | <pre> |
|---|
| 3011 | include "/path/to/adodb.inc.php"; |
|---|
| 3012 | $ADODB_CACHE_CLASS = 'MyCacheClass'; |
|---|
| 3013 | |
|---|
| 3014 | class MyCacheClass extends ADODB_Cache_File |
|---|
| 3015 | { |
|---|
| 3016 | function writecache($filename, $contents,$debug=false){...} |
|---|
| 3017 | function &readcache($filename, &$err, $secs2cache, $rsClass){ ...} |
|---|
| 3018 | : |
|---|
| 3019 | } |
|---|
| 3020 | |
|---|
| 3021 | $DB = NewADOConnection($driver); |
|---|
| 3022 | $DB->Connect(...); ## MyCacheClass created here and stored in $ADODB_CACHE global variable. |
|---|
| 3023 | |
|---|
| 3024 | $data = $rs->CacheGetOne($sql); ## MyCacheClass is used here for caching... |
|---|
| 3025 | </pre> |
|---|
| 3026 | <p> |
|---|
| 3027 | <p>Memcache supports multiple pooled hosts now. Only if none of the pooled servers can be contacted will a connect error be generated. |
|---|
| 3028 | Usage example below: |
|---|
| 3029 | <pre> |
|---|
| 3030 | $db = NewADOConnection($driver); |
|---|
| 3031 | $db->memCache = true; /// should we use memCache instead of caching in files |
|---|
| 3032 | $db->memCacheHost = array($ip1, $ip2, $ip3); /// $db->memCacheHost = $ip1; still works |
|---|
| 3033 | $db->memCachePort = 11211; /// this is default memCache port |
|---|
| 3034 | $db->memCacheCompress = false; /// Use 'true' to store the item compressed (uses zlib) |
|---|
| 3035 | |
|---|
| 3036 | $db->Connect(...); |
|---|
| 3037 | $db->CacheExecute($sql); |
|---|
| 3038 | </pre> |
|---|
| 3039 | <p><a name="4.98"></a><b>4.98/5.04 13 Feb 2008</b> |
|---|
| 3040 | <p> Fixed adodb_mktime problem which causes a performance bottleneck in $hrs. |
|---|
| 3041 | <p>Added mysqli support to adodb_getcount(). |
|---|
| 3042 | <p>Removed MYSQLI_TYPE_CHAR from MetaType(). |
|---|
| 3043 | |
|---|
| 3044 | <p><a name="4.97"></a><b>4.97/5.03 22 Jan 2008</b> |
|---|
| 3045 | <p>Active Record: $ADODB_ASSOC_CASE=1 did not work properly. Fixed. |
|---|
| 3046 | <p>Modified Fields() in recordset class to support display null fields in FetchNextObject(). |
|---|
| 3047 | <p>In ADOdb5, active record implementation, we now support column names with spaces in them - we autoconvert the spaces to _ using |
|---|
| 3048 | __set(). Thx Daniel Cook. http://phplens.com/lens/lensforum/msgs.php?id=17200 |
|---|
| 3049 | <p>Removed $arg3 from mysqli SelectLimit. See http://phplens.com/lens/lensforum/msgs.php?id=16243. Thx Zsolt Szeberenyi. |
|---|
| 3050 | <p>Changed oci8 FetchField, which returns the max_length of BLOB/CLOB/NCLOB as 4000 (incorrectly) to -1. |
|---|
| 3051 | <p>CacheExecute would sometimes return an error on Windows if it was unable to lock the cache file. This is harmless |
|---|
| 3052 | and has been changed to a warning that can be ignored. Also adodb_write_file() code revised. |
|---|
| 3053 | <p>ADOdb perf code changed to only log sql if execution time >= 0.05 seconds. New $ADODB_PERF_MIN variable holds min sql timing. |
|---|
| 3054 | Any SQL with timing value below this and is not causing an error is not logged. |
|---|
| 3055 | <p>Also adodb_backtrace() now traces 1 level deeper as sometimes actual culprit function is not displayed. |
|---|
| 3056 | <p>Fixed a group by problem with adodb_getcount() for db's which are not postgres/oci8 based. |
|---|
| 3057 | <p>Changed mssql driver Parameter() from SQLCHAR to SQLVARCHAR: case 'string': $type = SQLVARCHAR; break. |
|---|
| 3058 | <p>Problem with mssql driver in php5 (for adodb 5.03) because some functions are not static. Fixed. |
|---|
| 3059 | |
|---|
| 3060 | |
|---|
| 3061 | <p><a name="4.96"></a><b>4.96/5.02 24 Sept 2007</b> |
|---|
| 3062 | <p>ADOdb perf for oci8 now has non-table-locking code when clearing the sql. Slower but better transparency. Added in 4.96a and 5.02a. |
|---|
| 3063 | <p>Fix adodb count optimisation. Preg_match did not work properly. Also rewrote the ORDER BY stripping code in _adodb_getcount(), adodb-lib.inc.php. |
|---|
| 3064 | <p>SelectLimit for oci8 not optimal for large recordsets when offset=0. Changed $nrows check. |
|---|
| 3065 | <p>Active record optimizations. |
|---|
| 3066 | Added support for assoc arrays in Set(). |
|---|
| 3067 | <p>Now GetOne returns null if EOF (no records found), and false if error occurs. Use ErrorMsg()/ErrorNo() to get the error. |
|---|
| 3068 | <p>Also CacheGetRow and CacheGetCol will return false if error occurs, or empty array() if EOF, just like GetRow and GetCol. |
|---|
| 3069 | <p>Datadict now allows changing of types which are not resizable, eg. VARCHAR to TEXT in ChangeTableSQL. -- Mateo Tibaquirá |
|---|
| 3070 | <p>Added BIT data type support to adodb-ado.inc.php and adodb-ado5.inc.php. |
|---|
| 3071 | <p>Ldap driver did not return actual ldap error messages. Fixed. |
|---|
| 3072 | <p>Implemented GetRandRow($sql, $inputarr). Optimized for Oci8. |
|---|
| 3073 | <p>Changed adodb5 active record to use static SetDatabaseAdapter() and removed php4 constructor. Bas van Beek bas.vanbeek#gmail.com. |
|---|
| 3074 | <p>Also in adodb5, changed adodb-session2 to use static function declarations in class. Thx Daniel Berlin. |
|---|
| 3075 | <p>Added "Clear SQL Log" to bottom of Performance screen. |
|---|
| 3076 | <p>Sessions2 code echo'ed directly to the screen in debug mode. Now uses ADOConnection::outp(). |
|---|
| 3077 | <p>In mysql/mysqli, qstr(null) will return the string "null" instead of empty quoted string "''". |
|---|
| 3078 | <p>postgresql optimizeTable in perf-postgres.inc.php added by Daniel Berlin (mail#daniel-berlin.de) |
|---|
| 3079 | <p>Added 5.2.1 compat code for oci8. |
|---|
| 3080 | <p>Changed @@identity to SCOPE_IDENTITY() for multiple mssql drivers. Thx Stefano Nari. |
|---|
| 3081 | <p>Code sanitization introduced in 4.95 caused problems in European locales (as float 3.2 was typecast to 3,2). Now we only sanitize if is_numeric fails. |
|---|
| 3082 | <p>Added support for customizing ADORecordset_empty using $this->rsPrefix.'empty'. By Josh Truwin. |
|---|
| 3083 | <p>Added proper support for ALterColumnSQL for Postgresql in datadict code. Thx. Josh Truwin. |
|---|
| 3084 | <p>Added better support for MetaType() in mysqli when using an array recordset. |
|---|
| 3085 | <p>Changed parser for pgsql error messages in adodb-error.inc.php to case-insensitive regex. |
|---|
| 3086 | <p><a name="4.95"></a><b>4.95/5.01 17 May 2007</b> |
|---|
| 3087 | <p>CacheFlush debug outp() passed in invalid parameters. Fixed. |
|---|
| 3088 | <p>Added Thai language file for adodb. Thx Trirat Petchsingh rosskouk#gmail.com and Marcos Pont</p> |
|---|
| 3089 | <p>Added zerofill checking support to MetaColumns for mysql and mysqli. |
|---|
| 3090 | <p>CacheFlush no longer deletes all files/directories. Only *.cache files deleted.</p> |
|---|
| 3091 | <p>DB2 timestamp format changed to var $fmtTimeStamp = "'Y-m-d-H:i:s'";</p> |
|---|
| 3092 | <p>Added some code sanitization to AutoExecute in adodb-lib.inc.php.</p> |
|---|
| 3093 | <p>Due to typo, all connections in adodb-oracle.inc.php would become persistent, even non-persistent ones. Fixed.</p> |
|---|
| 3094 | <P>Oci8 DBTimeStamp uses 24 hour time for input now, so you can perform string comparisons between 2 DBTimeStamp values.</P> |
|---|
| 3095 | <p>Some PHP4.4 compat issues fixed in adodb-session2.inc.php</p> |
|---|
| 3096 | <p>For ADOdb 5.01, fixed some adodb-datadict.inc.php MetaType compat issues with PHP5. |
|---|
| 3097 | <p>The $argHostname was wiped out in adodb-ado5.inc.php. Fixed. |
|---|
| 3098 | <p>Adodb5 version, added iterator support for adodb_recordset_empty. |
|---|
| 3099 | <p>Adodb5 version,more error checking code now will use exceptions if available. |
|---|
| 3100 | <p><a name="4.94"></a><b>4.94 23 Jan 2007</b> |
|---|
| 3101 | <p>Active Record: $ADODB_ASSOC_CASE=2 did not work properly. Fixed. Thx gmane#auxbuss.com. |
|---|
| 3102 | <p>mysqli had bugs in BeginTrans() and EndTrans(). Fixed.</p> |
|---|
| 3103 | <p>Improved error handling when no database is connected for oci8. Thx Andy Hassall.</p> |
|---|
| 3104 | <p>Names longer than 30 chars in oci8 datadict will be changed to random name. Thx Eugenio. http://phplens.com/lens/lensforum/msgs.php?id=16182 |
|---|
| 3105 | <p>Added var $upperCase = 'ucase' to access and ado_access drivers. Thx Renato De Giovanni renato#cria.org.br</p> |
|---|
| 3106 | <p>Postgres64 driver, if preparing plan failed in _query, did not handle error properly. Fixed. See http://phplens.com/lens/lensforum/msgs.php?id=16131. |
|---|
| 3107 | <p>Fixed GetActiveRecordsClass() reference bug. See http://phplens.com/lens/lensforum/msgs.php?id=16120 |
|---|
| 3108 | <p> |
|---|
| 3109 | |
|---|
| 3110 | Added handling of nulls in adodb-ado_mssql.inc.php for qstr(). Thx to Felix Rabinovich. |
|---|
| 3111 | <p> |
|---|
| 3112 | |
|---|
| 3113 | Adodb-dict contributions by Gaetano: |
|---|
| 3114 | <br> |
|---|
| 3115 | + Support for INDEX in data-dict. Example: |
|---|
| 3116 | idx_ev1. The ability to define indexes using the INDEX keyword was added in ADOdb 4.94. The following example features mutiple indexes, including a compound index idx_ev1. |
|---|
| 3117 | <pre> |
|---|
| 3118 | event_id I(11) NOTNULL AUTOINCREMENT PRIMARY, |
|---|
| 3119 | event_type I(4) NOTNULL <b>INDEX idx_evt</b>, |
|---|
| 3120 | event_start_date T DEFAULT NULL <b>INDEX id_esd</b>, |
|---|
| 3121 | event_end_date T DEFAULT '0000-00-00 00:00:00' <b>INDEX id_eted</b>, |
|---|
| 3122 | event_parent I(11) UNSIGNED NOTNULL DEFAULT 0 <b>INDEX id_evp</b>, |
|---|
| 3123 | event_owner I(11) DEFAULT 0 <b>INDEX idx_ev1</b>, |
|---|
| 3124 | event_project I(11) DEFAULT 0 <b>INDEX idx_ev1</b>, |
|---|
| 3125 | event_times_recuring I(11) UNSIGNED NOTNULL DEFAULT 0, |
|---|
| 3126 | event_icon C(20) DEFAULT 'obj/event', |
|---|
| 3127 | event_description X |
|---|
| 3128 | </pre> |
|---|
| 3129 | <br> |
|---|
| 3130 | + Prevents the generated SQL from including double drop-sequence statements for REPLACE case of tables with autoincrement columns (on those dbs that emulate it via sequences) |
|---|
| 3131 | <br> |
|---|
| 3132 | + makes any date defined as DEFAULT value for D and T columns work cross-database, not just the "sysdate" value (as long as it is specified using adodb standard format). See above example. |
|---|
| 3133 | <p>Fixed pdo's GetInsertID() support. Thx Ricky Su. |
|---|
| 3134 | <p>oci8 Prepare() now sets error messages if an error occurs. |
|---|
| 3135 | <p>Added 'PT_BR' to SetDateLocale() -- brazilian portugese. |
|---|
| 3136 | <p>charset in oci8 was not set correctly on *Connect() |
|---|
| 3137 | <p>ADOConnection::Transpose() now appends as first column the field names. |
|---|
| 3138 | <p>Added $ADODB_QUOTE_FIELDNAMES. If set to true, will autoquote field names in AutoExecute(),GetInsertSQL(), GetUpdateSQL(). |
|---|
| 3139 | <p>Transpose now adds the field names as the first column after transposition. |
|---|
| 3140 | <p>Added === check in ADODB_SetDatabaseAdapter for $db, adodb-active-record.inc.php. Thx Christian Affolter. |
|---|
| 3141 | <p>Added ErrorNo() to adodb-active-record.inc.php. Thx ante#novisplet.com. |
|---|
| 3142 | |
|---|
| 3143 | |
|---|
| 3144 | |
|---|
| 3145 | <p><a name="4.93"></a><b>4.93 10 Oct 2006</b> |
|---|
| 3146 | <p>Added support for multiple database connections in performance monitoring code (adodb-perf.inc.php). Now all sql in multiple database connections can be saved into one database ($ADODB_LOG_CONN). |
|---|
| 3147 | <p>Added MetaIndexes() to odbc_mssql. |
|---|
| 3148 | <p>Added connection property $db->null2null = 'null'. In autoexecute/getinsertsql/getupdatesql, this value will be converted to a null. Set this to a funny invalid value if you do not want null conversion. See http://phplens.com/lens/lensforum/msgs.php?id=15902. |
|---|
| 3149 | <p>Path disclosure problem in mysqli fixed. Thx Andy. |
|---|
| 3150 | <p>Fixed typo in session_schema2.xml. |
|---|
| 3151 | <p>Changed INT in oci8 to return correct precision in $fld->max_length, MetaColumns(). Thx Eloy Lafuente Plaza. |
|---|
| 3152 | <p>Patched postgres64 _connect to handle serverinfo(). see http://phplens.com/lens/lensforum/msgs.php?id=15887. |
|---|
| 3153 | <p>Added pdo fix for null columns. See http://phplens.com/lens/lensforum/msgs.php?id=15889 |
|---|
| 3154 | <p>For stored procedures, missing connection id now passed into mssql_query(). Thx Ecsy (ecsy#freemail.hu). |
|---|
| 3155 | |
|---|
| 3156 | <p><a name="4.92a"></a><b>4.92a 30 Aug 2006</b> |
|---|
| 3157 | <p>Syntax error in postgres7 driver. Thx Eloy Lafuente Plaza. |
|---|
| 3158 | <p>Minor bug fixes - adodb informix 10 types added to adodb.inc.php. Thx Fernando Ortiz. |
|---|
| 3159 | |
|---|
| 3160 | <p><a name="4.92"></a><b>4.92 29 Aug 2006</b> |
|---|
| 3161 | |
|---|
| 3162 | <p>Better odbtp date support. |
|---|
| 3163 | <P>Added IgnoreErrors() to bypass default error handling. |
|---|
| 3164 | <p>The _adodb_getcount() function in adodb-lib.inc.php, some ORDER BY bug fixes. |
|---|
| 3165 | <p>For ibase and firebird, set $sysTimeStamp = "CURRENT_TIMESTAMP". |
|---|
| 3166 | <p>Fixed postgres connection bug: http://phplens.com/lens/lensforum/msgs.php?id=11057. |
|---|
| 3167 | <p>Changed CacheSelectLimit() to flush cache when $secs2cache==-1 due to complaints from other users. |
|---|
| 3168 | <p>Added support for using memcached with CacheExecute/CacheSelectLimit. Requires memcache module PECL extension. Usage: |
|---|
| 3169 | <pre> |
|---|
| 3170 | $db = NewADOConnection($driver); |
|---|
| 3171 | $db->memCache = true; /// should we use memCache instead of caching in files |
|---|
| 3172 | $db->memCacheHost = "126.0.1.1"; /// memCache host |
|---|
| 3173 | $db->memCachePort = 11211; /// this is default memCache port |
|---|
| 3174 | $db->memCacheCompress = false; /// Use 'true' to store the item compressed (uses zlib) |
|---|
| 3175 | |
|---|
| 3176 | $db->Connect(...); |
|---|
| 3177 | $db->CacheExecute($sql); |
|---|
| 3178 | </pre> |
|---|
| 3179 | <p>Implemented Transpose() for recordsets. Recordset must be retrieved using ADODB_FETCH_NUM. First column becomes the |
|---|
| 3180 | column name. |
|---|
| 3181 | <pre> |
|---|
| 3182 | $DB = NewADOConnection('mysql'); |
|---|
| 3183 | $DB->Connect(...); |
|---|
| 3184 | $DB->SetFetchMode(ADODB_FETCH_NUM); |
|---|
| 3185 | $rs = $DB->Execute('select productname,productid,unitprice from products limit 10'); |
|---|
| 3186 | $rs2 = $DB->Transpose($rs); |
|---|
| 3187 | rs2html($rs2); |
|---|
| 3188 | </pre> |
|---|
| 3189 | <p><a name="4.91"></a><b>4.91 2 Aug 2006</b> |
|---|
| 3190 | <p>Major session code rewrite .... See session docs. |
|---|
| 3191 | <p>PDO bindinputarray was not set properly for MySQL (changed from true to false). |
|---|
| 3192 | <p>Changed CacheSelectLimit() to re-cache when $secs2cache==0. This is one way to flush the cache when SelectLimit is called. |
|---|
| 3193 | <p>Added to quotes to mysql and mysqli: "SHOW COLUMNS FROM `%s`"; |
|---|
| 3194 | <p>Removed accidental optgroup handling in GetMenu(). |
|---|
| 3195 | <a>Fixed ibase _BlobDecode for php5 compat, and also mem alloc issues for small blobs, thx salvatori#interia.pl |
|---|
| 3196 | <p>Mysql driver OffsetDate() speedup, useful for adodb-sessions. |
|---|
| 3197 | <p>Fix for GetAssoc() PHP5 compat. See http://phplens.com/lens/lensforum/msgs.php?id=15425 |
|---|
| 3198 | <p>Active Record - If inserting a record and the value of a primary key field is null, then we do not insert that field in as we assume it is an auto-increment field. Needed by mssql. |
|---|
| 3199 | <p>Changed postgres7 MetaForeignKeys() see http://phplens.com/lens/lensforum/msgs.php?id=15531 |
|---|
| 3200 | <p>DB2 will now return db2_conn_errormsg() when it is a connection error. |
|---|
| 3201 | <p><a name="4.90"></a><b>4.90 8 June 2006</b> |
|---|
| 3202 | <p>Changed adodb_countrec() in adodb-lib.inc.php to allow LIMIT to be used as a speedup to reduce no of records counted. |
|---|
| 3203 | <p>Added support for transaction modes for postgres and oci8 with SetTransactionMode(). |
|---|
| 3204 | These transaction modes affect all subsequent transactions of that connection. |
|---|
| 3205 | <p>Thanks to Halmai Csongor for suggestion. |
|---|
| 3206 | <p>Removed $off = $fieldOffset - 1 line in db2 driver, FetchField(). Tx Larry Menard. |
|---|
| 3207 | <p>Added support for PHP5 objects as Execute() bind parameters using __toString (eg. Simple-XML). Thx Carl-Christian Salvesen. |
|---|
| 3208 | <p>Rounding in tohtml.inc.php did not work properly. Fixed. |
|---|
| 3209 | <p>MetaIndexes in postgres fails when fields are deleted then added in again because the attnum has gaps in it. |
|---|
| 3210 | See http://sourceforge.net/tracker/index.php?func=detail&aid=1451245&group_id=42718&atid=433976. Fixed. |
|---|
| 3211 | <p>MetaForeignkeys in mysql and mysqli did not work when fetchMode==ADODB_FETCH_ASSOC used. Fixed. |
|---|
| 3212 | <p>Reference error in AutoExecute() fixed. |
|---|
| 3213 | <p>Added macaddr postgres type to MetaType. Maps to 'C'. |
|---|
| 3214 | <p>Added to _connect() in adodb-ado5.inc.php support for $database and $dataProvider parameters. Thx Larry Menard. |
|---|
| 3215 | <p>Added support for sequences in adodb-ado_mssql.inc.php. Thx Larry Menard. |
|---|
| 3216 | <p>Added ADODB_SESSION_READONLY. |
|---|
| 3217 | <p>Added session expiryref support to crc32 mode, and in LOB code. |
|---|
| 3218 | <p>Clear _errorMsg in postgres7 driver, so that ErrorMsg() displays properly when no error occurs. |
|---|
| 3219 | <p>Added BindDate and BindTimeStamp |
|---|
| 3220 | <p><a name="4.81"></a><b>4.81 3 May 2006</b> |
|---|
| 3221 | <p>Fixed variable ref errors in adodb-ado5.inc.php in _query(). |
|---|
| 3222 | <p>Mysqli setcharset fix using method_exists(). |
|---|
| 3223 | <p>The adodb-perf.inc.php CreateLogTable() code now works for user-defined table names. |
|---|
| 3224 | <p>Error in ibase_blob_open() fixed. See http://phplens.com/lens/lensforum/msgs.php?id=14997 |
|---|
| 3225 | <p><a name="4.80"></a><b>4.80 8 Mar 2006</b> |
|---|
| 3226 | <p>Added activerecord support. |
|---|
| 3227 | <p>Added mysql $conn->compat323 = true if you want MySQL 3.23 compat enabled. Fixes GetOne() Select-Limit problems. |
|---|
| 3228 | <p>Added adodb-xmlschema03.inc.php to support XML Schema version 3 and updated adodb-datadict.htm docs. |
|---|
| 3229 | <p>Better memory management in Execute. Thx Mike Fedyk. |
|---|
| 3230 | <p><a name="4.72"></a><b>4.72 21 Feb 2006</b> |
|---|
| 3231 | <p>Added 'new' DSN parameter for NConnect(). |
|---|
| 3232 | <p>Pager now sanitizes $PHP_SELF to protect against XSS. Thx to James Bercegay and others. |
|---|
| 3233 | <p>ADOConnection::MetaType changed to setup $rs->connection correctly. |
|---|
| 3234 | <p>New native DB2 driver contributed by Larry Menard, Dan Scott, Andy Staudacher, Bharat Mediratta. |
|---|
| 3235 | <p>The mssql CreateSequence() did not BEGIN TRANSACTION correctly. Fixed. Thx Sean Lee. |
|---|
| 3236 | <p>The _adodb_countrecs() function in adodb-lib.inc.php has been revised to handle more ORDER BY variations. |
|---|
| 3237 | <p><a name="4.71"></a><b>4.71 24 Jan 2006</b> |
|---|
| 3238 | <p>Fixes postgresql security issue related to binary strings. Thx to Andy Staudacher. |
|---|
| 3239 | <p>Several DSN bugs found: |
|---|
| 3240 | <p>1. Fix bugs in DSN connections introduced in 4.70 when underscores are found in the DSN. |
|---|
| 3241 | <p>2. DSN with _ did not work properly in PHP5 (fine in PHP4). Fixed. |
|---|
| 3242 | <p>3. Added support for PDO DSN connections in NewADOConnection(), and database parameter in PDO::Connect(). |
|---|
| 3243 | <p>The oci8 datetime flag not correctly implemented in ADORecordSet_array. Fixed. |
|---|
| 3244 | <p>Added BlobDelete() to postgres, as a counterpoint to UpdateBlobFile(). |
|---|
| 3245 | <p>Fixed GetInsertSQL() to support oci8po. |
|---|
| 3246 | <p>Fixed qstr() issue with postgresql with \0 in strings. |
|---|
| 3247 | <p>Fixed some datadict driver loading issues in _adodb_getdriver(). |
|---|
| 3248 | <p>Added register shutdown function session_write_close in adodb-session.inc.php for PHP 5 compat. See http://phplens.com/lens/lensforum/msgs.php?id=14200. |
|---|
| 3249 | <p><a name="4.70"></a><b>4.70 6 Jan 2006</b> |
|---|
| 3250 | <p>Many fixes from Danila Ulyanov to ibase, oci8, postgres, mssql, odbc_oracle, odbtp, etc drivers. |
|---|
| 3251 | <p>Changed usage of binary hint in adodb-session.inc.php for mysql. See |
|---|
| 3252 | http://phplens.com/lens/lensforum/msgs.php?id=14160 |
|---|
| 3253 | <p>Fixed invalid variable reference problem in undomq(), adodb-perf.inc.php. |
|---|
| 3254 | <p>Fixed http://phplens.com/lens/lensforum/msgs.php?id=14254 in adodb-perf.inc.php, _DBParameter() settings of fetchmode was wrong. |
|---|
| 3255 | <p>Fixed security issues in server.php and tmssql.php discussed by Andreas Sandblad in a Secunia security advisory. Added $ACCEPTIP = 127.0.0.1 |
|---|
| 3256 | and changed suggested root password to something more secure. |
|---|
| 3257 | <p>Changed pager to close recordset after RenderLayout(). |
|---|
| 3258 | <p><a name="4.68"></a><b>4.68 25 Nov 2005</b> |
|---|
| 3259 | <p>PHP 5 compat for mysqli. MetaForeignKeys repeated twice and MYSQLI_BINARY_FLAG missing. |
|---|
| 3260 | <p>PHP 5.1 support for postgresql bind parameters using ? did not work if >= 10 parameters. Fixed. Thx to Stanislav Shramko. |
|---|
| 3261 | <p>Lots of PDO improvements. |
|---|
| 3262 | <p>Spelling error fixed in mysql MetaForeignKeys, $associative parameter. |
|---|
| 3263 | <p><a name="4.67"></a><b>4.67 16 Nov 2005</b> |
|---|
| 3264 | <p>Postgresql not_null flag not set to false correctly. Thx Cristian MARIN. |
|---|
| 3265 | <p>We now check in Replace() if key is in fieldArray. Thx Sébastien Vanvelthem. |
|---|
| 3266 | <p>_file_get_contents() function was missing in xmlschema. fixed. |
|---|
| 3267 | <p>Added week in year support to SQLDate(), using 'W' flag. Thx Spider. |
|---|
| 3268 | <p>In sqlite metacolumns was repeated twice, causing PHP 5 problems. Fixed. |
|---|
| 3269 | <p>Made debug output XHTML compliant. |
|---|
| 3270 | <p><a name="4.66"></a><b>4.66 28 Sept 2005</b> |
|---|
| 3271 | <p>ExecuteCursor() in oci8 did not clean up properly on failure. Fixed. |
|---|
| 3272 | <p>Updated xmlschema.dtd, by "Alec Smecher" asmecher#smecher.bc.ca |
|---|
| 3273 | <p>Hardened SelectLimit, typecasting nrows and offset to integer. |
|---|
| 3274 | <p>Fixed misc bugs in AutoExecute() and GetInsertSQL(). |
|---|
| 3275 | <p>Added $conn->database as the property holding the database name. The older $conn->databaseName is retained for backward |
|---|
| 3276 | compat. |
|---|
| 3277 | <p>Changed _adodb_backtrace() compat check to use function_exists(). |
|---|
| 3278 | <p>Bug in postgresql MetaIndexes fixed. Thx Kevin Jamieson. |
|---|
| 3279 | <p>Improved OffsetDate for MySQL, reducing rounding error. |
|---|
| 3280 | <p>Metacolumns added to sqlite. Thx Mark Newnham. |
|---|
| 3281 | <p>PHP 4.4 compat fixes for GetAssoc(). |
|---|
| 3282 | <p>Added postgresql bind support for php 5.1. Thx Cristiano da Cunha Duarte |
|---|
| 3283 | <p>OffsetDate() fixes for postgresql, typecasting strings to date or timestamp. |
|---|
| 3284 | <p>DBTimeStamp formats for mssql, odbc_mssql and postgresql made to conform with other db's. |
|---|
| 3285 | <p>Changed PDO constants from PDO_ to PDO:: to support latest spec. |
|---|
| 3286 | <p><a name="4.65"></a><b>4.65 22 July 2005</b> |
|---|
| 3287 | <p>Reverted 'X' in mssql datadict to 'TEXT' to be compat with mssql driver. However now you can |
|---|
| 3288 | set $datadict->typeX = 'varchar(4000)' or 'TEXT' or 'CLOB' for mssql and oci8 drivers. |
|---|
| 3289 | <p>Added charset support when using DSN for Oracle. |
|---|
| 3290 | <p>_adodb_getmenu did not use fieldcount() to get number of fields. Fixed. |
|---|
| 3291 | <p>MetaForeignKeys() for mysql/mysqli contributed by Juan Carlos Gonzalez. |
|---|
| 3292 | <p>MetaDatabases() now correctly returns an array for mysqli driver. Thx Cristian MARIN. |
|---|
| 3293 | <p>CompleteTrans(false) did not return false. Fixed. Thx to JMF. |
|---|
| 3294 | <p>AutoExecute() did not work with Oracle. Fixed. Thx José Moreira. |
|---|
| 3295 | <p>MetaType() added to connection object. |
|---|
| 3296 | <p>More PHP 4.4 reference return fixes. Thx Ryan C Bonham and others. |
|---|
| 3297 | |
|---|
| 3298 | <p><a name="4.64"></a><b>4.64 20 June 2005</b> |
|---|
| 3299 | <p>In datadict, if the default field value is set to '', then it is not applied when the field is created. Fixed by Eugenio. |
|---|
| 3300 | <p>MetaPrimaryKeys for postgres did not work because of true/false change in 4.63. Fixed. |
|---|
| 3301 | <p>Tested ocifetchstatement in oci8. Rejected at the end. |
|---|
| 3302 | <p>Added port to dsn handling. Supported in postgres, mysql, mysqli,ldap. |
|---|
| 3303 | <p>Added 'w' and 'l' to mysqli SQLDate(). |
|---|
| 3304 | <p>Fixed error handling in ldap _connect() to be more consistent. Also added ErrorMsg() handling to ldap. |
|---|
| 3305 | <p>Added support for union in _adodb_getcount, adodb-lib.inc.php for postgres and oci8. |
|---|
| 3306 | <p>rs2html() did not work with null dates properly. |
|---|
| 3307 | <p>PHP 4.4 reference return fixes. |
|---|
| 3308 | |
|---|
| 3309 | <p><a name="4.63"></a><b>4.63 18 May 2005</b> |
|---|
| 3310 | <p>Added $nrows<0 check to mysqli's SelectLimit(). |
|---|
| 3311 | <p>Added OptimizeTable() and OptimizeTables() in adodb-perf.inc.php. By Markus Staab. |
|---|
| 3312 | <p>PostgreSQL inconsistencies fixed. true and false set to TRUE and FALSE, and boolean type in datadict-postgres.inc.php set |
|---|
| 3313 | to 'L' => 'BOOLEAN'. Thx Kevin Jamieson. |
|---|
| 3314 | <p>New adodb_session_create_table() function in adodb-session.inc.php. By Markus Staab. |
|---|
| 3315 | <p>Added null check to UserTimeStamp(). |
|---|
| 3316 | <p>Fixed typo in mysqlt driver in adorecordset. Thx to Andy Staudacher. |
|---|
| 3317 | <p>GenID() had a bug in the raiseErrorFn handling. Fixed. Thx Marcos Pont. |
|---|
| 3318 | <p>Datadict name quoting now handles ( ) in index fields correctly - they aren't part of the index field. |
|---|
| 3319 | <p>Performance monitoring: (1) oci8 Ixora checks moved down; (2) expensive sql changed so that only those sql with |
|---|
| 3320 | count(*)>1 are shown; (3) changed sql1 field to a length+crc32 checksum - this breaks backward compat. |
|---|
| 3321 | <p>We remap firebird15 to firebird in data dictionary. |
|---|
| 3322 | |
|---|
| 3323 | <p><a name="4.62"></a><b>4.62 2 Apr 2005</b> |
|---|
| 3324 | <p>Added 'w' (dow as 0-6 or 1-7) and 'l' (dow as string) for SQLDate for oci8, postgres and mysql. |
|---|
| 3325 | <p>Rolled back MetaType() changes for mysqli done in prev version. |
|---|
| 3326 | <p>Datadict change by chris, cblin#tennaxia.com data mappings from: |
|---|
| 3327 | <pre> |
|---|
| 3328 | oci8: X->varchar(4000) XL->CLOB |
|---|
| 3329 | mssql: X->XL->TEXT |
|---|
| 3330 | mysql: X->XL->LONGTEXT |
|---|
| 3331 | fbird: X->XL->varchar(4000) |
|---|
| 3332 | </pre> |
|---|
| 3333 | <p>to: |
|---|
| 3334 | <pre> |
|---|
| 3335 | oci8: X->varchar(4000) XL->CLOB |
|---|
| 3336 | mssql: X->VARCHAR(4000) XL->TEXT |
|---|
| 3337 | mysql: X->TEXT XL->LONGTEXT |
|---|
| 3338 | fbird: X->VARCHAR(4000) XL->VARCHAR(32000) |
|---|
| 3339 | </pre> |
|---|
| 3340 | <p>Added $connection->disableBlobs to postgresql to improve performance when no bytea is used (2-5% improvement). |
|---|
| 3341 | <p>Removed all HTTP_* vars. |
|---|
| 3342 | <p>Added $rs->tableName to be set before calling AutoExecute(). |
|---|
| 3343 | <p>Alex Rootoff rootoff#pisem.net contributed ukrainian language file. |
|---|
| 3344 | <p>Added new mysql_option() support using $conn->optionFlags array. |
|---|
| 3345 | <p>Added support for ldap_set_option() using the $LDAP_CONNECT_OPTIONS global variable. Contributed by Josh Eldridge. |
|---|
| 3346 | <p>Added LDAP_* constant definitions to ldap. |
|---|
| 3347 | <p>Added support for boolean bind variables. We use $conn->false and $conn->true to hold values to set false/true to. |
|---|
| 3348 | <p>We now do not close the session connection in adodb-session.inc.php as other objects could be using this connection. |
|---|
| 3349 | <p>We now strip off \0 at end of Ixora SQL strings in $perf->tohtml() for oci8. |
|---|
| 3350 | <p><a name="4.61"></a><b>4.61 23 Feb 2005</b> |
|---|
| 3351 | <p>MySQLi added support for mysqli_connect_errno() and mysqli_connect_error(). |
|---|
| 3352 | <p>Massive improvements to alpha PDO driver. |
|---|
| 3353 | <p>Quote string bind parameters logged by performance monitor for easy type checking. Thx Jason Judge. |
|---|
| 3354 | <p>Added support for $role when connecting with Interbase/firebird. |
|---|
| 3355 | <p>Added support for enum recognition in MetaColumns() mysql and mysqli. Thx Amedeo Petrella. |
|---|
| 3356 | <p>The sybase_ase driver contributed by Interakt Online. Thx Cristian Marin cristic#interaktonline.com. |
|---|
| 3357 | <p>Removed not_null, has_default, and default_value from ADOFieldObject. |
|---|
| 3358 | <p>Sessions code, fixed quoting of keys when handling LOBs in session write() function. |
|---|
| 3359 | <p>Sessions code, added adodb_session_regenerate_id(), to reduce risk of session hijacking by changing session cookie dynamically. Thx Joe Li. |
|---|
| 3360 | <p>Perf monitor, polling for CPU did not work for PHP 4.3.10 and 5.0.0-5.0.3 due to PHP bugs, so we special case these versions. |
|---|
| 3361 | <p>Postgresql, UpdateBlob() added code to handle type==CLOB. |
|---|
| 3362 | <p><a name="4.60"></a><b>4.60 24 Jan 2005</b> |
|---|
| 3363 | <p>Implemented PEAR DB's autoExecute(). Simplified design because I don't like using constants when |
|---|
| 3364 | strings work fine. |
|---|
| 3365 | <p>_rs2serialize will now update $rs->sql and $rs->oldProvider. |
|---|
| 3366 | <p>Added autoExecute(). |
|---|
| 3367 | <p>Added support for postgres8 driver. Currently just remapped to postgres7 driver. |
|---|
| 3368 | <p>Changed oci8 _query(), so that OCIBindByName() sets the length to -1 if element size is > 4000. This provides better support |
|---|
| 3369 | for LONGs. |
|---|
| 3370 | <p>Added SetDateLocale() support for netherlands (Nl). |
|---|
| 3371 | <p>Spelling error in pivot code ($iff should be $iif). |
|---|
| 3372 | </p><p>mysql insert_id() did not work with mysql 3.x. Fixed. |
|---|
| 3373 | </p><p>"\r\n" not converted to spaces correctly in exporting data. Fixed. |
|---|
| 3374 | </p><p>_nconnect() in mysqli did not return value correctly. Fixed. |
|---|
| 3375 | </p><p>Arne Eckmann contributed danish language file. |
|---|
| 3376 | </p><p>Added clone() support to FetchObject() for PHP5.<br> |
|---|
| 3377 | </p> |
|---|
| 3378 | <p>Removed SQL_CUR_USE_ODBC from odbc_mssql.<br> |
|---|
| 3379 | </p> |
|---|
| 3380 | <p><a name="4.55"></a><b>4.55 5 Jan 2005</b> |
|---|
| 3381 | </p><p>Found bug in Execute() with bind params for db's that do not support binding natively. |
|---|
| 3382 | </p><p>DropSequence() now correctly uses default parameter. |
|---|
| 3383 | </p><p>Now Execute() ignores locale for floats, so 1.23 is NEVER converted to 1,23. |
|---|
| 3384 | </p><p>SetFetchMode() not properly saved in adodb-perf, suspicious sql and expensive sql. Fixed. |
|---|
| 3385 | </p><p>Added INET to postgresql metatypes. Thx motzel. |
|---|
| 3386 | </p><p>Allow oracle hints to work when counting with _adodb_getcount in adodb-lib.inc.php. Thx Chris Wrye. |
|---|
| 3387 | </p><p>Changed mysql insert_id() to use SELECT LAST_INSERT_ID(). |
|---|
| 3388 | </p><p>If alter col in datadict does not modify col type/size of actual |
|---|
| 3389 | col, then it is removed from alter col code. By Mark Newham. Not |
|---|
| 3390 | perfect as MetaType() !== ActualType(). |
|---|
| 3391 | </p><p>Added handling of view fields in metacolumns() for postgresql. Thx Renato De Giovanni. |
|---|
| 3392 | </p><p>Added to informix MetaPrimaryKeys and MetaColumns fixes for null bit. Thx to Cecilio Albero. |
|---|
| 3393 | </p><p>Removed obsolete connection_timeout() from perf code. |
|---|
| 3394 | </p><p>Added support for arrayClass in adodb-csv.inc.php. |
|---|
| 3395 | </p><p>RSFilter now accepts methods of the form $array($obj, 'methodname'). Thx to blake#near-time.com. |
|---|
| 3396 | </p><p>Changed CacheFlush to $cmd = 'rm -rf '.$ADODB_CACHE_DIR.'/[0-9a-f][0-9a-f]/'; |
|---|
| 3397 | </p><p>For better cursor concurrency, added code to free ref cursors in |
|---|
| 3398 | oci8 when $rs->Close() is called. Note that CLose() is called |
|---|
| 3399 | internally by the Get* functions too. |
|---|
| 3400 | </p><p>Added IIF support for access when pivoting. Thx Volodia Krupach. |
|---|
| 3401 | </p><p>Added mssql datadict support for timestamp. Thx Alexios. |
|---|
| 3402 | </p><p>Informix pager fix. By Mario Ramirez. |
|---|
| 3403 | </p><p>ADODB_TABLE_REGEX now includes ':'. By Mario Ramirez. |
|---|
| 3404 | </p><p>Mark Newnham contributed MetaIndexes for oci8 and db2. |
|---|
| 3405 | </p><p><a name="4.54"></a><b>4.54 5 Nov 2004</b> |
|---|
| 3406 | </p><p> |
|---|
| 3407 | Now you can set $db->charSet = ?? before doing a Connect() in oci8. |
|---|
| 3408 | </p><p> |
|---|
| 3409 | Added adodbFetchMode to sqlite. |
|---|
| 3410 | </p><p> |
|---|
| 3411 | Perf code, added a string typecast to substr in adodb_log_sql(). |
|---|
| 3412 | </p><p> |
|---|
| 3413 | Postgres: Changed BlobDecode() to use po_loread, added new $maxblobsize parameter, and now it returns the blob instead |
|---|
| 3414 | of sending it to stdout - make sure to mention that as a compat warning. |
|---|
| 3415 | Also added $db->IsOID($oid) function; uses a heuristic, not guaranteed to work 100%. |
|---|
| 3416 | </p><p> |
|---|
| 3417 | Contributed arabic language file by "El-Shamaa, Khaled" k.el-shamaa#cgiar.org |
|---|
| 3418 | </p><p> |
|---|
| 3419 | PHP5 exceptions did not handle @ protocol properly. Fixed. |
|---|
| 3420 | </p><p> |
|---|
| 3421 | Added ifnull handling for postgresql (using coalesce). |
|---|
| 3422 | </p><p> |
|---|
| 3423 | Added metatables() support for Postgresql 8.0 (no longer uses pg_% dictionary tables). |
|---|
| 3424 | </p><p> |
|---|
| 3425 | Improved Sybase ErrorMsg() function. By Gaetano Giunta. |
|---|
| 3426 | </p><p> |
|---|
| 3427 | Improved oci8 SelectLimit() to use Prepare(). By Cristiano Duarte. |
|---|
| 3428 | </p><p> |
|---|
| 3429 | Type-cast $row parameter in ifx_fetch_row() to int. Thx stefan bodgan. |
|---|
| 3430 | </p><p>Ralf becker contributed improvements in postgresql, sapdb, mysql data dictionary handling:<br> |
|---|
| 3431 | - MySql and Postgres MetaType was reporting every int column which was |
|---|
| 3432 | part of a primary key and unique as serial<br> |
|---|
| 3433 | - Postgres was not reporting the scale of decimal types<br> |
|---|
| 3434 | - MaxDB was padding the defaults of none-string types with spaces<br> |
|---|
| 3435 | - MySql now correctly converts enum columns to varchar |
|---|
| 3436 | </p><p> |
|---|
| 3437 | Ralf also changed Postgresql datadict:<br> |
|---|
| 3438 | - you cant add NOT NULL columns in postgres in one go, they need to be |
|---|
| 3439 | added as NULL and then altered to NOT NULL<br> |
|---|
| 3440 | - AlterColumnSQL could not change a varchar column with numbers into an |
|---|
| 3441 | integer column, postgres need an explicit conversation<br> |
|---|
| 3442 | - a re-created sequence was not set to the correct value, if the name |
|---|
| 3443 | was the old name (no implicit sequence), now always the new name of the |
|---|
| 3444 | implicit sequence is used<br> |
|---|
| 3445 | </p><p>Sergio Strampelli added extra $intoken check to Lens_ParseArgs() in datadict code. |
|---|
| 3446 | </p><p><a name="4.53"></a><b>4.53 28 Sept 2004</b> |
|---|
| 3447 | </p><p>FetchMode cached in recordset is sometimes mapped to native db fetchMode. Normally this does not matter, |
|---|
| 3448 | but when using cached recordsets, we need to switch back to using adodb fetchmode. So we cache this |
|---|
| 3449 | in $rs->adodbFetchMode if it differs from the db's fetchMode. |
|---|
| 3450 | </p><p>For informix we now set canSeek = false driver because stefan bodgan tells me that seeking doesn't work. |
|---|
| 3451 | </p><p>SetDateLocale() never worked till now ;-) Thx david#tomato.it |
|---|
| 3452 | </p><p>Set $_bindInputArray = true in sapdb driver. Required for clob support. |
|---|
| 3453 | </p><p>Fixed some PEAR::DB emulation issues with isError() and isWarning. Thx to Gert-Rainer Bitterlich. |
|---|
| 3454 | </p><p>Empty() used in getupdatesql without strlen() check. Fixed.</p> |
|---|
| 3455 | <p>Added unsigned detection to mysql and mysqli drivers. Thx to dan cech. |
|---|
| 3456 | </p><p>Added hungarian language file. Thx to Halászvári Gábor. |
|---|
| 3457 | </p><p>Improved fieldname-type formatting of datadict SQL generated (adding $widespacing parameter to _GenField). |
|---|
| 3458 | </p><p>Datadict oci8 DROP CONSTRAINTS misspelt. Fixed. Thx Mark Newnham. |
|---|
| 3459 | </p><p>Changed odbtp to dynamically change databaseType based on connection, eg. from 'odbtp' to 'odbtp_mssql' when connecting |
|---|
| 3460 | to mssql database. |
|---|
| 3461 | </p><p>In datadict, MySQL I4 was wrongly mapped to MEDIUMINT, which is actually I3. Fixed. |
|---|
| 3462 | </p><p>Fixed mysqli MetaType() recognition. Mysqli returns numeric types unlike mysql extension. Thx Francesco Riosa. |
|---|
| 3463 | </p><p>VFP odbc driver curmode set wrongly, causing problems with memo fields. Fixed. |
|---|
| 3464 | </p><p>Odbc driver did not recognize odbc version 2 driver date types properly. Fixed. Thx Bostjan. |
|---|
| 3465 | </p><p>ChangeTableSQL() fixes to datadict-db2.inc.php by Mark Newnham. |
|---|
| 3466 | </p><p>Perf monitoring with odbc improved. Now we try in perf code to manually set the sysTimeStamp using date() if sysTimeStamp |
|---|
| 3467 | is empty. |
|---|
| 3468 | </p><p>All ADO errors are thrown as exceptions in PHP5. |
|---|
| 3469 | So we added exception handling to ado in PHP5 by creating new adodb-ado5.inc.php driver. |
|---|
| 3470 | </p><p>Added IsConnected(). Returns true if connection object connected. By Luca.Gioppo. |
|---|
| 3471 | </p><p>"Ralf Becker" |
|---|
| 3472 | RalfBecker#digitalROCK.de contributed new sapdb data-dictionary driver |
|---|
| 3473 | and a large patch that implements field and table renaming for oracle, |
|---|
| 3474 | mssql, postgresql, mysql and sapdb. See the new RenameTableSQL() and |
|---|
| 3475 | RenameColumnSQL() functions. |
|---|
| 3476 | </p><p>We now check ExecuteCursor to see if PrepareSP was initially called. |
|---|
| 3477 | </p><p>Changed oci8 datadict to use MODIFY for $dd->alterCol. Thx Mark Newnham. |
|---|
| 3478 | </p><p><a name="4.52"></a><b>4.52 10 Aug 2004</b> |
|---|
| 3479 | </p><p>Bug found in Replace() when performance logging enabled, introduced in ADOdb 4.50. Fixed. |
|---|
| 3480 | </p><p>Replace() checks update stmt. If update stmt fails, we now return immediately. Thx to alex. |
|---|
| 3481 | </p><p>Added support for $ADODB_FORCE_TYPE in GetUpdateSQL/GetInsertSQL. Thx to niko. |
|---|
| 3482 | </p><p>Added ADODB_ASSOC_CASE support to postgres/postgres7 driver. |
|---|
| 3483 | </p><p>Support for DECLARE stmt in oci8. Thx Lochbrunner. |
|---|
| 3484 | </p><p><a name="4.51"></a><b>4.51 29 July 2004</b> |
|---|
| 3485 | </p><p>Added adodb-xmlschema 1.0.2. Thx dan and richard. |
|---|
| 3486 | </p><p>Added new adorecordset_ext_* classes. If ADOdb extension installed for mysql, mysqlt and oci8 |
|---|
| 3487 | (but not oci8po), we use the superfast ADOdb extension code for movenext. |
|---|
| 3488 | </p><p>Added schema support to mssql and odbc_mssql MetaPrimaryKeys(). |
|---|
| 3489 | </p><p>Patched MSSQL driver to support PHP NULL and Boolean values |
|---|
| 3490 | while binding the input array parameters in the _query() function. By Stephen Farmer. |
|---|
| 3491 | </p><p>Added support for clob's for mssql, UpdateBlob(). Thx to gfran#directa.com.br |
|---|
| 3492 | </p><p>Added normalize support for postgresql (true=lowercase table name, or false=case-sensitive table names) |
|---|
| 3493 | to MetaColumns($table, $normalize=true). |
|---|
| 3494 | </p><p>PHP5 variant dates in ADO not working. Fixed in adodb-ado.inc.php. |
|---|
| 3495 | </p><p>Constant ADODB_FORCE_NULLS was not working properly for many releases (for GetUpdateSQL). Fixed. |
|---|
| 3496 | Also GetUpdateSQL strips off ORDER BY now - thx Elieser Leão. |
|---|
| 3497 | </p><p>Perf Monitor for oci8 now dynamically highlights optimizer_* params if too high/low. |
|---|
| 3498 | </p><p>Added dsn support to NewADOConnection/ADONewConnection. |
|---|
| 3499 | </p><p>Fixed out of page bounds bug in _adodb_pageexecute_all_rows() Thx to "Sergio Strampelli" sergio#rir.it |
|---|
| 3500 | </p><p>Speedup of movenext for mysql and oci8 drivers. |
|---|
| 3501 | </p><p>Moved debugging code _adodb_debug_execute() to adodb-lib.inc.php. |
|---|
| 3502 | </p><p>Fixed postgresql bytea detection bug. See http://phplens.com/lens/lensforum/msgs.php?id=9849. |
|---|
| 3503 | </p><p>Fixed ibase datetimestamp typo in PHP5. Thx stefan. |
|---|
| 3504 | </p><p>Removed whitespace at end of odbtp drivers. |
|---|
| 3505 | </p><p>Added db2 metaprimarykeys fix. |
|---|
| 3506 | </p><p>Optimizations to MoveNext() for mysql and oci8. Misc speedups to Get* functions. |
|---|
| 3507 | </p><p><a name="4.50"></a><b>4.50 6 July 2004</b> |
|---|
| 3508 | </p><p>Bumped it to 4.50 to avoid confusion with PHP 4.3.x series. |
|---|
| 3509 | </p><p>Added db2 metatables and metacolumns extensions. |
|---|
| 3510 | </p><p>Added alpha PDO driver. Very buggy, only works with odbc. |
|---|
| 3511 | </p><p>Tested mysqli. Set poorAffectedRows = true. Cleaned up movenext() and _fetch(). |
|---|
| 3512 | </p><p>PageExecute does not work properly with php5 (return val not a variable). Reported Dmytro Sychevsky sych#php.com.ua. Fixed. |
|---|
| 3513 | </p><p>MetaTables() for mysql, $showschema parameter was not backward compatible with older versions of adodb. Fixed. |
|---|
| 3514 | </p><p>Changed mysql GetOne() to work with mysql 3.23 when using with non-select stmts (e.g. SHOW TABLES). |
|---|
| 3515 | </p><p>Changed TRIG_ prefix to a variable in datadict-oci8.inc.php. Thx to Luca.Gioppo#csi.it. |
|---|
| 3516 | </p><p>New to adodb-time code. We allow you to define your own daylights savings function, |
|---|
| 3517 | adodb_daylight_sv for pre-1970 dates. If the function is defined |
|---|
| 3518 | (somewhere in an include), then you can correct |
|---|
| 3519 | for daylights savings. See http://phplens.com/phpeverywhere/node/view/16#daylightsavings |
|---|
| 3520 | for more info. |
|---|
| 3521 | </p><p>New sqlitepo driver. This is because assoc mode does not work like other drivers in sqlite. |
|---|
| 3522 | Namely, when selecting (joining) multiple tables, in assoc mode the table |
|---|
| 3523 | names are included in the assoc keys in the "sqlite" driver. |
|---|
| 3524 | In "sqlitepo" driver, the table names are stripped from the returned column names. |
|---|
| 3525 | When this results in a conflict, the first field get preference. |
|---|
| 3526 | Contributed by Herman Kuiper herman#ozuzo.net |
|---|
| 3527 | </p><p>Added $forcenull parameter to GetInsertSQL/GetUpdateSQL. Idea by Marco Aurelio Silva. |
|---|
| 3528 | </p><p>More XHTML changes for GetMenu. By Jeremy Evans. |
|---|
| 3529 | </p><p>Fixes some ibase date issues. Thx to stefan bogdan. |
|---|
| 3530 | </p><p>Improvements to mysqli driver to support $ADODB_COUNTRECS. |
|---|
| 3531 | </p><p>Fixed adodb-csvlib.inc.php problem when reading stream from socket. We need to poll stream continiously. |
|---|
| 3532 | </p><p><a name="4.23"></a><b>4.23 16 June 2004</b> |
|---|
| 3533 | </p><p> |
|---|
| 3534 | New interbase/firebird fixes thx to Lester Caine. |
|---|
| 3535 | Driver fixes a problem with getting field names in the result array, and |
|---|
| 3536 | corrects a couple of data conversions. Also we default to dialect3 for firebird. |
|---|
| 3537 | Also ibase sysDate property was wrong. Changed to cast as timestamp. |
|---|
| 3538 | </p><p> |
|---|
| 3539 | The datadict driver is set up to give quoted tables and fields as this |
|---|
| 3540 | was the only way round reserved words being used as field names in |
|---|
| 3541 | TikiWiki. TikiPro is tidying that up, and I hope to be able to produce a |
|---|
| 3542 | build of THAT which uses what I consider proper UPPERCASE field and |
|---|
| 3543 | table names. The conversion of TikiWiki to ADOdb helped in that, but |
|---|
| 3544 | until the database is completely tidied up in TikiPro ... |
|---|
| 3545 | </p><p>Modified _gencachename() to include fetchmode in name hash. |
|---|
| 3546 | This means you should clear your cache directory after installing this release as the |
|---|
| 3547 | cache name algorithm has changed. |
|---|
| 3548 | </p><p>Now Cache* functions work in safe |
|---|
| 3549 | mode, because we do not create sub-directories in the $ADODB_CACHE_DIR |
|---|
| 3550 | in safe mode. In non-safe mode we still create sub-directories. Done by |
|---|
| 3551 | modifying _gencachename(). |
|---|
| 3552 | </p><p>Added $gmt parameter (true/false) |
|---|
| 3553 | to UserDate and UserTimeStamp in connection class, to force conversion |
|---|
| 3554 | of input (in local time) to be converted to UTC/GMT. |
|---|
| 3555 | </p><p>Mssql datadict did not support INT types properly (no size param allowed). |
|---|
| 3556 | Added _GetSize() to datadict-mssql.inc.php. |
|---|
| 3557 | </p><p>For borland_ibase, BeginTrans(), changed:<br> |
|---|
| 3558 | </p><pre> $this->_transactionID = $this->_connectionID;</pre> |
|---|
| 3559 | to<br> |
|---|
| 3560 | <pre> $this->_transactionID = ibase_trans($this->ibasetrans, $this->_connectionID);</pre> |
|---|
| 3561 | |
|---|
| 3562 | <p>Fixed typo in mysqi_field_seek(). Thx to Sh4dow (sh4dow#php.pl). |
|---|
| 3563 | </p><p>LogSQL did not work with Firebird/Interbase. Fixed. |
|---|
| 3564 | </p><p>Postgres: made errorno() handling more consistent. Thx to Michael Jahn, Michael.Jahn#mailbox.tu-dresden.de. |
|---|
| 3565 | </p><p>Added informix patch to better support metatables, metacolumns by "Cecilio Albero" c-albero#eos-i.com |
|---|
| 3566 | </p><p>Cyril Malevanov contributed patch to oci8 to support passing of LOB parameters: |
|---|
| 3567 | </p><pre> $text = 'test test test';<br> $sql = "declare rs clob; begin :rs := lobinout(:sa0); end;";<br> $stmt = $conn -> PrepareSP($sql);<br> $conn -> InParameter($stmt,$text,'sa0', -1, OCI_B_CLOB);<br> $rs = '';<br> $conn -> OutParameter($stmt,$rs,'rs', -1, OCI_B_CLOB);<br> $conn -> Execute($stmt);<br> echo "return = ".$rs."<br>";<br></pre> |
|---|
| 3568 | As he says, the LOBs limitations are: |
|---|
| 3569 | <pre> - use OCINewDescriptor before binding<br> - if Param is IN, uses save() before each execute. This is done automatically for you.<br> - if Param is OUT, uses load() after each execute. This is done automatically for you.<br> - when we bind $var as LOB, we create new descriptor and return it as a<br> Bind Result, so if we want to use OUT parameters, we have to store<br> somewhere &$var to load() data from LOB to it.<br> - IN OUT params are not working now (should not be a big problem to fix it)<br> - now mass binding not working too (I've wrote about it before)<br></pre> |
|---|
| 3570 | <p>Simplified Connect() and PConnect() error handling. |
|---|
| 3571 | </p><p>When extension not loaded, Connect() and PConnect() will return null. On connect error, the fns will return false. |
|---|
| 3572 | </p><p>CacheGetArray() added to code. |
|---|
| 3573 | </p><p>Added Init() to adorecordset_empty(). |
|---|
| 3574 | </p><p>Changed postgres64 driver, MetaColumns() to not strip off quotes in default value if :: detected (type-casting of default). |
|---|
| 3575 | </p><p>Added test: if (!defined('ADODB_DIR')) die(). Useful to prevent hackers from detecting file paths. |
|---|
| 3576 | </p><p>Changed metaTablesSQL to ignore Postgres 7.4 information schemas (sql_*). |
|---|
| 3577 | </p><p>New polish language file by Grzegorz Pacan |
|---|
| 3578 | </p><p>Added support for UNION in _adodb_getcount(). |
|---|
| 3579 | </p><p>Added security check for ADODB_DIR to limit path disclosure issues. Requested by postnuke team. |
|---|
| 3580 | </p><p>Added better error message support to oracle driver. Thx to Gaetano Giunta. |
|---|
| 3581 | </p><p>Added showSchema support to mysql. |
|---|
| 3582 | </p><p>Bind in oci8 did not handle $name=false properly. Fixed. |
|---|
| 3583 | </p><p>If extension not loaded, Connect(), PConnect(), NConnect() will return null. |
|---|
| 3584 | </p><p><b>4.22 15 Apr 2004</b> |
|---|
| 3585 | </p><p>Moved docs to own adodb/docs folder. |
|---|
| 3586 | </p><p>Fixed session bug when quoting compressed/encrypted data in Replace(). |
|---|
| 3587 | </p><p>Netezza Driver and LDAP drivers contributed by Josh Eldridge. |
|---|
| 3588 | </p><p>GetMenu now uses rtrim() on values instead of trim(). |
|---|
| 3589 | </p><p>Changed MetaColumnNames to return an associative array, keys being the field names in uppercase. |
|---|
| 3590 | </p><p>Suggested fix to adodb-ado.inc.php affected_rows to support PHP5 variants. Thx to Alexios Fakos. |
|---|
| 3591 | </p><p>Contributed bulgarian language file by Valentin Sheiretsky valio#valio.eu.org. |
|---|
| 3592 | </p><p>Contributed romanian language file by stefan bogdan. |
|---|
| 3593 | </p><p>GetInsertSQL now checks for table name (string) in $rs, and will create a recordset for that |
|---|
| 3594 | table automatically. Contributed by Walt Boring. Also added OCI_B_BLOB in bind on Walt's request - hope |
|---|
| 3595 | it doesn't break anything :-) |
|---|
| 3596 | </p><p>Some minor postgres speedups in _initrs(). |
|---|
| 3597 | </p><p> ChangeTableSQL checks now if MetaColumns returns empty. Thx Jason Judge. |
|---|
| 3598 | </p><p>Added ADOConnection::Time(), returns current database time in unix timestamp format, or false. |
|---|
| 3599 | </p><p><b>4.21 20 Mar 2004</b> |
|---|
| 3600 | </p><p>We no longer in SelectLimit for VFP driver add SELECT TOP X unless an ORDER BY exists. |
|---|
| 3601 | </p><p>Pim Koeman contributed dutch language file adodb-nl.inc.php. |
|---|
| 3602 | </p><p>Rick Hickerson added CLOB support to db2 datadict. |
|---|
| 3603 | </p><p>Added odbtp driver. Thx to "stefan bogdan" sbogdan#rsb.ro. |
|---|
| 3604 | </p><p>Changed PrepareSP() 2nd parameter, $cursor, to default to true (formerly false). Fixes oci8 backward |
|---|
| 3605 | compat problems with OUT params. |
|---|
| 3606 | </p><p>Fixed month calculation error in adodb-time.inc.php. 2102-June-01 appeared as 2102-May-32. |
|---|
| 3607 | </p><p>Updated PHP5 RC1 iterator support. API changed, hasMore() renamed to valid(). |
|---|
| 3608 | </p><p>Changed internal format of serialized cache recordsets. As we store a version number, this should be |
|---|
| 3609 | backward compatible. |
|---|
| 3610 | </p><p>Error handling when driver file not found was flawed in ADOLoadCode(). Fixed. |
|---|
| 3611 | </p><p><b>4.20 27 Feb 2004</b> |
|---|
| 3612 | </p><p>Updated to AXMLS 1.01. |
|---|
| 3613 | </p><p>MetaForeignKeys for postgres7 modified by Edward Jaramilla, works on pg 7.4. |
|---|
| 3614 | </p><p>Now numbers accepts function calls or sequences for GetInsertSQL/GetUpdateSQL numeric fields. |
|---|
| 3615 | </p><p>Changed quotes of 'delete from $perf_table' to "". Thx Kehui (webmaster#kehui.net) |
|---|
| 3616 | </p><p>Added ServerInfo() for ifx, and putenv trim fix. Thx Fernando Ortiz. |
|---|
| 3617 | </p><p>Added addq(), which is analogous to addslashes(). |
|---|
| 3618 | </p><p>Tested with php5b4. Fix some php5 compat problems with exceptions and sybase. |
|---|
| 3619 | </p><p>Carl-Christian Salvesen added patch to mssql _query to support binds greater than 4000 chars. |
|---|
| 3620 | </p><p>Mike suggested patch to PHP5 exception handler. $errno must be numeric. |
|---|
| 3621 | </p><p>Added double quotes (") to ADODB_TABLE_REGEX. |
|---|
| 3622 | </p><p>For oci8, Prepare(...,$cursor), |
|---|
| 3623 | $cursor's meaning was accidentally inverted in 4.11. This causes |
|---|
| 3624 | problems with ExecuteCursor() too, which calls Prepare() internally. |
|---|
| 3625 | Thx to William Lovaton. |
|---|
| 3626 | </p><p>Now dateHasTime property in connection object renamed to datetime for consistency. This could break bc. |
|---|
| 3627 | </p><p>Csongor Halmai reports that db2 SelectLimit with input array is not working. Fixed.. |
|---|
| 3628 | </p><p><b>4.11 27 Jan 2004</b> |
|---|
| 3629 | </p><p>Csongor Halmai reports db2 binding not working. Reverted back to emulated binding. |
|---|
| 3630 | </p><p>Dan Cech modifies datadict code. Adds support for DropIndex. Minor cleanups. |
|---|
| 3631 | </p><p>Table misspelt in perf-oci8.inc.php. Changed v$conn_cache_advice to v$db_cache_advice. Reported by Steve W. |
|---|
| 3632 | </p><p>UserTimeStamp and DBTimeStamp did not handle YYYYMMDDHHMMSS format properly. Reported by Mike Muir. Fixed. |
|---|
| 3633 | </p><p>Changed oci8 Prepare(). Does not auto-allocate OCINewCursor automatically, unless 2nd param is set to true. |
|---|
| 3634 | This will break backward compat, if Prepare/Execute is used instead of ExecuteCursor. Reported by Chris Jones. |
|---|
| 3635 | </p><p>Added InParameter() and OutParameter(). Wrapper functions to Parameter(), but nicer because they |
|---|
| 3636 | are self-documenting. |
|---|
| 3637 | </p><p>Added 'R' handling in ActualType() to datadict-mysql.inc.php |
|---|
| 3638 | </p><p>Added ADOConnection::SerializableRS($rs). Returns a recordset that can be serialized in a session. |
|---|
| 3639 | </p><p>Added "Run SQL" to performance UI(). |
|---|
| 3640 | </p><p>Misc spelling corrections in adodb-mysqli.inc.php, adodb-oci8.inc.php and datadict-oci8.inc.php, from Heinz Hombergs. |
|---|
| 3641 | </p><p>MetaIndexes() for ibase contributed by Heinz Hombergs. |
|---|
| 3642 | </p><p><b>4.10 12 Jan 2004</b> |
|---|
| 3643 | </p><p>Dan Cech contributed extensive changes to data dictionary to support name quoting (with `), and drop table/index. |
|---|
| 3644 | </p><p>Informix added cursorType property. Default remains IFX_SCROLL, but you can change to 0 (non-scrollable cursor) for performance. |
|---|
| 3645 | </p><p>Added ADODB_View_PrimaryKeys() for returning view primary keys to MetaPrimaryKeys(). |
|---|
| 3646 | </p><p>Simplified chinese file, adodb-cn.inc.php from cysoft. |
|---|
| 3647 | </p><p>Added check for ctype_alnum in adodb-datadict.inc.php. Thx to Jason Judge. |
|---|
| 3648 | </p><p>Added connection parameter to ibase Prepare(). Fix by Daniel Hassan. |
|---|
| 3649 | </p><p>Added nameQuote for quoting identifiers and names to connection obj. Requested by Jason Judge. Also the |
|---|
| 3650 | data dictionary parser now detects `field name` and generates column names with spaces correctly. |
|---|
| 3651 | </p><p>BOOL type not recognised correctly as L. Fixed. |
|---|
| 3652 | </p><p>Fixed paths in ADODB_DIR for session files, and back-ported it to 4.05 (15 Dec 2003) |
|---|
| 3653 | </p><p>Added Schema to postgresql MetaTables. Thx to col#gear.hu |
|---|
| 3654 | </p><p>Empty postgresql recordsets that had blob fields did not set EOF properly. Fixed. |
|---|
| 3655 | </p><p>CacheSelectLimit internal parameters to SelectLimit were wrong. Thx to Nio. |
|---|
| 3656 | </p><p>Modified adodb_pr() and adodb_backtrace() to support command-line usage (eg. no html). |
|---|
| 3657 | </p><p>Fixed some fr and it lang errors. Thx to Gaetano G. |
|---|
| 3658 | </p><p>Added contrib directory, with adodb rs to xmlrpc convertor by Gaetano G. |
|---|
| 3659 | </p><p>Fixed array recordset bugs when _skiprow1 is true. Thx to Gaetano G. |
|---|
| 3660 | </p><p>Fixed pivot table code when count is false. |
|---|
| 3661 | </p><p> |
|---|
| 3662 | |
|---|
| 3663 | </p><p><b>4.05 13 Dec 2003 </b> |
|---|
| 3664 | </p><p>Added MetaIndexes to data-dict code - thx to Dan Cech. |
|---|
| 3665 | </p><p>Rewritten session code by Ross Smith. Moved code to adodb/session directory. |
|---|
| 3666 | </p><p>Added function exists check on connecting to most drivers, so we don't crash with the unknown function error. |
|---|
| 3667 | </p><p>Smart Transactions failed with GenID() when it no seq table has been created because the sql |
|---|
| 3668 | statement fails. Fix by Mark Newnham. |
|---|
| 3669 | </p><p>Added $db->length, which holds name of function that returns strlen. |
|---|
| 3670 | </p><p>Fixed error handling for bad driver in ADONewConnection - passed too few params to error-handler. |
|---|
| 3671 | </p><p>Datadict did not handle types like 16.0 properly in _GetSize. Fixed. |
|---|
| 3672 | </p><p>Oci8 driver SelectLimit() bug &= instead of =& used. Thx to Swen Thümmler. |
|---|
| 3673 | </p><p>Jesse Mullan suggested not flushing outp when output buffering enabled. Due to Apache 2.0 bug. Added. |
|---|
| 3674 | </p><p>MetaTables/MetaColumns return ref bug with PHP5 fixed in adodb-datadict.inc.php. |
|---|
| 3675 | </p><p>New mysqli driver contributed by Arjen de Rijke. Based on adodb 3.40 driver. |
|---|
| 3676 | Then jlim added BeginTrans, CommitTrans, RollbackTrans, IfNull, SQLDate. Also fixed return ref bug. |
|---|
| 3677 | </p><p>$ADODB_FLUSH added, if true then force flush in debugging outp. Default is false. In earlier |
|---|
| 3678 | versions, outp defaulted to flush, which is not compat with apache 2.0. |
|---|
| 3679 | </p><p>Mysql driver's GenID() function did not work when when sql logging is on. Fixed. |
|---|
| 3680 | </p><p>$ADODB_SESSION_TBL not declared as global var. Not available if adodb-session.inc.php included in function. Fixed. |
|---|
| 3681 | </p><p>The input array not passed to Execute() in _adodb_getcount(). Fixed. |
|---|
| 3682 | </p><p><b>4.04 13 Nov 2003 </b> |
|---|
| 3683 | </p><p>Switched back to foreach - faster than list-each. |
|---|
| 3684 | </p><p>Fixed bug in ado driver - wiping out $this->fields with date fields. |
|---|
| 3685 | </p><p>Performance Monitor, View SQL, Explain Plan did not work if strlen($SQL)>max($_GET length). Fixed. |
|---|
| 3686 | </p><p>Performance monitor, oci8 driver added memory sort ratio. |
|---|
| 3687 | </p><p>Added random property, returns SQL to generate a floating point number between 0 and 1; |
|---|
| 3688 | </p><p><b>4.03 6 Nov 2003 </b> |
|---|
| 3689 | </p><p>The path to adodb-php4.inc.php and adodb-iterators.inc.php was not setup properly. |
|---|
| 3690 | </p><p>Patched SQLDate in interbase to support hours/mins/secs. Thx to ari kuorikoski. |
|---|
| 3691 | </p><p>Force autorollback for pgsql persistent connections - |
|---|
| 3692 | apparently pgsql did not autorollback properly before 4.3.4. See http://bugs.php.net/bug.php?id=25404 |
|---|
| 3693 | </p><p><b>4.02 5 Nov 2003 </b> |
|---|
| 3694 | </p><p>Some errors in adodb_error_pg() fixed. Thx to Styve. |
|---|
| 3695 | </p><p>Spurious Insert_ID() error was generated by LogSQL(). Fixed. |
|---|
| 3696 | </p><p>Insert_ID was interfering with Affected_Rows() and Replace() when LogSQL() enabled. Fixed. |
|---|
| 3697 | </p><p>More foreach loops optimized with list/each. |
|---|
| 3698 | </p><p>Null dates not handled properly in ADO driver (it becomes 31 Dec 1969!). |
|---|
| 3699 | </p><p>Heinz Hombergs contributed patches for mysql MetaColumns - adding scale, made |
|---|
| 3700 | interbase MetaColumns work with firebird/interbase, and added lang/adodb-de.inc.php. |
|---|
| 3701 | </p><p>Added INFORMIXSERVER environment variable. |
|---|
| 3702 | </p><p>Added $ADODB_ANSI_PADDING_OFF for interbase/firebird. |
|---|
| 3703 | </p><p>PHP 5 beta 2 compat check. Foreach (Iterator) support. Exceptions support. |
|---|
| 3704 | </p><p><b>4.01 23 Oct 2003 </b> |
|---|
| 3705 | </p><p>Fixed bug in rs2html(), tohtml.inc.php, that generated blank table cells. |
|---|
| 3706 | </p><p>Fixed insert_id() incorrectly generated when logsql() enabled. |
|---|
| 3707 | </p><p>Modified PostgreSQL _fixblobs to use list/each instead of foreach. |
|---|
| 3708 | </p><p>Informix ErrorNo() implemented correctly. |
|---|
| 3709 | </p><p>Modified several places to use list/each, including GetRowAssoc(). |
|---|
| 3710 | </p><p>Added UserTimeStamp() to connection class. |
|---|
| 3711 | </p><p>Added $ADODB_ANSI_PADDING_OFF for oci8po. |
|---|
| 3712 | </p><p><b>4.00 20 Oct 2003 </b> |
|---|
| 3713 | </p><p>Upgraded adodb-xmlschema to 1 Oct 2003 snapshot. |
|---|
| 3714 | </p><p>Fix to rs2html warning message. Thx to Filo. |
|---|
| 3715 | </p><p>Fix for odbc_mssql/mssql SQLDate(), hours was wrong. |
|---|
| 3716 | </p><p>Added MetaColumns and MetaPrimaryKeys for sybase. Thx to Chris Phillipson. |
|---|
| 3717 | </p><p>Added autoquoting to datadict for MySQL and PostgreSQL. Suggestion by Karsten Dambekalns |
|---|
| 3718 | </p><p><b>3.94 11 Oct 2003 </b> |
|---|
| 3719 | </p><p>Create trigger in datadict-oci8.inc.php did not work, because all cr/lf's must be removed. |
|---|
| 3720 | </p><p>ErrorMsg()/ErrorNo() did not work for many databases when logging enabled. Fixed. |
|---|
| 3721 | </p><p>Removed global variable $ADODB_LOGSQL as it does not work properly with multiple connections. |
|---|
| 3722 | </p><p>Added SQLDate support for sybase. Thx to Chris Phillipson |
|---|
| 3723 | </p><p>Postgresql checking of pgsql resultset resource was incorrect. Fix by Bharat Mediratta bharat#menalto.com. |
|---|
| 3724 | Same patch applied to _insertid and _affectedrows for adodb-postgres64.inc.php. |
|---|
| 3725 | </p><p>Added support for NConnect for postgresql. |
|---|
| 3726 | </p><p>Added Sybase data dict support. Thx to Chris Phillipson |
|---|
| 3727 | </p><p>Extensive improvements in $perf->UI(), eg. Explain now opens in new window, we show scripts |
|---|
| 3728 | which call sql, etc. |
|---|
| 3729 | </p><p>Perf Monitor UI works with magic quotes enabled. |
|---|
| 3730 | </p><p>rsPrefix was declared twice. Removed. |
|---|
| 3731 | </p><p>Oci8 stored procedure support, eg. "begin func(); end;" was incorrect in _query. Fixed. |
|---|
| 3732 | </p><p>Tiraboschi Massimiliano contributed italian language file. |
|---|
| 3733 | </p><p>Fernando Ortiz, fortiz#lacorona.com.mx, contributed informix performance monitor. |
|---|
| 3734 | </p><p>Added _varchar (varchar arrays) support for postgresql. Reported by PREVOT Stéphane.<hr /> |
|---|
| 3735 | <p><strong>0.10 Sept 9 2000</strong> First release |
|---|
| 3736 | </p><h3><strong>Old change log history moved to <a href="old-changelog.htm">old-changelog.htm</a>. |
|---|
| 3737 | </strong></h3> |
|---|
| 3738 | <p> </p> |
|---|
| 3739 | <p> |
|---|
| 3740 | </p></body></html> |
|---|
