public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: Replace xorm with sqlx (#52575)

Browse Source 
* Change of sqlstore to use sqlx

* Use sqlx in the playlist store

* Refectory of the interface

* update playlist service

* go mod tidy

* some refectory on interface

* fix kyle
This commit is contained in:
ying-jeanne
2022-08-16 13:17:14 -05:00
committed by GitHub
parent 860fd83ab4
commit 25de383540
16 changed files with 652 additions and 266 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/sqlstore/db/db.go
+2
View File
@@ -5,6 +5,7 @@ import (
"github.com/grafana/grafana/pkg/services/sqlstore"
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/services/sqlstore/session"
)
type DB interface {
@@ -12,4 +13,5 @@ type DB interface {
WithDbSession(ctx context.Context, callback sqlstore.DBTransactionFunc) error
NewSession(ctx context.Context) *sqlstore.DBSession
GetDialect() migrator.Dialect
GetSqlxSession() *session.SessionDB
}
pkg/services/sqlstore/mockstore/mockstore.go
+5
View File
@@ -7,6 +7,7 @@ import (
"github.com/grafana/grafana/pkg/services/apikey"
"github.com/grafana/grafana/pkg/services/sqlstore"
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/services/sqlstore/session"
"github.com/grafana/grafana/pkg/services/user"
)
@@ -458,3 +459,7 @@ func (m *SQLStoreMock) IsAdminOfTeams(ctx context.Context, query *models.IsAdmin
func (m *SQLStoreMock) GetAPIKeyByHash(ctx context.Context, hash string) (*apikey.APIKey, error) {
return nil, m.ExpectedError
}
func (m *SQLStoreMock) GetSqlxSession() *session.SessionDB {
return nil
}
pkg/services/sqlstore/session/session.go
+112
View File
@@ -0,0 +1,112 @@
package session
import (
"context"
"database/sql"
"fmt"
"github.com/jmoiron/sqlx"
)
type Session interface {
Get(ctx context.Context, dest interface{}, query string, args ...interface{}) error
Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
}
type SessionDB struct {
sqlxdb *sqlx.DB
}
func GetSession(sqlxdb *sqlx.DB) *SessionDB {
return &SessionDB{sqlxdb: sqlxdb}
}
func (gs *SessionDB) Get(ctx context.Context, dest interface{}, query string, args ...interface{}) error {
return gs.sqlxdb.GetContext(ctx, dest, gs.sqlxdb.Rebind(query), args...)
}
func (gs *SessionDB) Select(ctx context.Context, dest interface{}, query string, args ...interface{}) error {
return gs.sqlxdb.SelectContext(ctx, dest, gs.sqlxdb.Rebind(query), args...)
}
func (gs *SessionDB) Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
return gs.sqlxdb.ExecContext(ctx, gs.sqlxdb.Rebind(query), args...)
}
func (gs *SessionDB) driverName() string {
return gs.sqlxdb.DriverName()
}
func (gs *SessionDB) Beginx() (*SessionTx, error) {
tx, err := gs.sqlxdb.Beginx()
return &SessionTx{sqlxtx: tx}, err
}
func (gs *SessionDB) WithTransaction(ctx context.Context, callback func(*SessionTx) error) error {
tx, err := gs.Beginx()
if err != nil {
return err
}
err = callback(tx)
if err != nil {
if rbErr := tx.sqlxtx.Rollback(); rbErr != nil {
return fmt.Errorf("tx err: %v, rb err: %v", err, rbErr)
}
return err
}
return tx.sqlxtx.Commit()
}
func (gs *SessionDB) ExecWithReturningId(ctx context.Context, query string, args ...interface{}) (int64, error) {
return execWithReturningId(ctx, gs.driverName(), query, gs, args...)
}
type SessionTx struct {
sqlxtx *sqlx.Tx
}
func (gtx *SessionTx) NamedExec(ctx context.Context, query string, arg interface{}) (sql.Result, error) {
return gtx.sqlxtx.NamedExecContext(ctx, gtx.sqlxtx.Rebind(query), arg)
}
func (gtx *SessionTx) Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
return gtx.sqlxtx.ExecContext(ctx, gtx.sqlxtx.Rebind(query), args...)
}
func (gtx *SessionTx) Get(ctx context.Context, dest interface{}, query string, args ...interface{}) error {
return gtx.sqlxtx.GetContext(ctx, dest, gtx.sqlxtx.Rebind(query), args...)
}
func (gtx *SessionTx) driverName() string {
return gtx.sqlxtx.DriverName()
}
func (gtx *SessionTx) ExecWithReturningId(ctx context.Context, query string, args ...interface{}) (int64, error) {
return execWithReturningId(ctx, gtx.driverName(), query, gtx, args...)
}
func execWithReturningId(ctx context.Context, driverName string, query string, sess Session, args ...interface{}) (int64, error) {
supported := false
var id int64
if driverName == "postgres" {
query = fmt.Sprintf("%s RETURNING id", query)
supported = true
}
if supported {
err := sess.Get(ctx, &id, query, args...)
if err != nil {
return id, err
}
return id, nil
} else {
res, err := sess.Exec(ctx, query, args...)
if err != nil {
return id, err
}
id, err = res.LastInsertId()
if err != nil {
return id, err
}
}
return id, nil
}
pkg/services/sqlstore/sqlstore.go
+11 -1
View File
@@ -12,6 +12,7 @@ import (
"time"
"github.com/go-sql-driver/mysql"
"github.com/jmoiron/sqlx"
_ "github.com/lib/pq"
"github.com/prometheus/client_golang/prometheus"
"xorm.io/xorm"
@@ -27,6 +28,7 @@ import (
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/sqlstore/migrations"
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/services/sqlstore/session"
"github.com/grafana/grafana/pkg/services/sqlstore/sqlutil"
"github.com/grafana/grafana/pkg/services/user"
"github.com/grafana/grafana/pkg/setting"
@@ -44,6 +46,7 @@ type ContextSessionKey struct{}
type SQLStore struct {
Cfg *setting.Cfg
sqlxsession *session.SessionDB
CacheService *localcache.CacheService
bus bus.Bus
@@ -183,6 +186,13 @@ func (ss *SQLStore) Bus() bus.Bus {
return ss.bus
}
func (ss *SQLStore) GetSqlxSession() *session.SessionDB {
if ss.sqlxsession == nil {
ss.sqlxsession = session.GetSession(sqlx.NewDb(ss.engine.DB().DB, ss.GetDialect().DriverName()))
}
return ss.sqlxsession
}
func (ss *SQLStore) ensureMainOrgAndAdminUser() error {
ctx := context.Background()
err := ss.WithTransactionalDbSession(ctx, func(sess *DBSession) error {
@@ -285,7 +295,7 @@ func (ss *SQLStore) buildConnectionString() (string, error) {
cnnstr += fmt.Sprintf("&tx_isolation=%s", val)
}
if ss.Cfg.IsFeatureToggleEnabled("mysqlAnsiQuotes") {
if ss.Cfg.IsFeatureToggleEnabled("mysqlAnsiQuotes") || ss.Cfg.IsFeatureToggleEnabled("newDBLibrary") {
cnnstr += "&sql_mode='ANSI_QUOTES'"
}
pkg/services/sqlstore/sqlutil/sqlutil.go
+1 -4
View File
@@ -28,10 +28,7 @@ func MySQLTestDB() TestDB {
if port == "" {
port = "3306"
}
conn_str := fmt.Sprintf("grafana:password@tcp(%s:%s)/grafana_tests?collation=utf8mb4_unicode_ci", host, port)
if _, present := os.LookupEnv("MYSQL_ANSI_QUOTES"); present {
conn_str += "&sql_mode='ANSI_QUOTES'"
}
conn_str := fmt.Sprintf("grafana:password@tcp(%s:%s)/grafana_tests?collation=utf8mb4_unicode_ci&sql_mode='ANSI_QUOTES'", host, port)
return TestDB{
DriverName: "mysql",
ConnStr: conn_str,
pkg/services/sqlstore/store.go
+2
View File
@@ -6,6 +6,7 @@ import (
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/services/sqlstore/session"
"github.com/grafana/grafana/pkg/services/user"
)
@@ -77,4 +78,5 @@ type Store interface {
GetDBHealthQuery(ctx context.Context, query *models.GetDBHealthQuery) error
SearchOrgs(ctx context.Context, query *models.SearchOrgsQuery) error
IsAdminOfTeams(ctx context.Context, query *models.IsAdminOfTeamsQuery) error
GetSqlxSession() *session.SessionDB
}