Merge branch 'main' into DOC-4928

Author: rrelledge

.github/workflows/redisvl_docs_sync.yaml

@@ -34,7 +34,7 @@ jobs:
 
           # Get latest release
           latest_release=$(gh release -R redis/redis-vl-python list --json name,isLatest --jq '.[] | select(.isLatest)|.name')
-          git checkout "tags/${latest_release}"
+          git checkout "tags/${latest_release}" || git checkout "tags/v${latest_release}"
           pip3 install -e .
 
           popd

README.md

@@ -102,7 +102,7 @@ The `filename` property value can be any file name path which is relative to the
 We added a new property `class` which allows you to override the CSS class of the image. Images have by default a `block` display in Tailwind. You can change this by setting the class property to `inline`. The following example shows two images that are in a single line:
 
 ```
-{{< image filename="/images/rc/icon-database-update-status-pending.png#no-click" alt="Pending database status" class="inline" >}} &nbsp; {{< image filename="/images/rc/icon-database-update-status-active.png#no-click" alt="Active database status" class="inline" >}}
+{{< image filename="/images/rc/icon-database-update-status-pending.png#no-click" alt="Pending database status" class="inline" >}} &nbsp; {{< image filename="/images/rc/icon-database-status-active.png#no-click" alt="Active database status" class="inline" >}}
 ```
 
 ### Templating

build/image_report.py

@@ -7,17 +7,19 @@
 import os
 
 
-def scan_file(path: str) -> int:
+def scan_file(path: str, verbose: bool = True) -> list:
     """Scans a file for all `image` shortcodes.
 
     Args:
         path (str): Path to file.
+        verbose (bool, optional): If True, prints the shortcodes found. Defaults to True.
 
     Returns:
-        (int) Number of shortcodes found.
+        (list) A list of all image shortcodes found.
     """
 
     img_list = []
+    img_names = []
 
     with open(path, encoding="utf_8") as md_file:
         text = md_file.read()
@@ -26,16 +28,18 @@ def scan_file(path: str) -> int:
             text, lambda t: t.tag == "image"
         ):
             img_list.append((img, pos_info))
+            img_names.append(img.named_params["filename"])
 
-    if len(img_list) > 0:
+    if len(img_list) > 0 and verbose:
         print(f"File '{path}':")
 
         for img in img_list:
             print(
                 f"    Line {img[1].line}: '{img[0].named_params['filename']}'"
             )
 
-    return len(img_list)
+    # return len(img_list)
+    return img_names
 
 
 parser = argparse.ArgumentParser(
@@ -44,20 +48,50 @@ def scan_file(path: str) -> int:
 )
 
 parser.add_argument("pathname", help="Path of the folder to scan")
+parser.add_argument("--find-unused", nargs=1, help="Prints out all images in IMAGEFOLDER that are not found in pathname. Set pathname to the top content folder to scan all content for images.", metavar="IMAGEFOLDER")
 
 args = parser.parse_args()
 
 print(f"Scanning '{args.pathname}'")
 
 num_found = 0
+all_images_found = []
 
 for root, dirs, files in os.walk(args.pathname):
     for file in files:
         if file.endswith(".md"):
             fullpath = os.path.join(root, file)
-            num_found += scan_file(fullpath)
+            images_found = scan_file(fullpath, verbose=args.find_unused is None)
+            num_found += len(images_found)
+            all_images_found.extend(images_found)
 
 if num_found == 0:
     print(f"No image shortcodes found in '{args.pathname}'")
 else:
     print(f"Found {num_found} image shortcodes.")
+
+if args.find_unused and num_found > 0:
+    unique_images = list(set(all_images_found))
+    print(f"Found {len(unique_images)} unique images in '{args.pathname}'.")
+    print(f"Checking for images not found in '{args.pathname}' that are in '{args.find_unused[0]}'")
+
+    unused_images = []
+    total_images = 0
+
+    for root, dirs, files in os.walk(args.find_unused[0]):
+        for file in files:
+            if (file.endswith(".png") or file.endswith(".jpg") or file.endswith(".webp")):
+                total_images += 1
+                if not any(file in img for img in unique_images):
+                    img_filepath = os.path.join(root, file)
+                    print(f"    Image '{img_filepath}' not found in '{args.pathname}'")
+                    unused_images.append(img_filepath)
+
+    print(f"Found {len(unused_images)} unused images out of {total_images} images in '{args.find_unused[0]}.'")
+
+    if len(unused_images) > 0:
+        print("Do you want to remove these images? (y/n) (DO NOT DO ON MAIN BRANCH!)")
+        if input().lower() == "y":
+            for img in unused_images:
+                os.remove(img)
+                print(f"Removed '{img}'")

config.toml

@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
 rdi_debezium_server_version = "2.3.0.Final"
 rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
-rdi_current_version = "v1.6.6"
+rdi_current_version = "v1.6.7"
 
 [params.clientsConfig]
 "Python"={quickstartSlug="redis-py"}

content/commands/client-list/index.md

@@ -117,6 +117,9 @@ Here is the meaning of the fields:
 * `rbp`: peak size of the client's read buffer since the client connected. Added in Redis 7.0
 * `rbs`: current size of the client's read buffer in bytes. Added in Redis 7.0
 * `io-thread`: id of I/O thread assigned to the client. Added in Redis 8.0
+* `tot-net-in`: total network input bytes read from this client.
+* `tot-net-out`: total network output bytes sent to this client.
+* `tot-cmds`: total count of commands this client executed.
 
 The client flags can be a combination of:
 

content/commands/json.debug-memory/index.md

@@ -35,6 +35,10 @@ title: JSON.DEBUG MEMORY
 ---
 Report a value's memory usage in bytes 
 
+{{< warning >}}
+The actual total memory consumption by a key could be much lower than the value reported by this command because of an internal JSON string reuse mechanism. For more information, see the [JSON memory usage page]({{< relref "/develop/data-types/json/ram#json-string-reuse-mechanism" >}}).
+{{< /warning >}}
+
 [Examples](#examples)
 
 ## Required arguments

content/commands/spublish/index.md

@@ -52,14 +52,14 @@ title: SPUBLISH
 Posts a message to the given shard channel.
 
 In Redis Cluster, shard channels are assigned to slots by the same algorithm used to assign keys to slots.
-A shard message must be sent to a node that own the slot the shard channel is hashed to. 
-The cluster makes sure that published shard messages are forwarded to all the node in the shard, so clients can subscribe to a shard channel by connecting to any one of the nodes in the shard.
+A shard message must be sent to a node that owns the slot the shard channel is hashed to. 
+The cluster makes sure that published shard messages are forwarded to all the nodes in the shard, so clients can subscribe to a shard channel by connecting to any one of the nodes in the shard.
 
 For more information about sharded pubsub, see [Sharded Pubsub]({{< relref "/develop/interact/pubsub#sharded-pubsub" >}}).
 
 ## Examples
 
-For example the following command publish to channel `orders` with a subscriber already waiting for message(s).
+For example the following command publishes to the `orders` channel with a subscriber already waiting for message(s).
 
 ```
 > spublish orders hello

content/develop/clients/dotnet/transpipe.md

@@ -37,26 +37,8 @@ versions of the standard command methods
 buffered in the pipeline and only execute when you call the `Execute()`
 method on the pipeline object.
 
-<!-- < clients-example pipe_trans_tutorial basic_pipe "C#" >}}
-< /clients-example >}} -->
-
-```csharp
-var pipeline = new Pipeline(db);
-        
-for (int i = 0; i < 5; i++) {
-    pipeline.Db.StringSetAsync($"seat:{i}", $"#{i}");
-}
-pipeline.Execute();
-
-var resp1 = db.StringGet("seat:0");
-Console.WriteLine(resp1); // >>> #0
-
-var resp2 = db.StringGet("seat:3");
-Console.WriteLine(resp2); // >>> #3
-
-var resp3 = db.StringGet("seat:4");
-Console.WriteLine(resp2); // >>> #4
-```
+{{< clients-example pipe_trans_tutorial basic_pipe "C#" >}}
+{{< /clients-example >}}
 
 ## Execute a transaction
 
@@ -65,27 +47,8 @@ instance of the `Transaction` class, call async command methods
 on that object, and then call the transaction object's 
 `Execute()` method to execute it.
 
-<!-- < clients-example pipe_trans_tutorial basic_trans "C#" >}}
-< /clients-example >}}-->
-
-```csharp
-var trans = new Transaction(db);
-
-trans.Db.StringIncrementAsync("counter:1", 1);
-trans.Db.StringIncrementAsync("counter:2", 2);
-trans.Db.StringIncrementAsync("counter:3", 3);
-
-trans.Execute();
-
-var resp4 = db.StringGet("counter:1");
-Console.WriteLine(resp4); // >>> 1
-
-var resp5 = db.StringGet("counter:2");
-Console.WriteLine(resp5); // >>> 2
-
-var resp6 = db.StringGet("counter:3");
-Console.WriteLine(resp6);  // >>> 3
-```
+{{< clients-example pipe_trans_tutorial basic_trans "C#" >}}
+{{< /clients-example >}}
 
 ## Watch keys for changes
 
@@ -114,25 +77,8 @@ For example, the `KeyNotExists` condition aborts the transaction
 if a specified key exists or is added by another client while the
 transaction executes:
 
-<!-- < clients-example pipe_trans_tutorial trans_watch "C#" >}}
-< /clients-example >}} -->
-
-```csharp
-var watchedTrans = new Transaction(db);
-
-watchedTrans.AddCondition(Condition.KeyNotExists("customer:39182"));
-
-watchedTrans.Db.HashSetAsync(
-    "customer:39182",
-    new HashEntry[]{
-        new HashEntry("name", "David"),
-        new HashEntry("age", "27")
-    }
-);
-
-bool succeeded = watchedTrans.Execute();
-Console.WriteLine(succeeded); // >>> true
-```
+{{< clients-example pipe_trans_tutorial trans_watch "C#" >}}
+{{< /clients-example >}}
 
 You can also use a `When` condition on certain individual commands to
 specify that they only execute when a certain condition holds

content/develop/data-types/json/ram.md

@@ -123,3 +123,12 @@ JSON. The _MessagePack_ column is for reference purposes and reflects the length
 
 > Note: In the current version, deleting values from containers **does not** free the container's
 allocated memory.
+
+## JSON string reuse mechanism
+
+Redis uses a global string reuse mechanism to reduce memory usage. When a string value appears multiple times, either within the same JSON document
+or across different documents on the same node, Redis stores only a single copy of that string and uses references to it.
+This approach is especially efficient when many documents share similar structures.
+
+However, the `JSON.DEBUG MEMORY` command reports memory usage as if each string instance is stored independently, even when it's actually reused.
+For example, the document `{"foo": ["foo", "foo"]}` reuses the string `"foo"` internally, but the reported memory usage counts the string three times: once for the key and once for each array element.

content/develop/interact/search-and-query/_index.md

@@ -53,8 +53,8 @@ for full installation instructions.
 
 ## License and source code
 
-The Redis Query Engine features of Redis are available under the Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1). Please read the [license file](https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE.txt) for further details. The source code and the [detailed release notes](https://github.com/RediSearch/RediSearch/releases) are available on [GitHub](https://github.com/RediSearch/RediSearch).
+The Redis Query Engine features of Redis are available under the Source Available License 2.0 (RSALv2), the Server Side Public License v1 (SSPLv1), or the GNU Affero General Public License version 3 (AGPLv3). Please read the [license file](https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE.txt) for further details. The source code and the [detailed release notes](https://github.com/RediSearch/RediSearch/releases) are available on [GitHub](https://github.com/RediSearch/RediSearch).
 
 Do you have questions? Feel free to ask at the [RediSearch forum](https://forum.redis.com/c/modules/redisearch/).
 
-<br/>
+<br/>