Help:Maintenance script "rebuildFulltextSearchTable.php"

From semantic-mediawiki.org
Jump to: navigation, search
rebuildFulltextSearchTable.php
Allows to rebuild the full text search data table
Further Information
Provided by: Semantic MediaWiki
Added: 2.5.0
Removed: still in use
Location (path): ./extensions/SemanticMediaWiki/maintenance/
Class docu: RebuildFulltextSearchTable
Table of Contents

The "rebuildFulltextSearchTable.php" maintenance script rebuilds the database table used for the full-text search feature. The maintenance script was introduced in Semantic MediaWiki 2.5.01 and currently only works if the configuration parameter $smwgDefaultStore is set to SMWSQLStore3 (= default setting) and here only for MySQL/MariaDB1 and SQLite2, i.e. PostgreSQL3 and SPARQL stores are currently not supported. Note that this script enforces an five second countdown period prior to its actual execution.

It is recommended to run this script in daily intervals as part of the general wiki maintenance.

Important noteImportant Note: If Semantic MediaWiki is not installed in its standard path then the "MW_INSTALL_PATH" environment variable must be set. See README in the maintenance directory.

Usage

php rebuildFulltextSearchTable.php [--v|--quick|--optimize|--report-runtime|--with-maintenance-log]
NoteNote: This only shows the script specific parameters.

Parameters

Generic parameters

--help (-h)
Display this help message
--quiet (-q)
Whether to supress non-error output
--conf:
Location of "LocalSettings.php", if not default
--wiki
For specifying the wiki ID
--globals
Output globals at the end of processing for debugging
--memory-limit
Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it
--server:
The protocol and server name to use in URLs, e.g. https://www.semantic-mediawiki.org. This is sometimes necessary because server name detection may fail in command line scripts.

Script dependant parameters

--dbuser
The DB user to use for this script
--dbpass
The password to use for this script

Script specific parameters

--v
Be verbose about the progress4
--quick
Skip the five second countdown sequence4
--optimize
Run possible table optimization5
--report-runtime
Return memory usage and runtime of the respective script execution1
--with-maintenance-log
Add a log entry to "Special:Logs" on the wiki and report the script's runtime6
NoteNote:  If you are using this parameter make sure that MediaWiki's configuration parameter $wgMaxNameChars is set to a value not lower than "32".7 Otherwise an exception will be issued informing about the minimum value for this setting ("32" or higher is recommended).8

Examples



This documentation page applies to all SMW versions from 2.5.0 to the most current version.
     

Help:RebuildFulltextSearchTable.php en 2.5.0