Source for file mysql.php
Documentation is available at mysql.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB2 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@pooteeweet.org> |
// +----------------------------------------------------------------------+
// $Id: mysql.php,v 1.87 2005/12/10 15:24:17 lsmith Exp $
* @author Lukas Smith <smith@pooteeweet.org>
$this->phptype = 'mysql';
$this->dbsyntax = 'mysql';
$this->supported['sequences'] = 'emulated';
$this->supported['indexes'] = true;
$this->supported['affected_rows'] = true;
$this->supported['transactions'] = false;
$this->supported['summary_functions'] = true;
$this->supported['order_by_text'] = true;
$this->supported['current_id'] = 'emulated';
$this->supported['limit_queries'] = true;
$this->supported['LOBs'] = true;
$this->supported['replace'] = true;
$this->supported['sub_selects'] = 'emulated';
$this->supported['auto_increment'] = true;
$this->supported['primary_key'] = true;
$this->options['default_table_type'] = null;
* This method is used to collect information about an error
1004 => MDB2_ERROR_CANNOT_CREATE ,
1005 => MDB2_ERROR_CANNOT_CREATE ,
1006 => MDB2_ERROR_CANNOT_CREATE ,
1007 => MDB2_ERROR_ALREADY_EXISTS ,
1008 => MDB2_ERROR_CANNOT_DROP ,
1022 => MDB2_ERROR_ALREADY_EXISTS ,
1044 => MDB2_ERROR_ACCESS_VIOLATION ,
1046 => MDB2_ERROR_NODBSELECTED ,
1048 => MDB2_ERROR_CONSTRAINT ,
1049 => MDB2_ERROR_NOSUCHDB ,
1050 => MDB2_ERROR_ALREADY_EXISTS ,
1051 => MDB2_ERROR_NOSUCHTABLE ,
1054 => MDB2_ERROR_NOSUCHFIELD ,
1061 => MDB2_ERROR_ALREADY_EXISTS ,
1062 => MDB2_ERROR_ALREADY_EXISTS ,
1064 => MDB2_ERROR_SYNTAX ,
1091 => MDB2_ERROR_NOT_FOUND ,
1100 => MDB2_ERROR_NOT_LOCKED ,
1136 => MDB2_ERROR_VALUE_COUNT_ON_ROW ,
1142 => MDB2_ERROR_ACCESS_VIOLATION ,
1146 => MDB2_ERROR_NOSUCHTABLE ,
1216 => MDB2_ERROR_CONSTRAINT ,
1217 => MDB2_ERROR_CONSTRAINT ,
if ($this->options['portability'] & MDB2_PORTABILITY_ERRORS ) {
$ecode_map[1022 ] = MDB2_ERROR_CONSTRAINT;
$ecode_map[1048 ] = MDB2_ERROR_CONSTRAINT_NOT_NULL;
$ecode_map[1062 ] = MDB2_ERROR_CONSTRAINT;
// Doing this in case mode changes during runtime.
$ecode_map[1022 ] = MDB2_ERROR_ALREADY_EXISTS;
$ecode_map[1048 ] = MDB2_ERROR_CONSTRAINT;
$ecode_map[1062 ] = MDB2_ERROR_ALREADY_EXISTS;
if (isset ($ecode_map[$native_code])) {
$error = $ecode_map[$native_code];
return array ($error, $native_code, $native_msg);
* Quotes a string so it can be safely used in a query. It will quote
* the text so it can safely be used within a query.
* @param string $text the input string to quote
* @return string quoted string
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
* 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
* @param bool $check_option check the 'quote_identifier' option
* @return string quoted identifier string
if ($check_option && !$this->options['quote_identifier']) {
// {{{ beginTransaction()
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('starting transaction', 'beginTransaction');
if (!$this->supports ('transactions')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'beginTransaction: transactions are not in use');
if ($this->in_transaction) {
return MDB2_OK; //nothing to do
if (!$this->destructor_registered && $this->opened_persistent) {
$this->destructor_registered = true;
$result = $this->_doQuery('SET AUTOCOMMIT = 0', true );
if (PEAR ::isError ($result)) {
$this->in_transaction = true;
* Commit the database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('commit transaction', 'commit');
if (!$this->supports ('transactions')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'commit: transactions are not in use');
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR , null , null ,
'commit: transaction changes are being auto committed');
$result = $this->_doQuery('COMMIT', true );
if (PEAR ::isError ($result)) {
$result = $this->_doQuery('SET AUTOCOMMIT = 1', true );
if (PEAR ::isError ($result)) {
$this->in_transaction = false;
* Cancel any database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('rolling back transaction', 'rollback');
if (!$this->supports ('transactions')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'rollback: transactions are not in use');
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR , null , null ,
'rollback: transactions can not be rolled back when changes are auto committed');
$result = $this->_doQuery('ROLLBACK', true );
if (PEAR ::isError ($result)) {
$result = $this->_doQuery('SET AUTOCOMMIT = 1', true );
if (PEAR ::isError ($result)) {
$this->in_transaction = false;
* Connect to the database
* @return true on success, MDB2 Error Object on failure
&& $this->opened_persistent == $this->options['persistent']
if (!PEAR ::loadExtension ($this->phptype)) {
return $this->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'connect: extension '. $this->phptype. ' is not compiled into PHP');
if ($this->dsn['protocol'] && $this->dsn['protocol'] == 'unix') {
$params[0 ] = ':' . $this->dsn['socket'];
$params[0 ] = $this->dsn['hostspec'] ? $this->dsn['hostspec']
if ($this->dsn['port']) {
$params[0 ].= ':' . $this->dsn['port'];
$params[] = $this->dsn['username'] ? $this->dsn['username'] : null;
$params[] = $this->dsn['password'] ? $this->dsn['password'] : null;
if (!$this->options['persistent']) {
if (isset ($this->dsn['new_link'])
&& ($this->dsn['new_link'] == 'true' || $this->dsn['new_link'] === true )
$params[] = isset ($this->dsn['client_flags'])
? $this->dsn['client_flags'] : null;
$connect_function = $this->options['persistent'] ? 'mysql_pconnect' : 'mysql_connect';
return $this->raiseError (MDB2_ERROR_CONNECT_FAILED , null , null , $err);
return $this->raiseError (MDB2_ERROR_CONNECT_FAILED , null , null , $php_errormsg);
$this->connection = $connection;
$this->connected_dsn = $this->dsn;
$this->connected_database_name = '';
$this->opened_persistent = $this->options['persistent'];
$this->dbsyntax = $this->dsn['dbsyntax'] ? $this->dsn['dbsyntax'] : $this->phptype;
$this->supported['transactions'] = false;
if ($this->options['default_table_type']) {
switch (strtoupper($this->options['default_table_type'])) {
$this->options['default_table_type'] = 'BDB';
$this->supported['transactions'] = true;
$this->warnings[] = $default_table_type.
' is not a supported default table type';
if ($this->options['use_transactions'] && !$this->supports ('transactions')) {
$this->warnings[] = $this->options['default_table_type'].
' is not a transaction-safe default table type; switched to INNODB';
$this->options['default_table_type'] = 'INNODB';
$this->supported['transactions'] = true;
&& ($server_info['major'] > 4 )
|| ($server_info['major'] > 4 && $server_info['minor'] > 1 )
$this->supported['sub_selects'] = true;
* Log out and disconnect from the database.
* @return mixed true on success, false if not connected and error
if($this->in_transaction) {
if (!$this->opened_persistent || $force) {
$this->in_transaction = false;
* @param string $query query
* @param boolean $is_manip if the query is a manipulation query
* @param resource $connection
* @param string $database_name
* @return result or error object
function _doQuery($query, $is_manip = false , $connection = null , $database_name = null )
$this->last_query = $query;
$this->debug ($query, 'query');
if ($this->options['disable_query']) {
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
$database_name = $this->database_name;
if ($database_name != $this->connected_database_name) {
return $this->raiseError ();
$this->connected_database_name = $database_name;
$function = $this->options['result_buffering']
? 'mysql_query' : 'mysql_unbuffered_query';
$result = @$function($query, $connection);
return $this->raiseError ();
* returns the number of rows affected
* @param resource $result
* @param resource $connection
* @return mixed MDB2 Error Object or the number of rows affected
function _affectedRows ($connection, $result = null )
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
* Changes a query string for various DBMS specific reasons
* @param string $query query to modify
* @return the new (modified) query
if ($this->options['portability'] & MDB2_PORTABILITY_DELETE_COUNT ) {
// "DELETE FROM table" gives 0 affected rows in MySQL.
// This little hack lets you know how many rows were deleted.
if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $query)) {
'DELETE FROM \1 WHERE 1=1', $query);
&& !preg_match('/LIMIT\s*\d(\s*(,|OFFSET)\s*\d+)?/i', $query)
if (substr($query, -1 ) == ';') {
$query = substr($query, 0 , -1 );
return $query . " LIMIT $limit";
return $query . " LIMIT $offset, $limit";
// {{{ getServerVersion()
* return version information about the server
* @param string $native determines if the raw version string should be returned
* @return mixed array with versoin information or row string
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
'native' => $server_info,
* 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 MDB2_OK on success, a MDB2 error on failure
for (reset($fields); $colnum < $count; next($fields), $colnum++ ) {
if (isset ($fields[$name]['null']) && $fields[$name]['null']) {
$value = $this->quote ($fields[$name]['value'], $fields[$name]['type']);
if (isset ($fields[$name]['key']) && $fields[$name]['key']) {
return $this->raiseError (MDB2_ERROR_CANNOT_REPLACE , null , null ,
'replace: key value '. $name. ' may not be NULL');
return $this->raiseError (MDB2_ERROR_CANNOT_REPLACE , null , null ,
'replace: not specified which fields are keys');
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
$query = " REPLACE INTO $table ($query) VALUES ($values)";
$this->last_query = $query;
$this->debug ($query, 'query');
$result = $this->_doQuery($query, true , $connection);
if (PEAR ::isError ($result)) {
return $this->_affectedRows ($connection, $result);
* 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 MDB2 Error Object or id
function nextID($seq_name, $ondemand = true )
$sequence_name = $this->quoteIdentifier($this->getSequenceName ($seq_name), true );
$seqcol_name = $this->quoteIdentifier($this->options['seqcol_name'], true );
$query = " INSERT INTO $sequence_name ($seqcol_name) VALUES (NULL)";
$this->expectError (MDB2_ERROR_NOSUCHTABLE );
$result = $this->_doQuery($query, true );
if (PEAR ::isError ($result)) {
if ($ondemand && $result->getCode () == MDB2_ERROR_NOSUCHTABLE ) {
$this->loadModule ('Manager');
// Since we are creating the sequence on demand
// we know the first id = 1 so initialize the
$result = $this->manager->createSequence ($seq_name, 2 );
if (PEAR ::isError ($result)) {
return $this->raiseError (MDB2_ERROR , null , null ,
'nextID: on demand sequence '. $seq_name. ' could not be created');
// First ID of a newly created sequence is 1
$query = " DELETE FROM $sequence_name WHERE $seqcol_name < $value";
$result = $this->_doQuery($query, true );
if (PEAR ::isError ($result)) {
$this->warnings[] = 'nextID: could not delete previous sequence table values from '. $seq_name;
* returns the autoincrement ID if supported or $id
* @param mixed $id value as returned by getBeforeId()
* @param string $table name of the table into which a new row was inserted
* @return mixed MDB2 Error Object or id
$connection = $this->getConnection ();
if (PEAR ::isError ($connection)) {
return $this->raiseError ();
* returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB2 Error Object or id
$sequence_name = $this->quoteIdentifier($this->getSequenceName ($seq_name), true );
$seqcol_name = $this->quoteIdentifier($this->options['seqcol_name'], true );
$query = " SELECT MAX($seqcol_name) FROM $sequence_name";
return $this->queryOne ($query, 'integer');
* Fetch a row and insert the data into an existing array.
* @param int $fetchmode how the array data should be indexed
* @param int $rownum number of the row where the data can be found
* @return int data array on success, a MDB2 error on failure
function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT , $rownum = null )
$seek = $this->seek ($rownum);
if (PEAR ::isError ($seek)) {
if ($fetchmode == MDB2_FETCHMODE_DEFAULT ) {
$fetchmode = $this->db->fetchmode;
if ($fetchmode & MDB2_FETCHMODE_ASSOC ) {
&& $this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
$err = & $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'fetchRow: resultset has already been freed');
if ($this->db->options ['portability'] & MDB2_PORTABILITY_EMPTY_TO_NULL ) {
$this->db->_fixResultArrayValues ($row, MDB2_PORTABILITY_EMPTY_TO_NULL );
if (!empty ($this->values)) {
$this->_assignBindColumns ($row);
if (!empty ($this->types)) {
$row = $this->db->datatype ->convertResultRow ($this->types, $row);
if ($fetchmode === MDB2_FETCHMODE_OBJECT ) {
$object_class = $this->db->options ['fetch_class'];
if ($object_class == 'stdClass') {
$row = &new $object_class($row);
* Retrieve the names of columns returned by the DBMS in a query result.
* @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
* a MDB2 error on failure
function _getColumnNames ()
if (PEAR ::isError ($numcols)) {
for ($column = 0; $column < $numcols; $column++ ) {
$columns[$column_name] = $column;
if ($this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
* Count the number of columns returned by the DBMS in a query result.
* @return mixed integer value with the number of columns, a MDB2 error
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'numCols: resultset has already been freed');
return $this->db->raiseError ();
* Free the internal resources associated with result.
* @return boolean true on success, false if result is invalid
return $this->db->raiseError ();
* seek to a specific row in a result set
* @param int $rownum number of the row where the data can be found
* @return mixed MDB2_OK on success, a MDB2 error on failure
function seek($rownum = 0 )
if ($this->rownum != ($rownum - 1 ) && !@mysql_data_seek($this->result, $rownum)) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'seek: resultset has already been freed');
return $this->db->raiseError (MDB2_ERROR_INVALID , null , null ,
'seek: tried to seek to an invalid row number ('. $rownum. ')');
$this->rownum = $rownum - 1;
* check if the end of the result set has been reached
* @return mixed true or false on sucess, a MDB2 error on failure
if (PEAR ::isError ($numrows)) {
return $this->rownum < ($numrows - 1 );
* returns the number of rows in a result object
* @return mixed MDB2 Error Object or the number of rows
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'numRows: resultset has already been freed');
return $this->raiseError ();
Documentation generated on Mon, 11 Mar 2019 14:31:44 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|