MediaWiki REL1_30
sqlite.php
Go to the documentation of this file.
1<?php
24require_once __DIR__ . '/Maintenance.php';
25
32 public function __construct() {
33 parent::__construct();
34 $this->addDescription( 'Performs some operations specific to SQLite database backend' );
35 $this->addOption(
36 'vacuum',
37 'Clean up database by removing deleted pages. Decreases database file size'
38 );
39 $this->addOption( 'integrity', 'Check database for integrity' );
40 $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
41 $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
42 }
43
50 public function getDbType() {
52 }
53
54 public function execute() {
55 // Should work even if we use a non-SQLite database
56 if ( $this->hasOption( 'check-syntax' ) ) {
57 $this->checkSyntax();
58
59 return;
60 }
61
62 $this->db = $this->getDB( DB_MASTER );
63
64 if ( $this->db->getType() != 'sqlite' ) {
65 $this->error( "This maintenance script requires a SQLite database.\n" );
66
67 return;
68 }
69
70 if ( $this->hasOption( 'vacuum' ) ) {
71 $this->vacuum();
72 }
73
74 if ( $this->hasOption( 'integrity' ) ) {
75 $this->integrityCheck();
76 }
77
78 if ( $this->hasOption( 'backup-to' ) ) {
79 $this->backup( $this->getOption( 'backup-to' ) );
80 }
81 }
82
83 private function vacuum() {
84 $prevSize = filesize( $this->db->getDbFilePath() );
85 if ( $prevSize == 0 ) {
86 $this->error( "Can't vacuum an empty database.\n", true );
87 }
88
89 $this->output( 'VACUUM: ' );
90 if ( $this->db->query( 'VACUUM' ) ) {
91 clearstatcache();
92 $newSize = filesize( $this->db->getDbFilePath() );
93 $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
94 $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
95 } else {
96 $this->output( 'Error\n' );
97 }
98 }
99
100 private function integrityCheck() {
101 $this->output( "Performing database integrity checks:\n" );
102 $res = $this->db->query( 'PRAGMA integrity_check' );
103
104 if ( !$res || $res->numRows() == 0 ) {
105 $this->error( "Error: integrity check query returned nothing.\n" );
106
107 return;
108 }
109
110 foreach ( $res as $row ) {
111 $this->output( $row->integrity_check );
112 }
113 }
114
115 private function backup( $fileName ) {
116 $this->output( "Backing up database:\n Locking..." );
117 $this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
118 $ourFile = $this->db->getDbFilePath();
119 $this->output( " Copying database file $ourFile to $fileName... " );
120 MediaWiki\suppressWarnings( false );
121 if ( !copy( $ourFile, $fileName ) ) {
122 $err = error_get_last();
123 $this->error( " {$err['message']}" );
124 }
125 MediaWiki\suppressWarnings( true );
126 $this->output( " Releasing lock...\n" );
127 $this->db->query( 'COMMIT TRANSACTION', __METHOD__ );
128 }
129
130 private function checkSyntax() {
131 if ( !Sqlite::isPresent() ) {
132 $this->error( "Error: SQLite support not found\n" );
133 }
134 $files = [ $this->getOption( 'check-syntax' ) ];
135 $files = array_merge( $files, $this->mArgs );
136 $result = Sqlite::checkSqlSyntax( $files );
137 if ( $result === true ) {
138 $this->output( "SQL syntax check: no errors detected.\n" );
139 } else {
140 $this->error( "Error: $result\n" );
141 }
142 }
143}
144
145$maintClass = "SqliteMaintenance";
146require_once RUN_MAINTENANCE_IF_MAIN;
and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a copy
Definition COPYING.txt:87
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
const DB_NONE
Constants for DB access type.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
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.
Maintenance script that performs some operations specific to SQLite database backend.
Definition sqlite.php:31
backup( $fileName)
Definition sqlite.php:115
execute()
Do the actual work.
Definition sqlite.php:54
__construct()
Default constructor.
Definition sqlite.php:32
getDbType()
While we use database connection, this simple lie prevents useless –dbpass and –dbuser options from a...
Definition sqlite.php:50
static isPresent()
Checks whether PHP has SQLite support.
Definition sqlite.inc:38
static checkSqlSyntax( $files)
Checks given files for correctness of SQL syntax.
Definition sqlite.inc:50
$res
Definition database.txt:21
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
require_once RUN_MAINTENANCE_IF_MAIN
const DB_MASTER
Definition defines.php:26
$maintClass
Definition sqlite.php:145