Merge branch 'master' into DOC-4560-trans-pipe-examples

Author: andy-stark-redis

.github/workflows/integration.yml

@@ -37,7 +37,7 @@ jobs:
         max-parallel: 15
         fail-fast: false
         matrix:
-          redis-version: [ '8.0-M04-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.6', '6.2.16']
+          redis-version: [ '8.0-RC2-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.6', '6.2.16']
           dotnet-version: ['6.0', '7.0', '8.0']
       env:
         ACTIONS_ALLOW_UNSECURE_COMMANDS: true

README.md

@@ -40,8 +40,9 @@ Each module has a command class with its own commands.
 
 The supported modules are [Search](https://redis.io/commands/?group=search), [JSON](https://redis.io/commands/?group=json), [TimeSeries](https://redis.io/commands/?group=timeseries), [Bloom Filter](https://redis.io/commands/?group=bf), [Cuckoo Filter](https://redis.io/commands/?group=cf), [T-Digest](https://redis.io/commands/?group=tdigest), [Count-min Sketch](https://redis.io/commands/?group=cms), and [Top-K](https://redis.io/commands/?group=topk).
 
-**Note:** RedisGraph support has been deprecated starting from Redis Stack version 7.2. For more information, please refer to [this blog post](https://redis.com/blog/redisgraph-eol/).
-**IMPORTANT:** NRedisStack will end the support for Graph functionalities with version 0.13.x  
+**Note:** RedisGraph support has been deprecated starting from Redis Stack version 7.2. For more information, please refer to [this blog post](https://redis.com/blog/redisgraph-eol/).<br>
+**IMPORTANT:** NRedisStack will end the support for Graph functionalities with version 0.13.x<br>
+**IMPORTANT:** Starting from version **1.0.0-beta1**, by default, the client now overrides the [server-side dialect](https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/) with version 2, automatically appending `DIALECT 2` to commands like **FT.AGGREGATE** and **FT.SEARCH**. Be aware that the query dialect may impact the results returned. If needed, you can revert to a different dialect version by configuring the client accordingly. Please see [release notes](https://github.com/redis/NRedisStack/releases/tag/v1.0.0-beta1).
 
 # Usage
 

src/NRedisStack/NRedisStack.csproj

@@ -10,9 +10,9 @@
 	<Owners>Redis OSS</Owners>
 	<Description>.Net Client for Redis Stack</Description>
 	<PackageReadmeFile>README.md</PackageReadmeFile>
-	<Version>0.13.1</Version>
-	<ReleaseVersion>0.13.1</ReleaseVersion>
-	<PackageVersion>0.13.1</PackageVersion>
+	<Version>1.0.0-beta1</Version>
+	<ReleaseVersion>1.0.0-beta1</ReleaseVersion>
+	<PackageVersion>1.0.0-beta1</PackageVersion>
   </PropertyGroup>
 
   <ItemGroup>

src/NRedisStack/Pipeline.cs

@@ -6,6 +6,7 @@ public class Pipeline
 {
     public Pipeline(IDatabase db)
     {
+        db.SetInfoInPipeline();
         _batch = db.CreateBatch();
     }
 

src/NRedisStack/Search/Schema.cs

@@ -97,11 +97,10 @@ internal override void AddFieldTypeArgs(List<object> args)
                 AddPhonetic(args);
                 AddWeight(args);
                 if (WithSuffixTrie) args.Add(SearchArgs.WITHSUFFIXTRIE);
-                if (Sortable) args.Add(FieldOptions.SORTABLE);
                 if (Unf) args.Add(SearchArgs.UNF);
                 if (MissingIndex) args.Add(FieldOptions.INDEXMISSING);
                 if (EmptyIndex) args.Add(FieldOptions.INDEXEMPTY);
-
+                if (Sortable) args.Add(FieldOptions.SORTABLE);
             }
 
             private void AddWeight(List<object> args)
@@ -165,10 +164,10 @@ internal override void AddFieldTypeArgs(List<object> args)
                     args.Add(Separator);
                 }
                 if (CaseSensitive) args.Add(SearchArgs.CASESENSITIVE);
-                if (Sortable) args.Add(FieldOptions.SORTABLE);
                 if (Unf) args.Add(SearchArgs.UNF);
                 if (MissingIndex) args.Add(FieldOptions.INDEXMISSING);
                 if (EmptyIndex) args.Add(FieldOptions.INDEXEMPTY);
+                if (Sortable) args.Add(FieldOptions.SORTABLE);
             }
         }
 
@@ -192,10 +191,9 @@ internal GeoField(string name, bool sortable = false, bool noIndex = false, bool
             internal override void AddFieldTypeArgs(List<object> args)
             {
                 if (NoIndex) args.Add(SearchArgs.NOINDEX);
-                if (Sortable) args.Add(FieldOptions.SORTABLE);
                 if (MissingIndex) args.Add(FieldOptions.INDEXMISSING);
+                if (Sortable) args.Add(FieldOptions.SORTABLE);
             }
-
         }
 
         public class GeoShapeField : Field
@@ -252,10 +250,9 @@ internal NumericField(string name, bool sortable = false, bool noIndex = false,
             internal override void AddFieldTypeArgs(List<object> args)
             {
                 if (NoIndex) args.Add(SearchArgs.NOINDEX);
-                if (Sortable) args.Add(FieldOptions.SORTABLE);
                 if (MissingIndex) args.Add(FieldOptions.INDEXMISSING);
+                if (Sortable) args.Add(FieldOptions.SORTABLE);
             }
-
         }
 
         public class VectorField : Field
@@ -322,6 +319,10 @@ public Schema AddField(Field field)
         /// <param name="unf">Set this to true to prevent the indexer from sorting on the normalized form.
         /// Normalied form is the field sent to lower case with all diaretics removed</param>
         /// <param name="withSuffixTrie">Keeps a suffix trie with all terms which match the suffix.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
+        /// <param name="emptyIndex">  allows you to index and search for empty strings. By default, empty strings are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddTextField(string name, double weight = 1.0, bool sortable = false, bool unf = false, bool noStem = false,
                                    string? phonetic = null, bool noIndex = false, bool withSuffixTrie = false, bool missingIndex = false, bool emptyIndex = false)
@@ -342,6 +343,10 @@ public Schema AddTextField(string name, double weight = 1.0, bool sortable = fal
         /// <param name="unf">Set this to true to prevent the indexer from sorting on the normalized form.
         /// Normalied form is the field sent to lower case with all diaretics removed</param>
         /// <param name="withSuffixTrie">Keeps a suffix trie with all terms which match the suffix.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
+        /// <param name="emptyIndex">  allows you to index and search for empty strings. By default, empty strings are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddTextField(FieldName name, double weight = 1.0, bool sortable = false, bool unf = false, bool noStem = false,
                                    string? phonetic = null, bool noIndex = false, bool withSuffixTrie = false, bool missingIndex = false, bool emptyIndex = false)
@@ -355,6 +360,9 @@ public Schema AddTextField(FieldName name, double weight = 1.0, bool sortable =
         /// </summary>
         /// <param name="name">The field's name.</param>
         /// <param name="system">The coordinate system to use.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddGeoShapeField(string name, CoordinateSystem system, bool missingIndex = false)
         {
@@ -367,6 +375,9 @@ public Schema AddGeoShapeField(string name, CoordinateSystem system, bool missin
         /// </summary>
         /// <param name="name">The field's name.</param>
         /// <param name="system">The coordinate system to use.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddGeoShapeField(FieldName name, CoordinateSystem system, bool missingIndex = false)
         {
@@ -380,6 +391,9 @@ public Schema AddGeoShapeField(FieldName name, CoordinateSystem system, bool mis
         /// <param name="name">The field's name.</param>
         /// <param name="sortable">If true, the text field can be sorted.</param>
         /// <param name="noIndex">Attributes can have the NOINDEX option, which means they will not be indexed.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddGeoField(FieldName name, bool sortable = false, bool noIndex = false, bool missingIndex = false)
         {
@@ -393,6 +407,9 @@ public Schema AddGeoField(FieldName name, bool sortable = false, bool noIndex =
         /// <param name="name">The field's name.</param>
         /// <param name="sortable">If true, the text field can be sorted.</param>
         /// <param name="noIndex">Attributes can have the NOINDEX option, which means they will not be indexed.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddGeoField(string name, bool sortable = false, bool noIndex = false, bool missingIndex = false)
         {
@@ -406,6 +423,9 @@ public Schema AddGeoField(string name, bool sortable = false, bool noIndex = fal
         /// <param name="name">The field's name.</param>
         /// <param name="sortable">If true, the text field can be sorted.</param>
         /// <param name="noIndex">Attributes can have the NOINDEX option, which means they will not be indexed.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddNumericField(FieldName name, bool sortable = false, bool noIndex = false, bool missingIndex = false)
         {
@@ -419,6 +439,9 @@ public Schema AddNumericField(FieldName name, bool sortable = false, bool noInde
         /// <param name="name">The field's name.</param>
         /// <param name="sortable">If true, the text field can be sorted.</param>
         /// <param name="noIndex">Attributes can have the NOINDEX option, which means they will not be indexed.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddNumericField(string name, bool sortable = false, bool noIndex = false, bool missingIndex = false)
         {
@@ -437,6 +460,10 @@ public Schema AddNumericField(string name, bool sortable = false, bool noIndex =
         /// <param name="caseSensitive">If true, Keeps the original letter cases of the tags.</param>
         /// Normalied form is the field sent to lower case with all diaretics removed</param>
         /// <param name="withSuffixTrie">Keeps a suffix trie with all terms which match the suffix.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
+        /// <param name="emptyIndex">  allows you to index and search for empty strings. By default, empty strings are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddTagField(FieldName name, bool sortable = false, bool unf = false,
                               bool noIndex = false, string separator = ",",
@@ -457,6 +484,10 @@ public Schema AddTagField(FieldName name, bool sortable = false, bool unf = fals
         /// <param name="caseSensitive">If true, Keeps the original letter cases of the tags.</param>
         /// Normalied form is the field sent to lower case with all diaretics removed</param>
         /// <param name="withSuffixTrie">Keeps a suffix trie with all terms which match the suffix.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
+        /// <param name="emptyIndex">  allows you to index and search for empty strings. By default, empty strings are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddTagField(string name, bool sortable = false, bool unf = false,
                               bool noIndex = false, string separator = ",",
@@ -471,7 +502,10 @@ public Schema AddTagField(string name, bool sortable = false, bool unf = false,
         /// </summary>
         /// <param name="name">The field's name.</param>
         /// <param name="algorithm">The vector similarity algorithm to use.</param>
-        /// <param name="attribute">The algorithm attributes for the creation of the vector index.</param>
+        /// <param name="attributes">The algorithm attributes for the creation of the vector index.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddVectorField(FieldName name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null, bool missingIndex = false)
         {
@@ -484,7 +518,10 @@ public Schema AddVectorField(FieldName name, VectorAlgo algorithm, Dictionary<st
         /// </summary>
         /// <param name="name">The field's name.</param>
         /// <param name="algorithm">The vector similarity algorithm to use.</param>
-        /// <param name="attribute">The algorithm attributes for the creation of the vector index.</param>
+        /// <param name="attributes">The algorithm attributes for the creation of the vector index.</param>
+        /// <param name="missingIndex"> search for missing values, that is, documents that do not contain a specific field. 
+        /// Note the difference between a field with an empty value and a document with a missing value. 
+        /// By default, missing values are not indexed.</param>
         /// <returns>The <see cref="Schema"/> object.</returns>
         public Schema AddVectorField(string name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null, bool missingIndex = false)
         {

tests/Doc/HomeJsonExample.cs

@@ -86,8 +86,6 @@ public void run()
             schema
         );
         // STEP_END
-
-        // Tests for 'make_index' step.
         // REMOVE_START
         Assert.True(indexCreated);
         // REMOVE_END
@@ -98,8 +96,6 @@ public void run()
         bool user2Set = db.JSON().Set("user:2", "$", user2);
         bool user3Set = db.JSON().Set("user:3", "$", user3);
         // STEP_END
-
-        // Tests for 'add_data' step.
         // REMOVE_START
         Assert.True(user1Set);
         Assert.True(user2Set);
@@ -118,8 +114,6 @@ public void run()
         ));
         // >>> {"name":"Paul Zamir","email":"[email protected]", ...
         // STEP_END
-
-        // Tests for 'query1' step.
         // REMOVE_START
         Assert.Equal(
             "{\"name\":\"Paul Zamir\",\"email\":\"[email protected]\",\"age\":35,\"city\":\"Tel Aviv\"}",
@@ -140,8 +134,6 @@ public void run()
         ));
         // >>> London, Tel Aviv
         // STEP_END
-
-        // Tests for 'query2' step.
         // REMOVE_START
         Assert.Equal(
             "London, Tel Aviv",
@@ -166,8 +158,6 @@ public void run()
         // >>> London - 1
         // >>> Tel Aviv - 2
         // STEP_END
-
-        // Tests for 'query3' step.
         // REMOVE_START
         Assert.Equal(2, resultsList.Count);
 
@@ -181,7 +171,70 @@ public void run()
         Assert.Equal(2, testItem["count"]);
         // REMOVE_END
 
+        // STEP_START make_hash_index
+        var hashSchema = new Schema()
+            .AddTextField("name")
+            .AddTagField("city")
+            .AddNumericField("age");
+
+        bool hashIndexCreated = db.FT().Create(
+            "hash-idx:users",
+            new FTCreateParams()
+                .On(IndexDataType.HASH)
+                .Prefix("huser:"),
+            hashSchema
+        );
+        // STEP_END
+        // REMOVE_START
+        Assert.True(hashIndexCreated);
+        // REMOVE_END
 
+        // STEP_START add_hash_data
+        db.HashSet("huser:1", new HashEntry[] {
+            new("name", "Paul John"),
+            new("email", "[email protected]"),
+            new("age", 42),
+            new("city", "London")
+        });
+
+        db.HashSet("huser:2", new HashEntry[] {
+            new("name", "Eden Zamir"),
+            new("email", "[email protected]"),
+            new("age", 29),
+            new("city", "Tel Aviv")
+        });
+
+        db.HashSet("huser:3", new HashEntry[] {
+            new("name", "Paul Zamir"),
+            new("email", "[email protected]"),
+            new("age", 35),
+            new("city", "Tel Aviv")
+        });
+        // STEP_END
+
+        // STEP_START query1_hash
+        SearchResult findPaulHashResult = db.FT().Search(
+            "hash-idx:users",
+            new Query("Paul @age:[30 40]")
+        );
+
+        foreach (Document doc in findPaulHashResult.Documents)
+        {
+            Console.WriteLine(
+                $"Name: {doc["name"]}, email: {doc["email"]}, " +
+                $"age: {doc["age"]}, city:{doc["city"]}"
+            );
+        }
+        // >>> Name: Paul Zamir, email: [email protected], age: 35, ...
+        // STEP_END
+        // REMOVE_START
+        Document d = findPaulHashResult.Documents[0];
+        Assert.Equal(
+            "Name: Paul Zamir, email: [email protected], age: 35, city:Tel Aviv",
+            $"Name: {d["name"]}, email: {d["email"]}, " +
+                $"age: {d["age"]}, city:{d["city"]}"
+        );
+        // REMOVE_END
         // HIDE_START
     }
 }