Source for file mysql.php
Documentation is available at mysql.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Author: Lukas Smith <smith@backendmedia.com> |
// +----------------------------------------------------------------------+
// $Id: mysql.php,v 1.80.4.18 2004/04/22 11:31:56 lsmith Exp $
require_once('MDB/Common.php');
* - The decimal type fields are emulated with integer fields.
* @author Lukas Smith <smith@backendmedia.com>
// MySQL specific class variable
$this->phptype = 'mysql';
$this->dbsyntax = 'mysql';
$this->supported['Sequences'] = 1;
$this->supported['Indexes'] = 1;
$this->supported['AffectedRows'] = 1;
$this->supported['Summaryfunctions'] = 1;
$this->supported['OrderByText'] = 1;
$this->supported['CurrId'] = 1;
$this->supported['SelectRowRanges'] = 1;
$this->supported['LOBs'] = 1;
$this->supported['Replace'] = 1;
$this->supported['SubSelects'] = 0;
$this->supported['Transactions'] = 0;
$this->options['DefaultTableType'] = FALSE;
$this->options['fixed_float'] = FALSE;
$this->errorcode_map = array (
* Get the native error code of the last error (if any) that
* occured on the current connection.
* @return int native MySQL error code
* This method is used to communicate an error and invoke error
* callbacks etc. Basically a wrapper for MDB::raiseError
* that checks for native error msgs.
* @param integer $errno error code
* @param string $message userinfo message
* @return object a PEAR error object
* Quote a string so it can be safely used as a table or column name
* Quoting style depends on which database driver is being used.
* MySQL can't handle the backtick character (<kbd>`</kbd>) in
* @param string $str identifier name to be quoted
* @return string quoted identifier string
* Define whether database changes done on the database be automatically
* committed. This function may also implicitly start or end a transaction.
* @param boolean $auto_commit flag that indicates whether the database
* changes should be committed right after
* executing every query statement. If this
* argument is 0 a transaction implicitly
* started. Otherwise, if a transaction is
* in progress it is ended by committing any
* database changes that were pending.
* @return mixed MDB_OK on success, a MDB error on failure
$this->debug("AutoCommit: ". ($auto_commit ? "On" : "Off"));
if (!isset ($this->supported['Transactions'])) {
'Auto-commit transactions: transactions are not in use'));
if ($this->auto_commit == $auto_commit) {
$result = $this->query('COMMIT');
$result = $this->query('SET AUTOCOMMIT = 1');
$result = $this->query('SET AUTOCOMMIT = 0');
$this->auto_commit = $auto_commit;
$this->in_transaction = !$auto_commit;
* Commit the database changes done during a transaction that is in
* progress. This function may only be called when auto-committing is
* disabled, otherwise it will fail. Therefore, a new transaction is
* implicitly started after committing the pending changes.
* @return mixed MDB_OK on success, a MDB error on failure
$this->debug("Commit Transaction");
if (!isset ($this->supported['Transactions'])) {
'Commit transactions: transactions are not in use'));
if ($this->auto_commit) {
'Commit transactions: transaction changes are being auto commited'));
return($this->query('COMMIT'));
* Cancel any database changes done during a transaction that is in
* progress. This function may only be called when auto-committing is
* disabled, otherwise it will fail. Therefore, a new transaction is
* implicitly started after canceling the pending changes.
* @return mixed MDB_OK on success, a MDB error on failure
$this->debug("Rollback Transaction");
if (!isset ($this->supported['Transactions'])) {
'Rollback transactions: transactions are not in use'));
if ($this->auto_commit) {
'Rollback transactions: transactions can not be rolled back when changes are auto commited'));
return($this->query('ROLLBACK'));
* Connect to the database
* @return TRUE on success, MDB_Error on failure
$port = (isset ($this->port) ? $this->port : '');
$this->affected_rows = -1;
if(!PEAR ::loadExtension ($this->phptype)) {
NULL , NULL , 'extension '. $this->phptype. ' is not compiled into PHP',
$UseTransactions = $this->getOption('UseTransactions');
if(!MDB::isError($UseTransactions) && $UseTransactions) {
$this->supported['Transactions'] = 1;
$this->supported['Transactions'] = 0;
$DefaultTableType = $this->getOption('DefaultTableType');
if(!MDB::isError($DefaultTableType) && $DefaultTableType) {
if(isset ($this->supported['Transactions'])) {
$this->warnings[] = $DefaultTableType
. ' is not a transaction-safe default table type';
$this->warnings[] = $DefaultTableType
. ' is not a supported default table type';
$function = ($this->options['persistent'] ? 'mysql_pconnect' : 'mysql_connect');
$this->host. (!strcmp($port,'') ? '' : ':'. $port),
$this->user, $this->password);
if (isset ($this->options['fixedfloat'])) {
$revision = intval($version[2 ]);
if ($major > 3 || ($major == 3 && $minor >= 23
&& ($minor > 23 || $revision >= 6 )))
if (isset ($this->supported['Transactions']) && !$this->auto_commit) {
$this->affected_rows = -1;
$this->in_transaction = TRUE;
* all the RDBMS specific things needed close a DB connection
if (isset ($this->supported['Transactions']) && !$this->auto_commit) {
$this->affected_rows = -1;
unset ($GLOBALS['_MDB_databases'][$this->database]);
* Send a query to the database and return any results
* @param string $query the SQL query
* @param mixed $types array that contains the types of the columns in
* @return mixed a result handle or MDB_OK on success, a MDB error on failure
function query($query, $types = NULL )
$this->debug(" Query: $query" );
$this->last_query = $query;
$first = $this->first_selected_row;
$limit = $this->selected_row_limit;
$this->first_selected_row = $this->selected_row_limit = 0;
$query .= " LIMIT $limit";
$query .= " LIMIT $first,$limit";
if ($this->database_name) {
$result_value = intval($result);
* simple subselect emulation for Mysql
* @param string $query the SQL query for the subselect that may only
* @param string $quote determines if the data needs to be quoted before
* @return string the query
if($this->supported['SubSelects'] == 1 ) {
for($i = 0 , $j = count($col); $i < $j; ++ $i) {
* Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
* query, except that if there is already a row in the table with the same
* key field values, the REPLACE query just updates its values instead of
* The REPLACE type of query does not make part of the SQL standards. Since
* practically only MySQL implements it natively, this type of query is
* emulated through this method for other DBMS using standard types of
* queries inside a transaction to assure the atomicity of the operation.
* @param string $table name of the table on which the REPLACE query will
* @param array $fields associative array that describes the fields and the
* values that will be inserted or updated in the specified table. The
* indexes of the array are the names of all the fields of the table. The
* values of the array are also associative arrays that describe the
* values and other properties of the table fields.
* Here follows a list of field properties that need to be specified:
* Value to be assigned to the specified field. This value may be
* of specified in database independent type format as this
* function can perform the necessary datatype conversions.
* this property is required unless the Null property
* Name of the type of the field. Currently, all types Metabase
* are supported except for clob and blob.
* Default: no type conversion
* Boolean property that indicates that the value for this field
* The default value for fields missing in INSERT queries may be
* specified the definition of a table. Often, the default value
* is already NULL, but since the REPLACE may be emulated using
* an UPDATE query, make sure that all fields of the table are
* listed in this function argument array.
* Boolean property that indicates that this field should be
* handled as a primary key or at least as part of the compound
* unique index of the table that will determine the row that will
* updated if it exists or inserted a new row otherwise.
* This function will fail if no key field is specified or if the
* value of a key field is set to NULL because fields that are
* part of unique index they may not be NULL.
* @return mixed MDB_OK on success, a MDB error on failure
for($keys = 0 , $query = $values = '',reset($fields), $field = 0;
if (isset ($fields[$name]['Null']) && $fields[$name]['Null']) {
if(isset ($fields[$name]['Type'])) {
switch ($fields[$name]['Type']) {
'no supported type for field "' . $name . '" specified'));
$value = $fields[$name]['Value'];
if (isset ($fields[$name]['Key']) && $fields[$name]['Key']) {
$name. ': key values may not be NULL'));
'not specified which fields are keys'));
return($this->query(" REPLACE INTO $table ($query) VALUES ($values)" ));
* Retrieve the names of columns returned by the DBMS in a query result.
* @param resource $result result identifier
* @return mixed an associative array variable
* that will hold the names of columns. The
* indexes of the array are the column names
* mapped to lower case and the values are the
* respective numbers of the columns starting
* from 0. Some DBMS may not return any
* columns when the result set does not
$result_value = intval($result);
'Get column names: it was specified an inexisting result set'));
if (!isset ($this->columns[$result_value])) {
$this->columns[$result_value] = array ();
for($column = 0; $column < $columns; $column++ ) {
if ($this->options['optimize'] == 'portability') {
$this->columns[$result_value][$field_name] = $column;
return($this->columns[$result_value]);
* Count the number of columns returned by the DBMS in a query result.
* @param resource $result result identifier
* @return mixed integer value with the number of columns, a MDB error
$result_value = intval($result);
'numCols: it was specified an inexisting result set'));
* check if the end of the result set has been reached
* @param resource $result result identifier
* @return mixed TRUE or FALSE on sucess, a MDB error on failure
$result_value = intval($result);
'End of result: attempted to check the end of an unknown result'));
* fetch value from a result set
* @param resource $result result identifier
* @param int $row number of the row where the data can be found
* @param int $field field number where the data can be found
* @return mixed string on success, a MDB error on failure
function fetch($result, $row, $field)
$result_value = intval($result);
if ($res === FALSE && $res != NULL ) {
* fetch a clob value from a result set
* @param resource $result result identifier
* @param int $row number of the row where the data can be found
* @param int $field field number where the data can be found
* @return mixed content of the specified data cell, a MDB error on failure,
return($this->fetchLob($result, $row, $field));
* fetch a blob value from a result set
* @param resource $result result identifier
* @param int $row number of the row where the data can be found
* @param int $field field number where the data can be found
* @return mixed content of the specified data cell, a MDB error on failure
return($this->fetchLob($result, $row, $field));
* convert a value to a RDBMS indepdenant MDB type
* @param mixed $value value to be converted
* @param int $type constant that specifies which type to convert to
* @return mixed converted value
return($this->_baseConvertResult ($value, $type));
* returns the number of rows in a result object
* @param ressource $result a valid result ressouce pointer
* @return mixed MDB_Error or the number of rows
* Free the internal resources associated with $result.
* @param $result result identifier
* @return boolean TRUE on success, FALSE if $result is invalid
$result_value = intval($result);
if(isset ($this->columns[$result_value])) {
unset ($this->columns[$result_value]);
if(isset ($this->result_types[$result_value])) {
unset ($this->result_types[$result_value]);
// {{{ getIntegerDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an integer type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Boolean flag that indicates whether the field
* should be declared as unsigned integer if
* Integer value to be used as default for this
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
(isset ($field['unsigned']) ? ' UNSIGNED' : '').
(isset ($field['default']) ? ' DEFAULT '. $field['default'] : '').
(isset ($field['notnull']) ? ' NOT NULL' : '')
// {{{ getClobDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an character
* large object type field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the
* properties of the field being declared as array
* indexes. Currently, the types of supported field
* properties are as follows:
* Integer value that determines the maximum length
* of the large object field. If this argument is
* missing the field should be declared to have the
* longest length allowed by the DBMS.
* Boolean flag that indicates whether this field
* is constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
if (isset ($field['length'])) {
$length = $field['length'];
if ($length <= 16777215 ) {
(isset ($field['notnull']) ? ' NOT NULL' : ''));
// {{{ getBlobDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an binary large
* object type field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Integer value that determines the maximum length
* of the large object field. If this argument is
* missing the field should be declared to have the
* longest length allowed by the DBMS.
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
if (isset ($field['length'])) {
$length = $field['length'];
if ($length <= 16777215 ) {
(isset ($field['notnull']) ? ' NOT NULL' : ''));
// {{{ getDateDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an date type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field properties
* Date value to be used as default for this field.
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
(isset ($field['default']) ? " DEFAULT '". $field['default']. "'" : '').
(isset ($field['notnull']) ? ' NOT NULL' : '')
// {{{ getTimestampDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an timestamp
* type field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Time stamp value to be used as default for this
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
(isset ($field['default']) ? " DEFAULT '". $field['default']. "'" : '').
(isset ($field['notnull']) ? ' NOT NULL' : '')
// {{{ getTimeDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an time type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Time value to be used as default for this field.
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
(isset ($field['default']) ? " DEFAULT '". $field['default']. "'" : '').
(isset ($field['notnull']) ? ' NOT NULL' : '')
// {{{ getFloatDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an float type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Integer value to be used as default for this
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
if (isset ($this->options['fixedfloat'])) {
// XXX needs more checking
(isset ($field['default']) ?
(isset ($field['notnull']) ? ' NOT NULL' : '')
// {{{ getDecimalDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an decimal type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $field associative array with the name of the properties
* of the field being declared as array indexes.
* Currently, the types of supported field
* properties are as follows:
* Integer value to be used as default for this
* Boolean flag that indicates whether this field is
* constrained to not be set to NULL.
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
(isset ($field['default']) ?
(isset ($field['notnull']) ? ' NOT NULL' : '')
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param resource $prepared_query query handle from prepare()
* @return string text string that represents the given argument value in
* a DBMS specific format.
if (MDB::isError($result = $this->readLob($clob, $data, $this->options['lob_buffer_length']))) {
$value .= $this->_quote ($data);
* free a character large object
* @param resource $prepared_query query handle from prepare()
unset ($this->lobs[$clob]);
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param resource $prepared_query query handle from prepare()
* @return string text string that represents the given argument value in
* a DBMS specific format.
if (MDB::isError($result = $this->readLob($blob, $data, $this->options['lob_buffer_length']))) {
* free a binary large object
* @param resource $prepared_query query handle from prepare()
unset ($this->lobs[$blob]);
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param string $value text string value that is intended to be converted.
* @return string text string that represents the given argument value in
* a DBMS specific format.
return(($value === NULL ) ? 'NULL' : (float) $value);
* Convert a text value into a DBMS specific format that is suitable to
* compose query statements.
* @param string $value text string value that is intended to be converted.
* @return string text string that represents the given argument value in
* a DBMS specific format.
* returns the next free id of a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true the seqence is
* automatic created, if it
* @return mixed MDB_Error or id
function nextId($seq_name, $ondemand = TRUE )
$result = $this->query(" INSERT INTO $sequence_name ("
. $this->options['sequence_col_name']. ") VALUES (NULL)");
// Since we are create the sequence on demand
// we know the first id = 1 so initialize the
'Next ID: on demand sequence could not be created'));
// First ID of a newly created sequence is 1
$res = $this->query(" DELETE FROM $sequence_name WHERE "
. $this->options['sequence_col_name']." < $value" );
$this->warnings[] = 'Next ID: could not delete previous sequence table values';
* returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB_Error or id
$result = $this->query("SELECT MAX(". $this->options['sequence_col_name']." ) FROM $sequence_name" , 'integer');
* Fetch a row and insert the data into an existing array.
* @param resource $result result identifier
* @param int $fetchmode how the array data should be indexed
* @param int $rownum the row number to fetch
* @return int data array on success, a MDB error on failure
function fetchInto($result, $fetchmode = MDB_FETCHMODE_DEFAULT , $rownum = NULL )
$result_value = intval($result);
$fetchmode = $this->fetchmode;
if (is_array($row) && $this->options['optimize'] == 'portability') {
if($this->options['autofree']) {
if (isset ($this->result_types[$result_value])) {
* Move the internal mysql result pointer to the next available result
* Currently not supported
* @param a valid result resource
* @return true if a result is available otherwise return false
* returns meta data about the result set
* @param resource $result result identifier
* @param mixed $mode depends on implementation
* @return array an nested array, or a MDB error
* depending on $mode, metadata returns the following values:
* - mode is false (default):
* [0]['table'] table name
* [0]['len'] field length
* [0]['flags'] field flags
* - mode is MDB_TABLEINFO_ORDER
* ['num_fields'] number of metadata records
* [0]['table'] table name
* [0]['len'] field length
* [0]['flags'] field flags
* ['order'][field name] index of field named "field name"
* The last one is used, if you have a field name, but no index.
* Test: if (isset($result['meta']['myfield'])) { ...
* - mode is MDB_TABLEINFO_ORDERTABLE
* the same as above. but additionally
* ['ordertable'][table name][field name] index of field
* this is, because if you have fields from different
* tables with the same field name * they override each
* other with MDB_TABLEINFO_ORDER
* you can combine MDB_TABLEINFO_ORDER and
* MDB_TABLEINFO_ORDERTABLE with MDB_TABLEINFO_ORDER |
* MDB_TABLEINFO_ORDERTABLE * or with MDB_TABLEINFO_FULL
// if $result is a string, then we want information about a
// table without a resultset
} else { // else we want information about a resultset
// made this IF due to performance (one if is faster than $count if's)
for ($i = 0 , $j = 0; $i< $count; $i++ ) {
if ($name != 'dummy_primary_key') {
$res[$j]['name'] = $name;
$res['num_fields'] = $count;
for ($i = 0; $i< $count; $i++ ) {
if ($name != 'dummy_primary_key') {
$res[$j]['name'] = $name;
// note sure if this should be $i or $j
$res['order'][$res[$j]['name']] = $i;
$res['ordertable'][$res[$j]['table']][$res[$j]['name']] = $j;
// free the result only if we were called on a table
Documentation generated on Mon, 11 Mar 2019 10:15:28 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|