sqlite

Documentation

Overview

Package sqlite contains an implementation of the `gokv.Store` interface for sqlite.

Index

• Variables
• type Client
  • func NewClient(options Options) (Client, error)
  • func (c Client) Close() error
  • func (c Client) Delete(k string) error
  • func (c Client) Get(k string, v any) (found bool, err error)
  • func (c Client) Set(k string, v any) error
• type Options

Variables

var DefaultOptions = Options{
	Path:      "sqlite.db",
	TableName: defaultDBname,
	Codec:     encoding.JSON,
}

DefaultOptions is an Options object with default values.

Types

type Client

type Client struct {
	*sql.Client
}

Client is a gokv.Store implementation for sqlite.

func NewClient

func NewClient(options Options) (Client, error)

NewClient creates a new sqlite client.

You must call the Close() method on the client when you're done working with it.

func (Client) Close

func (c Client) Close() error

Close closes the client. It must be called to make sure that all open transactions finish and to release all DB resources.

func (Client) Delete

func (c Client) Delete(k string) error

Delete deletes the stored value for the given key.

func (Client) Get

func (c Client) Get(k string, v any) (found bool, err error)

Get retrieves the stored value for the given key.

func (Client) Set

func (c Client) Set(k string, v any) error

type Options

type Options struct {
	// Path
	Path string
	// Name of the table in which the key-value pairs are stored.
	// Optional ("Item" by default).
	TableName string
	// Encoding format.
	// Optional (encoding.JSON by default).
	Codec encoding.Codec
	Db    *gosql.DB
}

Options are the options for the sqlite client.