Simple interfaces for working with basic key-value storage in your Go application https://pkg.go.dev/github.com/annybs/ezdb

Aneurin Barker Snook f26b55327f improve tests, clean up some inadequately tested code 11 months ago
.github 351090ee3c test pull requests too 11 months ago
.gitignore b7b920a637 initial commit, untested 11 months ago
LICENSE.md d3ead919a4 set standard license text 11 months ago
README.md f26b55327f improve tests, clean up some inadequately tested code 11 months ago
collection_tester.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
errors.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
go.mod 6ec75f4b90 slightly lower required go version 11 months ago
go.sum b7b920a637 initial commit, untested 11 months ago
interfaces.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
json.go b7b920a637 initial commit, untested 11 months ago
key.go b7b920a637 initial commit, untested 11 months ago
leveldb.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
leveldb_iter.go 43c486b95e rename, publish MemoryIter 11 months ago
leveldb_options.go 404ff3bd7c add leveldb options passthrough 11 months ago
leveldb_test.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
memory.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
memory_iter.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
memory_test.go f26b55327f improve tests, clean up some inadequately tested code 11 months ago
sort.go 379450fa36 fix memory sort 11 months ago
staticcheck.conf b7b920a637 initial commit, untested 11 months ago

README.md

EZ DB

This package provides simple interfaces for working with basic key-value storage in your Go application.

EZ DB is not a database unto itself. If you want more control or features, just use the appropriate database software and connector for your needs.

System requirements

Basic usage

The primary interface in EZ DB is Collection[T] which reflects a single key-value store. This is analogous to tables in RDBMS, collections in NoSQL databases etc.

Collections use a generic type T to specify the document type. You can use this to enforce a document schema. This example creates a collection which only accepts Student documents:

package main

import "github.com/annybs/ezdb"

type Student struct {
	Name string
	Age int
}

var db = ezdb.Memory[Student](nil)

func main() {
	db.Open()
	db.Put("annie", Student{Name: "Annie", Age: "32"})
	db.Close()
}

In other cases, such as media stores, you may prefer not to specify a document type. This example allows arbitrary bytes to be written:

package main

import "github.com/annybs/ezdb"

var db = ezdb.Memory[[]byte](nil)

func main() {
	db.Open()
	db.Put("data", []byte("arbitrary bytes"))
	db.Close()
}

Marshaling data

Some database backends require marshaling and unmarshaling data. The DocumentMarshaler[T1, T2] interface allows you to use whatever marshaler suits your needs or the requirements of your chosen database.

The following marshalers are included in EZ DB:

Supported databases

The following databases are included in EZ DB:

  • LevelDB[T] is fast key-value storage on disk
  • Memory[T] is essentially a wrapper for map[string]T. It can be provided another Collection to use as a persistence backend

License

See LICENSE.md