drivers

package

v0.0.0-...-bb9d0af Latest Latest Go to latest Published: Sep 27, 2018 License: MIT Imports: 5 Imported by: 2

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

Package drivers contains our database driver connections, that can be used interchangeably by using interfaces

This section is empty.

This section is empty.

This section is empty.

type DBDriver interface {
	Search(string, bool, bool) (SearchFeed, error)
	Insert(string, *DBObj, bool) error
	Delete(string) error
}

DBDriver defines our database interface, so that different drivers can be swapped out, as needed.

type DBObj struct {
	Key string
	Obj interface{}
}

DBObj holds our database objects, along with the key, for convenience

type SQ3Driver struct {
	Location string
	DB       *sql.DB
}

SQ3Driver is our DBDriver for sqlite3

func NewSqlite(dataDir string) (*SQ3Driver, error)

NewSqlite allocates a new sqlite3 driver connection.

func (sq *SQ3Driver) Delete(key string) error

Delete also returns the object it deleted. The key must be an exact match

func (sq *SQ3Driver) Insert(key string, obj *DBObj, force bool) error

Insert adds a new record to the DB, it will return an error if the object already exists, unless force is specified.

func (sq *SQ3Driver) Search(pattern string, ignoreCase, searchContent bool) (SearchFeed, error)

Search is our search function for sqlite3

type SearchFeed chan *DBObj

SearchFeed is our channel to receive search results on