db

Documentation

Index

• Constants
• type BadgerConnector
  • func NewBadgerConnector(cfg *config.Config) (*BadgerConnector, error)
  • func (c *BadgerConnector) Close() error
  • func (c *BadgerConnector) DBType() string
  • func (c *BadgerConnector) Get(key string) (*KV, error)
  • func (c *BadgerConnector) Set(input *KV) error
• type CockroachConnector
  • func NewCockroachConnector(_ *config.Config) (*CockroachConnector, error)
  • func (c *CockroachConnector) Close() error
  • func (c *CockroachConnector) DBType() string
  • func (c *CockroachConnector) Get(key string) (*KV, error)
  • func (c *CockroachConnector) Set(inpuc *KV) error
• type DB
  • func Open(cfg *config.Config) (DB, error)
• type KV
• type TestStoreConnector
  • func NewTestStoreConnector(_ *config.Config) (*TestStoreConnector, error)
  • func (c *TestStoreConnector) Close() error
  • func (c *TestStoreConnector) DBType() string
  • func (c *TestStoreConnector) Get(key string) (*KV, error)
  • func (c *TestStoreConnector) Set(inpuc *KV) error
• type UndefinedConnector
  • func NewUndefinedConnection(err error) (*UndefinedConnector, error)
  • func (c *UndefinedConnector) Close() error
  • func (c *UndefinedConnector) DBType() string
  • func (c *UndefinedConnector) Get(key string) (*KV, error)
  • func (c *UndefinedConnector) Set(inpuc *KV) error

Constants

const (
	// Connection types
	BADGER    string = "badger"
	COCKROACH string = "cockroach"
	TESTSTORE string = "teststore"
	UNDEFINED string = "undefined"
)

db-wide constants

const (
	TestCreatedTime = "2006-01-02T15:04:05Z"
	TestUpdatedTime = "2006-01-08T10:00:08Z"
	TestKey         = "a key"
	TestVal         = "a value"
)

Constants for testing

Types

type BadgerConnector

type BadgerConnector struct {
	ConnType string
	Conn     *badger.DB
}

BadgerConnector ...

func NewBadgerConnector

func NewBadgerConnector(cfg *config.Config) (*BadgerConnector, error)

NewBadgerConnector ...

func (*BadgerConnector) Close

func (c *BadgerConnector) Close() error

Close closes the connection to the database

func (*BadgerConnector) DBType

func (c *BadgerConnector) DBType() string

DBType returns the database type

func (*BadgerConnector) Get

func (c *BadgerConnector) Get(key string) (*KV, error)

Get ...

func (*BadgerConnector) Set

func (c *BadgerConnector) Set(input *KV) error

Set ...

type CockroachConnector

type CockroachConnector struct {
	ConnType string
}

CockroachConnector ...

func NewCockroachConnector

func NewCockroachConnector(_ *config.Config) (*CockroachConnector, error)

NewCockroachConnector ...

func (*CockroachConnector) Close

func (c *CockroachConnector) Close() error

Close closes the connection to the database

func (*CockroachConnector) DBType

func (c *CockroachConnector) DBType() string

DBType returns the database type

func (*CockroachConnector) Get

func (c *CockroachConnector) Get(key string) (*KV, error)

Get ...

func (*CockroachConnector) Set

func (c *CockroachConnector) Set(inpuc *KV) error

Set ...

type DB

type DB interface {
	Close() error
	DBType() string
	Get(key string) (*KV, error)
	Set(*KV) error
}

DB ...

func Open

func Open(cfg *config.Config) (DB, error)

Open dispatches the creation of a specific DB connection type

type KV

type KV struct {
	Key     string
	Value   []byte
	Created *time.Time
	Updated *time.Time
}

KV ...

type TestStoreConnector

type TestStoreConnector struct {
	ConnType string
}

TestStoreConnector is for test dbs that will be used in unit tests

func NewTestStoreConnector

func NewTestStoreConnector(_ *config.Config) (*TestStoreConnector, error)

NewTestStoreConnector is for use with unit tests

func (*TestStoreConnector) Close

func (c *TestStoreConnector) Close() error

Close closes the connection to the database

func (*TestStoreConnector) DBType

func (c *TestStoreConnector) DBType() string

DBType returns the database type

func (*TestStoreConnector) Get

func (c *TestStoreConnector) Get(key string) (*KV, error)

Get ...

func (*TestStoreConnector) Set

func (c *TestStoreConnector) Set(inpuc *KV) error

Set ...

type UndefinedConnector

type UndefinedConnector struct {
	ConnType string
}

UndefinedConnector is for situations where an implementation needs to be returned, even when there is none.

func NewUndefinedConnection

func NewUndefinedConnection(err error) (*UndefinedConnector, error)

NewUndefinedConnection is for use with unit tests

func (*UndefinedConnector) Close

func (c *UndefinedConnector) Close() error

Close closes the connection to the database

func (*UndefinedConnector) DBType

func (c *UndefinedConnector) DBType() string

DBType returns the database type

func (*UndefinedConnector) Get

func (c *UndefinedConnector) Get(key string) (*KV, error)

Get ...

func (*UndefinedConnector) Set

func (c *UndefinedConnector) Set(inpuc *KV) error

Set ...