Extension:WikibaseCirrusSearch

From MediaWiki.org
Jump to navigation Jump to search

The WikibaseCirrusSearch provides ElasticSearch functionality, as supported by CirrusSearch extension, to Wikibase Repository extension. It requires both CirrusSearch and Wikibase Repository extensions to be installed.


MediaWiki extensions manual
OOjs UI icon advanced.svg
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
MediaWiki 1.33+
PHP 7.0+
Database changes No
License GNU General Public License 2.0 or later
Download
README
Translate the WikibaseCirrusSearch extension if it is available at translatewiki.net
Check usage and version matrix.
Vagrant role wikibasecirrussearch
Issues Open tasks · Report a bug

Installation[edit]

  • Download and place the file(s) in a directory called WikibaseCirrusSearch in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'WikibaseCirrusSearch' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

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):

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.
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.

See Also[edit]