redis

Documentation

Index

• Constants
• Variables
• func Module() dep.Module
• type Client
  • func (c *Client) GetAny(ctx context.Context, key string, valuePtr any) error
  • func (c *Client) GetBytes(ctx context.Context, key string) ([]byte, error)
  • func (c *Client) GetString(ctx context.Context, key string) (string, error)
  • func (c *Client) GetTTL(ctx context.Context, key string) (*time.Duration, error)
  • func (c *Client) Key(args ...string) string
  • func (c *Client) Ping(ctx context.Context) error
  • func (c *Client) SetAny(ctx context.Context, key string, value any) error
  • func (c *Client) SetBytes(ctx context.Context, key string, value []byte) error
  • func (c *Client) SetString(ctx context.Context, key, value string) error
  • func (c *Client) SetTTL(ctx context.Context, key string, ttl time.Duration) error
• type Configuration
  • func ConfigFrom(ctx context.Context, conf config.Config) (*Configuration, error)
• type ServerConfiguration

Constants

const (
	ModeLocal    = "local"
	ModeSentinel = "sentinel"
	ModeCluster  = "cluster"
)

Variables

var (
	ConfMode = config.Key("redis", "mode")

	ConfAddr = config.Key("redis", "addr")

	ConfDatabase = config.Key("redis", "database")

	ConfUsername = config.Key("redis", "username")

	ConfPassword = config.Key("redis", "password")
)

var (
	ModuleName = dep.Name("wk", "redis")
)

Functions

func Module

func Module() dep.Module

Types

type Client

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

func (*Client) GetAny

func (c *Client) GetAny(ctx context.Context, key string, valuePtr any) error

func (*Client) GetBytes

func (c *Client) GetBytes(ctx context.Context, key string) ([]byte, error)

func (*Client) GetString

func (c *Client) GetString(ctx context.Context, key string) (string, error)

func (*Client) GetTTL

func (c *Client) GetTTL(ctx context.Context, key string) (*time.Duration, error)

func (*Client) Key

func (c *Client) Key(args ...string) string

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) error

func (*Client) SetAny

func (c *Client) SetAny(ctx context.Context, key string, value any) error

func (*Client) SetBytes

func (c *Client) SetBytes(ctx context.Context, key string, value []byte) error

func (*Client) SetString

func (c *Client) SetString(ctx context.Context, key, value string) error

func (*Client) SetTTL

func (c *Client) SetTTL(ctx context.Context, key string, ttl time.Duration) error

type Configuration

type Configuration struct {
	Mode    string
	Servers []ServerConfiguration
}

func ConfigFrom

func ConfigFrom(ctx context.Context, conf config.Config) (*Configuration, error)

type ServerConfiguration

type ServerConfiguration struct {
	Addr     string
	Database int
	Password string
	Username string
}