MediaWiki  1.29.2
IMaintainableDatabase.php
Go to the documentation of this file.
1 <?php
2 
25 namespace Wikimedia\Rdbms;
26 
27 use Exception;
28 use RuntimeException;
29 
39 interface IMaintainableDatabase extends IDatabase {
59  public function tableName( $name, $format = 'quoted' );
60 
72  public function tableNames();
73 
85  public function tableNamesN();
86 
94  public function textFieldSize( $table, $field );
95 
112  public function sourceFile(
113  $filename,
114  callable $lineCallback = null,
115  callable $resultCallback = null,
116  $fname = false,
117  callable $inputCallback = null
118  );
119 
133  public function sourceStream(
134  $fp,
135  callable $lineCallback = null,
136  callable $resultCallback = null,
137  $fname = __METHOD__,
138  callable $inputCallback = null
139  );
140 
148  public function streamStatementEnd( &$sql, &$newLine );
149 
156  public function dropTable( $tableName, $fName = __METHOD__ );
157 
182  public function deadlockLoop();
183 
192  public function listViews( $prefix = null, $fname = __METHOD__ );
193 
209  public function duplicateTableStructure(
210  $oldName, $newName, $temporary = false, $fname = __METHOD__
211  );
212 
224  public function tableLocksHaveTransactionScope();
225 
266  public function lockTables( array $read, array $write, $method );
267 
278  public function unlockTables( $method );
279 }
280 
281 class_alias( IMaintainableDatabase::class, 'IMaintainableDatabase' );
Wikimedia\Rdbms\IMaintainableDatabase\lockTables
lockTables(array $read, array $write, $method)
Lock specific tables.
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Wikimedia\Rdbms
Definition: ChronologyProtector.php:24
$fname
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition: Setup.php:36
Wikimedia\Rdbms\IMaintainableDatabase\listViews
listViews( $prefix=null, $fname=__METHOD__)
Lists all the VIEWs in the database.
Wikimedia\Rdbms\IMaintainableDatabase\tableName
tableName( $name, $format='quoted')
Format a table name ready for use in constructing an SQL query.
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
Wikimedia\Rdbms\IMaintainableDatabase\tableNames
tableNames()
Fetch a number of table names into an array This is handy when you need to construct SQL for joins.
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
Wikimedia\Rdbms\IMaintainableDatabase\sourceStream
sourceStream( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
Read and execute commands from an open file handle.
Wikimedia\Rdbms\IMaintainableDatabase\deadlockLoop
deadlockLoop()
Perform a deadlock-prone transaction.
Wikimedia\Rdbms\IMaintainableDatabase\tableNamesN
tableNamesN()
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to con...
Wikimedia\Rdbms\IMaintainableDatabase\sourceFile
sourceFile( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
Read and execute SQL commands from a file.
Wikimedia\Rdbms\IMaintainableDatabase\unlockTables
unlockTables( $method)
Unlock all tables locked via lockTables()
Wikimedia\Rdbms\IMaintainableDatabase\tableLocksHaveTransactionScope
tableLocksHaveTransactionScope()
Checks if table locks acquired by lockTables() are transaction-bound in their scope.
Wikimedia\Rdbms\IMaintainableDatabase\dropTable
dropTable( $tableName, $fName=__METHOD__)
Delete a table.
Wikimedia\Rdbms\IMaintainableDatabase\textFieldSize
textFieldSize( $table, $field)
Returns the size of a text field, or -1 for "unlimited".
Wikimedia\Rdbms\IMaintainableDatabase\duplicateTableStructure
duplicateTableStructure( $oldName, $newName, $temporary=false, $fname=__METHOD__)
Creates a new table with structure copied from existing table.
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Wikimedia\Rdbms\IMaintainableDatabase\streamStatementEnd
streamStatementEnd(&$sql, &$newLine)
Called by sourceStream() to check if we've reached a statement end.
Wikimedia\Rdbms\IMaintainableDatabase
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:39
array
the array() calling protocol came about after MediaWiki 1.4rc1.