From af087694028417f26ece2ef032a7ed1cdec08620 Mon Sep 17 00:00:00 2001
From: "kayos@tcp.direct" <kayos@tcp.direct>
Date: Sat, 1 Jan 2022 11:20:40 -0800
Subject: [PATCH] init

---
 go.mod       |  3 +++
 interface.go | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 go.mod
 create mode 100644 interface.go

diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..f577722
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,3 @@
+module git.tcp.direct/kayos/database
+
+go 1.17
diff --git a/interface.go b/interface.go
new file mode 100644
index 0000000..3b0dce8
--- /dev/null
+++ b/interface.go
@@ -0,0 +1,51 @@
+package database
+
+// Filer is is a way to implement any generic key/value store.
+// These functions should be plug and play with most of the popular key/value store golang libraries.
+type Filer interface {
+	// NOTE: One can easily cast anything to a byte slice. (e.g: []byte("fuckholejones") )
+	// json.Marshal also returns a byte slice by default ;)
+
+	// Has should return true if the given key has an associated value.
+	Has(key []byte) bool
+	// Get should retrieve the byte slice corresponding to the given key, and any associated errors upon failure.
+	Get(key []byte) ([]byte, error)
+	// Put should insert the value data in a way that is associated and can be retrieved by the given key data.
+	Put(key []byte, value []byte) error
+	// Delete should delete the key and the value associated with the given key, and return an error upon failure.
+	Delete(key []byte) error
+}
+
+// Keeper will be in charge of the more meta operations involving Filers.
+// This includes operations like initialization, syncing to disk if applicable, and backing up.
+//
+// NOTE: Many key/value golang libraries will already implement this interface already.
+// This exists for more potential granular control in the case that they don't.
+// Otherwise you'd have to build a wrapper around an existing key/value store to satisfy an overencompassing interface.
+type Keeper interface {
+	// Open should initialize our Filer at the given path, to be referenced and called by bucketName.
+	Initialize(bucketName, path string) error
+	// With provides access to the given bucketName by providing a pointer to the related Filer.
+	With(bucketName string) *Filer
+	// Close should safely end any Filer operations of the given bucketName and close any relevant handlers.
+	Close(bucketName string) error
+	// Sync should take any volatile data and solidify it somehow if relevant. (ram to disk in most cases)
+	Sync(bucketName string) error
+
+	// TODO: Backups
+
+	CloseAll() error
+	SyncAll() error
+}
+
+// Searcher must be able to search through our datastore(s) with strings.
+type Searcher interface {
+	// AllKeys must retrieve all keys in the datastore with the given bucketName.
+	AllKeys() []string
+	// PrefixScan must return all keys that begin with the given prefix.
+	PrefixScan(prefix string) map[string]interface{}
+	// Search must be able to search through the contents of our database and return a map of results.
+	Search(query string) map[string]interface{}
+	// ValueExists searches for an exact match of the given value and returns the key that contains it.
+	ValueExists(value []byte) (key []byte, ok bool)
+}