Skip to content

Use explicit index name in RediSearch example #2466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 4, 2022
Merged

Use explicit index name in RediSearch example #2466

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a6b014
Use explicit index name in RediSearch example
uglide Nov 20, 2022
42cf790
Merge branch 'master' into doc_redisearch_show_index_name_in_example
chayim Dec 1, 2022
cc9ae9f
amending example text to highlight default
chayim Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/redismodules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ These are the commands for interacting with the `RedisBloom module <https://redi
**Create and add to a bloom filter**

.. code-block:: python
import redis

import redis
r = redis.Redis()
r.bf().create("bloom", 0.01, 1000)
r.bf().create("bloom", 0.01, 1000)
r.bf().add("bloom", "foo")

**Create and add to a cuckoo filter**

.. code-block:: python

import redis
import redis
r = redis.Redis()
r.cf().create("cuckoo", 1000)
r.cf().add("cuckoo", "filter")
Expand Down Expand Up @@ -107,7 +107,8 @@ Examples of how to combine search and json can be found `here <examples/search_j
RediSearch Commands
*******************

These are the commands for interacting with the `RediSearch module <https://redisearch.io>`_. Below is a brief example, as well as documentation on the commands themselves.
These are the commands for interacting with the `RediSearch module <https://redisearch.io>`_. Below is a brief example, as well as documentation on the commands themselves. In the example
below, an index named *my_index* is being created. When an index name is not specified, an index named *idx* is created.

**Create a search index, and display its information**

Expand All @@ -117,8 +118,9 @@ These are the commands for interacting with the `RediSearch module <https://redi
from redis.commands.search.field import TextField

r = redis.Redis()
r.ft().create_index(TextField("play", weight=5.0), TextField("ball"))
print(r.ft().info())
index_name = "my_index"
r.ft(index_name).create_index(TextField("play", weight=5.0), TextField("ball"))
print(r.ft(index_name).info())


.. automodule:: redis.commands.search.commands
Expand Down