Extension:WikibaseLexemeCirrusSearch

**MediaWiki extensions manual**
WikibaseLexemeCirrusSearch; 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
License	GNU General Public License 2.0 or later
Download	Download extension ; Git [?]: Download Git master; browse repository (GitHub); commit history; repository contributors (GitHub); code review; ; README
	Parameters $wgLexemeUseCirrus; $wgLexemePrefixSearchProfile; $wgLexemePrefixSearchProfiles; $wgLexemePrefixRescoreProfile; $wgLexemeFulltextRescoreProfile; $wgLexemeRescoreFunctions;
	Hooks used CirrusSearchProfileService; ShowSearchHit; WikibaseRepoEntityTypes;
Quarterly downloads	4 (Ranked 132nd)
	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

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

Following configuration options are supported:

$wgLexemeUseCirrus: 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.

$wgLexemePrefixSearchProfile: name of the label scoring profile to use for prefix search. The profile should be defined like examples in config/LexemePrefixSearchProfiles.php.

$wgLexemePrefixSearchProfiles: Loaded from config/LexemePrefixSearchProfiles.php, does not need to be defined manually.

$wgLexemePrefixRescoreProfile: name of the rescoring profile to use for prefix search. The profile should be defined in config/LexemePrefixSearchProfiles.php.

$wgLexemeFulltextRescoreProfile: name of the search profile to use for fulltext search. The profile should be defined like examples in config/LexemeRescoreProfiles.php.

$wgLexemeRescoreFunctions: Loaded from config/LexemeRescoreFunctions.php.php, does not have to be defined manually.

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.

This extension is included in the following wiki farms/hosts and/or packages:

This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.

WikibaseLexemeCirrusSearch 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
License	GNU General Public License 2.0 or later
Download	Download extension Git ^[?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review README
Parameters $wgLexemeUseCirrus $wgLexemePrefixSearchProfile $wgLexemePrefixSearchProfiles $wgLexemePrefixRescoreProfile $wgLexemeFulltextRescoreProfile $wgLexemeRescoreFunctions
Hooks used CirrusSearchProfileService ShowSearchHit WikibaseRepoEntityTypes
Quarterly downloads	4 (Ranked 132^nd)
Translate the WikibaseLexemeCirrusSearch extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Installation

Configuration

See Also