pgx lib中的命名准备语句,它是如何工作的?

Named prepared statement in pgx lib, how does it work?

简介

database/sql

在 Go 标准 sql 库中,*Stmt 类型的方法定义如下:

func (s *Stmt) Exec(args ...interface{}) (Result, error)
func (s *Stmt) Query(args ...interface{}) (*Rows, error)

新的(未命名的)语句由以下人员准备:

func (db *DB) Prepare(query string) (*Stmt, error)
  1. 连接池是抽象的,不能直接访问
  2. 在单个连接上准备事务
  3. 如果连接在语句执行时不可用,它将在新连接上重新准备。

pgx

PreparedStatement 类型没有定义任何方法。一个新的命名准备语句由以下人员准备:

func (p *ConnPool) Prepare(name, sql string) (*PreparedStatement, error)
  1. 直接在连接池上操作
  2. 交易在池的所有连接上准备就绪
  3. 没有明确的方法来执行准备好的语句

Github comment, the author explains better the differences of architecture between pgx and database/sql. The documentation on Prepare 中还指出(强调我的):

Prepare is idempotent; i.e. it is safe to call Prepare multiple times with the same name and sql arguments. This allows a code path to Prepare and Query/Exec/PrepareEx without concern for if the statement has already been prepared.

小例子

package main

import (
    "github.com/jackc/pgx"
)

func main() {
    conf := pgx.ConnPoolConfig{
        ConnConfig: pgx.ConnConfig{
            Host:     "/run/postgresql",
            User:     "postgres",
            Database: "test",
        },
        MaxConnections: 5,
    }
    db, err := pgx.NewConnPool(conf)
    if err != nil {
        panic(err)
    }
    _, err = db.Prepare("my-query", "select ")
    if err != nil {
        panic(err)
    }
    // What to do with the prepared statement?
}

问题

  1. name 参数给我的印象是可以通过 name 调用它来执行,但是如何呢?
  2. 文档给人的印象是 Query/Exec 方法以某种方式利用了准备好的语句。但是,这些方法不采用 name 参数。它如何匹配它们?
  3. 估计是通过查询内容来匹配的。那么命名语句的意义何在?

可能的答案

这是我自己达到的程度:

  1. 没有按名称引用查询的方法(假设)
  2. conn.ExecEx()中的查询正文中完成匹配。如果还没有准备好,那就做吧:
ps, ok := c.preparedStatements[sql]
            if !ok {
                var err error
                ps, err = c.prepareEx("", sql, nil)
                if err != nil {
                    return "", err
                }
            }
  1. PosgreSQL 本身需要它来做某事(假设)。

@mkopriva 指出 sql 的文字误导了我。它在这里有双重功能。如果 sql 变量与 c.preparedStatements[sql] 映射中的键不匹配,则准备 sql 中包含的查询并将新的 *PreparedStatement 结构指定给 ps.如果它确实匹配了一个键,ps 变量将指向映射的一个条目。

如此有效,您可以执行以下操作:

package main

import (
    "fmt"

    "github.com/jackc/pgx"
)

func main() {
    conf := pgx.ConnPoolConfig{
        ConnConfig: pgx.ConnConfig{
            Host:     "/run/postgresql",
            User:     "postgres",
            Database: "test",
        },
        MaxConnections: 5,
    }
    db, err := pgx.NewConnPool(conf)
    if err != nil {
        panic(err)
    }
    if _, err := db.Prepare("my-query", "select ::int"); err != nil {
        panic(err)
    }
    row := db.QueryRow("my-query", 10)
    var i int
    if err := row.Scan(&i); err != nil {
        panic(err)
    }
    fmt.Println(i)
}