Merge pull request #1454 from redis/DOC-5107-py-hash-query-example

DOC-5107 added Python hash search examples

Author: andy-stark-redis

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

@@ -9,39 +9,61 @@ categories:
 - oss
 - kubernetes
 - clients
-description: Learn how to use the Redis query engine with JSON
-linkTitle: Index and query JSON
-title: Example - Index and query JSON documents
+description: Learn how to use the Redis query engine with JSON and hash documents.
+linkTitle: Index and query documents
+title: Index and query documents
 weight: 30
 ---
 
 This example shows how to create a
 [search index]({{< relref "/develop/interact/search-and-query/indexing" >}})
-for [JSON]({{< relref "/develop/data-types/json" >}}) data and
-run queries against the index.
+for [JSON]({{< relref "/develop/data-types/json" >}}) documents and
+run queries against the index. It then goes on to show the slight differences
+in the equivalent code for [hash]({{< relref "/develop/data-types/hashes" >}})
+documents.
 
-Make sure that you have Redis Community Edition and `redis-py` installed.
+## Initialize
 
-Import dependencies:
+Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
+or another Redis server available. Also install the
+[`redis-py`]({{< relref "/develop/clients/redis-py" >}}) client library if you
+haven't already done so.
+
+Add the following dependencies. All of them are applicable to both JSON and hash,
+except for the `Path` class, which is specific to JSON (see
+[Path]({{< relref "/develop/data-types/json/path" >}}) for a description of the
+JSON path syntax).
 
 {{< clients-example py_home_json import >}}
 {{< /clients-example >}}
 
-Connect to your Redis database.
+## Create data
 
-{{< clients-example py_home_json connect >}}
+Create some test data to add to your database. The example data shown
+below is compatible with both JSON and hash objects.
+
+{{< clients-example py_home_json create_data >}}
 {{< /clients-example >}}
 
-Create some test data to add to your database.
+## Add the index
 
-{{< clients-example py_home_json create_data >}}
+Connect to your Redis database. The code below shows the most
+basic connection but see
+[Connect to the server]({{< relref "/develop/clients/redis-py/connect" >}})
+to learn more about the available connection options.
+
+{{< clients-example py_home_json connect >}}
 {{< /clients-example >}}
 
-Create an index. In this example, only JSON documents with the key prefix `user:` are indexed. For more information, see [Query syntax]({{< relref "/develop/interact/search-and-query/query/" >}}).
+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/interact/search-and-query/query/" >}}).
 
 {{< clients-example py_home_json make_index >}}
 {{< /clients-example >}}
 
+## Add the data
+
 Add the three sets of user data to the database as
 [JSON]({{< relref "/develop/data-types/json" >}}) objects.
 If you use keys with the `user:` prefix then Redis will index the
@@ -50,6 +72,8 @@ objects automatically as you add them:
 {{< clients-example py_home_json add_data >}}
 {{< /clients-example >}}
 
+## Query the data
+
 You can now use the index to search the JSON objects. The
 [query]({{< relref "/develop/interact/search-and-query/query" >}})
 below searches for objects that have the text "Paul" in any field
@@ -70,5 +94,38 @@ to count all users in each city.
 {{< clients-example py_home_json query3 >}}
 {{< /clients-example >}}
 
+## Differences with hash documents
+
+Indexing for hash documents is very similar to JSON indexing but you
+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.
+
+{{< clients-example py_home_json make_hash_index >}}
+{{< /clients-example >}}
+
+You use [`hset()`]({{< relref "/commands/hset" >}}) to add the hash
+documents instead of [`json().set()`]({{< relref "/commands/json.set" >}}),
+but the same flat `userX` dictionaries work equally well with either
+hash or JSON:
+
+{{< clients-example py_home_json add_hash_data >}}
+{{< /clients-example >}}
+
+The query commands work the same here for hash as they do for JSON (but
+the name of the hash index is different). The format of the result is
+almost the same except that the fields are returned directly in the
+result `Document` object instead of in an enclosing `json` dictionary:
+
+{{< clients-example py_home_json query1_hash >}}
+{{< /clients-example >}}
+
+## More information
+
 See the [Redis query engine]({{< relref "/develop/interact/search-and-query" >}}) docs
 for a full description of all query features with examples.