boltclient

package

v0.0.0-...-14b48b0 Latest Latest Go to latest Published: Nov 27, 2017 License: MIT Imports: 8 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

View Source

const PairBucket = "pairs"

View Source

const UserBucket = "giftees"

This section is empty.

This section is empty.

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

Client represents a client connection to a bolt database

func NewClient(path string, bucket ...string) *Client

NewClient takes a path string and returns a new `Client` to that database

func (c *Client) CleanDatabase() error

func (c *Client) Close() error

Close closes the database connection

func (c *Client) GetMatches() ([]match.Pair, error)

GetMatches retrieves the list of Pairs from the database

func (c *Client) GetPair(key string) (*match.Pair, error)

GetPair retrieves a single Pair from the database

func (c *Client) GetUser(key string) (*csv.User, error)

GetUser retrieves a single User from the database

func (c *Client) GetUserList() ([]csv.User, error)

GetUserList retrieves the list of Users from the database

func (c *Client) Open() error

Open opens a new bolt database and initializes the `buckets`

func (c *Client) SetBucket(buckets ...string)

SetBucket registers a bucket (or multiple) with the client

func (c *Client) StoreMatches(pl ...match.Pair) error

StoreMatches saves Pair data to the database. `pl` can be single or multiple Pair(s)

func (c *Client) StoreUsers(ul ...csv.User) error

StoreUsers saves User data to the database. `ul` can be single or multiple User(s)