class Redis::Client

• Redis::Client
• Reference
• Object

Overview

The Redis client is the expected entrypoint for this shard. By default, it will connect to localhost:6379, but you can also supply a URI to connect to an arbitrary Redis server. SSL, password authentication, and DB selection are all supported.

# Connects to localhost:6379
redis = Redis::Client.new

# Connects to a server at "redis.example.com" on port 6000 over a TLS
# connection, authenticates with the password "password", and uses DB 3
redis = Redis::Client.new(URI.parse("rediss://:[email protected]:6000/3"))

# Connects to a server at the URL in `ENV["REDIS_URL"]`
redis = Redis::Client.from_env("REDIS_URL")

Included Modules

• Redis::Commands

Defined in:

Constructors

• .new(uri : URI = URI.parse(ENV.fetch("REDIS_URL", "redis:///")))

  The client holds a pool of connections that expands and contracts as needed.

Class Method Summary

• .from_env(env_var)

Instance Method Summary

• #close
• #hscan_each(key : String, *, match pattern : String | Nil = nil, count : String | Int | Nil = nil, &) : Nil
• #multi(&)
• #pipeline(&)
• #psubscribe(*channels, &)
• #run(command)

  All Redis commands invoked on the client check out a connection from the connection pool, invoke the command on that connection, and then check the connection back into the pool.

• #scan_each(match pattern : String | Nil = nil, count : String | Int | Nil = nil, type : String | Nil = nil, &) : Nil
• #subscribe(*channels, &)

Constructor Detail

Class Method Detail

Instance Method Detail

redis = Redis::Client.new