Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dahomey-technologies/rustis
An asynchronous Redis client for Rust
https://github.com/dahomey-technologies/rustis
async database redis redis-client redis-cluster redis-database redis-sentinel redis-stack rust rust-crate rust-lang rust-library
Last synced: 7 days ago
JSON representation
An asynchronous Redis client for Rust
- Host: GitHub
- URL: https://github.com/dahomey-technologies/rustis
- Owner: dahomey-technologies
- License: mit
- Created: 2022-08-28T23:27:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T21:29:50.000Z (6 months ago)
- Last Synced: 2024-09-10T11:09:39.939Z (4 months ago)
- Topics: async, database, redis, redis-client, redis-cluster, redis-database, redis-sentinel, redis-stack, rust, rust-crate, rust-lang, rust-library
- Language: Rust
- Homepage: https://docs.rs/rustis
- Size: 1.33 MB
- Stars: 88
- Watchers: 4
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An asynchronous Redis client for Rust.
[](https://crates.io/crates/rustis)
[](https://docs.rs/rustis)
[](https://github.com/dahomey-technologies/rustis/actions/workflows/compile_and_test.yml)
[](LICENSE)
# Documentation
[Official Documentation](https://docs.rs/rustis/latest/rustis/)
# Philosophy
* Low allocations
* Full async library
* Lock free implementation
* Rust idiomatic API
* Multiplexing as a core feature
# Features
* Full documentation with multiple examples
* Support all [Redis Commands](https://redis.io/commands/) until Redis 7.0
* Async support ([tokio](https://tokio.rs/) or [async-std](https://async.rs/))
* Different client modes:
* Single client
* [Multiplexed](https://redis.com/blog/multiplexing-explained/) client
* Pooled client manager (based on [bb8](https://docs.rs/bb8/latest/bb8/))
* Automatic command batching
* Advanced reconnection & retry strategy
* [Pipelining](https://redis.io/docs/manual/pipelining/) support
* Configuration with Redis URL or dedicated builder
* [TLS](https://redis.io/docs/manual/security/encryption/) support
* [Transaction](https://redis.io/docs/manual/transactions/) support
* [Pub/sub](https://redis.io/docs/manual/pubsub/) support
* [Sentinel](https://redis.io/docs/manual/sentinel/) support
* [LUA Scripts/Functions](https://redis.io/docs/manual/programmability/) support
* [Cluster](https://redis.io/docs/manual/scaling/) support (minimus supported Redis version is 6)
* [Redis Stack](https://redis.io/docs/stack/) support:
* [RedisJSON v2.4](https://redis.io/docs/stack/json/) support
* [RedisSearch v2.6](https://redis.io/docs/stack/search/) support
* [RedisGraph v2.10](https://redis.io/docs/stack/graph/) support
* [RedisBloom v2.4](https://redis.io/docs/stack/bloom/) support
* [RedisTimeSeries v1.8](https://redis.io/docs/stack/timeseries/) support
# Basic Usage
```rust
use rustis::{
client::Client,
commands::{FlushingMode, ServerCommands, StringCommands},
Result,
};
#[tokio::main]
async fn main() -> Result<()> {
// Connect the client to a Redis server from its IP and port
let client = Client::connect("127.0.0.1:6379").await?;
// Flush all existing data in Redis
client.flushdb(FlushingMode::Sync).await?;
// sends the command SET to Redis. This command is defined in the StringCommands trait
client.set("key", "value").await?;
// sends the command GET to Redis. This command is defined in the StringCommands trait
let value: String = client.get("key").await?;
println!("value: {value:?}");
Ok(())
}
```
# Tests
1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd`
2. run `cargo test --features pool,redis-stack,tokio-tls` (Tokio runtime)
3. run `cargo test --no-default-features --features redis-stack,async-std-runtime,async-std-tls` (async-std runtime)
4. run `cargo fmt --all -- --check`
# Benchmarks
1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd`
2. run `cargo bench`