tinyredis

Documentation

Overview

Package tinyredis provides utilities for handling Redis.

Index

• func Dial(url string, opts ...Opt) (*redis.Client, error)
• type Config
• type Opt
  • func ConnectionTimeout(connectionTimeout time.Duration) Opt
  • func NoPing() Opt
  • func Options(redisOpt func(options *redis.Options)) Opt

Functions

func Dial

func Dial(url string, opts ...Opt) (*redis.Client, error)

Dial creates a connection to Redis and returns *redis.Client instance.

Types

type Config

type Config struct {
	// ConnectionTimeout is a maximum time client should spend trying to connect (default: 5s).
	ConnectionTimeout time.Duration

	// NoPing indicates whether Dial should skip the initial call to Ping method (default: false).
	NoPing bool
	// contains filtered or unexported fields
}

Config holds a configuration for Dial call.

type Opt

type Opt = func(*Config)

Opt is an option to be specified to Dial.

func ConnectionTimeout

func ConnectionTimeout(connectionTimeout time.Duration) Opt

ConnectionTimeout is a maximum time client should spend trying to connect.

func NoPing

func NoPing() Opt

NoPing indicates that Dial should skip the initial call to Ping method.

func Options

func Options(redisOpt func(options *redis.Options)) Opt

Options sets a function that allows to customize redis options.