https://github.com/andresoro/lytedb

Store Go structs on disk 👍
https://github.com/andresoro/lytedb

Last synced: 22 days ago
JSON representation

Store Go structs on disk 👍

• Host: GitHub
• URL: https://github.com/andresoro/lytedb
• Owner: andresoro
• License: mit
• Created: 2019-05-24T00:03:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T22:04:57.000Z (over 4 years ago)
• Last Synced: 2024-07-31T18:19:02.507Z (4 months ago)
• Language: Go
• Homepage:
• Size: 15.6 KB
• Stars: 19
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/etcd-io/bbolt) and the standard lib [encoding/gob](https://godoc.org/encoding/gob) to handle storage and serialization. Read about motivations [here](https://aoro.io/post/lytedb/).

Storing/retrieving structs on disk should be this easy:

``` go

// 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. 

``` go 

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.

``` go

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.

``` go

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.

``` go

var user User

db.Get("napoleon", &user)

```