MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=cirrus-schema-dump
(main | cirrus-schema-dump)
- This module is internal or unstable, and you should not use it. Its operation may change without notice.
- This module requires read rights.
- Source: CirrusSearch
- License: GPL-2.0-or-later
Dump of CirrusSearch schema (settings and mappings) for this wiki.
Specific parameters:
Other general parameters are available.
- build
Whether to build the schema from code (true) or fetch from live cluster (false).
- Type: boolean (details)
- plugins
List of OpenSearch/Elasticsearch plugins available on the target cluster. Only used when build=true. If not provided, plugins will be detected from the connected cluster.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
Examples:
- Get a dump of CirrusSearch schema from the live cluster.
- api.php?action=cirrus-schema-dump [open in sandbox]
- Generate CirrusSearch schema from code configuration.
- api.php?action=cirrus-schema-dump&build=true [open in sandbox]
- Generate CirrusSearch schema with specific plugins enabled.
- api.php?action=cirrus-schema-dump&build=true&plugins=analysis-icu|extra-analysis-textify [open in sandbox]