Add support for prepared statements caching.

This commit is contained in:
go-jet 2024-10-19 14:06:12 +02:00
parent 4bb9775134
commit 5f220569dd
20 changed files with 591 additions and 134 deletions

View file

@ -3,8 +3,10 @@ package mysql
import (
"context"
"database/sql"
"fmt"
"github.com/go-jet/jet/v2/mysql"
jetmysql "github.com/go-jet/jet/v2/mysql"
"github.com/go-jet/jet/v2/postgres"
"github.com/go-jet/jet/v2/stmtcache"
"github.com/go-jet/jet/v2/tests/dbconfig"
_ "github.com/go-sql-driver/mysql"
"github.com/stretchr/testify/require"
@ -15,14 +17,16 @@ import (
"testing"
)
var db *jetmysql.DB
var db *stmtcache.DB
var source string
var withStatementCaching bool
const MariaDB = "MariaDB"
func init() {
source = os.Getenv("MY_SQL_SOURCE")
withStatementCaching = os.Getenv("JET_TESTS_WITH_STMT_CACHE") == "true"
}
func sourceIsMariaDB() bool {
@ -32,21 +36,38 @@ func sourceIsMariaDB() bool {
func TestMain(m *testing.M) {
defer profile.Start().Stop()
var err error
sqlDB, err := sql.Open("mysql", dbconfig.MySQLConnectionString(sourceIsMariaDB(), ""))
if err != nil {
panic("Failed to connect to test db" + err.Error())
}
func() {
fmt.Printf("\nRunning mysql tests caching enabled: %t \n", withStatementCaching)
db = jetmysql.NewDB(sqlDB).WithStatementsCaching(true)
defer db.Close()
for i := 0; i < 2; i++ {
ret := m.Run()
if ret != 0 {
os.Exit(ret)
sqlDB, err := sql.Open("mysql", dbconfig.MySQLConnectionString(sourceIsMariaDB(), ""))
if err != nil {
panic("Failed to connect to test db" + err.Error())
}
db = stmtcache.New(sqlDB).SetCaching(withStatementCaching)
defer db.Close()
for i := 0; i < runCount(withStatementCaching); i++ {
ret := m.Run()
if ret != 0 {
fmt.Printf("\nFAIL: Running mysql tests failed, caching enabled: %t \n", withStatementCaching)
os.Exit(ret)
}
}
}()
}
func getConnectionString() string {
return dbconfig.MySQLConnectionString(sourceIsMariaDB(), "")
}
func runCount(stmtCaching bool) int {
if stmtCaching {
return 3
}
return 1
}
var loggedSQL string
@ -70,14 +91,14 @@ func init() {
})
}
func requireLogged(t *testing.T, statement postgres.Statement) {
func requireLogged(t *testing.T, statement mysql.Statement) {
query, args := statement.Sql()
require.Equal(t, loggedSQL, query)
require.Equal(t, loggedSQLArgs, args)
require.Equal(t, loggedDebugSQL, statement.DebugSql())
}
func requireQueryLogged(t *testing.T, statement postgres.Statement, rowsProcessed int64) {
func requireQueryLogged(t *testing.T, statement mysql.Statement, rowsProcessed int64) {
query, args := statement.Sql()
queryLogged, argsLogged := queryInfo.Statement.Sql()

View file

@ -0,0 +1,128 @@
package mysql
import (
"context"
"database/sql"
"github.com/go-jet/jet/v2/internal/testutils"
. "github.com/go-jet/jet/v2/mysql"
"github.com/go-jet/jet/v2/stmtcache"
"github.com/go-jet/jet/v2/tests/.gentestdata/mysql/dvds/model"
. "github.com/go-jet/jet/v2/tests/.gentestdata/mysql/dvds/table"
"github.com/stretchr/testify/require"
"testing"
)
func TestPreparedStatementCache(t *testing.T) {
sqlDB, err := sql.Open("mysql", getConnectionString())
require.NoError(t, err)
stmtCachedDB := stmtcache.New(sqlDB)
defer func(db *stmtcache.DB) {
err := db.Close()
require.NoError(t, err)
require.Equal(t, db.CacheSize(), 0)
}(stmtCachedDB)
require.True(t, stmtCachedDB.CachingEnabled())
require.Equal(t, stmtCachedDB.CacheSize(), 0)
testStatementCaching := func(cachingEnabled bool) {
stmtCachedDB.SetCaching(cachingEnabled)
require.Equal(t, stmtCachedDB.CachingEnabled(), cachingEnabled)
ctx := context.TODO()
stmt := SELECT(Actor.AllColumns).
FROM(Actor).
WHERE(Actor.ActorID.BETWEEN(Int(1), Int(10)))
query, args := stmt.Sql()
preStmt, err := stmtCachedDB.Prepare(query)
require.NoError(t, err)
preStmt2, err := stmtCachedDB.PrepareContext(ctx, query)
require.NoError(t, err)
require.Equal(t, preStmt == preStmt2, cachingEnabled)
t.Run("Exec", func(t *testing.T) {
testutils.AssertExec(t, stmt, stmtCachedDB)
testutils.AssertExecContext(t, stmt, ctx, stmtCachedDB)
_, err := stmtCachedDB.Exec(query, args...)
require.NoError(t, err)
})
t.Run("Query", func(t *testing.T) {
var dest []model.Actor
err := stmt.Query(stmtCachedDB, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
rows, err := stmtCachedDB.Query(query, args...)
rows.Close()
require.NoError(t, err)
t.Run("ctx", func(t *testing.T) {
var dest []model.Actor
err := stmt.QueryContext(ctx, stmtCachedDB, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
})
})
t.Run("tx", func(t *testing.T) {
tx, err := stmtCachedDB.Begin()
require.NoError(t, err)
preStmtTx, err := tx.Prepare(query)
require.NoError(t, err)
_, err = preStmtTx.Exec(args...)
require.NoError(t, err)
preStmtTx2, err := tx.PrepareContext(ctx, query)
require.NoError(t, err)
require.Equal(t, preStmtTx == preStmtTx2, cachingEnabled)
_, err = preStmtTx2.ExecContext(ctx, args...)
require.NoError(t, err)
t.Run("Exec", func(t *testing.T) {
testutils.AssertExec(t, stmt, tx)
testutils.AssertExecContext(t, stmt, ctx, tx)
_, err := tx.Exec(query, args...)
require.NoError(t, err)
})
t.Run("Query", func(t *testing.T) {
var dest []model.Actor
err = stmt.QueryContext(ctx, tx, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
rows, err := tx.Query(query, args...)
require.NoError(t, err)
require.NoError(t, rows.Close())
})
t.Run("new tx", func(t *testing.T) {
txCtx, err := stmtCachedDB.BeginTx(ctx, nil)
require.NoError(t, err)
preStmtTxCtx, err := txCtx.PrepareContext(ctx, query)
require.NoError(t, err)
require.NotEqual(t, preStmtTx, preStmtTxCtx)
require.NoError(t, txCtx.Rollback())
})
require.NoError(t, tx.Commit())
})
}
testStatementCaching(true)
require.Equal(t, stmtCachedDB.CacheSize(), 1)
testStatementCaching(false)
require.Equal(t, stmtCachedDB.CacheSize(), 1)
require.NoError(t, stmtCachedDB.ClearCache())
require.Equal(t, stmtCachedDB.CacheSize(), 0)
}