如何使sqlc生成适用于pgxpool的代码

Golang小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《如何使sqlc生成适用于pgxpool的代码》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

我最近开始使用 sqlc 和 jackc/pgx/v5。我也希望能够使用 pgxpool ，但是在 sqlc 接管流程后，确实没有什么好的方法来使用 pgxpool 。例如，这就是我初始化连接池的方式：

var err error
var pool *pgxpool.pool
if pool, err = pgxpool.new(context.background(), url); err != nil {
    log.panicf(...)
}
defer pool.close()

queries := db.new(pool) // queries *queries

基本上，我只是在需要数据库交互时使 queries 对整个应用程序可用，但我不会传递 pool。

此外，由于 sqlc 自动管理连接，我不确定使用类似以下代码片段的含义，因为涉及很多手动步骤并且有些重叠：

ctx := context.Background()

conn, _ := pool.Acquire(ctx)
tx, _ := conn.Begin(ctx)
defer tx.Rollback(ctx)

queries := db.New(pool)
queries.WithTx(tx).OneOfTheAutogeneratedQueries(ctx)

defer conn.Release()
tx.Commit(ctx)

有人有同样的情况吗？有更好的方法来解决这个问题吗？我假设 sqlc 自动生成的代码将提供一种相应的管理事务的机制，但看起来除了以编程方式关闭资源之外，仍然需要池的引用才能创建 pgx.tx 类型也是如此。

正确答案

当您使用 sqlc 时，它通常会生成一个接口，该接口抽象出底层驱动程序级数据库连接或连接池。该接口默认命名为dbtx

type dbtx interface {
    exec(context.context, string, ...interface{}) (pgconn.commandtag, error)
    query(context.context, string, ...interface{}) (pgx.rows, error)
    queryrow(context.context, string, ...interface{}) pgx.row
}

func new(db dbtx) *queries {
    return &queries{db: db}
}

type queries struct {
    db dbtx
}

func (q *queries) withtx(tx pgx.tx) *queries {
    return &queries{
        db: tx,
    }
}

这里需要注意一些事情

1. pgxpool.pool 和 pgxpool.conn 实现 dbtx 接口
2. pgx.tx 还实现了 dbtx 接口
3. 查询结构采用 dbtx 接口，这是为了抽象您可能对数据库连接或事务执行的操作

现在，如果您希望手动管理数据库连接，您可以在 sqlc.yaml 文件中将 emit_methods_with_db_argument 选项设置为 true。当您这样做时，生成的代码将如下所示

// db.go
type dbtx interface {
    exec(context.context, string, ...interface{}) (pgconn.commandtag, error)
    query(context.context, string, ...interface{}) (pgx.rows, error)
    queryrow(context.context, string, ...interface{}) pgx.row
}

func new() *queries {
    return &queries{}
}

type queries struct {
}

现在查询方法将具有以下签名

func (q *queries) createauthor(ctx context.context, db dbtx, arg createauthorparams) (author, error) {
    row := db.queryrow(ctx, createauthor, arg.name, arg.bio)
    // ...
}

请注意生成的查询方法如何接受 dbtx 作为第二个参数。您可以在此处传递单个连接、连接池甚至事务

基本上，我只是在需要数据库交互时使 queries 对整个应用程序可用，但我不会传递池。

我不确定我是否正确理解你的问题，但我们可以通过简单的依赖注入来实现这一点。您可以定义一个代表您的 api 或 app 的结构，如下所示

type app struct {
    queries *db.queries
    pool    *pgxpool.pool
    // other fields such as cache, logger, etc.

}

func newapp(pool *pgxpool.pool) *app {
    return &app{
        queries: db.new(),
        pool:    pool,
    }
}

然后，在您的主目录或初始化应用程序的任何位置：

func main() {
    pool, err := pgxpool.connect(context.background(), connectionstring)
    if err != nil {
        log.fatalf("unable to connect to database: %v", err)
    }
    defer pool.close()

    app := newapp(pool)
// rest of your application
}

现在您可以像这样执行交易

func (app *app) addbookandupdateauthorearningshandler(w http.responsewriter, r *http.request) {
    ctx := r.context()

    tx, err := app.pool.begin(ctx)
    if err != nil {
        http.error(w, "failed to begin transaction", http.statusinternalservererror)
        return
    }
    defer tx.rollback(ctx)

    book, err = app.queries.createbook(ctx, tx, newbook)
    // handle error

    err = app.queries.updateauthorearnings(ctx, tx, updateearningsparams)
    // handle error 

    err = tx.commit(ctx)
    // handle error 

    w.write([]byte("book added and author earnings updated successfully"))
}

您将对单个查询执行相同的操作，而不是启动事务，您只需获取一个连接并将其作为 dbtx 传递。

话虽这么说，你不一定需要这样做，exec、query 和 queryrow 将从连接池获取连接并在最后释放它。不使用 emit_methods_with_db_argument 我们可以像这样进行事务

package db


func (q *queries) addbookandupdateauthorearningstx(ctx context.context, author author, book book) error {
    // start a transaction
    // the underlying type of db (dbtx) is *pgxpool.pool
    tx, err := q.db.(*pgxpool.pool).begin(ctx)
    if err != nil {
        return err
    }
    defer tx.rollback(ctx)
    tq := q.withtx(tx)
    // ... (rest of the transaction remains the same)
    // (it's important to use `tq` not `q` to execute transaction queries
    err = tx.commit(ctx)
    if err != nil {
        return err
    }

    return nil
}

使用它，您的应用程序结构只需要包含对 queries 结构的引用

type App struct {
    Queries *db.Queries
    // Other fields such as Cache, Logger, etc.

}

func NewApp(pool *pgxpool.Pool) *App {
    return &App{
        Queries: db.New(pool),
    }
}

以上就是《如何使sqlc生成适用于pgxpool的代码》的详细内容，更多关于的资料请关注golang学习网公众号！