add readme
This commit is contained in:
parent
c0662f8bbe
commit
d94fc4e3be
17
README.md
Normal file
17
README.md
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
# tdb [![Build Status](https://jenkins.home.keganmyers.com/buildStatus/icon?job=tdb)](https://jenkins.home.keganmyers.com/job/tdb/)
|
||||||
|
|
||||||
|
TDB is a table-oriented database in golang built atop bolt. It does lots of things:
|
||||||
|
|
||||||
|
* Records stored in protobuf with automatic (de)serialization
|
||||||
|
* Indexed secondary fields
|
||||||
|
* Unique secondary fields
|
||||||
|
* Cross-table elationships (strong foreign keys)
|
||||||
|
* Indexing of array fields
|
||||||
|
* Non-null constraints
|
||||||
|
* (Vaguely) optimizing query engine
|
||||||
|
|
||||||
|
# Status
|
||||||
|
|
||||||
|
Proof of concept. I aim to use it in some of my projects so it will be maintained as long as makes sense.
|
||||||
|
|
||||||
|
It is tested, but iIt probably isn't safe. It isn't benchmarked, so it probably isn't fast. It's getting there, and currently achieves its goals of being feture rich and having few dependencies.
|
Loading…
Reference in a new issue