From d94fc4e3be83fa8e6348d8a4c87eb5ae30f70c93 Mon Sep 17 00:00:00 2001 From: Kegan Myers Date: Thu, 16 Apr 2020 00:22:30 -0500 Subject: [PATCH] add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6427cfd --- /dev/null +++ b/README.md @@ -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.