doc.go

/*
Package badgerhold is an indexing and querying layer on top of a badger DB.  The goal is to allow easy, persistent storage
and retrieval of Go types.  badgerDB is an embedded key-value store, and badgerhold serves a similar use case however with
a higher-level interface for common uses of Badger.

Go Types

BadgerHold deals directly with Go Types.  When inserting data, you pass in your structure directly.  When querying data you
pass in a pointer to a slice of the type you want to return. By default, Gob encoding is used. You can put multiple
different types into the same DB file and they (and their indexes) will be stored separately.

	err := store.Insert(1234, Item{
		Name:    "Test Name",
		Created: time.Now(),
	})

	var result []Item

	err := store.Find(&result, query)


Indexes

BadgerHold will automatically create an index for any struct fields tags with "badgerholdIndex"

	type Item struct {
		ID       int
		Name     string
		Category string `badgerholdIndex:"Category"`
		Created  time.Time
	}

The first field specified in query will be used as the index (if one exists).

Queries are chained together criteria that applies to a set of fields:

	badgerhold.Where("Name").Eq("John Doe").And("DOB").Lt(time.Now())


*/
package badgerhold