ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools

Trace:
v5:reference:reference_index

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
v5:reference:reference_index [2016/04/13 02:49] – [Generating Database Independent SQL strings] mnewnhamv5:reference:reference_index [2021/03/12 03:31] – [Establishing Connections] mnewnham
Line 34: Line 34:
 | [[v5:reference:connection:close|close()]]                         | Closes a database connection                                                        | | [[v5:reference:connection:close|close()]]                         | Closes a database connection                                                        |
  
 +
 +**See Also** [[v5:reference:connection:properties|Public Properties Of The Connection]]
  
 ==== Working With Cached Recordsets ==== ==== Working With Cached Recordsets ====
 ADOdb supports the ability to work with cached query results, either through storing the results on local disks, or via the use of a [[http://memcached.org|Memcached Server]]. The functions below work the same as their non-caching equivalents, but also check for the availabiltiy of cached results first. This can help reduce database load. ADOdb supports the ability to work with cached query results, either through storing the results on local disks, or via the use of a [[http://memcached.org|Memcached Server]]. The functions below work the same as their non-caching equivalents, but also check for the availabiltiy of cached results first. This can help reduce database load.
-|[[v5:userguide:local_cache|Local Caching Setup]]|Configuring local parameters for caching|  +| [[v5:userguide:local_cache|Local Caching Setup]]                 | Configuring local parameters for caching                                                                                                    | 
-|[[v5:userguide:memcached|Memcached Setup]]|Configuring a memcached server connection| +| [[v5:userguide:memcached|Memcached Setup]]                       | Configuring a memcached server connection                                                                                                   | 
-|[[v5:reference:connection:cacheexecute|cacheExecute()]]|Executes a provided SQL statement and returns a handle to the result, or a cached handle if available|  +| [[v5:reference:connection:cacheexecute|cacheExecute()]]          | Executes a provided SQL statement and returns a handle to the result, or a cached handle if available                                       | 
-|[[v5:reference:connection:cachegetall|cacheGetAll()]]|Executes a provided SQL statement and returns the entire recordset into an array| +| [[v5:reference:connection:cachegetall|cacheGetAll()]]            | Executes a provided SQL statement and returns the entire recordset into an array                                                            | 
-|[[v5:reference:connection:cachegetassoc|cacheGetAssoc()]]|Executes a provided SQL statement and returns the entire recordset into an associatitive array with the value of the first column as a key|  +| [[v5:reference:connection:cachegetassoc|cacheGetAssoc()]]        | Executes a provided SQL statement and returns the entire recordset into an associatitive array with the value of the first column as a key  | 
-|[[v5:reference:connection:cachegetcol|cacheGetCol()]]|Executes a provided SQL statement and returns the first row of the entire recordset into a numeric array|  +| [[v5:reference:connection:cachegetcol|cacheGetCol()]]            | Executes a provided SQL statement and returns the first column of each row in the  recordset into an array                                  | 
-|[[v5:reference:connection:cachegetone|cacheGetOne()]]|Retrieves the first column of the first matching row of an executed SQL statement|  +| [[v5:reference:connection:cachegetone|cacheGetOne()]]            | Retrieves the first column of the first matching row of an executed SQL statement                                                           | 
-|[[v5:reference:connection:cachegetrow|cacheGetRow()]]|Retrieves the first matching row of an executed SQL statement|  +| [[v5:reference:connection:cachegetrow|cacheGetRow()]]            | Retrieves the first matching row of an executed SQL statement                                                                               | 
-|[[v5:reference:connection:cacheselectlimit|cacheSelectLimit()]]|Executes a provided SQL statement and returns a handle to the result, with the ability to supply a starting offset and record count| +| [[v5:reference:connection:cacheselectlimit|cacheSelectLimit()]]  | Executes a provided SQL statement and returns a handle to the result, with the ability to supply a starting offset and record count         | 
-|[[v5:reference:connection:cacheflush|cacheFlush()]]|Flushes a cached result set|+| [[v5:reference:connection:cacheflush|cacheFlush()]]              | Flushes a cached result set                                                                                                                 |
  
 ==== Executing SQL ==== ==== Executing SQL ====
Line 53: Line 55:
 | [[v5:reference:connection:getall|getAll()]]            | Executes a provided SQL statement and returns the entire recordset into an array                                                            | | [[v5:reference:connection:getall|getAll()]]            | Executes a provided SQL statement and returns the entire recordset into an array                                                            |
 | [[v5:reference:connection:getassoc|getAssoc()]]        | Executes a provided SQL statement and returns the entire recordset into an associatitive array with the value of the first column as a key  | | [[v5:reference:connection:getassoc|getAssoc()]]        | Executes a provided SQL statement and returns the entire recordset into an associatitive array with the value of the first column as a key  |
-| [[v5:reference:connection:getcol|getCol()]]            | Executes a provided SQL statement and returns the first row of the entire recordset into a numeric array                                    |+| [[v5:reference:connection:getcol|getCol()]]            | Executes a provided SQL statement and returns the first column of each row of he entire recordset into an array                             |
 | [[v5:reference:connection:getmedian|getMedian()]]      | Returns the median value of a column in a table                                                                                             | | [[v5:reference:connection:getmedian|getMedian()]]      | Returns the median value of a column in a table                                                                                             |
 | [[v5:reference:connection:getone|getOne()]]            | Retrieves the first column of the first matching row of an executed SQL statement                                                           | | [[v5:reference:connection:getone|getOne()]]            | Retrieves the first column of the first matching row of an executed SQL statement                                                           |
Line 75: Line 77:
 | [[v5:reference:connection:charmax|charMax()]]            | Returns the largest length of data that can be inserted into a character field  | | [[v5:reference:connection:charmax|charMax()]]            | Returns the largest length of data that can be inserted into a character field  |
 | [[v5:reference:connection:concat|concat()]]              | Returns a database-specific concatenation of strings                            | | [[v5:reference:connection:concat|concat()]]              | Returns a database-specific concatenation of strings                            |
-| [[v5:reference:connection:dbdate|dbDate()]]              | Returns a database-specific date expression                                     | 
-| [[v5:reference:connection:dbtimestamp|dbTimeStamp()]]    | Returns a database-specific dateTime expression                                 | 
 | [[v5:reference:connection:getupdatesql|getUpdateSQL()]]  | Creates a database-specific SQL UPDATE statement based on supplied parameters   | | [[v5:reference:connection:getupdatesql|getUpdateSQL()]]  | Creates a database-specific SQL UPDATE statement based on supplied parameters   |
 | [[v5:reference:connection:getinsertsql|getInsertSQL()]]  | Creates a database-specific SQL INSERT statement based on supplied parameters   | | [[v5:reference:connection:getinsertsql|getInsertSQL()]]  | Creates a database-specific SQL INSERT statement based on supplied parameters   |
 | [[v5:reference:connection:ifnull|ifNull()]]              | Replaces a null value with a specified replacement                              | | [[v5:reference:connection:ifnull|ifNull()]]              | Replaces a null value with a specified replacement                              |
-| [[v5:reference:connection:offsetdate|offsetDate()]]      | Uses SQL to do date based offsets e.g. 'today + 3 days'                         | 
 | [[v5:reference:connection:qstr|quote()]]                 | Is a pseudonym for the function [[v5:reference:connection:qstr]]                | | [[v5:reference:connection:qstr|quote()]]                 | Is a pseudonym for the function [[v5:reference:connection:qstr]]                |
-| [[v5:reference:connection:qstr|qStr()]]                  | Appropiately quotes strings with ' characters for insertion into the database   |+| [[v5:reference:connection:qstr|qStr()]]                  | Appropriately quotes strings with ' characters for insertion into the database  |
 | [[v5:reference:connection:textmax|textMax()]]            | Returns the largest length of data that can be inserted into a text field       | | [[v5:reference:connection:textmax|textMax()]]            | Returns the largest length of data that can be inserted into a text field       |
  
Line 110: Line 109:
 | [[v5:reference:connection:settransactionmode|setTransactionMode()]]     || Sets the isolation level of a transaction.    | | [[v5:reference:connection:settransactionmode|setTransactionMode()]]     || Sets the isolation level of a transaction.    |
 | [[v5:reference:connection:starttrans|startTrans()]]                     || Starts a smart transaction                    | | [[v5:reference:connection:starttrans|startTrans()]]                     || Starts a smart transaction                    |
 +| [[v5:reference:connection:transcnt|transCnt]]|| Returns the nesting level of smart transactions| 
 +| [[v5:reference:connection:transcnt|transOff]]||Temporarily disables transactions| 
 ==== Fetching Data ==== ==== Fetching Data ====
 |[[v5:reference:connection:getfetchmode|getFetchMode()]]|Get the array type for return data| |[[v5:reference:connection:getfetchmode|getFetchMode()]]|Get the array type for return data|
Line 115: Line 116:
  
  
-==== Dates ====+==== Manipulating Dates & Times ====
 | [[v5:reference:connection:binddate|bindDate()]]               | Creates a portable date field, for use in bind statements        | | [[v5:reference:connection:binddate|bindDate()]]               | Creates a portable date field, for use in bind statements        |
 | [[v5:reference:connection:bindtimestamp|bindTimeStamp()]]     | Creates a portable timestamp field, for use in bind statements   | | [[v5:reference:connection:bindtimestamp|bindTimeStamp()]]     | Creates a portable timestamp field, for use in bind statements   |
Line 122: Line 123:
 | [[v5:reference:connection:offsetdate|offsetDate()]]           | Creates a portable date offset field, for use in SQL statements  | | [[v5:reference:connection:offsetdate|offsetDate()]]           | Creates a portable date offset field, for use in SQL statements  |
 | [[v5:reference:connection:setdatelocale|setDateLocale()]]                   | Changes the SQL connection to a specified Locale                 | | [[v5:reference:connection:setdatelocale|setDateLocale()]]                   | Changes the SQL connection to a specified Locale                 |
 +| [[v5:reference:connection:sqldate|sqlDate()]]            | Returns a portably-formatted date string from a timestamp database column       |
 | [[v5:reference:connection:unixdate|unixDate()]]               | Uses the database connection to create date strings              | | [[v5:reference:connection:unixdate|unixDate()]]               | Uses the database connection to create date strings              |
 | [[v5:reference:connection:unixtimestamp|unixTimeStamp()]]     | Uses the database connection to create date/time strings         | | [[v5:reference:connection:unixtimestamp|unixTimeStamp()]]     | Uses the database connection to create date/time strings         |
Line 166: Line 168:
 |[[v5:reference:connection:getarray|getArray()]]|Returns a complete recordset as an array| |[[v5:reference:connection:getarray|getArray()]]|Returns a complete recordset as an array|
 |[[v5:reference:connection:getassoc|getAssoc()]]|Returns an associate key/value array, with other options| |[[v5:reference:connection:getassoc|getAssoc()]]|Returns an associate key/value array, with other options|
-|[[v5:reference:connection:getarray|getRows()]]|This function is a pseudonym for [[v5:reference:connection:getarray|getArray()]], for ADO compatibility|+|[[v5:reference:connection:getarray|getRows()]]|This function is a pseudonym for [[v5:reference:connection:getarray|getArray()]]|
 |[[v5:reference:connection:getrandrow|getRandRow()]]|Returns a random record from a recordset| |[[v5:reference:connection:getrandrow|getRandRow()]]|Returns a random record from a recordset|
 ==== Scrolling ==== ==== Scrolling ====
 | [[v5:reference:recordset:move|move()]]                       || Move to the n<sup>th</sup> record of a recordset                                | | [[v5:reference:recordset:move|move()]]                       || Move to the n<sup>th</sup> record of a recordset                                |
-| [[v5:reference:connection:movenext|moveNext()]]               || Moves the cursor to the next record of the recordset from the current position  |+| [[v5:reference:recordset:movenext|moveNext()]]               || Moves the cursor to the next record of the recordset from the current position  |
 | [[v5:reference:recordset:movefirst|moveFirst()]]             || Moves the cursor to the first record of the recordset                           | | [[v5:reference:recordset:movefirst|moveFirst()]]             || Moves the cursor to the first record of the recordset                           |
-| [[v5:reference:connection:movelast|moveLast()]]               || Moves to the last record of a recordset                                         |+| [[v5:reference:recordset:movelast|moveLast()]]               || Moves to the last record of a recordset                                         |
 | [[v5:reference:connection:currentrow|AbsolutePosition()]]     || absolutePosition() is a pseudonym for currentRow()                              | | [[v5:reference:connection:currentrow|AbsolutePosition()]]     || absolutePosition() is a pseudonym for currentRow()                              |
 | [[v5:reference:connection:currentrow|currentRow()]]           || Returns the current row number of a recordset                                   | | [[v5:reference:connection:currentrow|currentRow()]]           || Returns the current row number of a recordset                                   |
Line 178: Line 180:
    
 ==== Menu generation ==== ==== Menu generation ====
-| [[v5:reference:recordset:getmenu|getMenu()]]    | Creates a string containing a basic HTML select box                                                  | +| [[v5:reference:recordset:getmenu|getMenu()]]    | Creates a string containing a single or multi select HTML select box                                              | 
-| [[v5:reference:recordset:getmenu2|getMenu2()]]  | Creates a string containing a basic HTML select box with alternate comparison criteria to getMenu()  | +| [[v5:reference:recordset:getmenu2|getMenu2()]]  | (deprecated) Creates a string containing a basic HTML select box with alternate comparison criteria to getMenu()  | 
-| [[v5:reference:recordset:getmenu3|getMenu3()]]  | Creates a string containing a grouped HTML muilti-select box                                         |+| [[v5:reference:recordset:getmenu3|getMenu3()]]  | Creates a string containing a grouped (optgroup)  HTML single or muilti-select box                                |
  
 ==== Dates ==== ==== Dates ====
v5/reference/reference_index.txt · Last modified: 2023/06/04 12:39 by dregad