6 Commits

Author SHA1 Message Date
Adrian Zürcher
5ff6b2b148 combine get with relation request 2025-11-19 14:10:56 +01:00
Adrian Zürcher
02a97b9762 add new functions and create folder of db path if nonexisting 2025-11-19 12:02:10 +01:00
Adrian Zürcher
c6157bb573 add new test file 2025-11-19 12:01:35 +01:00
Adrian Zürcher
98094abf3e fix delete function 2025-11-07 08:17:48 +01:00
Adrian Zürcher
97a3ebf3a0 remove refelect 2025-11-07 08:04:01 +01:00
Adrian Zürcher
f59d3e9b1b fix existing function add reflect, slow but safe 2025-11-07 08:02:19 +01:00
2 changed files with 164 additions and 39 deletions

View File

@@ -3,6 +3,7 @@ package dbHandler
import (
"errors"
"fmt"
"os"
"path/filepath"
"reflect"
"strings"
@@ -57,12 +58,30 @@ func NewDBHandler(name, path string, logger *logging.Logger) (dH *DBHandler, err
if filepath.Ext(name) == "" {
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)
logger.Debug("NewDBHandler", "open database "+dbPath)
dH.db, err = gorm.Open(sqlite.Open(dbPath), &gorm.Config{})
return
}
// close DB
func (dH *DBHandler) Close() error {
sqlDB, err := dH.db.DB()
if err != nil {
return err
}
return sqlDB.Close()
}
// addNewTable
//
// Description:
@@ -110,14 +129,22 @@ func (dH *DBHandler) AddNewColum(model any) error {
//
// Returns:
// - error: Any query error or “not found” message.
func (dH *DBHandler) GetById(model any, id uint) error {
func (dH *DBHandler) GetById(model any, relation string, id uint) (err error) {
dH.logger.Debug("getById", "find id "+fmt.Sprint(id))
if id == 0 {
if relation != "" {
return dH.db.Preload(relation).Find(model).Error
}
return dH.db.Find(model).Error
}
err := dH.db.First(model, id).Error
if relation != "" {
err = dH.db.Preload(relation).First(model, id).Error
} else {
err = dH.db.First(model, id).Error
}
if errors.Is(err, gorm.ErrRecordNotFound) {
return fmt.Errorf("no record found for id: %v", id)
} else if err != nil {
@@ -144,14 +171,20 @@ func (dH *DBHandler) GetById(model any, id uint) error {
//
// Returns:
// - error: Any database query error.
func (dH *DBHandler) GetByKey(model any, key string, value any, LikeSearch bool) error {
func (dH *DBHandler) GetByKey(model any, relation string, key string, value any, LikeSearch bool) error {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
dH.logger.Debug("getByKey", "find like key "+key+" value "+fmt.Sprint(value))
if relation != "" {
return dH.db.Preload(relation).Where(key+" LIKE ?", value).Delete(model).Error
}
return dH.db.Where(key+" LIKE ?", value).Find(model).Error
}
dH.logger.Debug("getByKey", "find equal key "+key+" value "+fmt.Sprint(value))
if relation != "" {
return dH.db.Preload(relation).Where(key+" = ?", value).Delete(model).Error
}
return dH.db.Find(model, key+" = ?", value).Error
}
@@ -172,7 +205,7 @@ func (dH *DBHandler) GetByKey(model any, key string, value any, LikeSearch bool)
//
// Returns:
// - 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, relation string, id uint) error {
dH.logger.Debug("updateValuesById", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
@@ -180,9 +213,12 @@ func (dH *DBHandler) UpdateValuesById(model any, id uint) error {
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.GetById(lookUpModel, id); err != nil {
if err := dH.GetById(lookUpModel, relation, id); err != nil {
return err
}
if relation != "" {
return dH.db.Preload(relation).Model(lookUpModel).Updates(model).Error
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
@@ -204,7 +240,7 @@ func (dH *DBHandler) UpdateValuesById(model any, id uint) error {
//
// Returns:
// - error: Any query or update error.
func (dH *DBHandler) UpdateValuesByKey(model any, key string, value any) error {
func (dH *DBHandler) UpdateValuesByKey(model any, relation string, key string, value any) error {
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
@@ -212,49 +248,32 @@ func (dH *DBHandler) UpdateValuesByKey(model any, key string, value any) error {
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.GetByKey(lookUpModel, key, value, false); err != nil {
if err := dH.GetByKey(lookUpModel, "", key, value, false); err != nil {
return err
}
if relation != "" {
return dH.db.Preload(relation).Model(lookUpModel).Updates(model).Error
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
// deleteById
//
// 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 {
return fmt.Errorf("no IDs provided")
}
if ids[0] == 0 {
dH.logger.Debug("deleteById", "delete all")
return dH.db.Where("1 = 1").Delete(model).Error
if len(ids) == 1 && ids[0] == 0 {
dH.logger.Debug("deleteById", "delete ALL records!")
return dH.db.Session(&gorm.Session{AllowGlobalUpdate: true}).
Delete(model).Error
}
dH.logger.Debug("deleteById", "delete ids "+fmt.Sprint(ids))
if !dH.Exists(model, "id", ids, false) {
return errors.New("no matching id(s) found")
}
// Always use Model() to avoid GORMs “limit 1” safeguard
if err := dH.db.Model(model).Where("id IN ?", ids).Delete(nil).Error; err != nil {
if err := dH.db.Delete(model, ids).Error; err != nil {
return fmt.Errorf("delete failed: %w", err)
}
return err
return nil
}
// deleteByKey
@@ -314,16 +333,15 @@ func (dH *DBHandler) Exists(model any, key string, value any, likeSearch bool) (
dH.logger.Debug("exists", "checking existence for key "+query+" value "+fmt.Sprint(args))
t := reflect.TypeOf(model)
if t.Kind() == reflect.Ptr {
t = t.Elem()
}
tx := dH.db.Where(query, args).Find(model)
if tx.Error != nil {
dH.logger.Error("Exists", fmt.Sprintf("query failed: %w", tx.Error))
dH.logger.Error("Exists", fmt.Sprintf("query failed: %v", tx.Error))
return false
}
return tx.RowsAffected > 0
}
func (dH *DBHandler) AddRelation(model, relation any, relationName string) error {
return dH.db.Model(model).Association(relationName).Append(relation)
}

107
db_test.go Normal file
View 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, "Events", 0); 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, "Attendees", 0); 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)
}
}