Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/aws/glide-for-redis into v1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
barshaul committed Jul 11, 2024
2 parents 73d36d0 + 029e208 commit 8831de8
Show file tree
Hide file tree
Showing 11 changed files with 37 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/java-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*'
description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*'
required: true

concurrency:
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/npm-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*'
description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*'
required: true

concurrency:
Expand All @@ -34,9 +34,6 @@ jobs:
runs-on: ubuntu-latest
environment: AWS_ACTIONS
steps:
- run: echo $OWNER
env:
OWNER: ${{ github.repository_owner }}
- name: Checkout
uses: actions/checkout@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pypi-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*'
description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*'
required: true

concurrency:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Valkey GLIDE is API-compatible with the following engine versions:

| Engine Type | 6.2 | 7.0 | 7.2 |
|-----------------------|-------|-------|-------|
| Valkey | V | V | V |
| Valkey | - | - | V |
| Redis | V | V | V |

## Current Status
In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).
In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/5).

## Getting Started
- [Java](./java/README.md)
Expand Down
4 changes: 2 additions & 2 deletions csharp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# C# wrapper

The C# wrapper is currently not in a usable state.
The C# wrapper is currently not in a usable state and is under development.

# Valkey GLIDE

Expand All @@ -12,7 +12,7 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk

## Current Status

We've made GLIDE for Redis an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
This preview release is recommended for testing purposes only.

# Getting Started - C# Wrapper
Expand Down
23 changes: 23 additions & 0 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# GO wrapper

The GO wrapper is currently not in a usable state and is under development.

# Valkey GLIDE

Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.

## Supported Engine Versions

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

# Getting Started - GO Wrapper

## GO supported version

## Basic Example

### Building & Testing

Development instructions for local building & testing the package are in the [DEVELOPER.md](DEVELOPER.md) file.
3 changes: 3 additions & 0 deletions java/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ protobuf

# Must be ignored as part of Maven Central publishing process
gradle.properties

# Ignore VSCode JUnit extension directories
bin/
2 changes: 1 addition & 1 deletion java/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Before starting this step, make sure you've installed all software dependencies.
```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/valkey-io/valkey-glide.git
cd glide-for-redis/java
cd valkey-glide/java
```
2. Initialize git submodule:
```bash
Expand Down
2 changes: 1 addition & 1 deletion java/client/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ tasks.withType(Test) {
}

jar {
archiveBaseName = "glide-for-redis"
archiveBaseName = "valkey-glide"
// placeholder will be renamed by platform+arch on the release workflow java-cd.yml
archiveClassifier = "placeholder"
}
Expand Down
64 changes: 1 addition & 63 deletions node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,74 +15,12 @@ This preview release is recommended for testing purposes only.

## System Requirements

The beta release of Valkey GLIDE was tested on Intel x86_64 using Ubuntu 22.04.1, Amazon Linux 2023 (AL2023), and macOS 12.7.
In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).

## NodeJS supported version

Node.js 16.20 or higher.

## Installation and Setup

### Installing via Package Manager (npm)

To install GLIDE for Redis using `npm`, follow these steps:

1. Open your terminal.
2. Execute the command below:
```bash
$ npm install @aws/glide-for-redis
```
3. After installation, confirm the client is installed by running:
```bash
$ npm list
myApp@ /home/ubuntu/myApp
└── @aws/glide-for-redis@0.1.0
```

## Basic Examples

#### Cluster Redis:

```node
import { GlideClusterClient } from "@aws/glide-for-redis";
const addresses = [
{
host: "redis.example.com",
port: 6379,
},
];
const client = await GlideClusterClient.createClient({
addresses: addresses,
});
await client.set("foo", "bar");
const value = await client.get("foo");
client.close();
```
#### Standalone Redis:
```node
import { GlideClient } from "@aws/glide-for-redis";
const addresses = [
{
host: "redis_primary.example.com",
port: 6379,
},
{
host: "redis_replica.example.com",
port: 6379,
},
];
const client = await GlideClient.createClient({
addresses: addresses,
});
await client.set("foo", "bar");
const value = await client.get("foo");
client.close();
```
## Documentation

Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
Expand Down
2 changes: 1 addition & 1 deletion submodules/redis-rs

0 comments on commit 8831de8

Please sign in to comment.