| Total Coverage | Unit Tests | Flow Tests |
|---|---|---|
 |
 |
 |
Starting with version 8.0, RediSearch is an integral part of Redis. See https://github.com/redis/redis
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.
If you're just getting started with RediSearch, check out the official RediSearch tutorial. Also, consider viewing our RediSearch video explainer.
The fastest way to get up and running with RediSearch is by using the Redis Stack Docker image.
Learn for free at Redis University
Build faster with the Redis Launchpad
To try RediSearch, either use the RediSearch Docker image, or create a free Redis Cloud Essentials account to get a RediSearch instance in the cloud.
The Redis Stack Docker image makes it easy to try RediSearch.
To create a local RediSearch container, run:
$ docker run -p 6379:6379 redis/redis-stack-server:latestTo connect to this instance, run:
$ redis-cliPlease check the developer notes for more information on how to build and test RediSearch.
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/)
Got questions? Join us in #redisearch on the Redis Discord server.
If you have a more detailed question, drop us a line on the RediSearch Discussion Forum.
 |
 |
 |
 |
|---|---|---|---|
| NRedisStack | Jedis | node-redis | redis-py |
| Redis.OM | Redis OM Spring | redis-om-node | redis-om |
| Project | Language | License | Author | Stars |
|---|---|---|---|---|
| redisson | Java | MIT | Redisson |  |
| redisearch-go | Go | BSD | Redis |  |
| rueidis | Go | Apache 2.0 | Rueian |  |
| redisearch-php | PHP | MIT | Ethan Hann |  |
| php-redisearch | PHP | MIT | MacFJA |  |
| redisearch-api-rs | Rust | BSD | Redis |  |
| redi_search_rails | Ruby | MIT | Dmitry Polyakovsky |  |
| redisearch-rb | Ruby | MIT | Victor Ruiz |  |
| redi_search | Ruby | MIT | Nick Pezza |  |
| coredis | Python | MIT | Ali-Akber Saifee |  |
- Full-Text indexing of multiple fields in Redis hashes
- Incremental indexing without performance loss
- Document ranking (using tf-idf, with optional user-provided weights)
- 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
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.
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).
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. For security bugs and vulnerabilities, please see SECURITY.md.
