Skip to content

Redis cluster docs #9321

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

Closed
vadimonus wants to merge 2 commits into from
Closed

Redis cluster docs #9321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0172065
Redis cluster notes for predis and phpredis
vadimonus Oct 16, 2023
b43d534
Redis connection options examples
vadimonus Oct 16, 2023
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
53 changes: 50 additions & 3 deletions redis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,18 @@ If your application is utilizing a cluster of Redis servers, you should define t

],

By default, clusters will perform client-side sharding across your nodes, allowing you to pool nodes and create a large amount of available RAM. However, client-side sharding does not handle failover; therefore, it is primarily suited for transient cached data that is available from another primary data store.
#### Clusters with Predis

When using Predis, by default, clusters will perform client-side sharding across your nodes, allowing you to pool nodes and create a large amount of available RAM. However, client-side sharding does not handle failover; therefore, it is primarily suited for transient cached data that is available from another primary data store.

If you would like to use native Redis clustering instead of client-side sharding, you may specify this by setting the `options.cluster` configuration value to `redis` within your application's `config/database.php` configuration file:

'redis' => [

'client' => env('REDIS_CLIENT', 'phpredis'),
'client' => env('REDIS_CLIENT', 'predis'),

'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'cluster' => env('REDIS_CLUSTER', 'redis'), // Option only for predis.
],

'clusters' => [
Expand All @@ -123,6 +125,51 @@ If you would like to use native Redis clustering instead of client-side sharding

],

#### Clusters with phpredis

When using phpredis, native Redis clustering is always used.

#### Specifying connection options

You can pass options for cluster connections in different places.

'redis' => [

'options' => [
// Options for all redis connections, including clusters.
],

'default' => [
'options' => [
// Options for connection 'default'.
// Takes precedence over options, defined above.
],
'host' => env('REDIS_HOST', 'localhost'),
'port' => env('REDIS_PORT', 6379),
]

'clusters' => [

'options' => [
// Options for all cluster connections.
// Takes precedence over options, defined in redis.options.
],

'default-cluster' => [
'options' => [
// Options for connection 'default-cluster'.
// Takes precedence over options, defined above.
],
[
'host' => env('REDIS_HOST', 'localhost'),
'port' => env('REDIS_PORT', 6379),
],
],

],

],

<a name="predis"></a>
### Predis

Expand Down