kvcmds

package

v0.0.0-...-d3719f8 Latest Latest Go to latest Published: May 17, 2025 License: MIT Imports: 26 Imported by: 0

Details

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

Repository

github.com/visvasity/kvcli

Links

Open Source Insights

Documentation ¶

Index ¶

type Backup
- func (c *Backup) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Backup) Purpose() string
type DBFlags
- func (v *DBFlags) Check() error
- func (v *DBFlags) Database(ctx context.Context) (kv.Database, func() error, error)
- func (v *DBFlags) SetFlags(fset *flag.FlagSet, defaults *DBFlags)
type Delete
- func (c *Delete) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Delete) Purpose() string
- func (c *Delete) Run(ctx context.Context, args []string) error
type Edit
- func (c *Edit) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Edit) Purpose() string
- func (c *Edit) Run(ctx context.Context, args []string) error
type Get
- func (c *Get) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Get) Purpose() string
- func (c *Get) Run(ctx context.Context, args []string) error
type HTTPClientFlags
- func (v *HTTPClientFlags) Client() *http.Client
- func (v *HTTPClientFlags) SetFlags(fset *flag.FlagSet, defaults *HTTPClientFlags)
type KVBadgerFlags
- func (v *KVBadgerFlags) Check() error
- func (v *KVBadgerFlags) Database(ctx context.Context) (kv.Database, func() error, error)
- func (v *KVBadgerFlags) SetFlags(fset *flag.FlagSet, defaults *KVBadgerFlags)
type KVHTTPFlags
- func (v *KVHTTPFlags) Check() error
- func (v *KVHTTPFlags) Database(ctx context.Context) (kv.Database, func() error, error)
- func (v *KVHTTPFlags) SetFlags(fset *flag.FlagSet, defaults *KVHTTPFlags)
type KVMemDBFlags
- func (v *KVMemDBFlags) Check() error
- func (v *KVMemDBFlags) Database(ctx context.Context) (kv.Database, func() error, error)
- func (v *KVMemDBFlags) SetFlags(fset *flag.FlagSet, defaults *KVMemDBFlags)
type List
- func (c *List) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *List) Purpose() string
- func (c *List) Run(ctx context.Context, args []string) error
type Restore
- func (c *Restore) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Restore) Purpose() string
type Set
- func (c *Set) Command() (string, *flag.FlagSet, cli.CmdFunc)
- func (c *Set) Purpose() string
- func (c *Set) Run(ctx context.Context, args []string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Backup ¶

type Backup struct {
	DBFlags
}

func (*Backup) Command ¶

func (c *Backup) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Backup) Purpose ¶

func (c *Backup) Purpose() string

type DBFlags ¶

type DBFlags struct {
	DBType string

	KVMemDBFlags
	KVBadgerFlags
	KVHTTPFlags
}

func (*DBFlags) Check ¶

func (v *DBFlags) Check() error

func (*DBFlags) Database ¶

func (v *DBFlags) Database(ctx context.Context) (kv.Database, func() error, error)

Database returns db stub for the remote database.

func (*DBFlags) SetFlags ¶

func (v *DBFlags) SetFlags(fset *flag.FlagSet, defaults *DBFlags)

SetFlags updates input flag set with additional database flags.

type Delete ¶

type Delete struct {
	DBFlags
}

func (*Delete) Command ¶

func (c *Delete) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Delete) Purpose ¶

func (c *Delete) Purpose() string

func (*Delete) Run ¶

func (c *Delete) Run(ctx context.Context, args []string) error

type Edit ¶

type Edit struct {
	DBFlags
	// contains filtered or unexported fields
}

func (*Edit) Command ¶

func (c *Edit) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Edit) Purpose ¶

func (c *Edit) Purpose() string

func (*Edit) Run ¶

func (c *Edit) Run(ctx context.Context, args []string) error

type Get ¶

type Get struct {
	DBFlags
	// contains filtered or unexported fields
}

func (*Get) Command ¶

func (c *Get) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Get) Purpose ¶

func (c *Get) Purpose() string

func (*Get) Run ¶

func (c *Get) Run(ctx context.Context, args []string) error

type HTTPClientFlags ¶

type HTTPClientFlags struct {
	DialerTimeout         time.Duration
	KeepAliveTimeout      time.Duration
	TLSHandshakeTimeout   time.Duration
	ResponseHeaderTimeout time.Duration
	ExpectContinueTimeout time.Duration
	IdleConnectionTimeout time.Duration
	ClientTimeout         time.Duration
}

func (*HTTPClientFlags) Client ¶

func (v *HTTPClientFlags) Client() *http.Client

func (*HTTPClientFlags) SetFlags ¶

func (v *HTTPClientFlags) SetFlags(fset *flag.FlagSet, defaults *HTTPClientFlags)

type KVBadgerFlags ¶

type KVBadgerFlags struct {
	Dir string
}

func (*KVBadgerFlags) Check ¶

func (v *KVBadgerFlags) Check() error

func (*KVBadgerFlags) Database ¶

func (v *KVBadgerFlags) Database(ctx context.Context) (kv.Database, func() error, error)

func (*KVBadgerFlags) SetFlags ¶

func (v *KVBadgerFlags) SetFlags(fset *flag.FlagSet, defaults *KVBadgerFlags)

type KVHTTPFlags ¶

type KVHTTPFlags struct {
	Port     int
	IP       string
	Path     string
	UseHTTPS bool

	HTTPClientFlags HTTPClientFlags
}

func (*KVHTTPFlags) Check ¶

func (v *KVHTTPFlags) Check() error

func (*KVHTTPFlags) Database ¶

func (v *KVHTTPFlags) Database(ctx context.Context) (kv.Database, func() error, error)

func (*KVHTTPFlags) SetFlags ¶

func (v *KVHTTPFlags) SetFlags(fset *flag.FlagSet, defaults *KVHTTPFlags)

type KVMemDBFlags ¶

type KVMemDBFlags struct {
	InitFile string
	SaveFile string
}

func (*KVMemDBFlags) Check ¶

func (v *KVMemDBFlags) Check() error

func (*KVMemDBFlags) Database ¶

func (v *KVMemDBFlags) Database(ctx context.Context) (kv.Database, func() error, error)

Database creates an in-memory database that is optionally initialized with user chosen snapshot.

func (*KVMemDBFlags) SetFlags ¶

func (v *KVMemDBFlags) SetFlags(fset *flag.FlagSet, defaults *KVMemDBFlags)

SetFlags updates input flag.FlagSet with customizable flags.

type List ¶

type List struct {
	DBFlags
	// contains filtered or unexported fields
}

func (*List) Command ¶

func (c *List) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*List) Purpose ¶

func (c *List) Purpose() string

func (*List) Run ¶

func (c *List) Run(ctx context.Context, args []string) error

type Restore ¶

type Restore struct {
	DBFlags
	// contains filtered or unexported fields
}

func (*Restore) Command ¶

func (c *Restore) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Restore) Purpose ¶

func (c *Restore) Purpose() string

type Set ¶

type Set struct {
	DBFlags
}

func (*Set) Command ¶

func (c *Set) Command() (string, *flag.FlagSet, cli.CmdFunc)

func (*Set) Purpose ¶

func (c *Set) Purpose() string

func (*Set) Run ¶

func (c *Set) Run(ctx context.Context, args []string) error

Source Files ¶

View all Source files

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