Customizable LogSQLFunc

db.go

@@ -38,6 +38,11 @@ type (
 	// while result and err refer to the result of the execution.
 	ExecLogFunc func(ctx context.Context, t time.Duration, sql string, result sql.Result, err error)
 
+	// LogSQLFunc returns the SQL statement for the given query with parameters being replaced with the actual values.
+	// It is called once for each call to ExecLogFunc(), QueryLogFunc(), LogFunc(), & PerfFunc()
+	// The result is only for logging purpose and should not be used to execute.
+	LogSQLFunc func(q *Query) string
+
 	// BuilderFunc creates a Builder instance using the given DB instance and Executor.
 	BuilderFunc func(*DB, Executor) Builder
 
@@ -59,6 +64,11 @@ type (
 		QueryLogFunc QueryLogFunc
 		// ExecLogFunc is called each time when a SQL statement is executed.
 		ExecLogFunc ExecLogFunc
+		// LogSQLFunc returns the SQL statement for the given query with parameters being replaced with the actual values.
+		// It is called once for each call to ExecLogFunc(), QueryLogFunc(), LogFunc(), & PerfFunc()
+		// The result is only for logging purpose and should not be used to execute.
+		// DefaultLogSQLFunc() is used when this is left nil.
+		LogSQLFunc LogSQLFunc
 
 		sqlDB      *sql.DB
 		driverName string

query.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"database/sql"
 	"database/sql/driver"
+	"encoding/hex"
 	"errors"
 	"fmt"
 	"strings"
@@ -57,6 +58,8 @@ type Query struct {
 	QueryLogFunc QueryLogFunc
 	// ExecLogFunc is called each time when a SQL statement is executed.
 	ExecLogFunc ExecLogFunc
+	// LogSQLFunc is called once for each call to ExecLogFunc(), QueryLogFunc(), LogFunc(), & PerfFunc()
+	LogSQLFunc LogSQLFunc
 }
 
 // NewQuery creates a new Query with the given SQL statement.
@@ -74,6 +77,7 @@ func NewQuery(db *DB, executor Executor, sql string) *Query {
 		PerfFunc:     db.PerfFunc,
 		QueryLogFunc: db.QueryLogFunc,
 		ExecLogFunc:  db.ExecLogFunc,
+		LogSQLFunc:   db.LogSQLFunc,
 	}
 }
 
@@ -95,9 +99,18 @@ func (q *Query) WithContext(ctx context.Context) *Query {
 	return q
 }
 
-// logSQL returns the SQL statement with parameters being replaced with the actual values.
-// The result is only for logging purpose and should not be used to execute.
 func (q *Query) logSQL() string {
+
+	if q.LogSQLFunc != nil {
+		return q.LogSQLFunc(q)
+	}
+
+	return DefaultLogSQLFunc(q)
+}
+
+// DefaultLogSQLFunc() returns the SQL statement for the given query with parameters being replaced with the actual values.
+// It is called once for each call to ExecLogFunc, QueryLogFunc, LogFunc, & PerfFunc.
+func DefaultLogSQLFunc(q *Query) string {
 	s := q.sql
 	for k, v := range q.params {
 		if valuer, ok := v.(driver.Valuer); ok && valuer != nil {
@@ -116,6 +129,28 @@ func (q *Query) logSQL() string {
 	return s
 }
 
+// Bin2HexLogSQLFunc() returns the SQL statement for the given query with parameters being replaced with the actual values.
+// It differs from DefaultLogSQLFunc() only in the respect that it prints []byte values in hexadecimal.
+// It is called once for each call to ExecLogFunc, QueryLogFunc, LogFunc, & PerfFunc.
+func Bin2HexLogSQLFunc(q *Query) string {
+	s := q.sql
+	for k, v := range q.params {
+		if valuer, ok := v.(driver.Valuer); ok && valuer != nil {
+			v, _ = valuer.Value()
+		}
+		var sv string
+		if str, ok := v.(string); ok {
+			sv = "'" + strings.Replace(str, "'", "''", -1) + "'"
+		} else if bs, ok := v.([]byte); ok {
+			sv = "0x" + hex.EncodeToString(bs)
+		} else {
+			sv = fmt.Sprintf("%v", v)
+		}
+		s = strings.Replace(s, "{:"+k+"}", sv, -1)
+	}
+	return s
+}
+
 // Params returns the parameters to be bound to the SQL statement represented by this query.
 func (q *Query) Params() Params {
 	return q.params