RediSearch Quick Start Tutorial

For this quick start tutorial, you need:

• Either:

  • A Redis Cloud database with the RediSearch module

    You can set up a free Redis Cloud database to see the module in action.

  • A Redis Enterprise Software database with the RediSearch module

• redis-cli with connectivity to a redis database

Creating Indexes

Let’s create a new index called “myidx”. When you define the index, you must pass in the structure of the data you are adding to the index. In this example, we have four things we input, the title, body, url, and value. In this example, we have three TEXT and one NUMERIC values. The title has a weight of 5.0.

Connect to redis.

$ redis-cli -p 12543
127.0.0.1:12543>

Run this command:

127.0.0.1:12543> FT.CREATE myIdx SCHEMA title TEXT WEIGHT 5.0 body TEXT url TEXT value NUMERIC

FT.CREATE {idx} ...
FT.ADD {idx} {idx}:docid ...

Add info to test index

Now add some data to this index. Here we add an object with the key doc1 and then add a title of “hello world”, body of “my favorite object”, and url of https://redislabs.com/ to the object as follows:

127.0.0.1:12543> FT.ADD myIdx doc1 1.0 FIELDS title "hello world" body "My first object" url "https://redislabs.com/"
OK

Search the Index

Do a search on this index for any object with the word “first”:

127.0.0.1:12543> FT.SEARCH myIdx "first" LIMIT 0 10
1) (integer) 1
2) "doc1"
3) 1) "title"
2) "hello world"
3) "body"
4) "My first object"
5) "url"
6) "https://redislabs.com/"

Drop the Index

Now that we are done with it, we can drop the index.

127.0.0.1:12543> FT.DROP myIdx
OK

Auto-Complete and Search Engine Suggestions

Let’s add a suggestion for the search engine to use

127.0.0.1:12543> FT.SUGADD autocomplete "hello world" 100
"(integer)" 1

Make sure the suggestion is there:

127.0.0.1:12543> FT.SUGGET autocomplete "he"
1) "hello world"