25use Wikimedia\AtEase\AtEase;
29require_once __DIR__ .
'/Maintenance.php';
38 parent::__construct();
39 $this->
addDescription(
'Performs some operations specific to SQLite database backend' );
42 'Clean up database by removing deleted pages. Decreases database file size'
44 $this->
addOption(
'integrity',
'Check database for integrity' );
45 $this->
addOption(
'backup-to',
'Backup database to the given file',
false,
true );
46 $this->
addOption(
'check-syntax',
'Check SQL file(s) for syntax errors',
false,
true );
51 if ( $this->
hasOption(
'check-syntax' ) ) {
56 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
57 $dbw = $lb->getMaintenanceConnectionRef(
DB_PRIMARY );
58 if ( $dbw->
getType() !==
'sqlite' ) {
59 $this->
error(
"This maintenance script requires a SQLite database.\n" );
65 $this->vacuum( $dbw );
69 $this->integrityCheck( $dbw );
73 $this->backup( $dbw, $this->
getOption(
'backup-to' ) );
77 private function vacuum(
DBConnRef $dbw ) {
79 $prevSize = filesize( $dbw->
__call(
'getDbFilePath', [] ) );
80 if ( $prevSize == 0 ) {
81 $this->
fatalError(
"Can't vacuum an empty database.\n" );
84 $this->
output(
'VACUUM: ' );
85 if ( $dbw->
query(
'VACUUM', __METHOD__ ) ) {
87 $newSize = filesize( $dbw->getDbFilePath() );
88 $this->
output( sprintf(
"Database size was %d, now %d (%.1f%% reduction).\n",
89 $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
91 $this->
output(
'Error\n' );
96 $this->
output(
"Performing database integrity checks:\n" );
97 $res = $dbw->
query(
'PRAGMA integrity_check', __METHOD__ );
99 if ( !
$res ||
$res->numRows() == 0 ) {
100 $this->
error(
"Error: integrity check query returned nothing.\n" );
105 foreach (
$res as $row ) {
106 $this->
output( $row->integrity_check );
110 private function backup(
DBConnRef $dbw, $fileName ) {
111 $this->
output(
"Backing up database:\n Locking..." );
112 $dbw->
query(
'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
113 $ourFile = $dbw->
__call(
'getDbFilePath', [] );
114 $this->
output(
" Copying database file $ourFile to $fileName..." );
115 AtEase::suppressWarnings();
116 if ( !copy( $ourFile, $fileName ) ) {
117 $err = error_get_last();
118 $this->
error(
" {$err['message']}" );
120 AtEase::restoreWarnings();
121 $this->
output(
" Releasing lock...\n" );
122 $dbw->
query(
'COMMIT TRANSACTION', __METHOD__ );
125 private function checkSyntax() {
127 $this->
error(
"Error: SQLite support not found\n" );
129 $files = [ $this->
getOption(
'check-syntax' ) ];
130 $files = array_merge( $files, $this->mArgs );
132 if ( $result ===
true ) {
133 $this->
output(
"SQL syntax check: no errors detected.\n" );
135 $this->
error(
"Error: $result\n" );
141require_once RUN_MAINTENANCE_IF_MAIN;
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
hasOption( $name)
Checks to see if a particular option was set.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Maintenance script that performs some operations specific to SQLite database backend.
execute()
Do the actual work.
__construct()
Default constructor.
static isPresent()
Checks whether PHP has SQLite support.
static checkSqlSyntax( $files)
Checks given files for correctness of SQL syntax.
Advanced database interface for IDatabase handles that include maintenance methods.