Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

fix: support pgbouncer transaction mode for Postgres (#20336)

p0ny8eef71a838de
diff --git a/backend/plugin/db/pg/pg.go b/backend/plugin/db/pg/pg.go
index d8396853b7..0960027398 100644
--- a/backend/plugin/db/pg/pg.go
+++ b/backend/plugin/db/pg/pg.go
@@ -214,6 +214,16 @@ func getPGConnectionConfig(config db.ConnectionConfig) (*pgx.ConnConfig, error)
util.ApplyPGTLSConfig(tlscfg, connConfig.Host, connConfig.Fallbacks)
}
+ // Apply pgbouncer-safe defaults unless the user has explicitly configured
+ // them via ExtraConnectionParameters (preserves escape hatches such as
+ // default_query_exec_mode=simple_protocol for non-PostgreSQL-compatible proxies).
+ extraParams := config.DataSource.GetExtraConnectionParameters()
+ if _, ok := extraParams["default_query_exec_mode"]; !ok {
+ connConfig.DefaultQueryExecMode = pgx.QueryExecModeExec
+ }
+ if _, ok := extraParams["statement_cache_capacity"]; !ok {
+ connConfig.StatementCacheCapacity = 0
+ }
return connConfig, nil
}
@@ -250,7 +260,13 @@ func getRDSConnectionConfig(ctx context.Context, conf db.ConnectionConfig) (*pgx
dsn := fmt.Sprintf("host=%s port=%s user=%s password=%s",
conf.DataSource.Host, conf.DataSource.Port, conf.DataSource.Username, password,
)
- return pgx.ParseConfig(dsn)
+ config, err := pgx.ParseConfig(dsn)
+ if err != nil {
+ return nil, err
+ }
+ config.DefaultQueryExecMode = pgx.QueryExecModeExec
+ config.StatementCacheCapacity = 0
+ return config, nil
}
// getCloudSQLConnectionConfig returns config for Cloud SQL connector.
@@ -272,6 +288,8 @@ func getCloudSQLConnectionConfig(ctx context.Context, conf db.ConnectionConfig)
return d.Dial(ctx, conf.DataSource.Host)
}
+ config.DefaultQueryExecMode = pgx.QueryExecModeExec
+ config.StatementCacheCapacity = 0
return config, nil
}
diff --git a/backend/plugin/db/pg/pg_test.go b/backend/plugin/db/pg/pg_test.go
index fe4a33f7dd..7f9735c9f6 100644
--- a/backend/plugin/db/pg/pg_test.go
+++ b/backend/plugin/db/pg/pg_test.go
@@ -10,6 +10,7 @@ import (
"testing"
"time"
+ "github.com/jackc/pgx/v5"
"github.com/stretchr/testify/require"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -60,6 +61,42 @@ func TestGetDatabaseInCreateDatabaseStatement(t *testing.T) {
}
}
+func TestGetPGConnectionConfigUsesPgBouncerCompatibleQueryMode(t *testing.T) {
+ connConfig, err := getPGConnectionConfig(db.ConnectionConfig{
+ DataSource: &storepb.DataSource{
+ Username: "dba",
+ Host: "pgbouncer.example.com",
+ Port: "6432",
+ },
+ ConnectionContext: db.ConnectionContext{
+ DatabaseName: "postgres",
+ },
+ })
+ require.NoError(t, err)
+ require.Equal(t, pgx.QueryExecModeExec, connConfig.DefaultQueryExecMode)
+ require.Zero(t, connConfig.StatementCacheCapacity)
+}
+
+func TestGetPGConnectionConfigPreservesExplicitQueryExecMode(t *testing.T) {
+ connConfig, err := getPGConnectionConfig(db.ConnectionConfig{
+ DataSource: &storepb.DataSource{
+ Username: "dba",
+ Host: "proxy.example.com",
+ Port: "6432",
+ ExtraConnectionParameters: map[string]string{
+ "default_query_exec_mode": "simple_protocol",
+ "statement_cache_capacity": "128",
+ },
+ },
+ ConnectionContext: db.ConnectionContext{
+ DatabaseName: "postgres",
+ },
+ })
+ require.NoError(t, err)
+ require.Equal(t, pgx.QueryExecModeSimpleProtocol, connConfig.DefaultQueryExecMode)
+ require.Equal(t, 128, connConfig.StatementCacheCapacity)
+}
+
func TestGetPGConnectionConfigDisablesTLSVerificationForAllHosts(t *testing.T) {
connConfig, err := getPGConnectionConfig(db.ConnectionConfig{
DataSource: &storepb.DataSource{