Extension:WikibaseCirrusSearch
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 |
License | GNU General Public License 2.0 or later |
Download | README |
Help | Help:Extension:WikibaseCirrusSearch |
|
|
Quarterly downloads | 10 (Ranked 127th) |
Translate the WikibaseCirrusSearch extension if it is available at translatewiki.net | |
Vagrant role | wikibasecirrussearch |
Issues | Open tasks · Report a bug |
The WikibaseCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to Wikibase Repository extension. It requires both CirrusSearch and Wikibase Repository extensions to be installed.
Installation
edit- Download and move the extracted
WikibaseCirrusSearch
folder to yourextensions/
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: Configure as required.
wfLoadExtension( 'WikibaseCirrusSearch' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
editThe 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
editThis 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. |