pgxpool.ConnectConfig未声明编译报错问题及解决方案

问题现象 #

编译代码时触发错误：ConnectConfig not declared by package pgxpool，相关代码片段如下：

package main

import (
    "context"
    "fmt"
    "time"
    "github.com/gin-gonic/gin"
    "github.com/jackc/pgx/v5/pgxpool"
)

// 省略其他代码
func NewConPool() pgxpool.Config {
    c, err := pgxpool.ParseConfig(config.GetString("pgx.constr"))
    if err != nil {
        panic(fmt.Errorf("database configuration could not be read, %w", err))
    }
    c.MaxConns = config.GetInt32("pgxpool.maxConns")
    c.MinConns = config.GetInt32("pgxpool.minConns")
    c.MaxConnLifetime = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.maxConnLifetimeSec"))
    c.MaxConnIdleTime = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.maxConnIdleTimeSec"))
    c.HealthCheckPeriod = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.healthCheckPeriodSec"))
    c.ConnConfig.ConnectTimeout = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.connectTimeoutSec"))
    pool, err := pgxpool.ConnectConfig(context.Background(), c)  // 错误行
    return *pool
}

问题原因 #

你参考的是pgx v4版本的文档，但当前使用的是pgx v5版本——v5对pgxpool的API做了调整，原v4中的ConnectConfig函数已被替换为NewWithConfig。

修正方案 #

将pgxpool.ConnectConfig替换为pgxpool.NewWithConfig，同时修正函数返回值类型错误：原函数声明返回pgxpool.Config，但实际要返回连接池实例*pgxpool.Pool。修正后的代码如下：

func NewConPool() *pgxpool.Pool {
    c, err := pgxpool.ParseConfig(config.GetString("pgx.constr"))
    if err != nil {
        panic(fmt.Errorf("database configuration could not be read, %w", err))
    }
    c.MaxConns = config.GetInt32("pgxpool.maxConns")
    c.MinConns = config.GetInt32("pgxpool.minConns")
    c.MaxConnLifetime = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.maxConnLifetimeSec"))
    c.MaxConnIdleTime = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.maxConnIdleTimeSec"))
    c.HealthCheckPeriod = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.healthCheckPeriodSec"))
    c.ConnConfig.ConnectTimeout = time.Duration(int32(time.Second) * config.GetInt32("pgxpool.connectTimeoutSec"))
    // 替换为NewWithConfig
    pool, err := pgxpool.NewWithConfig(context.Background(), c)
    if err != nil {
        panic(fmt.Errorf("failed to create connection pool, %w", err))
    }
    return pool
}

pgx v5连接池创建说明（官方文档翻译） #

创建连接池最灵活的方式是使用NewWithConfig：

1. 调用ParseConfig解析数据库连接字符串，得到pgxpool.Config结构体；
2. 根据需求修改配置参数（如最大连接数、连接生命周期等）；
3. 将上下文和配置传入NewWithConfig，获取连接池实例。

内容的提问来源于stack exchange，提问作者Mehmet