reldb

type AbstractRelDB struct{ IRelationalDB }

type DBObject struct{ IObject }

type IObject interface {
	Equals(v IObject) bool
	Hash() string
	ToString() string
	TableName() string
}

type IRelationalDB interface {
	// GetNextKey pick a key in tank of key. If tank is empty, it should be filled with unused key.
	GetNextKey() string
	// FreeKey check if key is used (return error otherwise) and make key available again.
	FreeKey(key ...string) []error
	CleanUnusedKey()

	// RawSet set a value in DB. prefix and key are simply concatenated. Don't care about Key is already in used or not.
	RawSet(prefix string, key string, value []byte)
	// RawGet get a value in DB. prefix and key are simply concatenated. If no value corresponding to this Key,
	//empty slice and false should be returned.
	RawGet(prefix string, key string) ([]byte, bool)
	// RawDelete delete a value in DB. prefix and key are simply concatenated. Return true if value is correctly deleted.
	RawDelete(prefix string, key string) bool
	// RawIterKey iterate in DB when prefix match with Key.
	//The action it called for each Key and the key is truncated with the prefix given.
	//The stop boolean defined if iteration should be stopped. No values are prefetched with this iterator.
	RawIterKey(prefix string, action func(key string) (stop bool))
	// RawIterKV iterate in DB when prefix match with Key.
	//The action it called for each Key and the key is truncated with the prefix given.
	//The stop boolean defined if iteration should be stopped. value is the corresponding value of the key.
	RawIterKV(prefix string, action func(key string, value []byte) (stop bool))

	// Insert create a new entry in storage with IObject passed. TableName is inferred with the IObject.
	Insert(object IObject) string
	// Set write a value for a specific id. TableName is inferred with the IObject. If Key not exist, an error is returned.
	Set(id string, object IObject) error
	SetWrp(objWrp ObjWrapper[IObject]) error
	// Get retrieve the value for corresponding TableName and ID. Return nil if nothing found.
	Get(tableName string, id string) *IObject
	// Update retrieve the value for corresponding TableName and ID, call the editor et Set the resulted value.
	Update(tableName string, id string, editor func(value IObject) IObject) *IObject
	// Delete remove the value for corresponding TableName and ID. If Key not exist,
	//an error is returned. The link using the object will be also deleted.
	Delete(tableName string, id string) error
	// DeepDelete remove the value for corresponding TableName and ID. If Key not exist,
	//an error is returned. It also recursively remove all values connected with a link.
	DeepDelete(tableName string, id string) error
	// Exist return true if the for corresponding TableName and ID exist in DB.
	Exist(tableName string, id string) bool

	// Count return the count for matching Key prefixed by TableName that exist in DB.
	Count(tableName string) int
	// Foreach call the do function for each value whose key is prefixed by TableName.
	Foreach(tableName string, do func(id string, value *IObject))
	// FindFirst iterate on values of tableName and apply the predicate: if predicate is true the
	//value is returned.
	FindFirst(tableName string, predicate func(id string, value *IObject) bool) (string, *IObject)
	// FindAll iterate on values of tableName and apply the predicate: all values matched are
	//returned.
	FindAll(tableName string, predicate func(id string, value *IObject) bool) ([]string, []*IObject)

	Print(tableName string) error
}

type ObjWrapper[T IObject] struct {
	ID    string
	Value T
	// contains filtered or unexported fields
}