Compare commits

...

10 Commits

Author SHA1 Message Date
e9b12dc3f6 Add support for int64 scans (#2)
All checks were successful
Build / build (push) Successful in 4m18s
Reviewed-on: #2
2025-05-14 15:21:32 +02:00
7daf1915a5 Fix yet another pointer
All checks were successful
Build / build (push) Successful in 41s
2025-05-09 10:55:16 +02:00
029cf6ce01 Merge pull request 'Add support for pointer arguments' (#1) from add-support-for-ptr-args into master
All checks were successful
Build / build (push) Successful in 36s
Reviewed-on: #1
2025-05-09 10:23:46 +02:00
278d7ed497 Add support for pointer arguments
All checks were successful
Build / build (push) Successful in 1m13s
2025-05-09 10:18:08 +02:00
dd6be6b9b6 Return a verifiable error if no results were returned
All checks were successful
Build / build (push) Successful in 3m9s
2025-05-08 11:14:41 +02:00
12a87a8762 Do not create backups for new databases
All checks were successful
Build / build (push) Successful in 1m27s
2025-03-24 12:07:42 +01:00
87f10c73d6 Add support for array binding
All checks were successful
Build / build (push) Successful in 1m39s
2025-03-24 12:05:10 +01:00
58d63b6cf3 Fix missing error and add test 2025-03-24 11:52:28 +01:00
850e4a27d8 Backup databases before migrating
All checks were successful
Build / build (push) Successful in 1m35s
2025-03-24 06:27:05 +01:00
3e7455ef31 Add tests for delete query and transaction rollback 2025-03-22 06:33:19 +01:00
5 changed files with 192 additions and 13 deletions

View File

@ -9,6 +9,7 @@ import (
// Db holds a connection to a SQLite database.
type Db struct {
Db *sqlite.Conn
source string
lock sync.Mutex
}
@ -21,7 +22,7 @@ func OpenDb(databaseSource string) (*Db, error) {
if err != nil {
return nil, err
}
return &Db{Db: conn}, nil
return &Db{Db: conn, source: databaseSource}, nil
}
// Close closes the database.

5
errors.go Normal file
View File

@ -0,0 +1,5 @@
package mysqlite
import "errors"
var ErrNoRows = errors.New("mysqlite: no rows returned")

View File

@ -4,6 +4,7 @@ import (
"fmt"
"io/fs"
"log"
"os"
"path"
"strconv"
"strings"
@ -40,6 +41,20 @@ func (d *Db) MigrateDb(filesystem ReadDirFileFS, directory string) error {
}
log.Printf("Current version is %d, max migration version is %d", currentVersion, latestVersion)
// Create a backup if we're not on the latest version
if currentVersion != 0 && currentVersion != latestVersion && d.source != ":memory:" {
target := d.source + ".backup." + strconv.Itoa(currentVersion)
log.Printf("Creating backup of database to %s", target)
data, err := d.Db.Serialize("main")
if err != nil {
return fmt.Errorf("error serializing database: %v", err)
}
err = os.WriteFile(target, data, 0644)
if err != nil {
return fmt.Errorf("error writing backup: %v", err)
}
}
// If we are no up-to-date, bring the db up-to-date
for currentVersion != latestVersion {
targetVersion := currentVersion + 1

View File

@ -34,23 +34,51 @@ func (d *Db) query(query string) *Query {
}
func (q *Query) Bind(args ...any) *Query {
into := 0
return q.bindInto(&into, args...)
}
func (q *Query) bindInto(into *int, args ...any) *Query {
if q.err != nil || q.stmt == nil {
return q
}
for i, arg := range args {
*into++
if arg == nil {
q.stmt.BindNull(*into)
continue
}
v := reflect.ValueOf(arg)
if v.Kind() == reflect.Ptr {
if v.IsNil() {
q.stmt.BindNull(*into)
continue
}
arg = v.Elem().Interface()
}
if asString, ok := arg.(string); ok {
q.stmt.BindText(i+1, asString)
q.stmt.BindText(*into, asString)
} else if asInt, ok := arg.(int); ok {
q.stmt.BindInt64(i+1, int64(asInt))
q.stmt.BindInt64(*into, int64(asInt))
} else if asInt, ok := arg.(int64); ok {
q.stmt.BindInt64(i+1, asInt)
q.stmt.BindInt64(*into, asInt)
} else if asBool, ok := arg.(bool); ok {
q.stmt.BindBool(i+1, asBool)
q.stmt.BindBool(*into, asBool)
} else {
// Check if the argument is a slice or array of any type
v = reflect.ValueOf(arg)
if v.Kind() == reflect.Slice || v.Kind() == reflect.Array {
*into--
for i := 0; i < v.Len(); i++ {
q.bindInto(into, v.Index(i).Interface())
}
} else {
*into--
q.err = fmt.Errorf("unsupported column type %s at index %d", reflect.TypeOf(arg).Name(), i)
return q
}
}
}
return q
}
@ -100,7 +128,7 @@ func (q *Query) ScanSingle(results ...any) (rerr error) {
return err
}
if !hasResult {
return fmt.Errorf("did not return any rows")
return ErrNoRows
}
// Scan its columns
@ -138,6 +166,9 @@ type Rows struct {
}
func (q *Query) ScanMulti() (*Rows, error) {
if q.err != nil {
return nil, q.err
}
return &Rows{
query: q,
}, nil
@ -186,6 +217,8 @@ func (r *Rows) scanArgument(i int, arg any) error {
*asString = r.query.stmt.ColumnText(i)
} else if asInt, ok := arg.(*int); ok {
*asInt = r.query.stmt.ColumnInt(i)
} else if asInt, ok := arg.(*int64); ok {
*asInt = r.query.stmt.ColumnInt64(i)
} else if asBool, ok := arg.(*bool); ok {
*asBool = r.query.stmt.ColumnBool(i)
} else if reflect.TypeOf(arg).Kind() == reflect.Ptr && reflect.TypeOf(arg).Elem().Kind() == reflect.Ptr {

View File

@ -1,6 +1,7 @@
package mysqlite
import (
"errors"
"github.com/stretchr/testify/require"
"testing"
)
@ -19,6 +20,14 @@ func TestSimpleQuery(t *testing.T) {
require.Equal(t, 1, count, "expected empty count")
}
func TestSimpleQueryWithNoResults(t *testing.T) {
db := openTestDb(t)
var count int
err := db.Query("select 1 from mytable where key=999").ScanSingle(&count)
require.Equal(t, ErrNoRows, err)
require.True(t, errors.Is(err, ErrNoRows))
}
func TestSimpleQueryWithArgs(t *testing.T) {
db := openTestDb(t)
var value string
@ -85,12 +94,70 @@ func TestUpdateQuery(t *testing.T) {
}
func TestUpdateQueryWithWrongArguments(t *testing.T) {
type S struct {
Field string
}
db := openTestDb(t)
value := "ipsum"
err := db.Query("insert into mytable(key, value) values ('lorem', ?)").Bind(&value).Exec()
abc := S{
Field: "ipsum",
}
err := db.Query("insert into mytable(key, value) values ('lorem', ?)").Bind(abc).Exec()
require.Error(t, err)
}
func TestUpdateQueryWithPointerValue(t *testing.T) {
db := openTestDb(t)
func() {
tx := db.MustBegin()
defer tx.MustRollback()
tx.Query("insert into mytable(key, value) values ('lorem', 'bar')").MustExec()
value := "ipsum"
key := "lorem"
tx.Query("update mytable set value = ? where key = ?").Bind(&value, key).MustExec()
tx.MustCommit()
}()
var value string
db.Query("select value from mytable where key = 'lorem'").MustScanSingle(&value)
require.Equal(t, "ipsum", value)
}
func TestUpdateQueryWithSetPointerValue(t *testing.T) {
type S struct {
value *string
}
db := openTestDb(t)
func() {
tx := db.MustBegin()
defer tx.MustRollback()
tx.Query("insert into mytable(key, value) values ('lorem', 'bar')").MustExec()
s := S{nil}
key := "lorem"
tx.Query("update mytable set value = ? where key = ?").Bind(s.value, key).MustExec()
tx.MustCommit()
}()
var value *string
db.Query("select value from mytable where key = 'lorem'").MustScanSingle(&value)
require.Equal(t, (*string)(nil), value)
}
func TestUpdateQueryWithNullValue(t *testing.T) {
db := openTestDb(t)
func() {
tx := db.MustBegin()
defer tx.MustRollback()
tx.Query("insert into mytable(key, value) values ('lorem', 'bar')").MustExec()
key := "lorem"
tx.Query("update mytable set value = ? where key = ?").Bind(nil, key).MustExec()
tx.MustCommit()
}()
var value *string
db.Query("select value from mytable where key = 'lorem'").MustScanSingle(&value)
require.Nil(t, value)
}
func TestQueryWithPointerStringArguments(t *testing.T) {
db := openTestDb(t)
var result *string
@ -100,9 +167,18 @@ func TestQueryWithPointerStringArguments(t *testing.T) {
require.Equal(t, "bar", *result)
}
func TestQueryWithInt64Scan(t *testing.T) {
db := openTestDb(t)
var result int64
err := db.Query("select 2").ScanSingle(&result)
require.NoError(t, err)
require.NotNil(t, result)
require.Equal(t, int64(2), result)
}
func TestQueryWithPointerStringArgumentsCanSetToNull(t *testing.T) {
db := openTestDb(t)
db.Query("update mytable set value=NULL where key = 'foo'").MustExec()
db.Query("update mytable set value=null where key = 'foo'").MustExec()
myString := "some string"
var result *string
result = &myString
@ -110,3 +186,52 @@ func TestQueryWithPointerStringArgumentsCanSetToNull(t *testing.T) {
require.NoError(t, err)
require.Nil(t, result)
}
func TestDeleteQuery(t *testing.T) {
db := openTestDb(t)
db.Query("delete from mytable where key = 'foo'").MustExec()
var count int
db.Query("select count(*) from mytable where key = 'foo'").MustScanSingle(&count)
require.Equal(t, 0, count, "expected row to be deleted")
}
func TestTransactionRollback(t *testing.T) {
db := openTestDb(t)
func() {
tx := db.MustBegin()
defer tx.MustRollback()
tx.Query("update mytable set value = 'ipsum' where key = 'foo'").MustExec()
// Intentionally not committing the transaction
}()
var value string
db.Query("select value from mytable where key = 'foo'").MustScanSingle(&value)
require.Equal(t, "bar", value, "expected original value after rollback")
}
func TestQueryWithInClause(t *testing.T) {
db := openTestDb(t)
// Insert additional test rows
db.Query("insert into mytable(key, value) values ('key1', 'value1')").MustExec()
db.Query("insert into mytable(key, value) values ('key2', 'value2')").MustExec()
// Execute query with IN clause
args := []string{"foo", "key2"}
rows, err := db.Query("select key, value from mytable where key in (?, ?)").Bind(args).ScanMulti()
require.NoError(t, err)
defer rows.MustFinish()
// Check results
results := make(map[string]string)
for rows.MustNext() {
var key, value string
rows.MustScan(&key, &value)
results[key] = value
}
// Verify we got exactly the expected results
require.Equal(t, 2, len(results), "expected 2 matching rows")
require.Equal(t, "bar", results["foo"], "unexpected value for key 'foo'")
require.Equal(t, "value2", results["key2"], "unexpected value for key 'key2'")
}