lyte

lytedb

lytedb is an easy to use on-disk database for Go applications. Data is divided into collections and accessed by a key. This package leverages bolt and the standard lib encoding/gob to handle storage and serialization. Read about motivations here.

Storing/retrieving structs on disk should be this easy:

// add a new user under the key 'user-id'
lytedb.Add("user-id", User{Age: 22, Name: "Andres"})

// our user struct
var user User

// write value assigned to 'user-id' onto our struct
lytedb.Get("user-id", &user)

Usage

Open DB

Simply supply a path to a file. If no file exists, it will be created automatically. Remember that this will obtain a file lock on the specified file so no other process can open it.

db, err := lyte.New("/path/to/file.db")
if err != nil {
    // handle
}
defer db.Close()

Collections

Data can be divided into different groups called collections. Collections are a convenient way to seperate data while maintaining unique keys. Meaning you can have entries with the same key as long as they are in different collections.

userDB, err := db.Collection("users")

userDB.Add("user1", user)

Add/Get data

lytedb uses collections to seperate data but also uses a "main" collection for general storage. Remember that the db encodes values so only exported values get written.

type User struct {
    ID string
    Name string
    Age int
}

user := User{
    ID: "Vote for Pedro",
    Name: "Napoleon",
    Age: 25,
}

db.Add("napoleon", user)

Similarly, getting values writes back onto a struct. This is why values need to be exported so that the underlying encoding package (encoding/gob) can read/write from structs.

The Get method must recieve a pointer to the struct to write onto.

var user User
db.Get("napoleon", &user)