db

Documentation

Index

• Variables
• func IsErrDuplicateKey(err error) bool
• func IsErrIndexExists(err error) bool
• type ChanRecord
• type DB
  • func NewDB(namespace string, host string, port int) (DB, error)
  • func NewTestDB(host string, port int) (DB, error)
• type Record
  • func (r Record) GetCreatedAt() time.Time
  • func (r *Record) GetDB() DB
  • func (r Record) GetExpiration() int32
  • func (r Record) GetGeneration() int32
  • func (r *Record) GetPrimaryKey() []byte
  • func (r Record) GetUpdatedAt() time.Time
  • func (r *Record) SetExpiration(e int32)
  • func (r Record) Stored() bool
• type RecordObject

Variables

var (
	ERR_NO_EXIST           = errors.New("Key doesn't exist")
	ERR_NO_PK              = errors.New("No field is marked as primary key")
	ERR_INVALID_PK         = errors.New("The field maked as pk is not a []byte or a string or is nil")
	ERR_MULTIPLE_PK        = errors.New("Either one field can be marked as primary key or the GetPrimaryKey function returns one")
	ERR_NO_POINTER         = errors.New("A pointer is required to unmarshal data into it")
	ERR_DATA_TYPE_MISMATCH = errors.New("Data stored and expected value in struct do not match")
)

Functions

func IsErrDuplicateKey

func IsErrDuplicateKey(err error) bool

func IsErrIndexExists

func IsErrIndexExists(err error) bool

Types

type ChanRecord

type ChanRecord struct {
	Record interface{}
	Error  error
}

type DB

type DB interface {
	LinkRecordToDB(RecordObject) RecordObject
	CreateNewRecord(RecordObject) error
	DeleteRecord(RecordObject) (bool, error)
	GetRecord([]byte, RecordObject) error
	TouchRecord(RecordObject) error
	ExistsRecord(r RecordObject) (bool, error)
	ReplaceRecord(r RecordObject) error
	ScanRecords(r RecordObject) chan ChanRecord
	RegisterIndexes(r RecordObject) error
	DeleteIndexes(r RecordObject) error
	Search(RecordObject, string, string) chan ChanRecord
}

func NewDB

func NewDB(namespace string, host string, port int) (DB, error)

func NewTestDB

func NewTestDB(host string, port int) (DB, error)

type Record

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

func (Record) GetCreatedAt

func (r Record) GetCreatedAt() time.Time

func (*Record) GetDB

func (r *Record) GetDB() DB

func (Record) GetExpiration

func (r Record) GetExpiration() int32

func (Record) GetGeneration

func (r Record) GetGeneration() int32

func (*Record) GetPrimaryKey

func (r *Record) GetPrimaryKey() []byte

func (Record) GetUpdatedAt

func (r Record) GetUpdatedAt() time.Time

func (*Record) SetExpiration

func (r *Record) SetExpiration(e int32)

func (Record) Stored

func (r Record) Stored() bool

type RecordObject

type RecordObject interface {
	Validate() error
	// contains filtered or unexported methods
}