docs: update samples for HOW-TO GUIDES (#1953)

d-tsuji · web-flow · commit c4ceb0ed4ee7 · 2023-01-17T10:53:06.000-08:00
diff --git a/docs/howto/delete.md b/docs/howto/delete.md
@@ -19,7 +19,7 @@ import (
 )
 
 type DBTX interface {
-	ExecContext(context.Context, string, ...interface{}) error
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
 }
 
 func New(db DBTX) *Queries {
diff --git a/docs/howto/insert.md b/docs/howto/insert.md
@@ -19,7 +19,7 @@ import (
 )
 
 type DBTX interface {
-	ExecContext(context.Context, string, ...interface{}) error
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
 }
 
 func New(db DBTX) *Queries {
@@ -79,8 +79,8 @@ type Author struct {
 }
 
 type DBTX interface {
-	ExecContext(context.Context, string, ...interface{}) error
-	QueryRowContext(context.Context, string, ...interface{}) error
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
+	QueryRowContext(context.Context, string, ...interface{}) *sql.Row
 }
 
 func New(db DBTX) *Queries {
diff --git a/docs/howto/prepared_query.md b/docs/howto/prepared_query.md
@@ -19,10 +19,11 @@ package db
 import (
 	"context"
 	"database/sql"
+	"fmt"
 )
 
 type Record struct {
-	ID int
+	ID int32
 }
 
 type DBTX interface {
@@ -38,7 +39,7 @@ func Prepare(ctx context.Context, db DBTX) (*Queries, error) {
 	q := Queries{db: db}
 	var err error
 	if q.getRecordStmt, err = db.PrepareContext(ctx, getRecord); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("error preparing query GetRecord: %w", err)
 	}
 	return &q, nil
 }
@@ -73,11 +74,10 @@ SELECT id FROM records
 WHERE id = $1
 `
 
-func (q *Queries) GetRecord(ctx context.Context, id int) (Record, error) {
+func (q *Queries) GetRecord(ctx context.Context, id int32) (int32, error) {
 	row := q.queryRow(ctx, q.getRecordStmt, getRecord, id)
-	var i Record
-	err := row.Scan(&i.ID)
-	return i, err
+	err := row.Scan(&id)
+	return id, err
 }
 ```
 
diff --git a/docs/howto/update.md b/docs/howto/update.md
@@ -26,7 +26,7 @@ import (
 )
 
 type DBTX interface {
-	ExecContext(context.Context, string, ...interface{}) error
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
 }
 
 func New(db DBTX) *Queries {
@@ -52,6 +52,12 @@ func (q *Queries) UpdateAuthorBios(ctx context.Context, bio string) error {
 If your query has more than one parameter, your Go method will accept a
 `Params` struct.
 
+```sql
+-- name: UpdateAuthor :exec
+UPDATE authors SET bio = $2
+WHERE id = $1;
+```
+
 ```go
 package db
 
@@ -61,7 +67,7 @@ import (
 )
 
 type DBTX interface {
-	ExecContext(context.Context, string, ...interface{}) error
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
 }
 
 func New(db DBTX) *Queries {

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ import (`
`19`	`19`	`)`
`20`	`20`
`21`	`21`	`type DBTX interface {`
`22`		`- ExecContext(context.Context, string, ...interface{}) error`
	`22`	`+ ExecContext(context.Context, string, ...interface{}) (sql.Result, error)`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`func New(db DBTX) *Queries {`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,11 @@ package db`
`19`	`19`	`import (`
`20`	`20`	`"context"`
`21`	`21`	`"database/sql"`
	`22`	`+ "fmt"`
`22`	`23`	`)`
`23`	`24`
`24`	`25`	`type Record struct {`
`25`		`- ID int`
	`26`	`+ ID int32`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`type DBTX interface {`
`@@ -38,7 +39,7 @@ func Prepare(ctx context.Context, db DBTX) (*Queries, error) {`
`38`	`39`	`q := Queries{db: db}`
`39`	`40`	`var err error`
`40`	`41`	`if q.getRecordStmt, err = db.PrepareContext(ctx, getRecord); err != nil {`
`41`		`- return nil, err`
	`42`	`+ return nil, fmt.Errorf("error preparing query GetRecord: %w", err)`
`42`	`43`	`}`
`43`	`44`	`return &q, nil`
`44`	`45`	`}`
`@@ -73,11 +74,10 @@ SELECT id FROM records`
`73`	`74`	`WHERE id = $1`
`74`	`75`	`
`75`	`76`
`76`		`-func (q *Queries) GetRecord(ctx context.Context, id int) (Record, error) {`
	`77`	`+func (q *Queries) GetRecord(ctx context.Context, id int32) (int32, error) {`
`77`	`78`	`row := q.queryRow(ctx, q.getRecordStmt, getRecord, id)`
`78`		`- var i Record`
`79`		`- err := row.Scan(&i.ID)`
`80`		`- return i, err`
	`79`	`+ err := row.Scan(&id)`
	`80`	`+ return id, err`
`81`	`81`	`}`
`82`	`82`	```
`83`	`83`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`type DBTX interface {`
`29`		`- ExecContext(context.Context, string, ...interface{}) error`
	`29`	`+ ExecContext(context.Context, string, ...interface{}) (sql.Result, error)`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func New(db DBTX) *Queries {`
`@@ -52,6 +52,12 @@ func (q *Queries) UpdateAuthorBios(ctx context.Context, bio string) error {`
`52`	`52`	`If your query has more than one parameter, your Go method will accept a`
`53`	`53`	`Params` struct.
`54`	`54`
	`55`	+```sql
	`56`	`+-- name: UpdateAuthor :exec`
	`57`	`+UPDATE authors SET bio = $2`
	`58`	`+WHERE id = $1;`
	`59`	+```
	`60`	`+`
`55`	`61`	```go
`56`	`62`	`package db`
`57`	`63`
`@@ -61,7 +67,7 @@ import (`
`61`	`67`	`)`
`62`	`68`
`63`	`69`	`type DBTX interface {`
`64`		`- ExecContext(context.Context, string, ...interface{}) error`
	`70`	`+ ExecContext(context.Context, string, ...interface{}) (sql.Result, error)`
`65`	`71`	`}`
`66`	`72`
`67`	`73`	`func New(db DBTX) *Queries {`