redis

package module

v0.1.3 Latest Latest Go to latest Published: Jul 3, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/duxweb/runa

Links

Open Source Insights

Documentation ¶

Index ¶

func Driver(items ...Option) database.Driver
func Provider(items ...ProviderOption) runaprovider.Provider
type ConfigReader
type Option
type ProviderOption
- func Register(name string, options ...Option) ProviderOption
type RedisDatabase

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Driver ¶

func Driver(items ...Option) database.Driver

Database creates a Redis database driver.

func Provider ¶ added in v0.1.2

func Provider(items ...ProviderOption) runaprovider.Provider

Provider registers Redis database runtimes from options or [redis.<name>] config.

Types ¶

type ConfigReader ¶

type ConfigReader interface {
	GetString(string, string) string
	GetInt(string, int) int
}

ConfigReader reads config values used by the Redis driver.

type Option ¶

type Option func(*options)

Option configures a Redis database driver.

func Addr ¶

func Addr(value string) Option

Addr sets the Redis server address.

func Auth ¶

func Auth(username string, password string) Option

Auth sets Redis username and password.

func Client ¶ added in v0.1.2

func Client(client *goredis.Client) Option

Client uses an existing Redis client. The runtime will not close injected clients.

func Config ¶

func Config(path string) Option

Config reads Redis config from app config path.

func DB ¶

func DB(value int) Option

DB sets Redis logical database index.

func DialTimeout ¶

func DialTimeout(value time.Duration) Option

DialTimeout sets Redis dial timeout.

func Logger ¶

func Logger(name string) Option

Logger sets the Runa logger channel.

func Meta ¶

func Meta(key string, value any) Option

Meta sets runtime metadata.

func MinIdle ¶

func MinIdle(value int) Option

MinIdle sets Redis minimum idle connections.

func Password ¶

func Password(value string) Option

Password sets Redis password.

func PoolSize ¶

func PoolSize(value int) Option

PoolSize sets Redis connection pool size.

func ReadTimeout ¶

func ReadTimeout(value time.Duration) Option

ReadTimeout sets Redis read timeout.

func WriteTimeout ¶

func WriteTimeout(value time.Duration) Option

WriteTimeout sets Redis write timeout.

type ProviderOption ¶ added in v0.1.2

type ProviderOption func(*provider)

func Register ¶ added in v0.1.2

func Register(name string, options ...Option) ProviderOption

Register registers a named Redis runtime.

type RedisDatabase ¶

type RedisDatabase struct {
	// contains filtered or unexported fields
}

RedisDatabase is a Runa database runtime for Redis.

func (*RedisDatabase) Close ¶

func (db *RedisDatabase) Close(context.Context) error

Close closes Redis client.

func (*RedisDatabase) Info ¶

func (db *RedisDatabase) Info() database.Info

Info returns runtime info.

func (*RedisDatabase) Kind ¶

func (db *RedisDatabase) Kind() string

Kind returns runtime kind.

func (*RedisDatabase) Name ¶

func (db *RedisDatabase) Name() string

Name returns runtime name.

func (*RedisDatabase) Ping ¶

func (db *RedisDatabase) Ping(ctx context.Context) error

Ping checks Redis availability.

func (*RedisDatabase) Raw ¶

func (db *RedisDatabase) Raw() any

Raw returns the raw Redis client.

func (*RedisDatabase) Redis ¶

func (db *RedisDatabase) Redis() *goredis.Client

Redis returns the raw Redis client.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL