Skip to content

Commit

Permalink
change all aws links to valkey-io (#1869)
Browse files Browse the repository at this point in the history
  • Loading branch information
shohamazon authored Jul 8, 2024
1 parent c8b759b commit 6c52e2c
Show file tree
Hide file tree
Showing 34 changed files with 297 additions and 296 deletions.
372 changes: 186 additions & 186 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion csharp/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Before starting this step, make sure you've installed all software requirments.

```bash
VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch
git clone --branch ${VERSION} https://github.com/aws/glide-for-redis.git
git clone --branch ${VERSION} https://github.com/valkey-io/valkey-glide.git
cd glide-for-redis
```

Expand Down
2 changes: 1 addition & 1 deletion csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Strategic, mission-critical Redis-based applications have requirements for secur

## Supported Engine Versions

Refer to the [Supported Engine Versions table](https://github.com/aws/glide-for-redis/blob/main/README.md#supported-engine-versions) for details.
Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details.

## Current Status

Expand Down
2 changes: 1 addition & 1 deletion csharp/tests/Integration/IntegrationTestBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public IntegrationTestBase(IMessageSink diagnosticMessageSink)
// Stop all if weren't stopped on previous test run
StopRedis(false);

// Delete dirs if stop failed due to https://github.com/aws/glide-for-redis/issues/849
// Delete dirs if stop failed due to https://github.com/valkey-io/valkey-glide/issues/849
Directory.Delete(Path.Combine(_scriptDir, "clusters"), true);

// Start cluster
Expand Down
2 changes: 1 addition & 1 deletion glide-core/src/client/value_conversion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ pub(crate) fn convert_to_expected_type(
// First part of the response (`running_script`) is converted as `Map[str, any]`
// Second part is converted as `Map[str, Map[str, int]]`
ExpectedReturnType::FunctionStatsReturnType => match value {
// TODO reuse https://github.com/Bit-Quill/glide-for-redis/pull/331 and https://github.com/aws/glide-for-redis/pull/1489
// TODO reuse https://github.com/Bit-Quill/glide-for-redis/pull/331 and https://github.com/valkey-io/valkey-glide/pull/1489
Value::Map(map) => {
if map[0].0 == Value::BulkString(b"running_script".into()) {
// already a RESP3 response - do nothing
Expand Down
2 changes: 1 addition & 1 deletion go/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Before starting this step, make sure you've installed all software requirements.
1. Clone the repository:
```bash
VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch
git clone --branch ${VERSION} https://github.com/aws/glide-for-redis.git
git clone --branch ${VERSION} https://github.com/valkey-io/valkey-glide.git
cd glide-for-redis
```
2. Initialize git submodule:
Expand Down
34 changes: 17 additions & 17 deletions java/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Before starting this step, make sure you've installed all software dependencies.
1. Clone the repository:
```bash
VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch
git clone --branch ${VERSION} https://github.com/aws/glide-for-redis.git
git clone --branch ${VERSION} https://github.com/valkey-io/valkey-glide.git
cd glide-for-redis/java
```
2. Initialize git submodule:
Expand Down Expand Up @@ -213,45 +213,45 @@ A Valkey command can either have a standalone or cluster implementation which is
- A cluster command will require a note to indicate a node will follow a specific routing.
Refer to https://valkey.io/docs/topics/cluster-spec for more details on how hash slots work for cluster commands.
When you start implementing a new command, check the [command_request.proto](https://github.com/aws/glide-for-redis/blob/main/glide-core/src/protobuf/command_request.proto) and [request_type.rs](https://github.com/aws/glide-for-redis/blob/main/glide-core/src/request_type.rs) files to see whether the command has already been implemented in another language such as Python or Node.js.
When you start implementing a new command, check the [command_request.proto](https://github.com/valkey-io/valkey-glide/blob/main/glide-core/src/protobuf/command_request.proto) and [request_type.rs](https://github.com/valkey-io/valkey-glide/blob/main/glide-core/src/request_type.rs) files to see whether the command has already been implemented in another language such as Python or Node.js.
Standalone and cluster clients both extend [BaseClient.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/main/java/glide/api/BaseClient.java) and implement methods from the interfaces listed in `java/client/src/main/java/glide/api/commands`.
Standalone and cluster clients both extend [BaseClient.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/main/java/glide/api/BaseClient.java) and implement methods from the interfaces listed in `java/client/src/main/java/glide/api/commands`.
The return types of these methods are in the form of a `CompletableFuture`, which fulfill the purpose of the asynchronous features of the program.
### Tests
When implementing a command, include both a unit test and an integration test.
Implement unit tests in the following files:
- [GlideClientTest.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/test/java/glide/api/GlideClientTest.java) for standalone commands.
- [GlideClusterClientTest.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/test/java/glide/api/GlideClusterClientTest.java) for cluster commands.
- [GlideClientTest.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/test/java/glide/api/GlideClientTest.java) for standalone commands.
- [GlideClusterClientTest.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/test/java/glide/api/GlideClusterClientTest.java) for cluster commands.
These files are found in the java/client/src/test/java/glide/api path.
Implement integration tests in the following files:
- [TransactionTests.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/test/java/glide/api/models/TransactionTests.java) (standalone and cluster).
- [TransactionTestsUtilities.java](https://github.com/aws/glide-for-redis/blob/main/java/integTest/src/test/java/glide/TransactionTestUtilities.java) (standalone and cluster).
- [SharedCommandTests.java](https://github.com/aws/glide-for-redis/blob/main/java/integTest/src/test/java/glide/SharedCommandTests.java) (standalone and cluster).
- [cluster/CommandTests.java](https://github.com/aws/glide-for-redis/blob/main/java/integTest/src/test/java/glide/cluster/CommandTests.java) (cluster).
- [standalone/CommandTests.java](https://github.com/aws/glide-for-redis/blob/main/java/integTest/src/test/java/glide/standalone/CommandTests.java) (standalone).
- [TransactionTests.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/test/java/glide/api/models/TransactionTests.java) (standalone and cluster).
- [TransactionTestsUtilities.java](https://github.com/valkey-io/valkey-glide/blob/main/java/integTest/src/test/java/glide/TransactionTestUtilities.java) (standalone and cluster).
- [SharedCommandTests.java](https://github.com/valkey-io/valkey-glide/blob/main/java/integTest/src/test/java/glide/SharedCommandTests.java) (standalone and cluster).
- [cluster/CommandTests.java](https://github.com/valkey-io/valkey-glide/blob/main/java/integTest/src/test/java/glide/cluster/CommandTests.java) (cluster).
- [standalone/CommandTests.java](https://github.com/valkey-io/valkey-glide/blob/main/java/integTest/src/test/java/glide/standalone/CommandTests.java) (standalone).
For commands that have options, create a separate file for the optional values.
[BaseTransaction.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) will add the command to the Transactions API.
Refer to [this](https://github.com/aws/glide-for-redis/tree/main/java/client/src/main/java/glide/api/commands) link to view the interface directory.
[BaseTransaction.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) will add the command to the Transactions API.
Refer to [this](https://github.com/valkey-io/valkey-glide/tree/main/java/client/src/main/java/glide/api/commands) link to view the interface directory.
Refer to https://valkey.io/docs/topics/transactions/ for more details about how Transactions work in Valkey.
### Javadocs
[BaseTransaction.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) and the methods within the command interfaces will both contain documentation on how the command operates.
[BaseTransaction.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) and the methods within the command interfaces will both contain documentation on how the command operates.
In the command interface each command's javadoc should contain:
- Detail on when Valkey started supporting the command (if it wasn't initially implemented in 6.0.0 or before).
- A link to the Valkey documentation.
- Information about the function parameters.
- Any glide-core implementation details, such as how glide-core manages default routing for the command. Reference this [link](https://github.com/aws/glide-for-redis/blob/4df0dd939b515dbf9da0a00bfca6d3ad2f27440b/java/client/src/main/java/glide/api/commands/SetBaseCommands.java#L119) for an example.
- The command's return type. In the [BaseTransaction.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) file, include "Command Response" before specifying the return type.
- Any glide-core implementation details, such as how glide-core manages default routing for the command. Reference this [link](https://github.com/valkey-io/valkey-glide/blob/4df0dd939b515dbf9da0a00bfca6d3ad2f27440b/java/client/src/main/java/glide/api/commands/SetBaseCommands.java#L119) for an example.
- The command's return type. In the [BaseTransaction.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/main/java/glide/api/models/BaseTransaction.java) file, include "Command Response" before specifying the return type.

### Previous PR's

Refer to [closed-PRs](https://github.com/aws/glide-for-redis/pulls?q=is%3Apr+is%3Aclosed+label%3Ajava) to see commands that have been previously merged.
Refer to [closed-PRs](https://github.com/valkey-io/valkey-glide/pulls?q=is%3Apr+is%3Aclosed+label%3Ajava) to see commands that have been previously merged.

### FFI naming and signatures, and features

Expand All @@ -265,7 +265,7 @@ In this project, only the function name and signature name is necessary. lib.rs

### Module Information

- The [module-info.java](https://github.com/aws/glide-for-redis/blob/main/java/client/src/main/java/module-info.java) (glide.api) contains a list of all of the directories the user can access.
- The [module-info.java](https://github.com/valkey-io/valkey-glide/blob/main/java/client/src/main/java/module-info.java) (glide.api) contains a list of all of the directories the user can access.
- Ensure to update the exports list if there are more directories the user will need to access.

### Recommended extensions for VS Code
Expand Down
2 changes: 1 addition & 1 deletion java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The Java client contains the following parts:

## Supported Engine Versions

Refer to the [Supported Engine Versions table](https://github.com/aws/glide-for-redis/blob/main/README.md#supported-engine-versions) for details.
Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details.

## Installation and Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface GenericClusterCommands {
* <p>The command will be routed to all primaries.
*
* @apiNote See <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Valkey
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command">Valkey
* GLIDE Wiki</a> for details on the restrictions and limitations of the custom command API.
* @param args Arguments for the custom command including the command name.
* @return The returning value depends on the executed command.
Expand All @@ -46,7 +46,7 @@ public interface GenericClusterCommands {
* <p>Client will route the command to the nodes defined by <code>route</code>.
*
* @apiNote See <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Valkey
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command">Valkey
* GLIDE Wiki</a> for details on the restrictions and limitations of the custom command API.
* @param args Arguments for the custom command including the command name
* @param route Specifies the routing configuration for the command. The client will route the
Expand Down Expand Up @@ -194,7 +194,7 @@ public interface GenericClusterCommands {
* <p>This command is similar to the <code>SCAN</code> command, but it is designed to work in a
* Cluster environment. The main difference is that this command uses a {@link ClusterScanCursor}
* object to manage iterations. For more information about the Cluster Scan implementation, see <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#cluster-scan">Cluster
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan">Cluster
* Scan</a>.
*
* <p>As with the <code>SCAN</code> command, this command is a cursor-based iterator. This means
Expand Down Expand Up @@ -253,7 +253,7 @@ public interface GenericClusterCommands {
* <p>This command is similar to the <code>SCAN</code> command, but it is designed to work in a
* Cluster environment. The main difference is that this command uses a {@link ClusterScanCursor}
* object to manage iterations. For more information about the Cluster Scan implementation, see <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#cluster-scan">Cluster
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan">Cluster
* Scan</a>.
*
* <p>As with the <code>SCAN</code> command, this command is a cursor-based iterator. This means
Expand Down Expand Up @@ -311,7 +311,7 @@ public interface GenericClusterCommands {
* <p>This command is similar to the <code>SCAN</code> command, but it is designed to work in a
* Cluster environment. The main difference is that this command uses a {@link ClusterScanCursor}
* object to manage iterations. For more information about the Cluster Scan implementation, see <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#cluster-scan">Cluster
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan">Cluster
* Scan</a>.
*
* <p>As with the <code>SCAN</code> command, this command is a cursor-based iterator. This means
Expand Down Expand Up @@ -372,7 +372,7 @@ public interface GenericClusterCommands {
* <p>This command is similar to the <code>SCAN</code> command, but it is designed to work in a
* Cluster environment. The main difference is that this command uses a {@link ClusterScanCursor}
* object to manage iterations. For more information about the Cluster Scan implementation, see <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#cluster-scan">Cluster
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan">Cluster
* Scan</a>.
*
* <p>As with the <code>SCAN</code> command, this command is a cursor-based iterator. This means
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public interface GenericCommands {
* subcommands, should be added as a separate value in <code>args</code>.
*
* @apiNote See <a
* href="https://github.com/aws/glide-for-redis/wiki/General-Concepts#custom-command">Valkey
* href="https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command">Valkey
* GLIDE Wiki</a> for details on the restrictions and limitations of the custom command API.
* @param args Arguments for the custom command.
* @return The returning value depends on the executed command.
Expand Down
Loading

0 comments on commit 6c52e2c

Please sign in to comment.