MwSql Class Reference

Send SQL queries from the specified file to the database, performing variable replacement along the way. More...

Inherits Maintenance.

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 execute ()
 Do the actual work.
 sqlPrintResult ($res, $db)
 Print the results, callback for $db->sourceStream().
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.


Detailed Description

Send SQL queries from the specified file to the database, performing variable replacement along the way.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition at line 26 of file sql.php.


Constructor & Destructor Documentation

MwSql::__construct (  ) 

Default constructor.

Children should call this if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 27 of file sql.php.


Member Function Documentation

MwSql::execute (  ) 

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 32 of file sql.php.

References $dbw, Maintenance::error(), Maintenance::getArg(), Maintenance::getStdin(), Maintenance::hasArg(), and wfGetDB().

MwSql::getDbType (  ) 

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns:
int

Reimplemented from Maintenance.

Definition at line 73 of file sql.php.

References Maintenance::DB_ADMIN.

MwSql::sqlPrintResult ( res,
db 
)

Print the results, callback for $db->sourceStream().

Parameters:
$res The results object
$db Database object

Definition at line 60 of file sql.php.

References $res, and Maintenance::output().


The documentation for this class was generated from the following file:

Generated on Sat Apr 30 22:57:44 2011 for MediaWiki by  doxygen 1.5.9