MediaWiki extensions manual
Release status: stable
Implementation Search, API
Description Implements searching for Wikibase Lexeme space using ElasticSearch
Author(s) Stas Malyshev
Latest version 0.1.0 (continuous updates)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.33+
PHP 7.0+
Database changes No
Composer wikibase/lexeme-cirrusssearch
License GNU General Public License 2.0 or later

  • $wgLexemeUseCirrus
  • $wgLexemePrefixSearchProfile
  • $wgLexemePrefixSearchProfiles
  • $wgLexemePrefixRescoreProfile
  • $wgLexemeFulltextRescoreProfile
  • $wgLexemeRescoreFunctions
Quarterly downloads 2 (Ranked 144th)
Translate the WikibaseLexemeCirrusSearch extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The WikibaseLexemeCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to WikibaseLexeme extension. It requires both CirrusSearch and WikibaseLexeme extensions to be installed.

Installation edit

  • Download and move the extracted WikibaseLexemeCirrusSearch folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikibaseLexemeCirrusSearch
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'WikibaseLexemeCirrusSearch' );
  • Configure as required.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration edit

Following configuration options are supported:

boolean|null, whether we should use search functionality provided by this extension. If set to null, CirrusSearch is not used unless the request has useCirrus=1. Note: The default for this value is false, to enable search functionality it should be set to true in the configuration.
name of the label scoring profile to use for prefix search. The profile should be defined like examples in config/LexemePrefixSearchProfiles.php.
Loaded from config/LexemePrefixSearchProfiles.php, does not need to be defined manually.
name of the rescoring profile to use for prefix search. The profile should be defined in config/LexemePrefixSearchProfiles.php.
name of the search profile to use for fulltext search. The profile should be defined like examples in config/LexemeRescoreProfiles.php.
Loaded from config/LexemeRescoreFunctions.php.php, does not have to be defined manually.

See Also edit