Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dd4840b694 | ||
|
|
705a215707 | ||
|
|
7f27579050 | ||
|
|
81d7f5b9dc | ||
|
|
2974d80c11 | ||
|
|
8afcfcfc2d | ||
|
|
4f803b47a7 | ||
|
|
2bcd8a5a08 | ||
|
|
5ff6b2b148 | ||
|
|
02a97b9762 | ||
|
|
c6157bb573 | ||
|
|
98094abf3e | ||
|
|
97a3ebf3a0 | ||
|
|
f59d3e9b1b | ||
|
|
14cb20f306 |
177
dbHandler.go
177
dbHandler.go
@@ -3,6 +3,7 @@ package dbHandler
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -23,8 +24,9 @@ import (
|
|||||||
// - db: Active GORM database connection.
|
// - db: Active GORM database connection.
|
||||||
// - logger: Pointer to a custom logger instance for structured logging.
|
// - logger: Pointer to a custom logger instance for structured logging.
|
||||||
type DBHandler struct {
|
type DBHandler struct {
|
||||||
db *gorm.DB
|
db *gorm.DB
|
||||||
logger *logging.Logger
|
logger *logging.Logger
|
||||||
|
NewCreatedDB bool // indicater for new created database
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewDBHandler
|
// NewDBHandler
|
||||||
@@ -57,12 +59,34 @@ func NewDBHandler(name, path string, logger *logging.Logger) (dH *DBHandler, err
|
|||||||
if filepath.Ext(name) == "" {
|
if filepath.Ext(name) == "" {
|
||||||
name += ".db"
|
name += ".db"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if path != "" {
|
||||||
|
if _, err := os.Stat(path); err != nil {
|
||||||
|
if err := os.MkdirAll(path, 0666); err != err {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
dbPath := filepath.Join(path, name)
|
dbPath := filepath.Join(path, name)
|
||||||
|
|
||||||
|
//indicator if database exists
|
||||||
|
_, err = os.Stat(dbPath)
|
||||||
|
dH.NewCreatedDB = err != nil
|
||||||
logger.Debug("NewDBHandler", "open database "+dbPath)
|
logger.Debug("NewDBHandler", "open database "+dbPath)
|
||||||
dH.db, err = gorm.Open(sqlite.Open(dbPath), &gorm.Config{})
|
dH.db, err = gorm.Open(sqlite.Open(dbPath), &gorm.Config{})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// close DB
|
||||||
|
func (dH *DBHandler) Close() error {
|
||||||
|
sqlDB, err := dH.db.DB()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return sqlDB.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// addNewTable
|
// addNewTable
|
||||||
//
|
//
|
||||||
// Description:
|
// Description:
|
||||||
@@ -110,14 +134,21 @@ func (dH *DBHandler) AddNewColum(model any) error {
|
|||||||
//
|
//
|
||||||
// Returns:
|
// Returns:
|
||||||
// - error: Any query error or “not found” message.
|
// - error: Any query error or “not found” message.
|
||||||
func (dH *DBHandler) GetById(model any, id uint) error {
|
func (dH *DBHandler) GetById(model any, id uint, relations ...string) (err error) {
|
||||||
dH.logger.Debug("getById", "find id "+fmt.Sprint(id))
|
dH.logger.Debug("getById", "find id "+fmt.Sprint(id))
|
||||||
|
|
||||||
if id == 0 {
|
query := dH.db
|
||||||
return dH.db.Find(model).Error
|
|
||||||
|
for _, relation := range relations {
|
||||||
|
query = query.Preload(relation)
|
||||||
}
|
}
|
||||||
|
|
||||||
err := dH.db.First(model, id).Error
|
if id == 0 {
|
||||||
|
return query.Find(model).Error
|
||||||
|
}
|
||||||
|
|
||||||
|
err = query.First(model, id).Error
|
||||||
|
|
||||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||||
return fmt.Errorf("no record found for id: %v", id)
|
return fmt.Errorf("no record found for id: %v", id)
|
||||||
} else if err != nil {
|
} else if err != nil {
|
||||||
@@ -144,15 +175,20 @@ func (dH *DBHandler) GetById(model any, id uint) error {
|
|||||||
//
|
//
|
||||||
// Returns:
|
// Returns:
|
||||||
// - error: Any database query error.
|
// - error: Any database query error.
|
||||||
func (dH *DBHandler) GetByKey(model any, key string, value any, LikeSearch bool) error {
|
func (dH *DBHandler) GetByKey(model any, key string, value any, LikeSearch bool, relations ...string) error {
|
||||||
|
query := dH.db
|
||||||
|
|
||||||
|
for _, relation := range relations {
|
||||||
|
query = query.Preload(relation)
|
||||||
|
}
|
||||||
if LikeSearch {
|
if LikeSearch {
|
||||||
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
|
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
|
||||||
dH.logger.Debug("getByKey", "find like key "+key+" value "+fmt.Sprint(value))
|
dH.logger.Debug("getByKey", "find like key "+key+" value "+fmt.Sprint(value))
|
||||||
return dH.db.Where(key+" LIKE ?", value).Find(model).Error
|
return query.Where(key+" LIKE ?", value).Find(model).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
dH.logger.Debug("getByKey", "find equal key "+key+" value "+fmt.Sprint(value))
|
dH.logger.Debug("getByKey", "find equal key "+key+" value "+fmt.Sprint(value))
|
||||||
return dH.db.Find(model, key+" = ?", value).Error
|
return query.Find(model, key+" = ?", value).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
// updateValuesById
|
// updateValuesById
|
||||||
@@ -172,18 +208,27 @@ func (dH *DBHandler) GetByKey(model any, key string, value any, LikeSearch bool)
|
|||||||
//
|
//
|
||||||
// Returns:
|
// Returns:
|
||||||
// - error: If the model is invalid or query/update fails.
|
// - error: If the model is invalid or query/update fails.
|
||||||
func (dH *DBHandler) UpdateValuesById(model any, id uint) error {
|
func (dH *DBHandler) UpdateValuesById(model any, id uint, relations ...string) error {
|
||||||
dH.logger.Debug("updateValuesById", "model"+fmt.Sprint(model))
|
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
|
||||||
|
|
||||||
modelType := reflect.TypeOf(model)
|
modelType := reflect.TypeOf(model)
|
||||||
if modelType.Kind() != reflect.Ptr {
|
if modelType.Kind() != reflect.Ptr {
|
||||||
return errors.New("model must be a pointer to struct")
|
return errors.New("model must be a pointer to struct")
|
||||||
}
|
}
|
||||||
|
|
||||||
lookUpModel := reflect.New(modelType.Elem()).Interface()
|
lookUpModel := reflect.New(modelType.Elem()).Interface()
|
||||||
if err := dH.GetById(lookUpModel, id); err != nil {
|
if err := dH.GetById(lookUpModel, id, relations...); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return dH.db.Model(lookUpModel).Updates(model).Error
|
|
||||||
|
// Preload relations
|
||||||
|
query := dH.db
|
||||||
|
for _, relation := range relations {
|
||||||
|
query = query.Preload(relation)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update only provided keys
|
||||||
|
return query.Model(lookUpModel).Updates(model).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
// updateValuesByKey
|
// updateValuesByKey
|
||||||
@@ -204,7 +249,7 @@ func (dH *DBHandler) UpdateValuesById(model any, id uint) error {
|
|||||||
//
|
//
|
||||||
// Returns:
|
// Returns:
|
||||||
// - error: Any query or update error.
|
// - error: Any query or update error.
|
||||||
func (dH *DBHandler) UpdateValuesByKey(model any, key string, value any) error {
|
func (dH *DBHandler) UpdateValuesByKey(model any, key string, value any, relations ...string) error {
|
||||||
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
|
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
|
||||||
modelType := reflect.TypeOf(model)
|
modelType := reflect.TypeOf(model)
|
||||||
if modelType.Kind() != reflect.Ptr {
|
if modelType.Kind() != reflect.Ptr {
|
||||||
@@ -212,47 +257,35 @@ func (dH *DBHandler) UpdateValuesByKey(model any, key string, value any) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
lookUpModel := reflect.New(modelType.Elem()).Interface()
|
lookUpModel := reflect.New(modelType.Elem()).Interface()
|
||||||
if err := dH.GetByKey(lookUpModel, key, value, false); err != nil {
|
if err := dH.GetByKey(lookUpModel, key, value, false, relations...); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return dH.db.Model(lookUpModel).Updates(model).Error
|
|
||||||
|
query := dH.db
|
||||||
|
|
||||||
|
for _, relation := range relations {
|
||||||
|
query = query.Preload(relation)
|
||||||
|
}
|
||||||
|
return query.Model(lookUpModel).Updates(model).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
// deleteById
|
func (dH *DBHandler) DeleteById(model any, relation string, ids ...uint) error {
|
||||||
//
|
|
||||||
// Description:
|
|
||||||
//
|
|
||||||
// Deletes records by their ID(s).
|
|
||||||
//
|
|
||||||
// Behavior:
|
|
||||||
// - If the first ID == 0, all records in the table are deleted.
|
|
||||||
// - Otherwise, deletes the provided IDs.
|
|
||||||
//
|
|
||||||
// Parameters:
|
|
||||||
// - model: Model struct type representing the table.
|
|
||||||
// - id: Variadic list of IDs to delete.
|
|
||||||
//
|
|
||||||
// Returns:
|
|
||||||
// - error: Any deletion error.
|
|
||||||
func (dH *DBHandler) DeleteById(model any, ids ...uint) error {
|
|
||||||
if len(ids) == 0 {
|
if len(ids) == 0 {
|
||||||
return fmt.Errorf("no IDs provided")
|
return fmt.Errorf("no IDs provided")
|
||||||
}
|
}
|
||||||
|
|
||||||
if ids[0] == 0 {
|
if len(ids) == 1 && ids[0] == 0 {
|
||||||
dH.logger.Debug("deleteById", "delete all")
|
dH.logger.Debug("deleteById", "delete ALL records!")
|
||||||
return dH.db.Where("1 = 1").Delete(model).Error
|
return dH.db.Session(&gorm.Session{AllowGlobalUpdate: true, FullSaveAssociations: true}).
|
||||||
|
Delete(model).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
dH.logger.Debug("deleteById", "delete ids "+fmt.Sprint(ids))
|
dH.logger.Debug("deleteById", "delete ids "+fmt.Sprint(ids))
|
||||||
err := dH.Exists(model, "id", ids, false)
|
|
||||||
|
|
||||||
// Always use Model() to avoid GORM’s “limit 1” safeguard
|
if err := dH.db.Delete(model, ids).Error; err != nil {
|
||||||
if err := dH.db.Model(model).Where("id IN ?", ids).Delete(nil).Error; err != nil {
|
|
||||||
return fmt.Errorf("delete failed: %w", err)
|
return fmt.Errorf("delete failed: %w", err)
|
||||||
}
|
}
|
||||||
|
return nil
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// deleteByKey
|
// deleteByKey
|
||||||
@@ -272,7 +305,7 @@ func (dH *DBHandler) DeleteById(model any, ids ...uint) error {
|
|||||||
//
|
//
|
||||||
// Returns:
|
// Returns:
|
||||||
// - error: Any deletion error.
|
// - error: Any deletion error.
|
||||||
func (dH *DBHandler) DeleteByKey(model any, key string, value any, LikeSearch bool) error {
|
func (dH *DBHandler) DeleteByKey(model any, key string, value any, LikeSearch bool, relations ...string) error {
|
||||||
if LikeSearch {
|
if LikeSearch {
|
||||||
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
|
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
|
||||||
dH.logger.Debug("deleteByKey", "delete like key "+key+" value "+fmt.Sprint(value))
|
dH.logger.Debug("deleteByKey", "delete like key "+key+" value "+fmt.Sprint(value))
|
||||||
@@ -280,29 +313,17 @@ func (dH *DBHandler) DeleteByKey(model any, key string, value any, LikeSearch bo
|
|||||||
}
|
}
|
||||||
|
|
||||||
dH.logger.Debug("deleteByKey", "delete equal key "+key+" value "+fmt.Sprint(value))
|
dH.logger.Debug("deleteByKey", "delete equal key "+key+" value "+fmt.Sprint(value))
|
||||||
return dH.db.Where(key+" = ?", value).Delete(model).Error
|
|
||||||
|
query := dH.db
|
||||||
|
|
||||||
|
for _, relation := range relations {
|
||||||
|
query = query.Preload(relation)
|
||||||
|
}
|
||||||
|
|
||||||
|
return query.Where(key+" = ?", value).Delete(model).Error
|
||||||
}
|
}
|
||||||
|
|
||||||
// exists
|
func (dH *DBHandler) Exists(model any, key string, value any, likeSearch bool, relations ...string) (found bool) {
|
||||||
//
|
|
||||||
// Description:
|
|
||||||
//
|
|
||||||
// Checks whether a record exists matching the specified key/value filter.
|
|
||||||
//
|
|
||||||
// Behavior:
|
|
||||||
// - Performs a `First` query on the database.
|
|
||||||
// - If `LikeSearch` is true, performs a LIKE query.
|
|
||||||
// - Returns an error if the record does not exist or query fails.
|
|
||||||
//
|
|
||||||
// Parameters:
|
|
||||||
// - model: Model struct type to search.
|
|
||||||
// - key: Column name to filter by.
|
|
||||||
// - value: Value to match.
|
|
||||||
// - LikeSearch: Whether to use wildcard search.
|
|
||||||
//
|
|
||||||
// Returns:
|
|
||||||
// - error: “no record found” or DB error.
|
|
||||||
func (dH *DBHandler) Exists(model any, key string, value any, likeSearch bool) error {
|
|
||||||
var query string
|
var query string
|
||||||
var args any
|
var args any
|
||||||
|
|
||||||
@@ -313,7 +334,8 @@ func (dH *DBHandler) Exists(model any, key string, value any, likeSearch bool) e
|
|||||||
switch {
|
switch {
|
||||||
case isSlice:
|
case isSlice:
|
||||||
if val.Len() == 0 {
|
if val.Len() == 0 {
|
||||||
return fmt.Errorf("empty slice for %s", key)
|
dH.logger.Error("Exists", fmt.Sprintf("empty slice for %s", key))
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
query = fmt.Sprintf("%s IN ?", key)
|
query = fmt.Sprintf("%s IN ?", key)
|
||||||
args = value
|
args = value
|
||||||
@@ -330,15 +352,24 @@ func (dH *DBHandler) Exists(model any, key string, value any, likeSearch bool) e
|
|||||||
|
|
||||||
dH.logger.Debug("exists", "checking existence for key "+query+" value "+fmt.Sprint(args))
|
dH.logger.Debug("exists", "checking existence for key "+query+" value "+fmt.Sprint(args))
|
||||||
|
|
||||||
var count int64
|
datababase := dH.db
|
||||||
tx := dH.db.Model(model).Where(query, args).Count(&count)
|
for _, relation := range relations {
|
||||||
|
datababase = datababase.Preload(relation)
|
||||||
|
}
|
||||||
|
|
||||||
|
tx := datababase.Where(query, args).Find(model)
|
||||||
|
|
||||||
if tx.Error != nil {
|
if tx.Error != nil {
|
||||||
return fmt.Errorf("query failed: %w", tx.Error)
|
dH.logger.Error("Exists", fmt.Sprintf("query failed: %v", tx.Error))
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
|
return tx.RowsAffected > 0
|
||||||
if count == 0 {
|
}
|
||||||
return fmt.Errorf("no record found for %s %v", key, value)
|
|
||||||
}
|
func (dH *DBHandler) AddRelation(model, relation any, relationName string) error {
|
||||||
|
return dH.db.Model(model).Association(relationName).Append(relation)
|
||||||
return nil
|
}
|
||||||
|
|
||||||
|
func (dH *DBHandler) DeleteRelation(model, relation any, relationName string) error {
|
||||||
|
return dH.db.Model(model).Association(relationName).Delete(relation)
|
||||||
}
|
}
|
||||||
|
|||||||
107
db_test.go
Normal file
107
db_test.go
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
package dbHandler
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Event struct {
|
||||||
|
Id int `gorm:"primaryKey" json:"id"`
|
||||||
|
Name string `gorm:"column:name" json:"name"`
|
||||||
|
Attendees []*Member `gorm:"many2many:member_events;"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Member struct {
|
||||||
|
Id int `gorm:"primaryKey" json:"id"`
|
||||||
|
FirstName string `gorm:"column:firstName" json:"firstName,omitempty"`
|
||||||
|
LastName string `gorm:"column:lastName" json:"lastName,omitempty"`
|
||||||
|
ResponsiblePersonID *int `json:"responsiblePersonId"`
|
||||||
|
ResponsiblePerson *Member `gorm:"foreignKey:ResponsiblePersonID" json:"responsiblePerson"`
|
||||||
|
Events []*Event `gorm:"many2many:member_events;" json:"events"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDbHandler(t *testing.T) {
|
||||||
|
|
||||||
|
dbHandler, err := NewDBHandler("test.db", "test", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := dbHandler.AddNewTable(&Member{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := dbHandler.AddNewTable(&Event{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
membersIN := []*Member{{FirstName: "adrian", LastName: "zuercher"}, {FirstName: "adichild", LastName: "zuercher"}}
|
||||||
|
for _, member := range membersIN {
|
||||||
|
dbHandler.AddNewColum(member)
|
||||||
|
event := &Event{
|
||||||
|
Name: "testEvent",
|
||||||
|
}
|
||||||
|
dbHandler.AddNewColum(event)
|
||||||
|
dbHandler.AddRelation(event, member, "Attendees")
|
||||||
|
}
|
||||||
|
|
||||||
|
var members []Member
|
||||||
|
if err := dbHandler.GetById(&members, 0); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Log(members)
|
||||||
|
|
||||||
|
if err := dbHandler.GetById(&members, 0, "Events"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Log(members)
|
||||||
|
|
||||||
|
for _, member := range members {
|
||||||
|
t.Log("Member:", member.FirstName, member.LastName)
|
||||||
|
for _, event := range member.Events {
|
||||||
|
t.Log("Event:", event)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var events []Event
|
||||||
|
|
||||||
|
if err := dbHandler.GetById(&events, 0, "Attendees"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, event := range events {
|
||||||
|
t.Log("event:", event.Name)
|
||||||
|
for _, member := range event.Attendees {
|
||||||
|
t.Log("attendee:", member)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//add responsible
|
||||||
|
mem1 := &Member{}
|
||||||
|
if err := dbHandler.GetById(mem1, 2); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
mem2 := &Member{}
|
||||||
|
if err := dbHandler.GetById(mem2, 1); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
mem1.ResponsiblePerson = mem2
|
||||||
|
dbHandler.UpdateValuesById(mem1, uint(mem1.Id))
|
||||||
|
|
||||||
|
if err := dbHandler.GetById(mem1, 2); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Log(mem1)
|
||||||
|
t.Log(mem1.ResponsiblePerson)
|
||||||
|
|
||||||
|
if err := dbHandler.Close(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := os.RemoveAll("test"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user