fix(bundebug): change WithVerbose to accept a bool flag

uptrace · Oct 11, 2021 · b2f8b91 · b2f8b91
1 parent e621318
commit b2f8b91
Show file tree

Hide file tree

Showing 18 changed files with 24 additions and 24 deletions.
diff --git a/example/basic/main.go b/example/basic/main.go
@@ -23,7 +23,7 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	// Register models for the fixture.
 	db.RegisterModel((*User)(nil), (*Story)(nil))

diff --git a/example/belongs-to/main.go b/example/belongs-to/main.go
@@ -35,7 +35,7 @@ func main() {
 	db := bun.NewDB(sqldb, sqlitedialect.New())
 	defer db.Close()
 
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if err := createSchema(ctx, db); err != nil {
 		panic(err)

diff --git a/example/create-table-index/main.go b/example/create-table-index/main.go
@@ -37,7 +37,7 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if _, err := db.NewCreateTable().Model((*Book)(nil)).Exec(ctx); err != nil {
 		panic(err)

diff --git a/example/fixture/main.go b/example/fixture/main.go
@@ -40,7 +40,7 @@ func main() {
 	sqldb.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqldb, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	// Register models before loading fixtures.
 	db.RegisterModel((*User)(nil), (*Org)(nil))

diff --git a/example/has-many/main.go b/example/has-many/main.go
@@ -36,7 +36,7 @@ func main() {
 	db := bun.NewDB(sqldb, sqlitedialect.New())
 	defer db.Close()
 
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if err := createSchema(ctx, db); err != nil {
 		panic(err)

diff --git a/example/has-one/main.go b/example/has-one/main.go
@@ -35,7 +35,7 @@ func main() {
 	db := bun.NewDB(sqldb, sqlitedialect.New())
 	defer db.Close()
 
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if err := createSchema(ctx, db); err != nil {
 		panic(err)

diff --git a/example/many-to-many/main.go b/example/many-to-many/main.go
@@ -38,7 +38,7 @@ func main() {
 	db := bun.NewDB(sqldb, sqlitedialect.New())
 	defer db.Close()
 
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	// Register many to many model so bun can better recognize m2m relation.
 	// This should be done before you use the model for the first time.

diff --git a/example/migrate/main.go b/example/migrate/main.go
@@ -25,7 +25,7 @@ func main() {
 	}
 
 	db := bun.NewDB(sqldb, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	app := &cli.App{
 		Name: "bun",

diff --git a/example/model-hooks/main.go b/example/model-hooks/main.go
@@ -25,7 +25,7 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	// Register models for the fixture.
 	db.RegisterModel((*User)(nil), (*Story)(nil))

diff --git a/example/opentelemetry/main.go b/example/opentelemetry/main.go
@@ -31,7 +31,7 @@ func main() {
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
 	db.AddQueryHook(bunotel.NewQueryHook())
-	// db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	// db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if _, err := db.NewCreateTable().Model((*TestModel)(nil)).Exec(ctx); err != nil {
 		panic(err)

diff --git a/example/pg-faceted-search/main.go b/example/pg-faceted-search/main.go
@@ -47,7 +47,7 @@ func main() {
 	sqldb := sql.OpenDB(pgdriver.NewConnector(pgdriver.WithDSN(dsn)))
 
 	db := bun.NewDB(sqldb, pgdialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	// Register models for the fixture.
 	db.RegisterModel((*Book)(nil))

diff --git a/example/placeholders/main.go b/example/placeholders/main.go
@@ -27,7 +27,7 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	var tableName, tableAlias, pks, tablePKs, columns, tableColumns string
 

diff --git a/example/trivial/mysql/main.go b/example/trivial/mysql/main.go
@@ -24,7 +24,7 @@ func main() {
 	db := bun.NewDB(sqldb, mysqldialect.New())
 
 	// Print all queries to stdout.
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	var rnd float64
 

diff --git a/example/trivial/postgres/main.go b/example/trivial/postgres/main.go
@@ -22,7 +22,7 @@ func main() {
 	db := bun.NewDB(pgdb, pgdialect.New())
 
 	// Print all queries to stdout.
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	var rnd float64
 

diff --git a/example/trivial/sqlite/main.go b/example/trivial/sqlite/main.go
@@ -24,7 +24,7 @@ func main() {
 	db := bun.NewDB(sqlite, sqlitedialect.New())
 
 	// Print all queries to stdout.
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	var rnd int64
 

diff --git a/example/tx-composition/main.go b/example/tx-composition/main.go
@@ -20,7 +20,7 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 
 	if err := db.ResetModel(ctx, (*User)(nil), (*Profile)(nil)); err != nil {
 		panic(err)

diff --git a/extra/bundebug/debug.go b/extra/bundebug/debug.go
@@ -14,9 +14,9 @@ import (
 
 type ConfigOption func(*QueryHook)
 
-func WithVerbose() ConfigOption {
+func WithVerbose(on bool) ConfigOption {
 	return func(h *QueryHook) {
-		h.verbose = true
+		h.verbose = on
 	}
 }
 

diff --git a/internal/dbtest/db_test.go b/internal/dbtest/db_test.go
@@ -63,7 +63,7 @@ func pg(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=pg>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db
@@ -85,7 +85,7 @@ func pgx(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=pg>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db
@@ -107,7 +107,7 @@ func mysql8(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=mysql>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db
@@ -129,7 +129,7 @@ func mysql5(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=mysql>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db
@@ -151,7 +151,7 @@ func mariadb(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=mysql>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db
@@ -168,7 +168,7 @@ func sqlite(tb testing.TB) *bun.DB {
 	require.Equal(tb, "DB<dialect=sqlite>", db.String())
 
 	if _, ok := os.LookupEnv("DEBUG"); ok {
-		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose()))
+		db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
 	}
 
 	return db