UpdateSearchIndex Class Reference

Script for periodic off-peak updating of the search index. More...

Inherits Maintenance.

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 execute ()
 Do the actual work.

Private Member Functions

 doUpdateSearchIndex ($start, $end, $maxLockTime)
 lockSearchindex (&$db)
 Lock the search index.
 unlockSearchindex (&$db)
 Unlock the tables.
 relockSearchindex (&$db)
 Unlock and lock again Since the lock is low-priority, queued reads will be able to complete.


Detailed Description

Script for periodic off-peak updating of the search index.

Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q] Where START is the starting timestamp END is the ending timestamp POSFILE is a file to load timestamps from and save them to, searchUpdate.WIKI_ID.pos by default LOCKTIME is how long the searchindex and revision tables will be locked for -q means quiet

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 32 of file updateSearchIndex.php.


Constructor & Destructor Documentation

UpdateSearchIndex::__construct (  ) 

Default constructor.

Children should call this if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 34 of file updateSearchIndex.php.

References Maintenance::addOption().


Member Function Documentation

UpdateSearchIndex::doUpdateSearchIndex ( start,
end,
maxLockTime 
) [private]

UpdateSearchIndex::execute (  ) 

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 47 of file updateSearchIndex.php.

References doUpdateSearchIndex(), Maintenance::getOption(), Maintenance::hasOption(), wfTimestamp(), and wfTimestampNow().

UpdateSearchIndex::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 43 of file updateSearchIndex.php.

References Maintenance::DB_ADMIN.

UpdateSearchIndex::lockSearchindex ( &$  db  )  [private]

Lock the search index.

Parameters:
&$db Database object

Definition at line 147 of file updateSearchIndex.php.

Referenced by doUpdateSearchIndex(), and relockSearchindex().

UpdateSearchIndex::relockSearchindex ( &$  db  )  [private]

Unlock and lock again Since the lock is low-priority, queued reads will be able to complete.

Parameters:
&$db Database object

Definition at line 166 of file updateSearchIndex.php.

References lockSearchindex(), and unlockSearchindex().

Referenced by doUpdateSearchIndex().

UpdateSearchIndex::unlockSearchindex ( &$  db  )  [private]

Unlock the tables.

Parameters:
&$db Database object

Definition at line 157 of file updateSearchIndex.php.

Referenced by doUpdateSearchIndex(), and relockSearchindex().


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

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