Merge pull request #1 from liorsve/main

Update client json files and put client page in topics
valkey-io · Nov 25, 2024 · 26cbac9 · 26cbac9
2 parents 1e4bb60 + c1fb1a6
commit 26cbac9
Show file tree

Hide file tree

Showing 13 changed files with 137 additions and 88 deletions.
diff --git a/clients/go/github.com/valkey/valkey-go.json b/clients/go/github.com/valkey/valkey-go.json
@@ -0,0 +1,15 @@
+{
+    "name": "valkey-go",
+    "description": "A fast Golang Valkey client that does auto pipelining and supports server-assisted client-side caching.",
+    "language":"Go",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": true,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": true,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": true
+}
diff --git a/clients/java/github.com/AWS/valkey-GLIDE.json b/clients/java/github.com/AWS/valkey-GLIDE.json
@@ -0,0 +1,15 @@
+{
+    "name": "Valkey GLIDE",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Redis is an advanced multi-language Redis client that is feature rich, highly performant, and built for reliability and operational stability. GLIDE for Redis is supported by AWS.",
+    "language":"Java",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": true,
+    "cluster_scan": true,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": false
+}
diff --git a/clients/java/github.com/valkey/valkey-java.json b/clients/java/github.com/valkey/valkey-java.json
@@ -0,0 +1,15 @@
+{
+    "name": "valkey-java",
+    "description": "valkey-java is Valkey's Java client, derived from Jedis fork, dedicated to maintaining simplicity and high performance.",
+    "language":"Java",
+    "read_from_replica": false,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": false,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": true
+}
diff --git a/clients/nodejs/github.com/AWS/GLIDE-for-Redis.json b/clients/nodejs/github.com/AWS/GLIDE-for-Redis.json
diff --git a/clients/nodejs/github.com/AWS/valkey-GLIDE.json b/clients/nodejs/github.com/AWS/valkey-GLIDE.json
@@ -0,0 +1,15 @@
+{
+    "name": "Valkey GLIDE",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Redis is an advanced multi-language Redis client that is feature rich, highly performant, and built for reliability and operational stability. GLIDE for Redis is supported by AWS.",
+    "language":"Node.js",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": true,
+    "cluster_scan": true,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": false
+}
diff --git a/clients/nodejs/github.com/valkey/iovalkey.json b/clients/nodejs/github.com/valkey/iovalkey.json
@@ -0,0 +1,15 @@
+{
+    "name": "iovalkey",
+    "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
+    "language":"Node.js",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": false,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": true
+}
diff --git a/clients/php/github.com/nrk/predis.json b/clients/php/github.com/nrk/predis.json
@@ -1,8 +1,19 @@
 {
     "name": "Predis",
-    "description": "Mature and supported",
+    "description": "A flexible and feature-complete Redis client for PHP.",
     "recommended": true,
     "twitter": [
         "JoL1hAHN"
-    ]
+    ], 
+    "language":"PHP",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": false,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": true,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": false
 }
diff --git a/clients/php/github.com/phpredis/phpredis.json b/clients/php/github.com/phpredis/phpredis.json
@@ -1,10 +1,21 @@
 {
     "name": "phpredis",
-    "description": "This is a client written in C as a PHP module.",
+    "description": " A PHP extension for Redis, offering high performance and a native API.",
     "recommended": true,
     "twitter": [
         "grumi78",
         "yowgi",
         "yatsukhnenko"
-    ]
+    ],
+    "language":"PHP",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": false,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": true,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": true
 }
diff --git a/clients/python/github.com/AWS/GLIDE-for-Redis.json b/clients/python/github.com/AWS/GLIDE-for-Redis.json
diff --git a/clients/python/github.com/AWS/valkey-GLIDE.json b/clients/python/github.com/AWS/valkey-GLIDE.json
@@ -0,0 +1,15 @@
+{
+    "name": "Valkey GLIDE",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Redis is an advanced multi-language Redis client that is feature rich, highly performant, and built for reliability and operational stability. GLIDE for Redis is supported by AWS.",
+    "language":"Python",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": true,
+    "cluster_scan": true,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": false
+}
diff --git a/clients/python/github.com/valkey/valkey-py.json b/clients/python/github.com/valkey/valkey-py.json
@@ -0,0 +1,15 @@
+{
+    "name": "valkey-py",
+    "description": "The Python interface to the Valkey key-value store.",
+    "language":"Python",
+    "read_from_replica": true,
+    "smart_backoff_to_prevent_connection_storm": true,
+    "valkey_version_compatibility": 7.2, 
+    "pubsub_state_restoration": false,
+    "cluster_scan": false,
+    "latency_based_read_from_replica": false,
+    "AZ_based_read_from_replica": false,
+    "client_side_caching": false,
+    "client_capa_redirect": false,
+    "persistent_connection_pool": true
+}
diff --git a/topics/index.md b/topics/index.md
@@ -24,6 +24,7 @@ Programming with Valkey
 * [Client side caching](client-side-caching.md): How a client can be notified by the server when a key has changed.
 * [Keyspace notifications](notifications.md): Get notifications of keyspace events via Pub/Sub.
 * [Protocol specification](protocol.md): The client-server protocol, for client authors.
+* [Valkey clients](valkey-clients.md): An overview of recommended Valkey clients and their features.
 
 Server-side scripting in Valkey
 ---

diff --git a/clients/ValkeyClients.md → topics/valkey-clients.md b/clients/ValkeyClients.md → topics/valkey-clients.md
@@ -1,6 +1,9 @@
 ---
-Valkey Clients
-======
+title: "Valkey Clients"
+linkTitle: "Valkey Clients"
+description: Overview of Valkey clients and features
+---
+
 Selecting the right client is a complex task, given that there are over 200 clients compatible with Valkey across different programming languages. This document offers an overview of recommended Valkey clients for various programming languages. To be included in this list, a client must support a mandatory set of features, such as TLS support and cluster mode. Additionally, for each language, we have provided a list of advanced features supported by the respective clients, highlighting the unique advantages of one client over another.
 
 Mandatory Features Overview
@@ -54,20 +57,6 @@ Python
   - Installation: `pip install valkey`
   - Description: The Python interface to the Valkey key-value store.
 
-**Feature Comparison Table:**
-
-| Feature                                      | valkey-glide | valkey-py |
-|----------------------------------------------|:------------:|:---------:|
-| **Read from replica**                        |     Yes      |    Yes    |
-| **Smart Backoff to Prevent Connection Storm**|     Yes      |    Yes    |
-| **Valkey version compatibility**             |     7.2      |   7.2     |
-| **PubSub state restoration**                 |     Yes      |    No     |
-| **Cluster Scan**                             |     Yes      |    No     |
-| **Latency-Based Read from Replica**          |     No       |    No     |
-| **AZ-Based Read from Replica**               |     No       |    No     |
-| **Client Side Caching**                      |     No       |    No     |
-| **`CLIENT CAPA redirect`**                   |     No       |    No     |
-| **Persistent Connection Pool**               |     No       |    Yes    |
 
 JavaScript/Node.js
 ----
@@ -81,21 +70,6 @@ JavaScript/Node.js
   - Installation: `npm install iovalkey`
   - Description: A robust, performance-focused and full-featured Redis client for Node.js. This is a friendly fork of ioredis after this commit.
 
-**Feature Comparison Table:**
-
-| Feature                                      | valkey-glide | iovalkey  |
-|----------------------------------------------|:------------:|:---------:|
-| **Read from replica**                        |     Yes      |    Yes    |
-| **Smart Backoff to Prevent Connection Storm**|     Yes      |    Yes    |
-| **Valkey version compatibility**             |     7.2      |    7.2    |
-| **PubSub state restoration**                 |     Yes      |    No     |
-| **Cluster Scan**                             |     Yes      |    No     |
-| **Latency-Based Read from Replica**          |     No       |    No     |
-| **AZ-Based Read from Replica**               |     No       |    No     |
-| **Client Side Caching**                      |     No       |    No     |
-| **`CLIENT CAPA redirect`**                   |     No       |    No     |
-| **Persistent Connection Pool**               |     No       |    Yes    |
-
 Java
 ----
 
@@ -109,21 +83,6 @@ Java
   - Installation: Available via Maven and Gradle
   - Description: valkey-java is Valkey's Java client, derived from Jedis fork, dedicated to maintaining simplicity and high performance.
 
-**Feature Comparison Table:**
-
-| Feature                                      | valkey-glide | valkey-java |
-|----------------------------------------------|:------------:|:-----------:|
-| **Read from replica**                        |     Yes      |     No      |
-| **Smart Backoff to Prevent Connection Storm**|     Yes      |     Yes     |
-| **Valkey version compatibility**             |     7.2      |     7.2     |
-| **PubSub state restoration**                 |     Yes      |     No      |
-| **Cluster Scan**                             |     Yes      |     No      |
-| **Latency-Based Read from Replica**          |     No       |     No      |
-| **AZ-Based Read from Replica**               |     No       |     No      |
-| **Client Side Caching**                      |     No       |     No      |
-| **`CLIENT CAPA redirect`**                   |     No       |     No      |
-| **Persistent Connection Pool**               |     No       |     Yes     |
-
 
 Go
 -----
@@ -132,20 +91,6 @@ Go
   - Installation: TBD
   - Description: A fast Golang Valkey client that does auto pipelining and supports server-assisted client-side caching.
 
-**Feature Comparison Table:**
-
-| Feature                                      | valkey-go  |
-|----------------------------------------------|:----------:|
-| **Read from replica**                        |     Yes    |
-| **Smart Backoff to Prevent Connection Storm**|     Yes    |
-| **Valkey version compatibility**             |     7.2    |
-| **PubSub state restoration**                 |     Yes    |
-| **Cluster Scan**                             |     No     |
-| **Latency-Based Read from Replica**          |     No     |
-| **AZ-Based Read from Replica**               |     No     |
-| **Client Side Caching**                      |     Yes    |
-| **`CLIENT CAPA redirect`**                   |     No     |
-| **Persistent Connection Pool**               |     Yes    |
 
 PHP
 ----
@@ -158,19 +103,3 @@ PHP
   - GitHub: [phpredis](https://github.com/phpredis/phpredis)
   - Installation: Install via PECL or compile from source
   - Description: A PHP extension for Redis, offering high performance and a native API.
-
-**Feature Comparison Table:**
-
-| Feature                                      | Predis  | phpredis |
-|----------------------------------------------|:-------:|:--------:|
-| **Read from replica**                        |   Yes   |    Yes   |
-| **Smart Backoff to Prevent Connection Storm**|   No    |    Yes   |
-| **Valkey version compatibility**             |   7.2   |    7.2   |
-| **PubSub state restoration**                 |   No    |    No    |
-| **Cluster Scan**                             |   No    |    No    |
-| **Latency-Based Read from Replica**          |   No    |    No    |
-| **AZ-Based Read from Replica**               |   No    |    No    |
-| **Client Side Caching**                      |   No    |    No    |
-| **`CLIENT CAPA redirect`**                   |   No    |    No    |
-| **Persistent Connection Pool**               |   No    |    Yes   |
-