Quick Start Guide for RediSearch

    Get started here

    Running with Docker

    To build using CMake:

    2. cd RediSearch
    3. cd build
    4. cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo
    5. make
    7. redis-server --loadmodule ./redisearch.so

    You can also simply type make from the top level directory, this will take care of running with the appropriate arguments, and provide you with a redisearch.so file in the src directory:

    Creating an index with fields and weights (default weight is 1.0)

    1. 127.0.0.1:6379> FT.CREATE myIdx SCHEMA title TEXT WEIGHT 5.0 body TEXT url TEXT
    2. OK

    Searching the index

    1. 127.0.0.1:6379> FT.SEARCH myIdx "hello world" LIMIT 0 10
    2. 1) (integer) 1
    3. 2) "doc1"
    5.    3) "body"
    6.    4) "lorem ipsum"
    7.    5) "url"
    8.    6) "http://redis.io"

    Input is expected to be valid utf-8 or ASCII. The engine cannot handle wide character unicode at the moment.

    Adding and getting Auto-complete suggestions

    1. 127.0.0.1:6379> FT.SUGADD autocomplete "hello world" 100
    2. OK
    4. 127.0.0.1:6379> FT.SUGGET autocomplete "he"