Extension:WikibaseCirrusSearch

**MediaWiki extensions manual**
WikibaseCirrusSearch; Release status: stable
Implementation	Search, API
Description	Implements searching for Wikibase using ElasticSearch
Author(s)	Stas Malyshev
Latest version	0.0.1 (continuous updates)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.33+
PHP	7.0+
Composer	wikibase/cirrussearch
	Parameters $wgWBCSRescoreFunctionChains; $wgWBCSLanguageSelectorRescoreProfile; $wgWBCSLanguageSelectorPrefixSearchProfile; $wgWBCSLicenseMapping; $wgWBCSPrefixSearchProfiles; $wgWBCSInLabelSearchProfile; $wgWBCSStatementBoost; $wgWBCSFulltextSearchProfile; $wgWBCSDefaultPrefixRescoreProfile; $wgWBCSInLabelSearchProfiles; $wgWBCSLanguageSelectorStatementBoost; $wgWBCSUseStemming; $wgWBCSLanguageSelectorRescoreFunctionChains; $wgWBCSPrefixSearchProfile; $wgWBCSFulltextSearchProfiles; $wgWBCSRescoreProfiles; $wgWBCSUseCirrus; $wgWBCSDefaultInLabelRescoreProfile; $wgWBCSDefaultFulltextRescoreProfile;
	Hooks used ApiOpenSearchSuggest; CirrusSearchAddQueryFeatures; CirrusSearchAnalysisConfig; CirrusSearchProfileService; CirrusSearchRegisterFullTextQueryClassifiers; SetupAfterCache; ShowSearchHit; ShowSearchHitTitle; SpecialPage_initList; WikibaseRepoEntityTypes;
Licence	GNU General Public License 2.0 or later
Download	Download extension ; Git [?]: Browse repository (Phabricator · GitHub); Gerrit code review; Git commit log; Download source tarball; ; README
Help	Help:Extension:WikibaseCirrusSearch
	Translate the WikibaseCirrusSearch extension if it is available at translatewiki.net
Vagrant role	wikibasecirrussearch
Issues	Open tasks · Report a bug

Translate this page

The WikibaseCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to Wikibase Repository extension.

Installation

This extension requires the following extensions to be installed first:
Download and move the extracted WikibaseCirrusSearch 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/WikibaseCirrusSearch
```
Add the following code at the bottom of your LocalSettings.php file:
```
wfLoadExtension( 'WikibaseCirrusSearch' );
```
Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

The configuration options of WikibaseCirrusSearch are documented at the docs/config.wiki file.

Following configuration options are supported (all variables are prefixed with wgWBCS in globals):

Name	Type	Description	Default
UseCirrus	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.	`false`
PrefixSearchProfile		name of the label scoring profile to use for prefix search. The profile should be defined like examples in `config/EntityPrefixSearchProfiles.php`.
PrefixSearchProfiles		Loaded from `config/EntityPrefixSearchProfiles.php`, does not need to be defined manually.
DefaultPrefixRescoreProfile		name of the rescoring profile to use for prefix search. The profile should be defined in `config/ElasticSearchRescoreProfiles.php`.
FulltextSearchProfile		name of the search profile to use for fulltext search. The profile should be defined like examples in `config/EntitySearchProfiles.php`.
FulltextSearchProfiles		search profiles to use for fulltext search.
DefaultFulltextRescoreProfile		name of the rescoring profile to use for fulltext search. The profile should be defined in `config/ElasticSearchRescoreProfiles.php`.
RescoreProfiles		Loaded from `config/ElasticSearchRescoreProfiles.php`, does not have to be defined manually.
StatementBoost		Configuration to boost or deboost certain statement values.
UseStemming		Configuration to use stemming analyzer for descriptions in certain languages. Array of two fields: index – use it for indexing, query – use main text field for querying.

Installation

Configuration

See also