Extension:WikibaseCirrusSearch/diq

Category:GPL licensed extensions/diq
MediaWiki extensions manual
WikibaseCirrusSearch
Release status: stableCategory:Stable extensions/diq
Implementation SearchCategory:Search extensions/diq, API Category:API extensions/diq
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+Category:Extensions with manual MediaWiki version
PHP 7.0+
Composer wikibase/cirrussearchCategory:Extensions supporting Composer/diq
License GNU General Public License 2.0 or later
Download
Download extension
Git [?]:
Category:Extensions in Wikimedia version control/diq
README
Parameters
  • $wgLanguageSelectorRescoreFunctionChains
  • $wgUseCirrus
  • $wgRescoreFunctionChains
  • $wgLanguageSelectorRescoreProfile
  • $wgLicenseMapping
  • $wgPrefixSearchProfile
  • $wgInLabelSearchProfile
  • $wgFulltextSearchProfiles
  • $wgPrefixSearchProfiles
  • $wgLanguageSelectorStatementBoost
  • $wgFulltextSearchProfile
  • $wgRescoreProfiles
  • $wgLanguageSelectorPrefixSearchProfile
  • $wgStatementBoost
  • $wgUseStemming
  • $wgDefaultFulltextRescoreProfile
  • $wgDefaultInLabelRescoreProfile
  • $wgInLabelSearchProfiles
  • $wgDefaultPrefixRescoreProfile
Hooks used
Quarterly downloads 11 (Ranked 103rd)
Translate the WikibaseCirrusSearch extension if it is available at translatewiki.net
Vagrant role wikibasecirrussearch
Issues Open tasks · Report a bug
Category:All extensions/diq

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.
  • Yes 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):

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

Bıvênên

Category:Extensions used on Wikimedia/diq#WikibaseCirrusSearch/diq Category:Discovery/diq Category:Search/diq Category:Wikidata/diq Category:Wikibase/diq Category:Wikibase extensions/diq
Category:API extensions/diq Category:All extensions/diq Category:ApiOpenSearchSuggest extensions/diq Category:CirrusSearchAddQueryFeatures extensions/diq Category:CirrusSearchAnalysisConfig extensions/diq Category:CirrusSearchProfileService extensions/diq Category:Discovery/diq Category:Extensions in Wikimedia version control/diq Category:Extensions included in Miraheze/diq Category:Extensions included in WikiForge/diq Category:Extensions supporting Composer/diq Category:Extensions used on Wikimedia/diq Category:Extensions with manual MediaWiki version Category:GPL licensed extensions/diq Category:Search/diq Category:Search extensions/diq Category:SetupAfterCache extensions/diq Category:ShowSearchHitTitle extensions/diq Category:ShowSearchHit extensions/diq Category:SpecialPage initList extensions/diq Category:Stable extensions/diq Category:Wikibase/diq Category:WikibaseRepoEntityTypes extensions/diq Category:Wikibase extensions/diq Category:Wikidata/diq