mirror of
https://github.com/hanzoai/team.git
synced 2026-10-30 14:49:35 +00:00
bc56925599
* feat(docs): move docs-experimental content into monorepo docs/ * Remove plan related files and comments * Cleanup comments, remove generated files --------- Co-authored-by: Hanzo Dev <[email protected]>
65 lines
3.7 KiB
Plaintext
65 lines
3.7 KiB
Plaintext
---
|
|
title: "Bleve search"
|
|
---
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
<Important>
|
|
|
|
**From Mattermost v11, Bleve search has been deprecated.**
|
|
|
|
- **For v11.0 and later**: Use [Elasticsearch](/administration-guide/scale/elasticsearch-setup) or [OpenSearch](/administration-guide/scale/opensearch-setup) for [enterprise search](/administration-guide/scale/enterprise-search) capabilities
|
|
- **For pre-v11.0 deployments**: This documentation remains relevant for existing installations that continue using Bleve.
|
|
|
|
</Important>
|
|
|
|
Bleve is a search engine that uses Lucene-style full-text search and indexing. This style of search and indexing helps overcome limitations of the default database search such as challenges with characters and advanced search capabilities.
|
|
|
|
<Note>
|
|
|
|
Experimental Bleve search uses the scorch index type on newly-created indexes. This new index type features efficiency improvements and indexes that use significantly less disk space. Go to **System Console \> Experimental \> Bleve** and select **Purge Index** to run a purge operation. When that's complete, select **Index Now** to reindex. Bleve remains compatible with existing indexes, so currently indexed data will continue to work if a purge and reindex isn't run.
|
|
|
|
</Note>
|
|
|
|
## Configuring Bleve in Mattermost
|
|
|
|
<Note>
|
|
|
|
The following steps are only valid for Mattermost versions prior to v11.0. For v11.0 and later, consider using Elasticsearch or OpenSearch instead.
|
|
|
|
</Note>
|
|
|
|
Follow these steps to configure the Mattermost server to use Bleve and generate required indexes. Once the configuration is saved, new posts made to the database will be automatically indexed with Bleve.
|
|
|
|
**Note:** During indexing, search results may be incomplete until the indexing job is complete.
|
|
|
|
1. Open **System Console \> Experimental \> Bleve**.
|
|
2. Set **Enable Bleve Indexing** to **true** to enable the other settings on the page.
|
|
3. Set the directory path to use for storing Bleve indexes (e.g.: `/var/opt/mattermost/bleveindexes`). The user running Mattermost should have permissions to access the directory. See our [configuration settings](/administration-guide/configure/deprecated-configuration-settings#bleve-settings) documentation for details.
|
|
4. Save the configuration.
|
|
5. Select **Index Now**. All users, channels, and posts in the database will be indexed oldest to newest.
|
|
6. Set **Enable Bleve for search queries** to **true**.
|
|
7. Set **Enable Bleve for autocomplete queries** to **true**.
|
|
|
|
<Note>
|
|
|
|
Search results for files shared before upgrading to Mattermost Server v5.35 may be incomplete until an extraction command is run using the [mmctl](/administration-guide/manage/mmctl-command-line-tool#mmctl-extract). After running this command, the search index must be rebuilt. Go to **System Console \> Experimental \> Bleve \> Bulk Indexing**, then select **Index Now** to rebuild the search index to include older file contents.
|
|
|
|
</Note>
|
|
|
|
## Using Bleve search
|
|
|
|
<Note>
|
|
|
|
This section applies only to Mattermost versions prior to v11.0.
|
|
|
|
</Note>
|
|
|
|
The following conditions are applied when using Bleve search:
|
|
|
|
- **Unquoted terms:** Search terms that contain non-alphanumeric characters/special characters outside of quotation marks are removed. For example, using `abcd "**" && abc` as a search term will return results for a search for `abcd "**" abc` as the `&&` characters weren't within the quotation marks.
|
|
- **Wildcard search:** Wildcard search (e.g., `abc*`) is supported.
|
|
|
|
## How does search work with Bleve disabled?
|
|
|
|
Mattermost performs full text searches against the database unless you have an [Enterprise license](/product-overview/editions-and-offerings#mattermost-enterprise) and [enterprise search](/administration-guide/scale/enterprise-search) configured.
|