redis

package

v0.6.0 Latest Latest Go to latest Published: Feb 13, 2024 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mirzakhany/dbctl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Instances(ctx context.Context) ([]database.Info, error)
type Option
type Redis
- func New(options ...Option) (*Redis, error)

Constants ¶

View Source

const (
	// DefaultPort is the default port for redis
	DefaultPort = 16379
	// DefaultUser is the default user for redis
	DefaultUser = ""
	// DefaultPass is the default password for redis
	DefaultPass = ""
)

Variables ¶

This section is empty.

Functions ¶

func Instances ¶

func Instances(ctx context.Context) ([]database.Info, error)

Instances returns a list of running redis instances

Types ¶

type Option ¶

type Option func(*config) error

func WithHost ¶

func WithHost(user, pass string, dbIndex int, port uint32) Option

func WithLabel ¶ added in v0.4.8

func WithLabel(label string) Option

func WithLogger ¶

func WithLogger(logger io.Writer) Option

func WithVersion ¶

func WithVersion(version string) Option

WithVersion applied selected postgres version to config

type Redis ¶

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

Redis is a redis database

func New ¶

func New(options ...Option) (*Redis, error)

New creates a new redis database instance

func (*Redis) CreateDB ¶ added in v0.4.0

func (p *Redis) CreateDB(ctx context.Context, req *database.CreateDBRequest) (*database.CreateDBResponse, error)

CreateDB creates a new database

func (*Redis) RemoveDB ¶ added in v0.4.0

func (p *Redis) RemoveDB(ctx context.Context, uri string) error

RemoveDB removes a database by its uri

func (*Redis) Start ¶

func (p *Redis) Start(ctx context.Context, detach bool) error

Start starts the database

func (*Redis) Stop ¶

func (p *Redis) Stop(ctx context.Context) error

Stop stops the database

func (*Redis) URI ¶

func (p *Redis) URI() string

URI returns the connection string for the database

func (*Redis) WaitForStart ¶

func (p *Redis) WaitForStart(ctx context.Context, timeout time.Duration) error

WaitForStart waits for database to boot up

Source Files ¶

View all Source files

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