pgAdmin 4 Documentation

The LLM integration is structured into several layers:

• Abstraction Layer: client.py provides a unified interface for different LLM providers.
• Report Generation System (reports/):
  • generator.py: Core logic for generating reports.
  • security.py: Prompts and logic for security analysis.
  • performance.py: Prompts and logic for performance analysis.
  • design.py: Prompts and logic for design reviews.
• API Layer: views.py contains Flask endpoints for managing reports and chat.
• UI Layer: static/js/AIReport.jsx is the React component used to display reports with dark mode support.

The Master Password is used to secure and unlock saved server passwords.

• Desktop Mode (v7.2+): pgAdmin 4 uses the operating system password store by default, meaning a Master Password is typically not required.
• Server Mode: A Master Password is required if the authentication source includes OAuth2, Kerberos, or Webserver.
• Encryption: Saved passwords in the SQLite DB or External Database are encrypted/decrypted using the Master Password. The password itself is never stored on physical storage; it is held in application memory and must be re-entered whenever the application or server is restarted.
• First Use: You are prompted to set a Master Password the first time you open the application after starting it.

pgAdmin 4 can be deployed in three primary modes depending on your requirements:

• Server Deployment: Deployed behind a webserver or via a WSGI interface. In this mode, you will be prompted to provide a role name and password upon initial connection. The first registered role becomes the administrative user, capable of managing other accounts via the User Management dialog. Server definitions are displayed based on the authenticated login role.
• Desktop Deployment: Uses a desktop runtime environment to host the program on a supported platform. This is typically used via pre-built packages.
• Container Deployment: A pre-configured version of Server Mode optimized for security within containers.

Expand the Graphs node in Preferences to customize graph visualizations:

• Chart line width: Specify the width of the lines on the line chart.
• Show graph data points?: If True, data points are visible on graph lines.
• Show mouse hover tooltip?: If True, a tooltip appears on mouse hover showing data point details.
• Use different data point styles?: If True, uses different styles for data points on each graph line.

A Yum repository can be created by organizing RPMs into a specific directory structure and running the createrepo tool.

Directory Structure Example:

<root>
  redhat/
    rhel-7-x86_64/
      pgadmin4-4.21-1.el7.noarch.rpm
      ...
    rhel-8-x86_64/
      ...
  fedora/
    ...
  pgadmin4-fedora-repo-1-1.noarch.rpm
  pgadmin4-redhat-repo-1-1.noarch.rpm
  README

Generate Metadata: Run createrepo for each platform/architecture directory:

/usr/bin/createrepo <root>/redhat/rhel-7-x86_64
/usr/bin/createrepo <root>/redhat/rhel-8-x86_64

In the Definition tab, specify the core characteristics of the function:

• Return type:
  • Select trigger for DML triggers.
  • Select event_trigger for DDL triggers.
• Language: Select the implementation language (default is plpgsql).

Before building or running pgAdmin 4, ensure the following are installed:

1. Node.js 20 or above
2. yarn
3. Python 3.9 or above
4. PostgreSQL server

To add the yarn binary to your PATH using Corepack, run:

corepack enable

Within the PGD Replication Server Node dialog, you can perform the following actions using the available buttons:

• Info (i): Access online help for the current context.
• Save: Save any changes made to the configuration.
• Close: Exit the dialog without saving changes.
• Reset: Restore configuration parameters to their original values.

Be aware of the security context in which pgAgent tasks execute:

• SQL Steps: These run with the privileges of the user that pgAgent uses to connect to the database.
• Batch/Shell Scripts: These run with the privileges of the operating system user running the pgAgent service or daemon.
• Access Control: Because jobs can execute powerful commands, restrict who can create or modify jobs. By default, only the user who created the pgAgent database objects (typically the PostgreSQL superuser) can manage them.

To build the pgAdmin RPM packages, run either the make redhat command from the top-level source directory or execute the build.sh script. The resulting .rpm files will be located in the dist/ directory.

Generated packages include:

• pgadmin4-<version>.<distro>_noarch.rpm: A convenience package that depends on all others.
• pgadmin4-server-<version>.<distro>.<arch>.rpm: The core server (Python, JS code, and online documentation).
• pgadmin4-desktop-<version>.<distro>.<arch>.rpm: The desktop runtime (requires the server package).
• pgadmin4-web-<version>.<distro>.<arch>.rpm: The server mode setup script for Apache HTTPD (requires the server package).

$ make redhat
# OR
$ pkg/redhat/build.sh

Before building Debian or Ubuntu packages, you must install the required system dependencies by running the setup.sh script as root.

Note: This script must be executed with root privileges.