From 7476fef6fe5fc791cc5abfecae190c0c89e61e57 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Wed, 23 Apr 2025 13:14:30 +0100 Subject: [PATCH 1/2] DOC-5109 added C# hash search examples --- content/develop/clients/dotnet/queryjson.md | 74 ++++++++++++++++++--- 1 file changed, 63 insertions(+), 11 deletions(-) diff --git a/content/develop/clients/dotnet/queryjson.md b/content/develop/clients/dotnet/queryjson.md index 9a14e4f77c..796d9cf945 100644 --- a/content/develop/clients/dotnet/queryjson.md +++ b/content/develop/clients/dotnet/queryjson.md @@ -9,39 +9,55 @@ 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: 2 --- 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 `NRedisStack` installed. +## Initialize -Start by importing dependencies: +Make sure that you have [Redis Community Edition]({{< relref "/operate/rc" >}}) +or another Redis server available. Also install the +[`NRedisStack`]({{< relref "/develop/clients/dotnet" >}}) client library if you +haven't already done so. + +Add the following dependencies: {{< clients-example cs_home_json import >}} {{< /clients-example >}} -Connect to the database: - -{{< clients-example cs_home_json connect >}} -{{< /clients-example >}} +## Create data Create some test data to add to the database: {{< clients-example cs_home_json create_data >}} {{< /clients-example >}} +## Add the index + +Connect to your Redis database. The code below shows the most +basic connection but see +[Connect to the server]({{< relref "/develop/clients/dotnet/connect" >}}) +to learn more about the available connection options. + +{{< clients-example cs_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/" >}}). {{< clients-example cs_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 +66,8 @@ objects automatically as you add them: {{< clients-example cs_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 +88,39 @@ to count all users in each city. {{< clients-example cs_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 set the `On` option to `IndexDataType.HASH` +in the `FTCreateParams` object 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 cs_home_json make_hash_index >}} +{{< /clients-example >}} + +You use [`HashSet()`]({{< relref "/commands/hset" >}}) to add the hash +documents instead of [`JSON.Set()`]({{< relref "/commands/json.set" >}}). +Also, you must add the fields as key-value pairs instead of combining them +into a single object. + +{{< clients-example cs_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 +also almost the same except that the fields are returned directly in the +`Document` object of the result (for JSON, the fields are all enclosed +in a string under the key `json`): + +{{< clients-example cs_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. From 6d3b3ed16740bbbf50a3afecc9c7870a258bd1a9 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 1 May 2025 13:25:21 +0100 Subject: [PATCH 2/2] DOC-5109 minor fixes --- content/develop/clients/dotnet/queryjson.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/develop/clients/dotnet/queryjson.md b/content/develop/clients/dotnet/queryjson.md index 796d9cf945..a6ee76ebe9 100644 --- a/content/develop/clients/dotnet/queryjson.md +++ b/content/develop/clients/dotnet/queryjson.md @@ -24,7 +24,7 @@ documents. ## Initialize -Make sure that you have [Redis Community Edition]({{< relref "/operate/rc" >}}) +Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack" >}}) or another Redis server available. Also install the [`NRedisStack`]({{< relref "/develop/clients/dotnet" >}}) client library if you haven't already done so. @@ -113,7 +113,7 @@ into a single object. 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 -also almost the same except that the fields are returned directly in the +almost the same except that the fields are returned directly in the `Document` object of the result (for JSON, the fields are all enclosed in a string under the key `json`):