RediSearch

Total Coverage	Unit Tests	Flow Tests

[!NOTE] Starting with Redis 8, Redis Query Engine (RediSearch) is integral to Redis. You don't need to install this module separately.

We no longer release standalone versions of RediSearch.

See https://github.com/redis/redis for more information.

[!NOTE] 32 bit systems are not supported.

Overview

RediSearch is a Redis module that provides querying, secondary indexing, and full-text search for Redis. To use RediSearch, you first declare indexes on your Redis data. You can then use the RediSearch query language to query that data.

RediSearch uses compressed, inverted indexes for fast indexing with a low memory footprint.

RediSearch indexes enhance Redis by providing exact-phrase matching, fuzzy search, and numeric filtering, among many other features.

Getting started

If you're just getting started with RediSearch, check out the official RediSearch tutorial. Also, consider viewing our RediSearch video explainer.

Documentation

The RediSearch documentation provides a complete overview of RediSearch. Helpful sections include:

• The RediSearch quick start
• The RediSearch command reference
• References on features such as aggregations, highlights, stemming, and spelling correction.
• [Vector search] (https://redis.io/docs/latest/develop/interact/search-and-query/query/vector-search/)

Questions?

Got questions? Join us in #redisearch on the Redis Discord server.

RediSearch features

• Full-Text indexing of multiple fields in Redis hashes
• Incremental indexing without performance loss
• Document ranking (using BM25 as default, with optional user-provided weights). All available scoring methods described here
• Field weighting
• Complex boolean queries with AND, OR, and NOT operators
• Prefix matching, fuzzy matching, and exact-phrase queries
• Support for double-metaphone phonetic matching
• Auto-complete suggestions (with fuzzy prefix suggestions)
• Stemming-based query expansion in many languages (using Snowball)
• Support for Chinese-language tokenization and querying (using Friso)
• Numeric filters and ranges
• Geospatial searches using Redis geospatial indexing
• A powerful aggregations engine
• Supports for all utf-8 encoded text
• Retrieve full documents, selected fields, or only the document IDs
• Sorting results (for example, by creation date)
• Geoshape indexing
• Vector similarity search - KNN, filtered KNN and range query

Cluster support

RediSearch has a distributed cluster version that scales to billions of documents across hundreds of servers. At the moment, distributed RediSearch is available as part of Redis Cloud and Redis Enterprise Software.

See RediSearch on Redis Enterprise for more information.

License

Starting with Redis 8, RediSearch is licensed under your choice of: (i) Redis Source Available License 2.0 (RSALv2); (ii) the Server Side Public License v1 (SSPLv1); or (iii) the GNU Affero General Public License version 3 (AGPLv3). Please review the license folder for the full license terms and conditions. Prior versions remain subject to (i) and (ii).

Code contributions

Contributions are welcome — bug fixes, improvements, and new feature proposals alike, from both human and AI-assisted contributors.

• Getting started, setup, coding standards, and the PR workflow: see CONTRIBUTING.md.
• Proposing a feature or other large change (new commands, new index types, behavior or persistence changes): RediSearch uses a lightweight, framework-neutral spec-driven workflow so the design is reviewed before code is written — see docs/CONTRIBUTING-specs.md.
• Coding agents: repo conventions and the contribution workflow are summarized for automated tooling in AGENTS.md.
• Security bugs and vulnerabilities: see SECURITY.md.

By contributing code to this Redis module in any form, including sending a pull request via GitHub, a code fragment or patch via private email or public discussion groups, you agree to release your code under the terms of the Redis Software Grant and Contributor License Agreement. Please see the CONTRIBUTING.md file in this source distribution for more information.