sqlhooks
在任何 database/sql 驱动上附加钩子。
sqlhooks 的目的是提供一种方法来检测你的 sql 语句,使得真正容易记录查询或测量执行时间,而无需修改你的实际代码。
安装
go get github.com/qustavo/sqlhooks/v2
要求 Go >= 1.14.x
破坏性变化
V2 不向后兼容以前的版本,如果你想获取旧版本,你可以使用 go modules 或从 gopkg.in 获取它们
go get github.com/qustavo/sqlhooks go get gopkg.in/qustavo/sqlhooks.v1
使用方法
// 这个例子显示了如何检测sql查询,以显示它们所消耗的时间 package main import ( "context" "database/sql" "fmt" "time" "github.com/qustavo/sqlhooks/v2" "github.com/mattn/go-sqlite3" ) // 钩子满足sqlhook.Hooks接口 type Hooks struct {} // 在钩子之前,将打印查询和它的args,并返回带有时间戳的上下文 func (h *Hooks) Before(ctx context.Context, query string, args ...interface{}) (context.Context, error) { fmt.Printf("> %s %q", query, args) return context.WithValue(ctx, "begin", time.Now()), nil } // After钩子将获得在Before钩子上注册的时间戳,并打印经过的时间。 func (h *Hooks) After(ctx context.Context, query string, args ...interface{}) (context.Context, error) { begin := ctx.Value("begin").(time.Time) fmt.Printf(". took: %s\n", time.Since(begin)) return ctx, nil } func main() { // First, register the wrapper sql.Register("sqlite3WithHooks", sqlhooks.Wrap(&sqlite3.SQLiteDriver{}, &Hooks{})) // Connect to the registered wrapped driver db, _ := sql.Open("sqlite3WithHooks", ":memory:") // Do you're stuff db.Exec("CREATE TABLE t (id INTEGER, text VARCHAR(16))") db.Exec("INSERT into t (text) VALUES(?), (?)", "foo", "bar") db.Query("SELECT id, text FROM t") } /* Output should look like: > CREATE TABLE t (id INTEGER, text VARCHAR(16)) []. took: 121.238µs > INSERT into t (text) VALUES(?), (?) ["foo" "bar"]. took: 36.364µs > SELECT id, text FROM t []. took: 4.653µs */
基准测试
go test -bench=. -benchmem goos: linux goarch: amd64 pkg: github.com/qustavo/sqlhooks/v2 cpu: Intel(R) Xeon(R) W-10885M CPU @ 2.40GHz BenchmarkSQLite3/Without_Hooks-16 191196 6163 ns/op 456 B/op 14 allocs/op BenchmarkSQLite3/With_Hooks-16 189997 6329 ns/op 456 B/op 14 allocs/op BenchmarkMySQL/Without_Hooks-16 13278 83462 ns/op 309 B/op 7 allocs/op BenchmarkMySQL/With_Hooks-16 13460 87331 ns/op 309 B/op 7 allocs/op BenchmarkPostgres/Without_Hooks-16 13016 91421 ns/op 401 B/op 10 allocs/op BenchmarkPostgres/With_Hooks-16 12339 94033 ns/op 401 B/op 10 allocs/op PASS ok github.com/qustavo/sqlhooks/v2 10.294s