1<img src="img/logo.svg" alt="logo" width="200"/>
2
3# RediSearch - Redis Secondary Index & Query Engine
4[![Forum](https://img.shields.io/badge/Forum-RediSearch-blue)](https://forum.redislabs.com/c/modules/redisearch/)
5[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/xTbqgTB)
6
7RediSearch is a source available Secondary Index, Query Engine and Full-Text Search over Redis, developed by [Redis](http://redis.com).
8
9!!! note "Quick Links:"
10    * [Source Code at GitHub](https://github.com/RediSearch/RediSearch).
11    * [Latest Release](https://github.com/RediSearch/RediSearch/releases)
12    * [Docker Image: redislabs/redisearch](https://hub.docker.com/r/redislabs/redisearch/)
13    * [Quick Start Guide](Quick_Start.md)
14    * [Mailing list / Forum](https://forum.redis.com/c/modules/redisearch/)
15
16!!! tip "Supported Platforms"
17    RediSearch is developed and tested on Linux and Mac OS, on x86_64 CPUs.
18
19    i386 CPUs should work fine for small data-sets, but are not tested and not recommended. Atom CPUs are not supported currently.
20
21## Overview
22
23Redisearch implements a secondary index on top of Redis, but unlike other Redis
24indexing libraries, it does not use internal data structures such as sorted sets.
25
26This also enables more advanced features, such as multi-field queries, aggregation, and full text search capabilites.
27These capabilities include exact phrase matching and numeric filtering for text queries, something that is neither possible or efficient with traditional Redis indexing approaches.
28
29## Client Libraries
30
31Official and community client libraries in Python, Java, JavaScript, Ruby, Go, C#, and PHP.
32
33See the [Clients page](Clients.md) for the full list.
34
35## Cluster Support
36
37RediSearch has a distributed cluster version that scales to billions of documents, and hundreds of servers. We also offer official commercial support for RediSearch. See the [Redis Website](https://redis.com/redis-enterprise/technology/redis-search/#sds) for more info and contact information.
38
39## Primary Features
40
41* Secondary Index.
42* Multi field queries.
43* Aggregation.
44* Full-Text indexing of multiple fields in documents.
45* Incremental indexing without performance loss.
46* Document ranking (provided manually by the user at index time).
47* Complex boolean queries with AND, OR, NOT operators between sub-queries.
48* Optional query clauses.
49* Prefix based searches.
50* Field weights.
51* Auto-complete suggestions (with fuzzy prefix suggestions).
52* Exact Phrase Search, Slop based search.
53* Stemming based query expansion in [many languages](Stemming.md) (using [Snowball](http://snowballstem.org/)).
54* Support for custom functions for query expansion and scoring (see [Extensions](Extensions.md)).
55* Limiting searches to specific document fields.
56* Numeric filters and ranges.
57* Geo filtering using Redis' own Geo-commands.
58* Unicode support (UTF-8 input required).
59* Retrieve full document content or just ids.
60* Document deletion and updating with index garbage collection.
61* Partial and conditional document updates.
62
63## References
64### Videos
651. [RediSearch? - RedisConf 2020](https://youtu.be/9R29LLWquME)
661. [RediSearch Overview - RedisConf 2019](https://youtu.be/AwnEhr9BO74)
671. [RediSearch & CRDT - Redis Day Tel Aviv 2019](https://youtu.be/OGC6Mx9E3jU)
68
69
70### Course
71* [RU203: Querying, Indexing, and Full-Text Search](https://university.redis.com/courses/ru203/) - An online RediSearch course from [Redis University](https://university.redis.com/).
72
73### Blog posts
741. [Introducing RediSearch 2.0](https://redis.com/blog/introducing-redisearch-2-0/)
751. [Getting Started with RediSearch 2.0](https://redis.com/blog/getting-started-with-redisearch-2-0/)
761. [Mastering RediSearch / Part I](https://redis.com/blog/mastering-redisearch-part/)
771. [Mastering RediSearch / Part II](https://redis.com/blog/mastering-redisearch-part-ii/)
781. [Mastering RediSearch / Part III](https://redis.com/blog/mastering-redisearch-part-iii/)
791. [Building Real-Time Full-Text Site Search with RediSearch](https://redis.com/blog/building-real-time-full-text-site-search-with-redisearch/)
801. [Search Benchmarking: RediSearch vs. Elasticsearch](https://redis.com/blog/search-benchmarking-redisearch-vs-elasticsearch/)
811. [RediSearch Version 1.6 Adds Features, Improves Performance](https://redis.com/blog/redisearch-version-1-6-adds-features-improves-performance/)
821. [RediSearch 1.6 Boosts Performance Up to 64%](https://redis.com/blog/redisearch-1-6-boosts-performance-up-to-64/)
83
84## Mailing List / Forum
85
86Got questions? Feel free to ask at the [RediSearch forum](https://forum.redis.com/c/modules/redisearch/).
87
88## License
89
90Redis Source Available License Agreement - see [LICENSE](https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE)
91