[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/db/ -> DatabaseMysqlBase.php (summary)

This is the MySQL database abstraction layer. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 1274 lines (31 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

MySQLField:: (9 methods):
  __construct()
  name()
  tableName()
  type()
  isNullable()
  defaultValue()
  isKey()
  isMultipleKey()
  isBinary()

MySQLMasterPos:: (4 methods):
  __construct()
  __toString()
  getCoordinates()
  hasReached()

Defines 4 functions

  getType()
  open()
  connectInitCharset()
  freeResult()
  fetchObject()
  fetchRow()
  numRows()
  numFields()
  fieldName()
  fieldType()
  dataSeek()
  lastError()
  replace()
  estimateRowCount()
  fieldInfo()
  indexInfo()
  strencode()
  addIdentifierQuotes()
  isQuotedIdentifier()
  ping()
  setFakeSlaveLag()
  setFakeMaster()
  getLag()
  getLagFromSlaveStatus()
  masterPosWait()
  getSlavePos()
  getMasterPos()
  useIndexClause()
  lowPriorityOption()
  getSoftwareLink()
  setSessionOptions()
  streamStatementEnd()
  lockIsFree()
  lock()
  unlock()
  lockTables()
  unlockTables()
  getSearchEngine()
  setBigSelects()
  deleteJoin()
  upsert()
  getServerUptime()
  wasDeadlock()
  wasLockTimeout()
  wasErrorReissuable()
  wasReadOnlyError()
  duplicateTableStructure()
  listTables()
  dropTable()
  getDefaultSchemaVars()
  getMysqlStatus()
  listViews()
  isView()

Class: MySQLField  - X-Ref

Utility class.

__construct( $info )   X-Ref
No description

name()   X-Ref

return: string

tableName()   X-Ref

return: string

type()   X-Ref

return: string

isNullable()   X-Ref

return: bool

defaultValue()   X-Ref
No description

isKey()   X-Ref

return: bool

isMultipleKey()   X-Ref

return: bool

isBinary()   X-Ref
No description

Class: MySQLMasterPos  - X-Ref

__construct( $file, $pos )   X-Ref
No description

__toString()   X-Ref
No description

getCoordinates()   X-Ref

return: array|bool (int, int)

hasReached( MySQLMasterPos $pos )   X-Ref
No description

Functions
Functions that are not part of a class:

getType()   X-Ref

return: string

open( $server, $user, $password, $dbName )   X-Ref

param: string $server
param: string $user
param: string $password
param: string $dbName
return: bool

connectInitCharset()   X-Ref
Set the character set information right after connection

return: bool

freeResult( $res )   X-Ref

param: ResultWrapper|resource $res

fetchObject( $res )   X-Ref

param: ResultWrapper|resource $res
return: stdClass|bool

fetchRow( $res )   X-Ref

param: ResultWrapper|resource $res
return: array|bool

numRows( $res )   X-Ref

param: ResultWrapper|resource $res
return: int

numFields( $res )   X-Ref

param: ResultWrapper|resource $res
return: int

fieldName( $res, $n )   X-Ref

param: ResultWrapper|resource $res
param: int $n
return: string

fieldType( $res, $n )   X-Ref
mysql_field_type() wrapper

param: ResultWrapper|resource $res
param: int $n
return: string

dataSeek( $res, $row )   X-Ref

param: ResultWrapper|resource $res
param: int $row
return: bool

lastError()   X-Ref

return: string

replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ )   X-Ref

param: string $table
param: array $uniqueIndexes
param: array $rows
param: string $fname
return: ResultWrapper

estimateRowCount( $table, $vars = '*', $conds = '',$fname = __METHOD__, $options = array()   X-Ref
Estimate rows in dataset
Returns estimated count, based on EXPLAIN output
Takes same arguments as Database::select()

param: string|array $table
param: string|array $vars
param: string|array $conds
param: string $fname
param: string|array $options
return: bool|int

fieldInfo( $table, $field )   X-Ref

param: string $table
param: string $field
return: bool|MySQLField

indexInfo( $table, $index, $fname = __METHOD__ )   X-Ref
Get information about an index into an object
Returns false if the index does not exist

param: string $table
param: string $index
param: string $fname
return: bool|array|null False or null on failure

strencode( $s )   X-Ref

param: string $s
return: string

addIdentifierQuotes( $s )   X-Ref
MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".

param: string $s
return: string

isQuotedIdentifier( $name )   X-Ref

param: string $name
return: bool

ping()   X-Ref

return: bool

setFakeSlaveLag( $lag )   X-Ref
Set lag time in seconds for a fake slave

param: int $lag

setFakeMaster( $enabled = true )   X-Ref
Make this connection a fake master

param: bool $enabled

getLag()   X-Ref
Returns slave lag.

This will do a SHOW SLAVE STATUS

return: int

getLagFromSlaveStatus()   X-Ref

return: bool|int

masterPosWait( DBMasterPos $pos, $timeout )   X-Ref
Wait for the slave to catch up to a given master position.

param: DBMasterPos|MySQLMasterPos $pos
param: int $timeout The maximum number of seconds to wait for synchronisation
return: int Zero if the slave was past that position already,

getSlavePos()   X-Ref
Get the position of the master from SHOW SLAVE STATUS

return: MySQLMasterPos|bool

getMasterPos()   X-Ref
Get the position of the master from SHOW MASTER STATUS

return: MySQLMasterPos|bool

useIndexClause( $index )   X-Ref

param: string $index
return: string

lowPriorityOption()   X-Ref

return: string

getSoftwareLink()   X-Ref

return: string

setSessionOptions( array $options )   X-Ref

param: array $options

streamStatementEnd( &$sql, &$newLine )   X-Ref

param: string $sql
param: string $newLine
return: bool

lockIsFree( $lockName, $method )   X-Ref
Check to see if a named lock is available. This is non-blocking.

param: string $lockName Name of lock to poll
param: string $method Name of method calling us
return: bool

lock( $lockName, $method, $timeout = 5 )   X-Ref

param: string $lockName
param: string $method
param: int $timeout
return: bool

unlock( $lockName, $method )   X-Ref
FROM MYSQL DOCS:
http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock

param: string $lockName
param: string $method
return: bool

lockTables( $read, $write, $method, $lowPriority = true )   X-Ref

param: array $read
param: array $write
param: string $method
param: bool $lowPriority
return: bool

unlockTables( $method )   X-Ref

param: string $method
return: bool

getSearchEngine()   X-Ref
Get search engine class. All subclasses of this
need to implement this if they wish to use searching.

return: string

setBigSelects( $value = true )   X-Ref

param: bool $value

deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__ )   X-Ref
DELETE where the condition is a join. MySql uses multi-table deletes.

param: string $delTable
param: string $joinTable
param: string $delVar
param: string $joinVar
param: array|string $conds
param: bool|string $fname
return: bool|ResultWrapper

upsert( $table, array $rows, array $uniqueIndexes,array $set, $fname = __METHOD__)   X-Ref

param: string $table
param: array $rows
param: array $uniqueIndexes
param: array $set
param: string $fname
return: bool

getServerUptime()   X-Ref
Determines how long the server has been up

return: int

wasDeadlock()   X-Ref
Determines if the last failure was due to a deadlock

return: bool

wasLockTimeout()   X-Ref
Determines if the last failure was due to a lock timeout

return: bool

wasErrorReissuable()   X-Ref
Determines if the last query error was something that should be dealt
with by pinging the connection and reissuing the query

return: bool

wasReadOnlyError()   X-Ref
Determines if the last failure was due to the database being read-only.

return: bool

duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ )   X-Ref

param: string $oldName
param: string $newName
param: bool $temporary
param: string $fname
return: bool

listTables( $prefix = null, $fname = __METHOD__ )   X-Ref
List all tables on the database

param: string $prefix Only show tables with this prefix, e.g. mw_
param: string $fname Calling function name
return: array

dropTable( $tableName, $fName = __METHOD__ )   X-Ref

param: string $tableName
param: string $fName
return: bool|ResultWrapper

getDefaultSchemaVars()   X-Ref

return: array

getMysqlStatus( $which = "%" )   X-Ref
Get status information from SHOW STATUS in an associative array

param: string $which
return: array

listViews( $prefix = null, $fname = __METHOD__ )   X-Ref
Lists VIEWs in the database

param: string $prefix Only show VIEWs with this prefix, eg.
param: string $fname Name of calling function
return: array

isView( $name, $prefix = null )   X-Ref
Differentiates between a TABLE and a VIEW.

param: string $name Name of the TABLE/VIEW to test
param: string $prefix
return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1