dbd8ed1f8142f8bf6400757810399dec7505e2c1
3 * Performs some operations specific to SQLite database backend.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 require_once __DIR__
. '/Maintenance.php';
27 * Maintenance script that performs some operations specific to SQLite database backend.
29 * @ingroup Maintenance
31 class SqliteMaintenance
extends Maintenance
{
32 public function __construct() {
33 parent
::__construct();
34 $this->mDescription
= "Performs some operations specific to SQLite database backend";
37 'Clean up database by removing deleted pages. Decreases database file size'
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 );
45 * While we use database connection, this simple lie prevents useless --dbpass and
46 * --dbuser options from appearing in help message for this script.
48 * @return int DB constant
50 public function getDbType() {
51 return Maintenance
::DB_NONE
;
54 public function execute() {
55 // Should work even if we use a non-SQLite database
56 if ( $this->hasOption( 'check-syntax' ) ) {
61 $this->db
= wfGetDB( DB_MASTER
);
63 if ( $this->db
->getType() != 'sqlite' ) {
64 $this->error( "This maintenance script requires a SQLite database.\n" );
68 if ( $this->hasOption( 'vacuum' ) ) {
72 if ( $this->hasOption( 'integrity' ) ) {
73 $this->integrityCheck();
76 if ( $this->hasOption( 'backup-to' ) ) {
77 $this->backup( $this->getOption( 'backup-to' ) );
81 private function vacuum() {
82 $prevSize = filesize( $this->db
->mDatabaseFile
);
83 if ( $prevSize == 0 ) {
84 $this->error( "Can't vacuum an empty database.\n", true );
87 $this->output( 'VACUUM: ' );
88 if ( $this->db
->query( 'VACUUM' ) ) {
90 $newSize = filesize( $this->db
->mDatabaseFile
);
91 $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
92 $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
94 $this->output( 'Error\n' );
98 private function integrityCheck() {
99 $this->output( "Performing database integrity checks:\n" );
100 $res = $this->db
->query( 'PRAGMA integrity_check' );
102 if ( !$res ||
$res->numRows() == 0 ) {
103 $this->error( "Error: integrity check query returned nothing.\n" );
107 foreach ( $res as $row ) {
108 $this->output( $row->integrity_check
);
112 private function backup( $fileName ) {
113 $this->output( "Backing up database:\n Locking..." );
114 $this->db
->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__
);
115 $ourFile = $this->db
->mDatabaseFile
;
116 $this->output( " Copying database file $ourFile to $fileName... " );
117 wfSuppressWarnings( false );
118 if ( !copy( $ourFile, $fileName ) ) {
119 $err = error_get_last();
120 $this->error( " {$err['message']}" );
122 wfSuppressWarnings( true );
123 $this->output( " Releasing lock...\n" );
124 $this->db
->query( 'COMMIT TRANSACTION', __METHOD__
);
127 private function checkSyntax() {
128 if ( !Sqlite
::IsPresent() ) {
129 $this->error( "Error: SQLite support not found\n" );
131 $files = array( $this->getOption( 'check-syntax' ) );
132 $files +
= $this->mArgs
;
133 $result = Sqlite
::checkSqlSyntax( $files );
134 if ( $result === true ) {
135 $this->output( "SQL syntax check: no errors detected.\n" );
137 $this->error( "Error: $result\n" );
142 $maintClass = "SqliteMaintenance";
143 require_once RUN_MAINTENANCE_IF_MAIN
;