Allow adding and connecting the server using pgbouncer database aliases.#3564

Author: yogeshmahajan-1903

web/migrations/versions/320114f59d9c_.py

@@ -0,0 +1,36 @@
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2025, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+
+"""Update DB to version 43
+
+Add new column 'db_alias' to server table.
+
+Revision ID: 320114f59d9c
+Revises: 255e2842e4d7
+Create Date: 2025-02-21 16:25:50.934530
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = '320114f59d9c'
+down_revision = '255e2842e4d7'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    with op.batch_alter_table(
+            "server", table_kwargs={'sqlite_autoincrement': True}) as batch_op:
+        batch_op.add_column(sa.Column('db_alias', sa.String(length=256), nullable=True))
+
+def downgrade():
+    # pgAdmin only upgrades, downgrade not implemented.
+    pass

web/pgadmin/browser/server_groups/servers/__init__.py

@@ -738,6 +738,7 @@ def update(self, gid, sid):
             'host': 'host',
             'port': 'port',
             'db': 'maintenance_db',
+            'db_alias': 'db_alias',
             'username': 'username',
             'gid': 'servergroup_id',
             'comment': 'comment',
@@ -767,6 +768,7 @@ def update(self, gid, sid):
             'name': gettext('name'),
             'port': gettext('Port'),
             'db': gettext('Maintenance database'),
+            'db_alias': gettext('Database Alias'),
             'username': gettext('Username'),
             'comment': gettext('Comments'),
             'role': gettext('Role')
@@ -1014,6 +1016,7 @@ def properties(self, gid, sid):
             'host': server.host,
             'port': server.port,
             'db': server.maintenance_db,
+            'db_alias': server.db_alias,
             'shared': server.shared if config.SERVER_MODE else None,
             'shared_username': server.shared_username
             if config.SERVER_MODE else None,
@@ -1141,6 +1144,7 @@ def create(self, gid):
                 host=data.get('host', None),
                 port=data.get('port'),
                 maintenance_db=data.get('db', None),
+                db_alias=data.get('db_alias', None),
                 username=data.get('username'),
                 save_password=1 if data.get('save_password', False) and
                 config.ALLOW_SAVE_PASSWORD else 0,

web/pgadmin/browser/server_groups/servers/databases/__init__.py

@@ -360,18 +360,29 @@ def get_nodes(self, gid, sid, is_schema_diff=False):
                 ['%s'] * len(server_node_res.db_res.split(','))
             )
             params = tuple(server_node_res.db_res.split(','))
-        SQL = render_template(
-            "/".join([self.template_path, self._NODES_SQL]),
-            last_system_oid=last_system_oid,
-            db_restrictions=db_disp_res,
-        )
+        # if db_alias present, server is using pg_bouncer connection,
+        # hence pass the did. It will retrieve current database
+        if server_node_res and server_node_res.db_alias:
+            SQL = render_template(
+                "/".join([self.template_path, self._NODES_SQL]),
+                last_system_oid=last_system_oid,
+                db_restrictions=db_disp_res,
+                did=server_node_res.did)
+        else:
+            SQL = render_template(
+                "/".join([self.template_path, self._NODES_SQL]),
+                last_system_oid=last_system_oid,
+                db_restrictions=db_disp_res)
         status, rset = self.conn.execute_dict(SQL, params)
 
         if not status:
             return internal_server_error(errormsg=rset)
 
         for row in rset['rows']:
-            dbname = row['name']
+            # if db_alias then update db name to alias db_alias
+            # instead of actual
+            dbname = server_node_res.db_alias if server_node_res.db_alias \
+                else row['name']
             row['is_sys_obj'] = (
                 row['did'] <= self._DATABASE_LAST_SYSTEM_OID or
                 self.datistemplate)
@@ -392,7 +403,7 @@ def get_nodes(self, gid, sid, is_schema_diff=False):
                 self.blueprint.generate_browser_node(
                     row['did'],
                     sid,
-                    row['name'],
+                    label=dbname,
                     icon=icon,
                     connected=connected,
                     tablespace=row['spcname'],

web/pgadmin/browser/server_groups/servers/static/js/server.ui.js

@@ -148,6 +148,7 @@ export default class ServerSchema extends BaseUISchema {
       host: '',
       port: 5432,
       db: 'postgres',
+      db_alias: undefined,
       username: current_user.name,
       role: null,
       connect_now: true,
@@ -315,8 +316,17 @@ export default class ServerSchema extends BaseUISchema {
         }
       },{
         id: 'db', label: gettext('Maintenance database'), type: 'text', group: gettext('Connection'),
-        mode: ['properties', 'edit', 'create'], readonly: obj.isConnected, disabled: obj.isShared,
-        noEmpty: true,
+        mode: ['properties', 'edit', 'create'], readonly: obj.isConnected,
+        disabled: function(state) {
+          return !(isEmptyString(state.db_alias) && obj.isShared);
+        },
+      },{
+        id: 'db_alias', label: gettext('Database alias'), type: 'text', group: gettext('Connection'),
+        mode: ['properties', 'edit', 'create'], readonly: obj.isConnected,
+        disabled: function(state) {
+          return !isEmptyString(state.db);
+        },
+        helpMessage: gettext('Specify the database alias to connect to the server using pg_bouncer.')
       },{
         id: 'username', label: gettext('Username'), type: 'text', group: gettext('Connection'),
         mode: ['properties', 'edit', 'create'],
@@ -545,8 +555,20 @@ export default class ServerSchema extends BaseUISchema {
       } else {
         setError('port', null);
       }
+
+      if(isEmptyString(state.db)) {
+        errmsg = gettext('Maintainence database or Database alias must be specified.');
+        if(isEmptyString(state.db_alias)) {
+          setError('db', errmsg);
+          return true;
+        } else {
+          setError('db', null);
+        }
+      } else {
+        setError('db', null);
+      }
     } else {
-      _.each(['host', 'db', 'username', 'port'], (item) => {
+      _.each(['host', 'db', 'db_alias', 'username', 'port'], (item) => {
         setError(item, null);
       });
     }

web/pgadmin/model/__init__.py

@@ -33,7 +33,7 @@
 #
 ##########################################################################
 
-SCHEMA_VERSION = 42
+SCHEMA_VERSION = 43
 
 ##########################################################################
 #
@@ -162,6 +162,7 @@ class Server(db.Model):
         db.CheckConstraint('port >= 1 AND port <= 65534'),
         nullable=False)
     maintenance_db = db.Column(db.String(64), nullable=True)
+    db_alias = db.Column(db.String(64), nullable=True)
     username = db.Column(db.String(64), nullable=False)
     password = db.Column(PgAdminDbBinaryString())
     save_password = db.Column(

web/pgadmin/utils/driver/psycopg3/server_manager.py

@@ -72,6 +72,7 @@ def update(self, server):
         self.host = server.host
         self.port = server.port
         self.db = server.maintenance_db
+        self.db_alias = server.db_alias
         self.shared = server.shared
         self.did = None
         self.user = server.username
@@ -209,7 +210,7 @@ def connection(self, **kwargs):
         else:
             conn_str = CONN_STRING.format(conn_id)
             if did is None:
-                database = self.db
+                database = self.db if self.db else self.db_alias
             elif did in self.db_info:
                 database = self.db_info[did]['datname']
             elif conn_id and conn_str in self.connections:

web/regression/javascript/schema_ui_files/server.ui.spec.js

@@ -55,6 +55,7 @@ describe('ServerSchema', ()=>{
     expect(setError).toHaveBeenCalledWith('username', 'Username must be specified.');
 
     state.username = 'postgres';
+    state.db = 'postgres';
     schemaObj.validate(state, setError);
     expect(setError).toHaveBeenCalledWith('port', 'Port must be specified.');