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
v5:reference:reference_index [2016/04/14 15:59] – [Transaction Scoping] mnewnhamv5:reference:reference_index [2023/06/04 12:39] (current) – Add anchor link to ADODB_vers dregad
Line 6: Line 6:
 See the [[v5:database:feature_comparison|Feature Comparison Matrix]] See the [[v5:database:feature_comparison|Feature Comparison Matrix]]
 ===== Variables ===== ===== Variables =====
-| [[v5:reference:adodb_countrecs|$ADODB_COUNTRECS]]         | In database drivers that do not support native recordset counting, controls whether to emulate the functionality                       | +| [[v5:reference:adodb_countrecs|$ADODB_COUNTRECS]]                | In database drivers that do not support native recordset counting, controls whether to emulate the functionality                                     | 
-| [[v5:reference:adodb_ansi_padding_off|$ADODB_ANSI_PADDING_OFF]]  | Determines whether to right trim CHAR fields                                                                                           | +| [[v5:reference:adodb_ansi_padding_off|$ADODB_ANSI_PADDING_OFF]]  | Determines whether to right trim CHAR fields                                                                                                         | 
-| [[v5:reference:adodb_cache_dir|$ADODB_CACHE_DIR]]         | If using recordset caching, determines the directory holding the cached data                                                           | +| [[v5:reference:adodb_cache_dir|$ADODB_CACHE_DIR]]                | If using recordset caching, determines the directory holding the cached data                                                                         | 
-| [[v5:reference:adodb_cache_class|$ADODB_CACHE_CLASS]]       | If using recordset caching, specifies a class for cached recordset handling                                                            | +| [[v5:reference:adodb_cache_class|$ADODB_CACHE_CLASS]]            | If using recordset caching, specifies a class for cached recordset handling                                                                          | 
-| [[v5:datetime:adodb_date_locale|$ADODB_DATE_LOCALE]]        | Sets a default date and time format for the ADOdb date/time library                                                                    | +| [[v5:datetime:adodb_date_locale|$ADODB_DATE_LOCALE]]             | Sets a default date and time format for the ADOdb date/time library                                                                                  | 
-| [[v5:reference:adodb_force_type|$ADODB_FORCE_TYPE]]        | Changes the behavior of empty and null field handling when updating or creating records                                                | +| [[v5:reference:adodb_force_type|$ADODB_FORCE_TYPE]]              | Changes the behavior of empty and null field handling when updating or creating records                                                              | 
-| [[v5:reference:adodb_fetch_mode|$ADODB_FETCH_MODE]]        | Sets the global array type (numeric or associative) for returned recordsets                                                            | +| [[v5:reference:adodb_fetch_mode|$ADODB_FETCH_MODE]]              | Sets the global array type (numeric or associative) for returned recordsets                                                                          | 
-| [[v5:reference:adodb_getone_eof|$ADODB_GETONE_EOF]]        | Sets the returned value if a valid SQL statement does not match any record when the method [[v5:reference:connection:getone|getOne()]] is executed.  | +| [[v5:reference:adodb_getone_eof|$ADODB_GETONE_EOF]]              | Sets the returned value if a valid SQL statement does not match any record when the method [[v5:reference:connection:getone|getOne()]] is executed.  | 
-| [[v5:reference:adodb_lang|$ADODB_LANG]]              | Sets the language for error messages                                                                                                   | +| [[v5:reference:adodb_lang|$ADODB_LANG]]                          | Sets the language for error messages                                                                                                                 | 
-| [[v5:reference:adodb_quote_fieldnames|$ADODB_QUOTE_FIELDNAMES]]  | Quotes, and optionally controls the casing of field name in constructed SQL statements                                                 |+| [[v5:reference:adodb_quote_fieldnames|$ADODB_QUOTE_FIELDNAMES]]  | Quotes, and optionally controls the casing of field name in constructed SQL statements                                                               | 
 +| [[v5:reference:adodb_compat_fetch|$ADODB_COMPAT_FETCH]]          | Determines the behavior of a record buffer if the pointer is advanced beyond EOF                                                                     | 
 +| [[v5:reference:connection:version#adodb_vers|$ADODB_vers]]       | ADOdb version and release date                                                                                                                       |
  
 ===== Constants ===== ===== Constants =====
Line 34: Line 36:
 | [[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 57:
 | [[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 63: Line 67:
 ==== Prepared Statements ==== ==== Prepared Statements ====
  
-| [[v5:reference:connection:inparameter|inParameter()]]    | Sets an input parameter to a stored procedure                    | +| [[v5:reference:connection:inparameter|inParameter()]]            | Sets an input parameter to a stored procedure                    | 
-| [[v5:reference:connection:outparameter|outParameter()]]  | Receives an output parameter from a stored procedure             | +| [[v5:reference:connection:outparameter|outParameter()]]          | Receives an output parameter from a stored procedure             | 
-| [[v5:reference:connection:param|param()]]                | Returns a database specific parameter placeholder                | +| [[v5:reference:connection:param|param()]]                        | Returns a database specific parameter placeholder                | 
-| [[v5:reference:connection:prepare|prepare()]]            | Prepares an SQL statement and returns a handle to use            | +| [[v5:reference:connection:prepare|prepare()]]                    | Prepares an SQL statement and returns a handle to use            | 
-| [[v5:reference:connection:preparesp|prepareSp()]]        | Access a stored procedure and returns a handle to the procedure  |+| [[v5:reference:connection:preparesp|prepareSp()]]                | Access a stored procedure and returns a handle to the procedure  | 
 +| [[v5:reference:connection:releasestatement|releaseStatement()]]  | Releases a previously prepared statement                         |
  
  
Line 144: Line 149:
 | [[v5:reference:connection:fnexecute|fnExecute and fnCacheExecute]]     || A reference to a function that overrides the execute function  | | [[v5:reference:connection:fnexecute|fnExecute and fnCacheExecute]]     || A reference to a function that overrides the execute function  |
    
 +==== Information ====
 +
 +| [[v5:reference:connection:version|version()]] | ADOdb version number |
 +| [[v5:reference:connection:serverinfo|serverInfo()]] | Database server version and information |
 +
  
-====== The Recordset Object ====== +===== The Recordset Object =====
 ==== Returns one field ==== ==== Returns one field ====
 |[[v5:reference:recordset:fields|fields()]]|Returns a single field in a single row of the current recordset| |[[v5:reference:recordset:fields|fields()]]|Returns a single field in a single row of the current recordset|
Line 166: Line 176:
 |[[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 188:
    
 ==== 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.1460642364.txt.gz · Last modified: 2017/04/21 11:30 (external edit)