MediaWiki master
CloneDatabase.php
Go to the documentation of this file.
1<?php
25
28 private string $newTablePrefix;
29
31 private string $oldTablePrefix;
32
34 private array $tablesToClone;
35
37 private bool $dropCurrentTables;
38
40 private bool $useTemporaryTables = true;
41
42 private IMaintainableDatabase $db;
43
51 public function __construct(
53 array $tablesToClone,
54 string $newTablePrefix,
55 ?string $oldTablePrefix = null,
56 bool $dropCurrentTables = true
57 ) {
58 if ( !$tablesToClone ) {
59 throw new InvalidArgumentException( 'Empty list of tables to clone' );
60 }
61 $this->db = $db;
62 $this->tablesToClone = $tablesToClone;
63 $this->newTablePrefix = $newTablePrefix;
64 $this->oldTablePrefix = $oldTablePrefix ?? $this->db->tablePrefix();
65 $this->dropCurrentTables = $dropCurrentTables;
66 }
67
72 public function useTemporaryTables( bool $u = true ): void {
73 $this->useTemporaryTables = $u;
74 }
75
76 public function cloneTableStructure(): void {
78 foreach ( $this->tablesToClone as $tbl ) {
79 if ( $wgSharedDB && in_array( $tbl, $wgSharedTables, true ) ) {
80 // Shared tables don't work properly when cloning due to
81 // how prefixes are handled (T67654)
82 throw new RuntimeException( "Cannot clone shared table $tbl." );
83 }
84 # Clean up from previous aborted run. So that table escaping
85 # works correctly across DB engines, we need to change the pre-
86 # fix back and forth so tableName() works right.
87
88 $this->db->tablePrefix( $this->oldTablePrefix );
89 $oldTableName = $this->db->tableName( $tbl, 'raw' );
90
91 $this->db->tablePrefix( $this->newTablePrefix );
92 $newTableName = $this->db->tableName( $tbl, 'raw' );
93
94 // Postgres: Temp tables are automatically deleted upon end of session
95 // Same Temp table name hides existing table for current session
96 if ( $this->dropCurrentTables ) {
97 if ( $oldTableName === $newTableName ) {
98 // Last ditch check to avoid data loss
99 throw new LogicException( "Not dropping new table, as '$newTableName'"
100 . " is name of both the old and the new table." );
101 }
102 $this->db->dropTable( $tbl, __METHOD__ );
103 // Dropping the oldTable because the prefix was changed
104 }
105
106 # Create new table
107 $this->db->duplicateTableStructure(
108 $oldTableName, $newTableName, $this->useTemporaryTables, __METHOD__ );
109 }
110 }
111
116 public function destroy( bool $dropTables = false ): void {
117 if ( $dropTables ) {
118 $this->db->tablePrefix( $this->newTablePrefix );
119 foreach ( $this->tablesToClone as $tbl ) {
120 $this->db->dropTable( $tbl, __METHOD__ );
121 }
122 }
123 $this->db->tablePrefix( $this->oldTablePrefix );
124 }
125
132 public static function changePrefix( string $prefix ): void {
133 global $wgDBprefix, $wgDBname;
134
135 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
136 $lbFactory->setLocalDomainPrefix( $prefix );
137
138 $aliases = [
139 $wgDBname => $lbFactory->getLocalDomainID()
140 ];
141 $lbFactory->setDomainAliases( $aliases );
142 foreach ( $lbFactory->getAllLBs() as $lb ) {
143 $lb->setDomainAliases( $aliases );
144 }
145
146 $wgDBprefix = $prefix;
147 }
148}
if(!defined('MW_SETUP_CALLBACK'))
Definition WebStart.php:81
useTemporaryTables(bool $u=true)
Set whether to use temporary tables or not.
static changePrefix(string $prefix)
Change the table prefix on all open DB connections.
destroy(bool $dropTables=false)
Change the prefix back to the original.
__construct(IMaintainableDatabase $db, array $tablesToClone, string $newTablePrefix, ?string $oldTablePrefix=null, bool $dropCurrentTables=true)
Service locator for MediaWiki core services.
$wgDBprefix
Config variable stub for the DBprefix setting, for use by phpdoc and IDEs.
$wgSharedTables
Config variable stub for the SharedTables setting, for use by phpdoc and IDEs.
$wgDBname
Config variable stub for the DBname setting, for use by phpdoc and IDEs.
$wgSharedDB
Config variable stub for the SharedDB setting, for use by phpdoc and IDEs.
Advanced database interface for IDatabase handles that include maintenance methods.
tablePrefix( $prefix=null)
Get/set the table prefix.