Source for file mysql.php
Documentation is available at mysql.php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
* The PEAR DB driver for PHP's mysql extension
* for interacting with MySQL databases
* LICENSE: This source file is subject to version 3.0 of the PHP license
* that is available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
* the PHP License and are unable to obtain it through the web, please
* send a note to license@php.net so we can mail you a copy immediately.
* @author Stig Bakken <ssb@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version CVS: $Id: mysql.php,v 1.126 2007/09/21 13:32:52 aharvey Exp $
* @link http://pear.php.net/package/DB
* Obtain the DB_common class so it can be extended from
require_once DB_PEAR_PATH.
'DB/common.php';
* The methods PEAR DB uses to interact with PHP's mysql extension
* for interacting with MySQL databases
* These methods overload the ones declared in DB_common.
* @author Stig Bakken <ssb@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1997-2007 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version Release: 1.7.13
* @link http://pear.php.net/package/DB
* The DB driver type (mysql, oci8, odbc, etc.)
* The database syntax variant to be used (db2, access, etc.), if any
* The capabilities of this DB implementation
* The 'new_link' element contains the PHP version that first provided
* new_link support for this DBMS. Contains false if it's unsupported.
* Meaning of the 'limit' element:
* + 'emulate' = emulate with fetch row by number
* + 'alter' = alter the query
* A mapping of native error codes to DB error codes
1004 =>
DB_ERROR_CANNOT_CREATE,
1005 =>
DB_ERROR_CANNOT_CREATE,
1006 =>
DB_ERROR_CANNOT_CREATE,
1007 =>
DB_ERROR_ALREADY_EXISTS,
1008 =>
DB_ERROR_CANNOT_DROP,
1022 =>
DB_ERROR_ALREADY_EXISTS,
1044 =>
DB_ERROR_ACCESS_VIOLATION,
1046 =>
DB_ERROR_NODBSELECTED,
1048 =>
DB_ERROR_CONSTRAINT,
1049 =>
DB_ERROR_NOSUCHDB,
1050 =>
DB_ERROR_ALREADY_EXISTS,
1051 =>
DB_ERROR_NOSUCHTABLE,
1054 =>
DB_ERROR_NOSUCHFIELD,
1061 =>
DB_ERROR_ALREADY_EXISTS,
1062 =>
DB_ERROR_ALREADY_EXISTS,
1091 =>
DB_ERROR_NOT_FOUND,
1100 =>
DB_ERROR_NOT_LOCKED,
1136 =>
DB_ERROR_VALUE_COUNT_ON_ROW,
1142 =>
DB_ERROR_ACCESS_VIOLATION,
1146 =>
DB_ERROR_NOSUCHTABLE,
1216 =>
DB_ERROR_CONSTRAINT,
1217 =>
DB_ERROR_CONSTRAINT,
1356 =>
DB_ERROR_DIVZERO,
1451 =>
DB_ERROR_CONSTRAINT,
1452 =>
DB_ERROR_CONSTRAINT,
* The raw database connection created by PHP
* The DSN information for connecting to a database
* Should data manipulation queries be committed automatically?
* The quantity of transactions begun
* {@internal While this is private, it can't actually be designated
* private in PHP 5 because it is directly accessed in the test suite.}}}
var $transaction_opcount =
0;
* The database specified in the DSN
* It's a fix to allow calls to different databases in the same script.
* This constructor calls <kbd>$this->DB_common()</kbd>
* Connect to the database server, log in and open the database
* Don't call this method directly. Use DB::connect() instead.
* PEAR DB's mysql driver supports the following extra DSN options:
* + new_link If set to true, causes subsequent calls to connect()
* to return a new connection link instead of the
* existing one. WARNING: this is not portable to
* other DBMS's. Available since PEAR DB 1.7.0.
* + client_flags Any combination of MYSQL_CLIENT_* constants.
* Only used if PHP is at version 4.3.0 or greater.
* Available since PEAR DB 1.7.0.
* @param array $dsn the data source name
* @param bool $persistent should the connection be persistent?
* @return int DB_OK on success. A DB_Error object on failure.
function connect($dsn, $persistent =
false)
if ($dsn['protocol'] &&
$dsn['protocol'] ==
'unix') {
$params[0] =
':' .
$dsn['socket'];
$params[0] =
$dsn['hostspec'] ?
$dsn['hostspec']
$params[0] .=
':' .
$dsn['port'];
$params[] =
$dsn['username'] ?
$dsn['username'] :
null;
$params[] =
$dsn['password'] ?
$dsn['password'] :
null;
if (isset
($dsn['new_link'])
&&
($dsn['new_link'] ==
'true' ||
$dsn['new_link'] ===
true))
$params[] = isset
($dsn['client_flags'])
?
$dsn['client_flags'] :
null;
$connect_function =
$persistent ?
'mysql_pconnect' :
'mysql_connect';
$this->_db =
$dsn['database'];
* Disconnects from the database server
* @return bool TRUE on success, FALSE on failure
* Sends a query to the database server
* Generally uses mysql_query(). If you want to use
* mysql_unbuffered_query() set the "result_buffering" option to 0 using
* setOptions(). This option was added in Release 1.7.0.
* @param string the SQL query string
* @return mixed + a PHP result resrouce for successful SELECT queries
* + the DB_OK constant for other successful queries
* + a DB_Error object on failure
if (!$this->autocommit &&
$ismanip) {
if ($this->transaction_opcount ==
0) {
$this->transaction_opcount++
;
if (!$this->options['result_buffering']) {
* Move the internal mysql result pointer to the next available result
* This method has not been implemented yet.
* @param a valid sql result resource
* Places a row from the result set into the given array
* Formating of the array and the data therein are configurable.
* See DB_result::fetchInto() for more information.
* This method is not meant to be called directly. Use
* DB_result::fetchInto() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result the query result resource
* @param array $arr the referenced array to put the data in
* @param int $fetchmode how the resulting array should be indexed
* @param int $rownum the row number to fetch (0 = first row)
* @return mixed DB_OK on success, NULL when the end of a result set is
* @see DB_result::fetchInto()
function fetchInto($result, &$arr, $fetchmode, $rownum =
null)
* Even though this DBMS already trims output, we do this because
* a field might have intentional whitespace at the end that
* gets removed by DB_PORTABILITY_RTRIM under another driver.
* Deletes the result set and frees the memory occupied by the result set
* This method is not meant to be called directly. Use
* DB_result::free() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return bool TRUE on success, FALSE if $result is invalid
* Gets the number of columns in a result set
* This method is not meant to be called directly. Use
* DB_result::numCols() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of columns. A DB_Error object on failure.
* @see DB_result::numCols()
* Gets the number of rows in a result set
* This method is not meant to be called directly. Use
* DB_result::numRows() instead. It can't be declared "protected"
* because DB_result is a separate object.
* @param resource $result PHP's query result resource
* @return int the number of rows. A DB_Error object on failure.
* @see DB_result::numRows()
* Enables or disables automatic commits
* @param bool $onoff true turns it on, false turns it off
* @return int DB_OK on success. A DB_Error object if the driver
* doesn't support auto-committing transactions.
// XXX if $this->transaction_opcount > 0, we should probably
$this->autocommit =
$onoff ?
true :
false;
* Commits the current transaction
* @return int DB_OK on success. A DB_Error object on failure.
if ($this->transaction_opcount >
0) {
$this->transaction_opcount =
0;
* Reverts the current transaction
* @return int DB_OK on success. A DB_Error object on failure.
if ($this->transaction_opcount >
0) {
$this->transaction_opcount =
0;
* Determines the number of rows affected by a data maniuplation query
* 0 is returned for queries that don't manipulate data.
* @return int the number of rows. A DB_Error object on failure.
* Returns the next free id in a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true, the seqence is automatically
* created if it does not exist
* @return int the next id number in the sequence.
* A DB_Error object on failure.
* @see DB_common::nextID(), DB_common::getSequenceName(),
* DB_mysql::createSequence(), DB_mysql::dropSequence()
function nextId($seq_name, $ondemand =
true)
$result =
$this->query("UPDATE ${seqname} ".
'SET id=LAST_INSERT_ID(id+1)');
// Sequence table must be empty for some reason, so fill
// it and return 1 and obtain a user-level lock
$result =
$this->getOne("SELECT GET_LOCK('${seqname}_lock',10)");
// Failed to get the lock
$result =
$this->query("REPLACE INTO ${seqname} (id) VALUES (0)");
$result =
$this->getOne('SELECT RELEASE_LOCK('
// We know what the result will be, so no need to try again
} elseif ($ondemand &&
DB::isError($result) &&
// ONDEMAND TABLE CREATION
// see _BCsequence() comment
$result =
$this->_BCsequence($seqname);
* @param string $seq_name name of the new sequence
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::createSequence(), DB_common::getSequenceName(),
* DB_mysql::nextID(), DB_mysql::dropSequence()
$res =
$this->query('CREATE TABLE ' .
$seqname
.
' (id INTEGER UNSIGNED AUTO_INCREMENT NOT NULL,'
// insert yields value 1, nextId call will generate ID 2
$res =
$this->query("INSERT INTO ${seqname} (id) VALUES (0)");
return $this->query("UPDATE ${seqname} SET id = 0");
* @param string $seq_name name of the sequence to be deleted
* @return int DB_OK on success. A DB_Error object on failure.
* @see DB_common::dropSequence(), DB_common::getSequenceName(),
* DB_mysql::nextID(), DB_mysql::createSequence()
* Backwards compatibility with old sequence emulation implementation
* @param string $seqname the sequence name to clean up
* @return bool true on success. A DB_Error object on failure.
function _BCsequence($seqname)
// Obtain a user-level lock... this will release any previous
// application locks, but unlike LOCK TABLES, it does not abort
// the current transaction and is much less frequently used.
$result =
$this->getOne("SELECT GET_LOCK('${seqname}_lock',10)");
// Failed to get the lock, can't do the conversion, bail
// with a DB_ERROR_NOT_LOCKED error
$highest_id =
$this->getOne("SELECT MAX(id) FROM ${seqname}");
// This should kill all rows except the highest
// We should probably do something if $highest_id isn't
// numeric, but I'm at a loss as how to handle that...
$result =
$this->query('DELETE FROM ' .
$seqname
.
" WHERE id <> $highest_id");
// If another thread has been waiting for this lock,
// it will go thru the above procedure, but will have no
$result =
$this->getOne("SELECT RELEASE_LOCK('${seqname}_lock')");
* Quotes a string so it can be safely used as a table or column name
* (WARNING: using names that require this is a REALLY BAD IDEA)
* WARNING: Older versions of MySQL can't handle the backtick
* character (<kbd>`</kbd>) in table or column names.
* @param string $str identifier name to be quoted
* @return string quoted identifier string
* @see DB_common::quoteIdentifier()
* @since Method available since Release 1.6.0
* @deprecated Deprecated in release 1.6.0
* Escapes a string according to the current DBMS's standards
* @param string $str the string to be escaped
* @return string the escaped string
* @see DB_common::quoteSmart()
* @since Method available since Release 1.6.0
* Changes a query string for various DBMS specific reasons
* This little hack lets you know how many rows were deleted
* when running a "DELETE FROM table" query. Only implemented
* if the DB_PORTABILITY_DELETE_COUNT portability option is on.
* @param string $query the query string to modify
* @return string the modified query string
* @see DB_common::setOption()
// "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);
// {{{ modifyLimitQuery()
* Adds LIMIT clauses to a query string according to current DBMS standards
* @param string $query the query to modify
* @param int $from the row to start to fetching (0 = the first row)
* @param int $count the numbers of rows to fetch
* @param mixed $params array, string or numeric data to be used in
* execution of the statement. Quantity of items
* passed must match quantity of placeholders in
* query: meaning 1 placeholder for non-array
* parameters or 1 placeholder per array element.
* @return string the query string with LIMIT clauses added
return $query .
" LIMIT $count";
return $query .
" LIMIT $from, $count";
* Produces a DB_Error object regarding the current problem
* @param int $errno if the error is being manually raised pass a
* DB_ERROR* constant here. If this isn't passed
* the error information gathered from the DBMS.
* @return object the DB_Error object
* @see DB_common::raiseError(),
* DB_mysql::errorNative(), DB_common::errorCode()
// Doing this in case mode changes during runtime.
return $this->raiseError($errno, null, null, null,
* Gets the DBMS' native error code produced by the last query
* @return int the DBMS' error code
* Returns information about a table or a result set
* @param object|string $result DB_result object from a query or a
* string containing the name of a table.
* While this also accepts a query result
* resource identifier, this behavior is
* @param int $mode a valid tableInfo mode
* @return array an associative array with the information requested.
* A DB_Error object on failure.
* @see DB_common::tableInfo()
* Probably received a table name.
* Create a result resource identifier.
} elseif (isset
($result->result)) {
* Probably received a result object.
* Extract the result resource identifier.
* Probably received a result resource identifier.
* Deprecated. Here for compatibility only.
$case_func =
'strtolower';
$res['num_fields'] =
$count;
for ($i =
0; $i <
$count; $i++
) {
$res['order'][$res[$i]['name']] =
$i;
$res['ordertable'][$res[$i]['table']][$res[$i]['name']] =
$i;
// free the result only if we were called on a table
* Obtains the query string needed for listing a given type of objects
* @param string $type the kind of objects you want to retrieve
* @return string the SQL query string or null if the driver doesn't
* support the object type requested
* @see DB_common::getListOf()
return 'SELECT DISTINCT User FROM mysql.user';
Documentation generated on Wed, 09 Feb 2011 09:02:11 +0700 by phpDocumentor 1.4.2