Go object database
Go Shell
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
notes
src
.gitignore
README.md
TODO.md
set_env.sh

README.md

loge -- Go object database

Current Features:

  • Stores Go objects
  • Arbitrary ACID transactions with MVCC
  • Durability via leveldb storage layer
  • Link sets for objects, and reverse lookups on them
  • Fast-ish

Upcoming features (in approximate order):

  • Better link traversal
  • Replication and failover (no auto-sharding)
  • REST API
  • Some kind of high-level query language
  • Javascript transactions

Synopsis:

package main

import (
	"loge"
	"fmt"
)

type Person struct {
	Name string
	Age int
}

func main() {
	var db = loge.NewLogeDB(loge.NewLevelDBStore("data/example"))
	db.CreateType("person", 1, &Person{}, nil)


	// ------------------------------------
	// Create an object

	db.Transact(func(trans *loge.Transaction) {
		trans.Set("person", "brendon", &Person{ Name: "Brendon", Age: 31 })
	}, 0)


	// ------------------------------------
	// Load some objects

	db.Transact(func(trans *loge.Transaction) {
		if trans.Exists("person", "brendon") {
			var brendon = trans.Write("person", "brendon").(*Person)

			fmt.Printf("Existing Brendon: %v\n", brendon)

			// Update
			brendon.Age = 41
		}

		var defaultObj = trans.Read("person", "someone else").(*Person)
		fmt.Printf("Default value: %v\n", defaultObj)
	}, 0)


	// ------------------------------------
	// Check the update

	db.Transact(func(trans *loge.Transaction) {
		var brendon = trans.Read("person", "brendon").(*Person)
		fmt.Printf("Updated Brendon: %v\n", brendon)
	}, 0)


	// ------------------------------------
	// Intermingle transactions
	
	var trans1 = db.CreateTransaction()
	var trans2 = db.CreateTransaction()

	trans1.Set("person", "nai", &Person{ Name: "Nai Yu", Age: 32 })
	trans2.Set("person", "nai", &Person{ Name: "Not Nai Yu", Age: 16 })

	fmt.Printf("Commit 1: %v\n", trans1.Commit())
	fmt.Printf("Commit 2: %v\n", trans2.Commit())


	// ------------------------------------
	// Check which succeeded

	db.Transact(func(trans *loge.Transaction) {
		var nai = trans.Read("person", "nai")
		fmt.Printf("Nai: %v\n", nai)
	}, 0)
}

Output:

$ go install logetest && ./bin/logetest 
Updating type info: person
Existing Brendon: &{Brendon 31 []}
Default value: <nil>
Updated Brendon: &{Brendon 41 []}
Commit 1: true
Commit 2: false
Nai: &{Nai Yu 32 []}

Random Notes

  • All DB updates happen in transactions
  • In transactions, Read, Write, and Set mark an object as important, and the transaction will abort at commit time if the object has changed
  • Changes to an object retrieved with Read are discarded, unless Write or Set are called for it later in the transaction.
  • Object creation (via Set) follows transaction semantics
  • A transaction run by db.Transact(Func, Timeout) will retry in a loop until it succeeds or times out
  • Manual transactions via db.CreateTransaction do not retry