Merge pull request #2276 from redis/DOC-5821-python-query-notebook

DOC-5821 Python index/query notebook link

Author: andy-stark-redis

content/develop/clients/redis-py/queryjson.md

@@ -64,6 +64,14 @@ to learn more about the available connection options.
 {{< clients-example py_home_json connect >}}
 {{< /clients-example >}}
 
+The example uses an index called `idx:users` for JSON documents and adds
+some JSON documents with the `user:` key prefix. To avoid errors, first
+delete any existing index or documents whose names that might
+conflict with the example:
+
+{{< clients-example py_home_json cleanup_json >}}
+{{< /clients-example >}}
+
 Create an index for the JSON data. The code below specifies that only JSON documents with
 the key prefix `user:` are indexed. For more information, see
 [Query syntax]({{< relref "/develop/ai/search-and-query/query/" >}}).
@@ -111,9 +119,16 @@ need to specify some slightly different options.
 When you create the schema for a hash index, you don't need to
 add aliases for the fields, since you use the basic names to access
 the fields anyway. Also, you must use `HASH` for the `IndexType`
-when you create the index. The code below shows these changes with
-a new index called `hash-idx:users`, which is otherwise the same as
-the `idx:users` index used for JSON documents in the previous examples.
+when you create the index.
+
+First delete any existing index or documents
+whose names might conflict with the hash example:
+
+{{< clients-example py_home_json cleanup_hash >}}
+{{< /clients-example >}}
+
+Create a new index called `hash-idx:users`, which is otherwise the same as
+the `idx:users` index used for JSON documents in the previous examples:
 
 {{< clients-example py_home_json make_hash_index >}}
 {{< /clients-example >}}

local_examples/client-specific/redis-py/home_json.py

@@ -0,0 +1,189 @@
+# 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
+"""
+
+# STEP_START import
+import redis
+from redis.commands.json.path import Path
+import redis.commands.search.aggregation as aggregations
+import redis.commands.search.reducers as reducers
+from redis.commands.search.field import TextField, NumericField, TagField
+from redis.commands.search.index_definition import IndexDefinition, IndexType
+from redis.commands.search.query import Query
+import redis.exceptions
+# STEP_END
+
+# STEP_START create_data
+user1 = {
+    "name": "Paul John",
+    "email": "[email protected]",
+    "age": 42,
+    "city": "London"
+}
+
+user2 = {
+    "name": "Eden Zamir",
+    "email": "[email protected]",
+    "age": 29,
+    "city": "Tel Aviv"
+}
+
+user3 = {
+    "name": "Paul Zamir",
+    "email": "[email protected]",
+    "age": 35,
+    "city": "Tel Aviv"
+}
+# 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"),
+    TagField("$.city", as_name="city"),
+    NumericField("$.age", as_name="age")
+)
+
+indexCreated = r.ft("idx:users").create_index(
+    schema,
+    definition=IndexDefinition(
+        prefix=["user:"], index_type=IndexType.JSON
+    )
+)
+# STEP_END
+# REMOVE_START
+assert indexCreated
+# REMOVE_END
+
+# STEP_START add_data
+user1Set = r.json().set("user:1", Path.root_path(), user1)
+user2Set = r.json().set("user:2", Path.root_path(), user2)
+user3Set = r.json().set("user:3", Path.root_path(), user3)
+# STEP_END
+# REMOVE_START
+assert user1Set
+assert user2Set
+assert user3Set
+# REMOVE_END
+
+# STEP_START query1
+findPaulResult = r.ft("idx:users").search(
+    Query("Paul @age:[30 40]")
+)
+
+print(findPaulResult)
+# >>> Result{1 total, docs: [Document {'id': 'user:3', ...
+# STEP_END
+# REMOVE_START
+assert str(findPaulResult) == (
+    "Result{1 total, docs: [Document {'id': 'user:3', 'payload': None, "
+    + "'json': '{\"name\":\"Paul Zamir\",\"email\":"
+    + "\"[email protected]\",\"age\":35,\"city\":\"Tel Aviv\"}'}]}"
+)
+# REMOVE_END
+
+# STEP_START query2
+citiesResult = r.ft("idx:users").search(
+    Query("Paul").return_field("$.city", as_field="city")
+).docs
+
+print(citiesResult)
+# >>> [Document {'id': 'user:1', 'payload': None, ...
+# STEP_END
+# REMOVE_START
+citiesResult.sort(key=lambda doc: doc['id'])
+
+assert str(citiesResult) == (
+    "[Document {'id': 'user:1', 'payload': None, 'city': 'London'}, "
+    + "Document {'id': 'user:3', 'payload': None, 'city': 'Tel Aviv'}]"
+)
+# REMOVE_END
+
+# STEP_START query3
+req = aggregations.AggregateRequest("*").group_by(
+    '@city', reducers.count().alias('count')
+)
+
+aggResult = r.ft("idx:users").aggregate(req).rows
+print(aggResult)
+# >>> [['city', 'London', 'count', '1'], ['city', 'Tel Aviv', 'count', '2']]
+# STEP_END
+# REMOVE_START
+aggResult.sort(key=lambda row: row[1])
+
+assert str(aggResult) == (
+    "[['city', 'London', 'count', '1'], ['city', 'Tel Aviv', 'count', '2']]"
+)
+# 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"),
+    TagField("city"),
+    NumericField("age")
+)
+
+hashIndexCreated = r.ft("hash-idx:users").create_index(
+    hashSchema,
+    definition=IndexDefinition(
+        prefix=["huser:"], index_type=IndexType.HASH
+    )
+)
+# STEP_END
+# REMOVE_START
+assert hashIndexCreated
+# REMOVE_END
+
+# STEP_START add_hash_data
+huser1Set = r.hset("huser:1", mapping=user1)
+huser2Set = r.hset("huser:2", mapping=user2)
+huser3Set = r.hset("huser:3", mapping=user3)
+# STEP_END
+# REMOVE_START
+assert huser1Set
+assert huser2Set
+assert huser3Set
+# REMOVE_END
+
+# STEP_START query1_hash
+findPaulHashResult = r.ft("hash-idx:users").search(
+    Query("Paul @age:[30 40]")
+)
+
+print(findPaulHashResult)
+# >>> Result{1 total, docs: [Document {'id': 'huser:3',
+# >>>   'payload': None, 'name': 'Paul Zamir', ...
+# STEP_END
+# REMOVE_START
+assert str(findPaulHashResult) == (
+    "Result{1 total, docs: [Document " +
+    "{'id': 'huser:3', 'payload': None, 'name': 'Paul Zamir', " +
+    "'email': '[email protected]', 'age': '35', 'city': 'Tel Aviv'}]}"
+)
+# REMOVE_END
+
+r.close()