MediaWiki  1.29.1
Wikimedia\Rdbms\DatabaseMysqli Class Reference

Database abstraction object for PHP extension mysqli. More...

Inheritance diagram for Wikimedia\Rdbms\DatabaseMysqli:
Collaboration diagram for Wikimedia\Rdbms\DatabaseMysqli:

Public Member Functions

 __toString ()
 Give an id for the connection. More...
 
 affectedRows ()
 
 insertId ()
 
 lastErrno ()
 
 selectDB ( $db)
 
- Public Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
 __construct (array $params)
 Additional $params include: More...
 
 addIdentifierQuotes ( $s)
 MySQL uses backticks for identifier quoting instead of the sql standard "double quotes". More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. More...
 
 dataSeek ( $res, $row)
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 dropTable ( $tableName, $fName=__METHOD__)
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 
 estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
 Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Database::select() More...
 
 fetchObject ( $res)
 
 fetchRow ( $res)
 
 fieldInfo ( $table, $field)
 
 fieldName ( $res, $n)
 
 fieldType ( $res, $n)
 mysql_field_type() wrapper More...
 
 freeResult ( $res)
 
 getLag ()
 Get replica DB lag. More...
 
 getMasterPos ()
 Get the position of the master from SHOW MASTER STATUS. More...
 
 getReplicaPos ()
 Get the position of the master from SHOW SLAVE STATUS. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getType ()
 
 ignoreIndexClause ( $index)
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object Returns false if the index does not exist. More...
 
 isQuotedIdentifier ( $name)
 
 isView ( $name, $prefix=null)
 Differentiates between a TABLE and a VIEW. More...
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is available. More...
 
 lowPriorityOption ()
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 numFields ( $res)
 
 numRows ( $res)
 
 open ( $server, $user, $password, $dbName)
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 
 setSessionOptions (array $options)
 
 streamStatementEnd (&$sql, &$newLine)
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 unlock ( $lockName, $method)
 FROM MYSQL DOCS: https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock. More...
 
 upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 
 useIndexClause ( $index)
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value alias. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 bufferResults ( $buffer=null)
 Turns buffering of SQL result sets on (true) or off (false). More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...
 
 buildStringCast ( $field)
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Closes a database connection. More...
 
 commit ( $fname=__METHOD__, $flush='')
 Commits a transaction previously started using begin(). More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 This method should not be used outside of Database classes. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ( $table, $conds, $fname=__METHOD__)
 DELETE query wrapper. More...
 
 doAtomicSection ( $fname, callable $callback)
 Run a callback to do an atomic set of updates for this database. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. More...
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ( $fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getProperty ( $name)
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY. More...
 
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More...
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More...
 
 indexUnique ( $table, $index)
 Determines if a given index is unique. More...
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that went through IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. More...
 
 makeList ( $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited. More...
 
 nextSequenceValue ( $seqName)
 Returns an appropriately quoted sequence value for inserting a new row. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ( $sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 reportConnectionError ( $error='Unknown error')
 
 reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush='')
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually run and consume any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually run and consume any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ( $name, $value=null)
 Set the LB info array, or a member of it. More...
 
 setLogger (LoggerInterface $logger)
 
 setSchemaVars ( $vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__)
 Begin an atomic section of statements. More...
 
 strreplace ( $orig, $old, $new)
 Returns a comand for str_replace function in SQL query. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query. More...
 
 tableNames ()
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN ()
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited". More...
 
 timestamp ( $ts=0)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 timestampOrNull ( $ts=null)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionQueries ( $sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 

Public Attributes

return $ret
 
if( $this->bufferResults()) else
 
- Public Attributes inherited from Wikimedia\Rdbms\Database
const DEADLOCK_DELAY_MAX = 1500000
 Maximum time to wait before retry. More...
 
const DEADLOCK_DELAY_MIN = 500000
 Minimum time to wait before retry, in microseconds. More...
 
const DEADLOCK_TRIES = 4
 Number of times to re-try an operation in case of deadlock. More...
 
const PING_QUERY = 'SELECT 1 AS ping'
 
const PING_TTL = 1.0
 How long before it is worth doing a dummy query to test the connection. More...
 
const SLOW_WRITE_SEC = .500
 
const SMALL_WRITE_ROWS = 100
 
const TINY_WRITE_SEC = .010
 

Protected Member Functions

 closeConnection ()
 
 connectInitCharset ()
 Set the character set information right after connection. More...
 
 mysqlConnect ( $realServer)
 
 mysqlDataSeek ( $res, $row)
 
 mysqlError ( $conn=null)
 
 mysqlFetchArray ( $res)
 
 mysqlFetchField ( $res, $n)
 
 mysqlFetchObject ( $res)
 
 mysqlFieldName ( $res, $n)
 
 mysqlFieldType ( $res, $n)
 
 mysqlFreeResult ( $res)
 
 mysqlNumFields ( $res)
 
 mysqlNumRows ( $res)
 
 mysqlRealEscapeString ( $s)
 Escapes special characters in a string for use in an SQL statement. More...
 
 mysqlSetCharset ( $charset)
 
- Protected Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
 doLockTables (array $read, array $write, $method)
 
 doUnlockTables ( $method)
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getHeartbeatData (array $conds)
 
 getLagDetectionMethod ()
 
 getLagFromPtHeartbeat ()
 
 getLagFromSlaveStatus ()
 
 getMasterServerInfo ()
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertOpen ()
 Make sure isOpen() returns true as a sanity check. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doQuery ( $sql)
 The DBMS-dependent part of query() More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getBindingHandle ()
 Get the underlying binding handle, mConn. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 ignoreErrors ( $ignoreErrors=null)
 Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...
 
 installErrorHandler ()
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ( $options)
 Helper for Database::insert(). More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions ( $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 pendingWriteAndCallbackCallers ()
 
 reconnect ()
 
 registerTempTableOperation ( $sql)
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 requiresDatabaseUser ()
 
 restoreErrorHandler ()
 
 resultObject ( $result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names. More...
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More...
 
 tableNameWithAlias ( $name, $alias=false)
 Get an aliased table name e.g. More...
 

Protected Attributes

function doQuery $mConn $sql
 mysqli More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\DatabaseMysqlBase
string $lagDetectionMethod
 Method to detect replica DB lag. More...
 
array $lagDetectionOptions = []
 Method to detect replica DB lag. More...
 
MysqlMasterPos $lastKnownReplicaPos
 
string $sqlMode
 sql_mode value to send on connection More...
 
string null $sslCAPath
 
string null $sslCertPath
 
string[] null $sslCiphers
 
string null $sslKeyPath
 
bool $useGTIDs = false
 bool Whether to use GTID methods More...
 
bool $utf8Mode
 Use experimental UTF-8 transmission encoding. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 
callback $errorLogger
 Error logging callback. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
resource null $mConn = null
 Database connection. More...
 
string $mDBname
 
bool null $mDefaultBigSelects = null
 
integer $mFlags
 
string $mLastQuery = ''
 SQL query. More...
 
float bool $mLastWriteTime = false
 UNIX timestamp of last write query. More...
 
array $mLBInfo = []
 
bool $mOpened = false
 
string $mPassword
 
string bool $mPHPError = false
 
string $mSchema = ''
 
array bool $mSchemaVars = false
 
string $mServer
 
array $mSessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
array $mSessionVars = []
 
string $mTablePrefix = ''
 
array[] $mTrxEndCallbacks = []
 List of (callable, method name) More...
 
bool $mTrxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array[] $mTrxIdleCallbacks = []
 List of (callable, method name) More...
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array[] $mTrxPreCommitCallbacks = []
 List of (callable, method name) More...
 
callable[] $mTrxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $mTrxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
string $mUser
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
BagOStuff $srvCache
 APC cache. More...
 
 $tableAliases = []
 
TransactionProfiler $trxProfiler
 

Additional Inherited Members

- Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static factory ( $dbType, $p=[])
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (IDatabase $db1)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More...
 
- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static generalizeSQL ( $sql)
 Removes most variables from an SQL query and replaces them with X or N for numbers. More...
 

Detailed Description

Database abstraction object for PHP extension mysqli.

Since
1.22
See also
Database

Definition at line 35 of file DatabaseMysqli.php.

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\DatabaseMysqli::__toString ( )

Give an id for the connection.

mysql driver used resource id, but mysqli objects cannot be cast to string.

Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 327 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$mConn.

◆ affectedRows()

Wikimedia\Rdbms\DatabaseMysqli::affectedRows ( )
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 174 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\getBindingHandle().

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMysqli::closeConnection ( )
protected
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 145 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\getBindingHandle().

◆ connectInitCharset()

Wikimedia\Rdbms\DatabaseMysqli::connectInitCharset ( )
protected

Set the character set information right after connection.

Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 123 of file DatabaseMysqli.php.

◆ insertId()

Wikimedia\Rdbms\DatabaseMysqli::insertId ( )
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 154 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\getBindingHandle().

◆ lastErrno()

Wikimedia\Rdbms\DatabaseMysqli::lastErrno ( )
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 163 of file DatabaseMysqli.php.

◆ mysqlConnect()

Wikimedia\Rdbms\DatabaseMysqli::mysqlConnect (   $realServer)
protected
Parameters
string$realServer
Returns
bool|mysqli
Exceptions
DBConnectionError

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 59 of file DatabaseMysqli.php.

References DBO_COMPRESS, DBO_PERSISTENT, DBO_SSL, and IP\splitHostAndPort().

◆ mysqlDataSeek()

Wikimedia\Rdbms\DatabaseMysqli::mysqlDataSeek (   $res,
  $row 
)
protected
Parameters
mysqli$res
int$row
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 294 of file DatabaseMysqli.php.

References $res.

◆ mysqlError()

Wikimedia\Rdbms\DatabaseMysqli::mysqlError (   $conn = null)
protected
Parameters
mysqli$connOptional connection object
Returns
string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 302 of file DatabaseMysqli.php.

◆ mysqlFetchArray()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchArray (   $res)
protected
Parameters
mysqli$res
Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 219 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchField()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchField (   $res,
  $n 
)
protected
Parameters
mysqli$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 249 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchObject()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchObject (   $res)
protected
Parameters
mysqli$res
Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 206 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldName()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFieldName (   $res,
  $n 
)
protected
Parameters
mysqli$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 272 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldType()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFieldType (   $res,
  $n 
)
protected
Parameters
mysqli$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 283 of file DatabaseMysqli.php.

References $res.

◆ mysqlFreeResult()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFreeResult (   $res)
protected
Parameters
mysqli$res
Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 196 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumFields()

Wikimedia\Rdbms\DatabaseMysqli::mysqlNumFields (   $res)
protected
Parameters
mysqli$res
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 240 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumRows()

Wikimedia\Rdbms\DatabaseMysqli::mysqlNumRows (   $res)
protected
Parameters
mysqli$res
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 232 of file DatabaseMysqli.php.

References $res.

◆ mysqlRealEscapeString()

Wikimedia\Rdbms\DatabaseMysqli::mysqlRealEscapeString (   $s)
protected

Escapes special characters in a string for use in an SQL statement.

Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 315 of file DatabaseMysqli.php.

References $s, and Wikimedia\Rdbms\Database\getBindingHandle().

◆ mysqlSetCharset()

Wikimedia\Rdbms\DatabaseMysqli::mysqlSetCharset (   $charset)
protected
Parameters
string$charset
Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 132 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\getBindingHandle(), and Wikimedia\Rdbms\Database\query().

◆ selectDB()

Wikimedia\Rdbms\DatabaseMysqli::selectDB (   $db)
Parameters
string$db
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 184 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\getBindingHandle().

Member Data Documentation

◆ $ret

return Wikimedia\Rdbms\DatabaseMysqli::$ret

Definition at line 51 of file DatabaseMysqli.php.

◆ $sql

function doQuery $mConn Wikimedia\Rdbms\DatabaseMysqli::$sql
protected
Initial value:
{
$conn = $this->getBindingHandle()

mysqli

Parameters
string$sql
Returns
resource

Definition at line 42 of file DatabaseMysqli.php.

◆ else

if ($this->bufferResults()) Wikimedia\Rdbms\DatabaseMysqli::else
Initial value:
{
$ret = $conn->query( $sql, MYSQLI_USE_RESULT )

Definition at line 47 of file DatabaseMysqli.php.


The documentation for this class was generated from the following file:
Wikimedia\Rdbms\Database\getBindingHandle
getBindingHandle()
Get the underlying binding handle, mConn.
Definition: Database.php:3426
Wikimedia\Rdbms\DatabaseMysqli\$sql
function doQuery $mConn $sql
mysqli
Definition: DatabaseMysqli.php:42
Wikimedia\Rdbms\DatabaseMysqli\$ret
return $ret
Definition: DatabaseMysqli.php:51