Skip to content

Remove mentions of Redis driver from README #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandur merged 1 commit into from
Oct 1, 2026
+0 −24
Merged

Remove mentions of Redis driver from README #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,30 +738,6 @@ client = River::Client.new(River::Driver::Sequel.new(DB))

Neither driver installs `pg` or `sqlite3`; the application chooses its adapter.

### Redis (experimental)

Add `riverqueue-redis` to use Redis 7+ without either SQL adapter:

```ruby
require "riverqueue-redis"

pool = RedisClient.config(url: ENV.fetch("REDIS_URL")).new_pool(size: 10)
client = River::Client.new(
River::Driver::Redis.new(pool, prefix: "my_app", schema: "shared"),
config: River::Config.new(
queues: {ruby: 10},
workers: River::Workers.new.add(SortWorker)
)
).start
```

Ruby and Go's experimental `riverredisv9` driver can share the same namespace,
using identical job records, indexes, and ID allocation. Stop the client before
closing the pool. No migrations are needed. Redis-only transactions cannot be
atomic with application SQL writes; Rails integration and Pro's SQL-backed
features are not supported. See the [Redis driver guide](../driver/riverqueue-redis/README.md)
for durability requirements, compatibility, and other experimental limitations.

## Testing

For database-backed insertion assertions and synchronous worker tests, see
Expand Down
Loading