Help:Maintenance script "rebuildFulltextSearchTable.php"

From semantic-mediawiki.org
Jump to: navigation, search
Has maintenance script name::maintenance script "rebuildFulltextSearchTable.php"
Has description::Allows to rebuild the full text search data table
Further Information
Provided by: Has component::Semantic MediaWiki
Added: Has minimum version::2.5.0
Removed: Has maximum version::still in use
Location (path): Has 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 (SMW) Semantic MediaWiki 2.5.0CiteRef::gh:smw:1481CiteRef::gh:smw:1763CiteRef::gh:smw:1764 and currently only works if the configuration parameter $smwgDefaultStore is set to SMWSQLStore3 (= default setting), i.e. SPARQL stores are currently not supported. Note that this script enforces an five second countdown period prior to its actual execution.

Important Note

  • If SMW 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|--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. http://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 progress
--quick
Skip the five second countdown sequence
--report-runtime
Will return memory usage and runtime of the respective script execution.
--with-maintenance-log
Adds a log entry to "Special:Logs" on the wiki and reports the script's runtime.
NoteNote:  If you are using this parameter make sure that MediaWiki's configuration parameter $wgMaxNameChars is set to a value not lower than "32".CiteRef::gh:smw:1983 Otherwise an exception will be issued informing about the minimum value for this setting ("32" or higher is recommended).CiteRef::gh:smw:1985

Examples

{{#ask:

Has maintenance script name::rebuildFulltextSearchTable.php
|format=ul

}}

{{#scite:gh:smw:1763

|type=issue
|citation text=Semantic MediaWiki: GitHub issue #1763: Introducing the --v and --quick parameters

}} {{#scite:gh:smw:1764

|type=issue
|citation text=Semantic MediaWiki: GitHub issue #1764: Introducing the --with-maintenance-log parameter

}}


{{#set: |docinfo status=effective }}{{#set: |worn by =Template:Docinfo |warning =Master page updated }}{{#set:

|worn by =Template:Docinfo
|warning =No description
}}{{#set:

|revision id=47759 |namespace=Help |docinfo progress =100 |docinfo priority =2 }}{{#set:docinfo master page=Help:RebuildFulltextSearchTable.php }}{{#set:docinfo master rev =47759 }}{{#set:docinfo category=-}}{{#set:docinfo author=User:Kghbln}}{{#set:docinfo editor=User:Kghbln}}{{#set:docinfo support=-}}{{#set:docinfo language=en}}

This documentation page applies to all SMW versions from 2.5.0 to the most current version.
Other versions: {{#ask: Docinfo master page::Help:RebuildFulltextSearchTable.php Docinfo language::en from version::!2.5.0|
   ?from version = |
   ?to version = |
   sort = from version|
   order = desc|
   link=none|
   format=list|
   sep=, |
   template=versionlink|
   limit = 3|
   searchlabel = […]
  }}       Other languages: {{#ask: Docinfo master page::Help:RebuildFulltextSearchTable.php from version::2.5.0 Docinfo language::!en|
  ?Docinfo language =|
  link=none|
  format=list|
  sep=, |
  template=languagelink|
  sort = Docinfo language|
  order = asc|
  limit = 10|
  searchlabel = […]
}}

Docinfo master page::Help:RebuildFulltextSearchTable.php Docinfo language::en from version::2.5.0

{{#set:Release status=current}}

{{#set:Is master page=false}}