Skip to content

DOC-5821 update index/query example for runnable notebook #3807

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
Oct 22, 2025
+23 −22
Merged

DOC-5821 update index/query example for runnable notebook #3807

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca8bf52
DOC-5821 update index/query example for runnable notebook
andy-stark-redis Oct 21, 2025
fe66963
Merge branch 'master' into DOC-5821-update-query-example
petyaslavova Oct 21, 2025
187ccc9
Merge branch 'master' into DOC-5821-update-query-example
petyaslavova Oct 22, 2025
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
45 changes: 23 additions & 22 deletions doctests/home_json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# EXAMPLE: py_home_json
# BINDER_ID python-py_home_json
"""
JSON examples from redis-py "home" page"
https://redis.io/docs/latest/develop/connect/clients/python/redis-py/#example-indexing-and-querying-json-documents
Expand All @@ -15,23 +16,6 @@
import redis.exceptions
# STEP_END

# STEP_START connect
r = redis.Redis(decode_responses=True)
# STEP_END

# REMOVE_START
try:
r.ft("idx:users").dropindex(True)
except redis.exceptions.ResponseError:
pass

try:
r.ft("hash-idx:users").dropindex(True)
except redis.exceptions.ResponseError:
pass

r.delete("user:1", "user:2", "user:3", "huser:1", "huser:2", "huser:3")
# REMOVE_END
# STEP_START create_data
user1 = {
"name": "Paul John",
Expand All @@ -55,6 +39,19 @@
}
# STEP_END

# STEP_START connect
r = redis.Redis(decode_responses=True)
# STEP_END

# STEP_START cleanup_json
try:
r.ft("idx:users").dropindex(True)
except redis.exceptions.ResponseError:
pass

r.delete("user:1", "user:2", "user:3")
# STEP_END

# STEP_START make_index
schema = (
TextField("$.name", as_name="name"),
Expand All @@ -69,7 +66,6 @@
)
)
# STEP_END
# Tests for 'make_index' step.
# REMOVE_START
assert indexCreated
# REMOVE_END
Expand All @@ -79,7 +75,6 @@
user2Set = r.json().set("user:2", Path.root_path(), user2)
user3Set = r.json().set("user:3", Path.root_path(), user3)
# STEP_END
# Tests for 'add_data' step.
# REMOVE_START
assert user1Set
assert user2Set
Expand All @@ -94,7 +89,6 @@
print(findPaulResult)
# >>> Result{1 total, docs: [Document {'id': 'user:3', ...
# STEP_END
# Tests for 'query1' step.
# REMOVE_START
assert str(findPaulResult) == (
"Result{1 total, docs: [Document {'id': 'user:3', 'payload': None, "
Expand All @@ -111,7 +105,6 @@
print(citiesResult)
# >>> [Document {'id': 'user:1', 'payload': None, ...
# STEP_END
# Tests for 'query2' step.
# REMOVE_START
citiesResult.sort(key=lambda doc: doc['id'])

Expand All @@ -130,7 +123,6 @@
print(aggResult)
# >>> [['city', 'London', 'count', '1'], ['city', 'Tel Aviv', 'count', '2']]
# STEP_END
# Tests for 'query3' step.
# REMOVE_START
aggResult.sort(key=lambda row: row[1])

Expand All @@ -139,6 +131,15 @@
)
# REMOVE_END

# STEP_START cleanup_hash
try:
r.ft("hash-idx:users").dropindex(True)
except redis.exceptions.ResponseError:
pass

r.delete("huser:1", "huser:2", "huser:3")
# STEP_END

# STEP_START make_hash_index
hashSchema = (
TextField("name"),
Expand Down