Getting Started

Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible.

In a Server Deployment, the pgAdmin application is deployed behind a webserver or with the WSGI interface. If you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password when you initially connect to pgAdmin. The first role registered with pgAdmin will be an administrative user; the administrative role can use the pgAdmin User Management dialog to create and manage additional pgAdmin user accounts. When a user authenticates with pgAdmin, the pgAdmin tree control displays the server definitions associated with that login role.

In a Desktop Deployment, the pgAdmin application is configured to use the desktop runtime environment to host the program on a supported platform. Typically, users will install a pre-built package to run pgAdmin in desktop mode, but a manual desktop deployment can be installed and though it is more difficult to setup, it may be useful for developers interested in understanding how pgAdmin works.

It is also possible to use a Container Deployment of pgAdmin, in which Server Mode is pre-configured for security.

Deployment

The config.py File

Desktop Deployment

Server Deployment

Container Deployment

Login Page

Recovering a Lost Password

Avoiding a bruteforce attack

Enabling two-factor authentication (2FA)

About two-factor authentication

Setup two-factor authentication

Configure two-factor authentication

User Management Dialog

Using ‘setup.py’ command line script

Change Ownership Dialog

Change User Password Dialog

Lock/Restore Account

Enabling LDAP Authentication

Enabling Kerberos Authentication

Keytab file for HTTP Service

Apache HTTPD Configuration

Browser settings to configure Kerberos Authentication

PostgreSQL Server settings to configure Kerberos Authentication

Master Password

Enabling OAUTH2 Authentication

Redirect URL

Master Password

Login Page

Enabling Webserver Authentication

Master Password

Note

Pre-compiled and configured installation packages are available for a number of platforms. These packages should be used by end-users whereever possible - the following information is useful for the maintainers of those packages and users interested in understanding how pgAdmin works.

The pgAdmin 4 client features a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment.

The tree control provides an elegant overview of the managed servers, and the objects that reside on each server. Right-click on a node within the tree control to access context-sensitive menus that provide quick access to management tasks for the selected object.

The tabbed browser provide quick access to statistical information about each object in the tree control, and pgAdmin tools and utilities (such as the Query tool and the debugger). pgAdmin opens additional feature tabs each time you access the extended functionality offered by pgAdmin tools; you can open, close, and re-arrange feature tabs as needed.

Use the Preferences dialog to customize the content and behaviour of the pgAdmin display. To open the Preferences dialog, select Preferences from the File menu.

Help buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the Help menu, and selecting the name of the resource that you wish to open.

You can search for objects in the database using the Search objects

User Interface

Menu Bar

The File Menu

The Object Menu

The Tools Menu

The Help Menu

Toolbar

Tabbed Browser

Tree Control

Preferences Dialog

The Browser Node

The Dashboards Node

The Debugger Node

The ERD Tool Node

The Graphs Node

The Miscellaneous Node

The Paths Node

The Query Tool Node

The Schema Diff Node

The Storage Node

Manage Preferences

Get Preferences

Save Preferences

Updating Preferences preferences.json

JSON format

Keyboard Shortcuts:

Main Browser Window

Property Grid Controls

SQL Editors

Query Tool

Debugger

ERD Tool

Inner Tab and Panel Navigation

Search objects

Before using pgAdmin to manage objects that reside on a server, you must define a connection to the server; for more information please see Connecting to a Server in the next section.

Deployment

Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment.

The config.py File

Desktop Deployment

Configuration

Server Deployment

Requirements

Configuration

Hosting

Container Deployment

PostgreSQL Utilities

Environment Variables

Mapped Files and Directories

Examples

Reverse Proxying

The config.py File

There are multiple configuration files that are read at startup by pgAdmin. These files are used for configuration options that:

may be required to be set prior to startup of pgAdmin as they control how the application will operate.

system administrators may wish to control across an organisation to enforce security policies.

are so rarely or unlikely to be changed that it doesn’t make sense to allow them to be changed through the user interface.

The configuration files are as follows:

config.py: This is the main configuration file, and should not be modified. It can be used as a reference for configuration settings, that may be overridden in one of the following files.

config_distro.py: This file is read after config.py and is intended for packagers to change any settings that are required for their pgAdmin distribution. This may typically include certain paths and file locations. This file is optional, and may be created by packagers in the same directory as config.py if needed.

config_local.py: This file is read after config_distro.py and is intended for the owner of the installation to change any default or packaging specific settings that they may wish to adjust to meet local preferences or standards.This file is optional, and may be created by users in the same directory as config.py if needed.

config_system.py: This file is read after config_local.py and is intended for system administrators to include settings that are configured system-wide from a secure location that users cannot normally modify and that is outside of the pgAdmin installation. The location for this file varies based on the platform, and only needs to be created if desired.

Platform

File Location

Linux

/etc/pgadmin/config_system.py

macOS

/Library/Preferences/pgadmin/config_system.py

Windows

%CommonProgramFiles%\pgadmin\config_system.py

Note

If the SERVER_MODE or DATA_DIR settings are changed in config_distro.py, config_local.py, or config_system.py LOG_FILE, SQLITE_PATH, SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and AZURE_CREDENTIAL_CACHE_DIR values will be set based on DATA_DIR unless values are explicitly overridden for any of the variable in any of the above file.

The default config.py file is shown below for reference:

# -*- coding: utf-8 -*-

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2024, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
# config.py - Core application configuration settings
#
##########################################################################

import builtins
import logging
import os
import sys
from collections import OrderedDict

# We need to include the root directory in sys.path to ensure that we can
# find everything we need when running in the standalone runtime.
root = os.path.dirname(os.path.realpath(__file__))
if sys.path[0] != root:
    sys.path.insert(0, root)

# The config database connection pool size.
# Setting this to 0 will remove any limit.
CONFIG_DATABASE_CONNECTION_POOL_SIZE = 5
# The number of connections allowed to overflow beyond
# the connection pool size.
CONFIG_DATABASE_CONNECTION_MAX_OVERFLOW = 100

from pgadmin.utils import env, IS_WIN, fs_short_path
from version import APP_VERSION, APP_RELEASE, APP_REVISION, APP_SUFFIX, \
    APP_VERSION_INT
from branding import APP_NAME, APP_ICON, APP_COPYRIGHT, APP_PATH, \
    APP_WIN_PATH, APP_SHORT_NAME, APP_DEFAULT_EMAIL

##########################################################################
# Misc stuff
##########################################################################

# Path to the online help.
HELP_PATH = '../../../docs/en_US/_build/html/'

# Languages we support in the UI
LANGUAGES = {
    'en': 'English',
    'zh_Hans_CN': 'Chinese (Simplified)',
    'zh_Hant_TW': 'Chinese (Traditional)',
    'cs': 'Czech',
    'fr': 'French',
    'de': 'German',
    'id': 'Indonesian',
    'it': 'Italian',
    'ja': 'Japanese',
    'ko': 'Korean',
    'pl': 'Polish',
    'pt_BR': 'Portuguese (Brazilian)',
    'ru': 'Russian',
    'es': 'Spanish',
}

# DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!
# List of modules to skip when dynamically loading
MODULE_BLACKLIST = ['test']

# DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!
# List of treeview browser nodes to skip when dynamically loading
NODE_BLACKLIST = []

##########################################################################
# Server settings
##########################################################################

# The server mode determines whether or not we're running on a web server
# requiring user authentication, or desktop mode which uses an automatic
# default login.
#
# DO NOT DISABLE SERVER MODE IF RUNNING ON A WEBSERVER!!
#
# We only set SERVER_MODE if it's not already set. That's to allow the
# runtime to force it to False.
#
# NOTE: If you change the value of SERVER_MODE or DATA_DIR in an included
#       config file, you may also need to redefine any values below that are
#       derived from it, notably various paths such as LOG_FILE, SQLITE_PATH,
#       SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and
#       AZURE_CREDENTIAL_CACHE_DIR

if (not hasattr(builtins, 'SERVER_MODE')) or builtins.SERVER_MODE is None:
    SERVER_MODE = True
else:
    SERVER_MODE = builtins.SERVER_MODE

# HTTP headers to search for CSRF token when it is not provided in the form.
# Default is ['X-CSRFToken', 'X-CSRF-Token']
WTF_CSRF_HEADERS = ['X-pgA-CSRFToken']

# User ID (email address) to use for the default user in desktop mode.
# The default should be fine here, as it's not exposed in the app.
DESKTOP_USER = APP_DEFAULT_EMAIL

# This option allows the user to host the application on a LAN
# Default hosting is on localhost (DEFAULT_SERVER='localhost').
# To host pgAdmin4 over LAN set DEFAULT_SERVER='0.0.0.0' (or a specific
# adaptor address.
#
# NOTE: This is NOT recommended for production use, only for debugging
# or testing. Production installations should be run as a WSGI application
# behind Apache HTTPD.
DEFAULT_SERVER = '127.0.0.1'

# The default port on which the app server will listen if not set in the
# environment by the runtime
DEFAULT_SERVER_PORT = 5050

# This param is used to override the default web server information about
# the web technology and the frameworks being used in the application
# An attacker could use this information to fingerprint underlying operating
# system and research known exploits for the specific version of
# software in use
WEB_SERVER = 'Python'

# Enable X-Frame-Option protection.
# Set to one of "SAMEORIGIN", "ALLOW-FROM origin" or "" to disable.
# Note that "DENY" is NOT supported (and will be silently ignored).
# See https://tools.ietf.org/html/rfc7034 for more info.
X_FRAME_OPTIONS = "SAMEORIGIN"

# The Content-Security-Policy header allows you to restrict how resources
# such as JavaScript, CSS, or pretty much anything that the browser loads.
# see https://content-security-policy.com/#source_list for more info
# e.g. "default-src https: data: 'unsafe-inline' 'unsafe-eval';"
CONTENT_SECURITY_POLICY = "default-src ws: http: data: blob: 'unsafe-inline'" \
                          " 'unsafe-eval';"

# STRICT_TRANSPORT_SECURITY_ENABLED when set to True will set the
# Strict-Transport-Security header
STRICT_TRANSPORT_SECURITY_ENABLED = False

# The Strict-Transport-Security header tells the browser to convert all HTTP
# requests to HTTPS, preventing man-in-the-middle (MITM) attacks.
# e.g. 'max-age=31536000; includeSubDomains'
STRICT_TRANSPORT_SECURITY = "max-age=31536000; includeSubDomains"

# The X-Content-Type-Options header forces the browser to honor the response
# content type instead of trying to detect it, which can be abused to
# generate a cross-site scripting (XSS) attack.
# e.g. nosniff
X_CONTENT_TYPE_OPTIONS = "nosniff"

# The browser will try to prevent reflected XSS attacks by not loading the
# page if the request contains something that looks like JavaScript and the
# response contains the same data. e.g. '1; mode=block'
X_XSS_PROTECTION = "1; mode=block"

# This param is used to validate ALLOWED_HOSTS for the application
# This will be used to avoid Host Header Injection attack
# ALLOWED_HOSTS = ['225.0.0.0/8', '226.0.0.0/7', '228.0.0.0/6']
# ALLOWED_HOSTS = ['127.0.0.1', '192.168.0.1']
# if ALLOWED_HOSTS= [] then it will accept all ips (and application will be
# vulnerable to Host Header Injection attack)
ALLOWED_HOSTS = []

# Hashing algorithm used for password storage
SECURITY_PASSWORD_HASH = 'pbkdf2_sha512'

# Minimum password length
PASSWORD_LENGTH_MIN = 6

# Reverse Proxy parameters
# You must tell the middleware how many proxies set each header
# so it knows what values to trust.
# See https://tinyurl.com/yyg7r9av
# for more information.

# Number of values to trust for X-Forwarded-For
PROXY_X_FOR_COUNT = 1

# Number of values to trust for X-Forwarded-Proto.
PROXY_X_PROTO_COUNT = 1

# Number of values to trust for X-Forwarded-Host.
PROXY_X_HOST_COUNT = 0

# Number of values to trust for X-Forwarded-Port.
PROXY_X_PORT_COUNT = 1

# Number of values to trust for X-Forwarded-Prefix.
PROXY_X_PREFIX_COUNT = 0

# NOTE: CSRF_SESSION_KEY, SECRET_KEY and SECURITY_PASSWORD_SALT are no
#       longer part of the main configuration, but are stored in the
#       configuration databases 'keys' table and are auto-generated.

# COMPRESSION
COMPRESS_MIMETYPES = [
    'text/html', 'text/css', 'text/xml', 'text/javascript',
    'application/json', 'application/javascript'
]
COMPRESS_LEVEL = 9
COMPRESS_MIN_SIZE = 500

# Set the cache control max age for static files in flask to 1 year
SEND_FILE_MAX_AGE_DEFAULT = 31556952

# This will be added to static urls as url parameter with value as
# APP_VERSION_INT for cache busting on version upgrade. If the value is set as
# None or empty string then it will not be added.
# eg - http:localhost:5050/pgadmin.css?intver=3.13
APP_VERSION_PARAM = 'ver'

# Add the internal version param to below extensions only
APP_VERSION_EXTN = ('.css', '.js', '.html', '.svg', '.png', '.gif', '.ico')

# Data directory for storage of config settings etc. This shouldn't normally
# need to be changed - it's here as various other settings depend on it.
# On Windows, we always store data in %APPDATA%\$(APP_WIN_PATH). On other
# platforms, if we're in server mode we use /var/lib/$(APP_PATH),
# otherwise ~/.$(APP_PATH)
if IS_WIN:
    # Use the short path on windows
    DATA_DIR = os.path.realpath(
        os.path.join(fs_short_path(env('APPDATA')), APP_WIN_PATH)
    )
else:
    if SERVER_MODE:
        DATA_DIR = os.path.join('/var/lib/', APP_PATH)
    else:
        DATA_DIR = os.path.realpath(
            os.path.expanduser('~/' + '.' + APP_PATH + '/')
        )

# An optional login banner to show security warnings/disclaimers etc. at
# login and password recovery etc. HTML may be included for basic formatting,
# For example:
# LOGIN_BANNER = "<h4>Authorised Users Only!</h4>" \
#                "Unauthorised use is strictly forbidden."
LOGIN_BANNER = ""

##########################################################################
# Log settings
##########################################################################

# Debug mode?
DEBUG = False

# Application log level - one of:
#   CRITICAL 50
#   ERROR    40
#   WARNING  30
#   SQL      25
#   INFO     20
#   DEBUG    10
#   NOTSET    0
CONSOLE_LOG_LEVEL = logging.WARNING
FILE_LOG_LEVEL = logging.WARNING

# Log format.
JSON_LOGGER = False
CONSOLE_LOG_FORMAT_JSON = OrderedDict([
    ("time", "asctime"),
    ("message", "message"),
    ("level", "levelname")
])

FILE_LOG_FORMAT_JSON = OrderedDict([
    ("time", "asctime"),
    ("message", "message"),
    ("level", "levelname")
])

CONSOLE_LOG_FORMAT = '%(asctime)s: %(levelname)s\t%(name)s:\t%(message)s'
FILE_LOG_FORMAT = '%(asctime)s: %(levelname)s\t%(name)s:\t%(message)s'

# Log file name. This goes in the data directory, except on non-Windows
# platforms in server mode.
if SERVER_MODE and not IS_WIN:
    LOG_FILE = os.path.join('/var/log', APP_PATH, APP_SHORT_NAME + '.log')
else:
    LOG_FILE = os.path.join(DATA_DIR, APP_SHORT_NAME + '.log')

# Log rotation setting
# Log file will be rotated considering values for LOG_ROTATION_SIZE
# & LOG_ROTATION_AGE. Rotated file will be named in format
# - LOG_FILE.Y-m-d_H-M-S
LOG_ROTATION_SIZE = 10  # In MBs
LOG_ROTATION_AGE = 1440  # In minutes
LOG_ROTATION_MAX_LOG_FILES = 90  # Maximum number of backups to retain
##########################################################################
# Server Connection Driver Settings
##########################################################################

# The default driver used for making connection with PostgreSQL
PG_DEFAULT_DRIVER = 'psycopg3'

# Maximum allowed idle time in minutes before which releasing the connection
# for the particular session. (in minutes)
MAX_SESSION_IDLE_TIME = 60

##########################################################################
# External Database Settings
#
# All configuration settings are stored by default in the SQLite database.
# In order to use external databases like PostgreSQL sets the value of
# CONFIG_DATABASE_URI like below:
# dialect+driver://username:password@host:port/database
#
# PostgreSQL:
# postgresql://username:password@host:port/database
# Specify Schema Name
# postgresql://username:password@host:port/database?options=-csearch_path=pgadmin
# Using PGPASS file
# postgresql://username@host:port?options=-csearch_path=pgadmin
##########################################################################
CONFIG_DATABASE_URI = ''

##########################################################################
# User account and settings storage
##########################################################################

# The default path to the SQLite database used to store user accounts and
# settings. This default places the file in the same directory as this
# config file, but generates an absolute path for use througout the app.
SQLITE_PATH = env('SQLITE_PATH') or \
    os.path.join(DATA_DIR, APP_SHORT_NAME + '.db')

# SQLITE_TIMEOUT will define how long to wait before throwing the error -
# OperationError due to database lock. On slower system, you may need to change
# this to some higher value.
# (Default: 500 milliseconds)
SQLITE_TIMEOUT = 500

# Allow database connection passwords to be saved if the user chooses.
# Set to False to disable password saving.
ALLOW_SAVE_PASSWORD = True

# Maximum number of history queries stored per user/server/database
MAX_QUERY_HIST_STORED = 20

##########################################################################
# Server-side session storage path
#
# SESSION_DB_PATH (Default: $HOME/.pgadmin4/sessions)
##########################################################################
#
# We use SQLite for server-side session storage. There will be one
# SQLite database object per session created.
#
# Specify the path used to store your session objects.
#
# If the specified directory does not exist, the setup script will create
# it with permission mode 700 to keep the session database secure.
#
# On certain systems, you can use shared memory (tmpfs) for maximum
# scalability, for example, on Ubuntu:
#
# SESSION_DB_PATH = '/run/shm/pgAdmin4_session'
#
##########################################################################
SESSION_DB_PATH = os.path.join(DATA_DIR, 'sessions')

SESSION_COOKIE_NAME = 'pga4_session'

##########################################################################
# Mail server settings
##########################################################################

# These settings are used when running in web server mode for confirming
# and resetting passwords etc.
# See: http://pythonhosted.org/Flask-Mail/ for more info
MAIL_SERVER = 'localhost'
MAIL_PORT = 25
MAIL_USE_SSL = False
MAIL_USE_TLS = False
MAIL_USERNAME = ''
MAIL_PASSWORD = ''
MAIL_DEBUG = False

# Flask-Security overrides Flask-Mail's MAIL_DEFAULT_SENDER setting, so
# that should be set as such:
SECURITY_EMAIL_SENDER = 'no-reply@localhost'

##########################################################################
# Mail content settings
##########################################################################

# These settings define the content of password reset emails
SECURITY_EMAIL_SUBJECT_PASSWORD_RESET = "Password reset instructions for %s" \
                                        % APP_NAME
SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE = "Your %s password has been reset" \
                                         % APP_NAME
SECURITY_EMAIL_SUBJECT_PASSWORD_CHANGE_NOTICE = \
    "Your password for %s has been changed" % APP_NAME

##########################################################################
# Email address validation
##########################################################################
CHECK_EMAIL_DELIVERABILITY = False
SECURITY_EMAIL_VALIDATOR_ARGS = \
    {"check_deliverability": CHECK_EMAIL_DELIVERABILITY}
ALLOW_SPECIAL_EMAIL_DOMAINS = []

##########################################################################
# Upgrade checks
##########################################################################

# Check for new versions of the application?
UPGRADE_CHECK_ENABLED = True

# Where should we get the data from?
UPGRADE_CHECK_URL = 'https://www.pgadmin.org/versions.json'

# What key should we look at in the upgrade data file?
UPGRADE_CHECK_KEY = 'pgadmin4'

# Which CA file should we use?
# Default to cacert.pem in the same directory as config.py et al.
CA_FILE = os.path.join(os.path.dirname(os.path.realpath(__file__)),
                       "cacert.pem")

# Check if the detected browser is supported
CHECK_SUPPORTED_BROWSER = True

##########################################################################
# Storage Manager storage url config settings
# If user sets STORAGE_DIR to empty it will show all volumes if platform
# is Windows, '/' if it is Linux, Mac or any other unix type system.

# For example:
# 1. STORAGE_DIR = get_drive("C") or get_drive() # return C:/ by default
# where C can be any drive character such as "D", "E", "G" etc
# 2. Set path manually like
# STORAGE_DIR = "/path/to/directory/"
##########################################################################
STORAGE_DIR = os.path.join(DATA_DIR, 'storage')

##########################################################################
# Default locations for binary utilities (pg_dump, pg_restore etc)
#
# These are intentionally left empty in the main config file, but are
# expected to be overridden by packagers in config_distro.py.
#
# A default location can be specified for each database driver ID, in
# a dictionary. Either an absolute or relative path can be specified.
#
# Version-specific defaults can also be specified, which will take priority
# over un-versioned paths.
#
# In cases where it may be difficult to know what the working directory
# is, "$DIR" can be specified. This will be replaced with the path to the
# top-level pgAdmin4.py file. For example, on macOS we might use:
#
# $DIR/../../SharedSupport
#
##########################################################################
DEFAULT_BINARY_PATHS = {
    "pg": "",
    "pg-12": "",
    "pg-13": "",
    "pg-14": "",
    "pg-15": "",
    "pg-16": "",
    "pg-17": "",
    "ppas": "",
    "ppas-12": "",
    "ppas-13": "",
    "ppas-14": "",
    "ppas-15": "",
    "ppas-16": "",
    "ppas-17": ""
}

##########################################################################

# Admin can specify fixed binary paths to prevent users from changing.
# It will take precedence over DEFAULT_BINARY_PATHS.

FIXED_BINARY_PATHS = {
    "pg": "",
    "pg-12": "",
    "pg-13": "",
    "pg-14": "",
    "pg-15": "",
    "pg-16": "",
    "pg-17": "",
    "ppas": "",
    "ppas-12": "",
    "ppas-13": "",
    "ppas-14": "",
    "ppas-15": "",
    "ppas-16": "",
    "ppas-17": ""
}

##########################################################################
# Test settings - used primarily by the regression suite, not for users
##########################################################################

# The default path for SQLite database for testing
TEST_SQLITE_PATH = os.path.join(DATA_DIR, 'test_pgadmin4.db')

##########################################################################
# Allows flask application to response to the each request asynchronously
##########################################################################
THREADED_MODE = True

##########################################################################
# Do not allow SQLALCHEMY to track modification as it is going to be
# deprecated in future
##########################################################################
SQLALCHEMY_TRACK_MODIFICATIONS = False

##########################################################################
# Number of records to fetch in one page in query tool when query result
# set is large and is divided in multiple pages
##########################################################################
DATA_RESULT_ROWS_PER_PAGE = 1000

##########################################################################
# Allow users to display Gravatar image for their username in Server mode
##########################################################################
SHOW_GRAVATAR_IMAGE = True

##########################################################################
# Set cookie path and options
##########################################################################
COOKIE_DEFAULT_PATH = '/'
COOKIE_DEFAULT_DOMAIN = None
SESSION_COOKIE_DOMAIN = None
SESSION_COOKIE_SAMESITE = 'Lax'
SESSION_COOKIE_SECURE = False
SESSION_COOKIE_HTTPONLY = True

#########################################################################
# Skip storing session in files and cache for specific paths
#########################################################################
SESSION_SKIP_PATHS = [
    '/misc/ping'
]

##########################################################################
# Session expiration support
##########################################################################
# SESSION_EXPIRATION_TIME is the interval in Days. Session will be
# expire after the specified number of *days*.
SESSION_EXPIRATION_TIME = 1

# Make SESSION_EXPIRATION_TIME to 1 week in DESKTOP mode
if not SERVER_MODE:
    SESSION_EXPIRATION_TIME = 7

# CHECK_SESSION_FILES_INTERVAL is interval in Hours. Application will check
# the session files for cleanup after specified number of *hours*.
CHECK_SESSION_FILES_INTERVAL = 24

# USER_INACTIVITY_TIMEOUT is interval in Seconds. If the pgAdmin screen is left
# unattended for <USER_INACTIVITY_TIMEOUT> seconds then the user will
# be logged out. When set to 0, the timeout will be disabled.
# If pgAdmin doesn't detect any activity in the time specified (in seconds),
# the user will be forcibly logged out from pgAdmin. Set to zero to disable
# the timeout.
# Note: This is applicable only for SERVER_MODE=True.
USER_INACTIVITY_TIMEOUT = 0

# OVERRIDE_USER_INACTIVITY_TIMEOUT when set to True will override
# USER_INACTIVITY_TIMEOUT when long running queries in the Query Tool
# or Debugger are running. When the queries complete, the inactivity timer
# will restart in this case. If set to False, user inactivity may cause
# transactions or in-process debugging sessions to be aborted.
OVERRIDE_USER_INACTIVITY_TIMEOUT = True

##########################################################################
# SSH Tunneling supports only for Python 2.7 and 3.4+
##########################################################################
SUPPORT_SSH_TUNNEL = True
# Allow SSH Tunnel passwords to be saved if the user chooses.
# Set to False to disable password saving.
ALLOW_SAVE_TUNNEL_PASSWORD = False

##########################################################################
# Master password is used to encrypt/decrypt saved server passwords
# Applicable for desktop mode only
##########################################################################
MASTER_PASSWORD_REQUIRED = True
##########################################################################

##########################################################################
# Allow to save master password which is used to encrypt/decrypt saved
# passwords in the os level secret like Keychain, password store etc.
# Disabling this will require user to enter master password
# if MASTER_PASSWORD_REQUIRED is set to True. Note: this is applicable only
# in case of Desktop mode.
##########################################################################
USE_OS_SECRET_STORAGE = True
##########################################################################

# pgAdmin encrypts the database connection and ssh tunnel password using a
# master password or pgAdmin login password (for other authentication sources)
# before storing it in the pgAdmin configuration database.
#
# Below setting is used to allow the user to specify the path to a script
# or program that will return an encryption key which will be used to
# encrypt the passwords. This setting is used only in server mode when
# auth sources are oauth, Kerberos, and webserver.
#
# You can pass the current username as an argument to the external script
# by specifying %u in config value.
# E.g. - MASTER_PASSWORD_HOOK = '<PATH>/passwdgen_script.sh %u'
##########################################################################
MASTER_PASSWORD_HOOK = None

##########################################################################

# Allows pgAdmin4 to create session cookies based on IP address, so even
# if a cookie is stolen, the attacker will not be able to connect to the
# server using that stolen cookie.
# Note: This can cause problems when the server is deployed in dynamic IP
# address hosting environments, such as Kubernetes or behind load
# balancers. In such cases, this option should be set to False.
##########################################################################
ENHANCED_COOKIE_PROTECTION = True

##########################################################################
# External Authentication Sources
##########################################################################

# Default setting is internal
# External Supported Sources: ldap, kerberos, oauth2
# Multiple authentication can be achieved by setting this parameter to
# ['ldap', 'internal'] or ['oauth2', 'internal'] or
# ['webserver', 'internal'] etc.
# pgAdmin will authenticate the user with ldap/oauth2 whatever first in the
# list, in case of failure the second authentication option will be considered.

AUTHENTICATION_SOURCES = ['internal']

##########################################################################
# MAX_LOGIN_ATTEMPTS which sets the number of failed login attempts that
# are allowed. If this value is exceeded the account is locked and can be
# reset by an administrator. By setting the variable to the value zero
# this feature is deactivated.
##########################################################################
MAX_LOGIN_ATTEMPTS = 3

##########################################################################
# Only consider password to check the failed login attempts, email is
# excluded from this check
LOGIN_ATTEMPT_FIELDS = ['password']
##########################################################################
# LDAP Configuration
##########################################################################

# After ldap authentication, user will be added into the SQLite database
# automatically, if set to True.
# Set it to False, if user should not be added automatically,
# in this case Admin has to add the user manually in the SQLite database.
LDAP_AUTO_CREATE_USER = True

# Connection timeout
LDAP_CONNECTION_TIMEOUT = 10

# Server connection details (REQUIRED)
# example: ldap://<ip-address>:<port> or ldap://<hostname>:<port>
LDAP_SERVER_URI = 'ldap://<ip-address>:<port>'

# The LDAP attribute containing user names. In OpenLDAP, this may be 'uid'
# whilst in AD, 'sAMAccountName' might be appropriate. (REQUIRED)
LDAP_USERNAME_ATTRIBUTE = '<User-id>'

##########################################################################
# 3 ways to configure LDAP as follows (Choose anyone):

# 1. Dedicated User binding

# LDAP Bind User DN Example: cn=username,dc=example,dc=com
# Set this parameter to allow the connection to bind using a dedicated user.
# After the connection is made, the pgadmin login user will be further
# authenticated by the username and password provided
# at the login screen.
LDAP_BIND_USER = None

# LDAP Bind User Password
LDAP_BIND_PASSWORD = None

# OR ####################
# 2. Anonymous Binding

# Set this parameter to allow the anonymous bind.
# After the connection is made, the pgadmin login user will be further
# authenticated by the username and password provided

LDAP_ANONYMOUS_BIND = False

# OR ####################
# 3. Bind as pgAdmin user

# BaseDN (REQUIRED)
# AD example:
# (&(objectClass=user)(memberof=CN=MYGROUP,CN=Users,dc=example,dc=com))
# OpenLDAP example: CN=Users,dc=example,dc=com
LDAP_BASE_DN = '<Base-DN>'

# Configure the bind format string
# Default: LDAP_BIND_FORMAT="
#   {LDAP_USERNAME_ATTRIBUTE}={LDAP_USERNAME},{LDAP_BASE_DN}"
# The current available options are:
# LDAP_USERNAME_ATTRIBUTE, LDAP_USERNAME, LDAP_BASE_DN
# Example: LDAP_BIND_FORMAT="myldapuser@sales.example.com"
#          LDAP_BIND_FORMAT="NET\\myldapuser"
LDAP_BIND_FORMAT = '{LDAP_USERNAME_ATTRIBUTE}={LDAP_USERNAME},{LDAP_BASE_DN}'

##########################################################################

# Search ldap for further authentication (REQUIRED)
# It can be optional while bind as pgAdmin user
LDAP_SEARCH_BASE_DN = '<Search-Base-DN>'

# The LDAP attribute indicates whether the DN (Distinguished Names)
# are case sensitive or not
LDAP_DN_CASE_SENSITIVE = False

# Filter string for the user search.
# For OpenLDAP, '(cn=*)' may well be enough.
# For AD, you might use '(objectClass=user)' (REQUIRED)
LDAP_SEARCH_FILTER = '(objectclass=*)'

# Search scope for users (one of BASE, LEVEL or SUBTREE)
LDAP_SEARCH_SCOPE = 'SUBTREE'

# Use TLS? If the URI scheme is ldaps://, this is ignored.
LDAP_USE_STARTTLS = False

# TLS/SSL certificates. Specify if required, otherwise leave empty
LDAP_CA_CERT_FILE = ''
LDAP_CERT_FILE = ''
LDAP_KEY_FILE = ''

##########################################################################

# Some flaky LDAP servers returns malformed schema. If True, no exception
# will be raised and schema is thrown away but authentication will be done.
# This parameter should remain False, as recommended.
LDAP_IGNORE_MALFORMED_SCHEMA = False

##########################################################################
# Kerberos Configuration
##########################################################################

KRB_APP_HOST_NAME = DEFAULT_SERVER

# If the default_keytab_name is not set in krb5.conf or
# the KRB_KTNAME environment variable is not set then, explicitly set
# the Keytab file

KRB_KTNAME = '<KRB5_KEYTAB_FILE>'

# After kerberos authentication, user will be added into the SQLite database
# automatically, if set to True.
# Set it to False, if user should not be added automatically,
# in this case Admin has to add the user manually in the SQLite database.

KRB_AUTO_CREATE_USER = True

KERBEROS_CCACHE_DIR = os.path.join(DATA_DIR, 'krbccache')

#############################################################################
# Create local directory to store azure credential cache
#############################################################################

AZURE_CREDENTIAL_CACHE_DIR = os.path.join(DATA_DIR, 'azurecredentialcache')

##########################################################################
# OAuth2 Configuration
##########################################################################

# Multiple OAUTH2 providers can be added in the list like [{...},{...}]
# All parameters are required

OAUTH2_CONFIG = [
    {
        # The name of the of the oauth provider, ex: github, google
        'OAUTH2_NAME': None,
        # The display name, ex: Google
        'OAUTH2_DISPLAY_NAME': '<Oauth2 Display Name>',
        # Oauth client id
        'OAUTH2_CLIENT_ID': None,
        # Oauth secret
        'OAUTH2_CLIENT_SECRET': None,
        # URL to generate a token,
        # Ex: https://github.com/login/oauth/access_token
        'OAUTH2_TOKEN_URL': None,
        # URL is used for authentication,
        # Ex: https://github.com/login/oauth/authorize
        'OAUTH2_AUTHORIZATION_URL': None,
        # server metadata url might optional for your provider
        'OAUTH2_SERVER_METADATA_URL': None,
        # Oauth base url, ex: https://api.github.com/
        'OAUTH2_API_BASE_URL': None,
        # Name of the Endpoint, ex: user
        'OAUTH2_USERINFO_ENDPOINT': None,
        # Oauth scope, ex: 'openid email profile'
        # Note that an 'email' claim is required in the resulting profile
        'OAUTH2_SCOPE': None,
        # The claim which is used for the username. If the value is empty the
        # email is used as username, but if a value is provided,
        # the claim has to exist.
        'OAUTH2_USERNAME_CLAIM': None,
        # Font-awesome icon, ex: fa-github
        'OAUTH2_ICON': None,
        # UI button colour, ex: #0000ff
        'OAUTH2_BUTTON_COLOR': None,
        # The additional claims to check on user ID Token or Userinfo response.
        # This is useful to provide additional authorization checks
        # before allowing access.
        # Example for GitLab: allowing all maintainers teams, and a specific
        # developers group to access pgadmin:
        # 'OAUTH2_ADDITIONAL_CLAIMS': {
        #     'https://gitlab.org/claims/groups/maintainer': [
        #           'kuberheads/applications',
        #           'kuberheads/dba',
        #           'kuberheads/support'
        #      ],
        #     'https://gitlab.org/claims/groups/developer': [
        #           'kuberheads/applications/team01'
        #      ],
        # }
        # Example for AzureAD:
        # 'OAUTH2_ADDITIONAL_CLAIMS': {
        #     'groups': ["0760b6cf-170e-4a14-91b3-4b78e0739963"],
        #     'wids': ["cf1c38e5-3621-4004-a7cb-879624dced7c"],
        # }
        'OAUTH2_ADDITIONAL_CLAIMS': None,
        # Set this variable to False to disable SSL certificate verification
        # for OAuth2 provider.
        # This may need to set False, in case of self-signed certificates.
        # Ref: https://github.com/psf/requests/issues/6071
        'OAUTH2_SSL_CERT_VERIFICATION': True,
        # set this variable to invalidate the session of the oauth2 provider
        # Example for keycloak:
        # 'OAUTH2_LOGOUT_URL':
        # 'https://example.com/realms/master/protocol/openid-connect/logout?post_logout_redirect_uri={redirect_uri}&id_token_hint={id_token}'
        'OAUTH2_LOGOUT_URL': None
    }
]

# After Oauth authentication, user will be added into the SQLite database
# automatically, if set to True.
# Set it to False, if user should not be added automatically,
# in this case Admin has to add the user manually in the SQLite database.

OAUTH2_AUTO_CREATE_USER = True

##########################################################################
# Webserver Configuration
##########################################################################

WEBSERVER_AUTO_CREATE_USER = True

# REMOTE_USER variable will be used to check the environment variable
# is set or not first, if not available,
# request header will be checked for the same.
# Possible values: REMOTE_USER, HTTP_X_FORWARDED_USER, X-Forwarded-User

WEBSERVER_REMOTE_USER = 'REMOTE_USER'

##########################################################################
# Two-factor Authentication Configuration
##########################################################################

# Set it to True, to enable the two-factor authentication
MFA_ENABLED = True

# Set it to True, to ask the users to register forcefully for the
# two-authentication methods on logged-in.
MFA_FORCE_REGISTRATION = False

# pgAdmin supports Two-factor authentication by either sending an one-time code
# to an email, or using the TOTP based application like Google Authenticator.
MFA_SUPPORTED_METHODS = ["email", "authenticator"]

# NOTE: Please set the 'Mail server settings' to use 'email' as two-factor
#       authentication method.

# Subject for the email verification code
# Default: <APP_NAME> - Verification Code
# e.g.  pgAdmin 4 - Verification Code
MFA_EMAIL_SUBJECT = None

##########################################################################
# PSQL tool settings
##########################################################################
# This will enable PSQL tool in pgAdmin when running in server mode.
# PSQL is always enabled in Desktop mode, however in server mode it is
# disabled by default because users can run arbitrary commands on the
# server through it.
ENABLE_PSQL = False

##########################################################################
# ENABLE_BINARY_PATH_BROWSING setting is used to enable the browse button
# while selecting binary path for the database server in server mode.
# In Desktop mode it is always enabled and setting is of no use.
##########################################################################
ENABLE_BINARY_PATH_BROWSING = False

##########################################################################
# In server mode, the SHARED_STORAGE setting is used to enable shared storage.
# Specify the name, path, and restricted_access values that should be shared
# between users. When restricted_access is set to True, non-admin users cannot
# upload/add, delete, or rename files/folders in shared storage, only admins
# can do that. Users must provide the absolute path to the folder, and the name
# can be anything they see on the user interface.
# [{ 'name': 'Shared 1', 'path': '/shared_folder',
#   'restricted_access': True/False}]
##########################################################################
SHARED_STORAGE = []

#############################################################################
# AUTO_DISCOVER_SERVERS setting is used to enable the pgAdmin to discover the
# database server automatically on the local machine.
# When it is set to False, pgAdmin will not discover servers installed on
# the local machine.
#############################################################################
AUTO_DISCOVER_SERVERS = True

#############################################################################
# SERVER_HEARTBEAT_TIMEOUT is used to send the server heartbeat to server
# from the client. This will resolve the orphan database issue once
# browser tab is closed.
#############################################################################
SERVER_HEARTBEAT_TIMEOUT = 30  # In seconds

#############################################################################
# ENABLE_SERVER_PASS_EXEC_CMD is used to enable/disable Password exec command
# field in server properties. This is used to specify a shell command to be
# executed to retrieve a password to be used for server authentication.
# This setting is applicable only for server mode.
#############################################################################
ENABLE_SERVER_PASS_EXEC_CMD = False

#############################################################################
# Maximum number of Tags allowed on a server node
##############################################################################
MAX_SERVER_TAGS_ALLOWED = 5

#############################################################################
# Number of records to fetch in one batch for server logs.
##############################################################################

ON_DEMAND_LOG_COUNT = 10000

#############################################################################
# Patch the default config with custom config and other manipulations
#############################################################################
from pgadmin.evaluate_config import evaluate_and_patch_config
locals().update(evaluate_and_patch_config(locals()))

Desktop Deployment

pgAdmin may be deployed as a desktop application by configuring the application to run in desktop mode and then utilising the desktop runtime to host the program on a supported Windows, Mac OS X or Linux installation.

The desktop runtime is a standalone application that when launched, runs the pgAdmin server and opens a window to render the user interface.

Note

Pre-compiled and configured installation packages are available for a number of platforms. These packages should be used by end-users whereever possible - the following information is useful for the maintainers of those packages and users interested in understanding how pgAdmin works.

See also

For detailed instructions on building and configuring pgAdmin from scratch, please see the README file in the top level directory of the source code. For convenience, you can find the latest version of the file here [https://github.com/pgadmin-org/pgadmin4/blob/master/README.md], but be aware that this may differ from the version included with the source code for a specific version of pgAdmin.

Configuration

From pgAdmin 4 v2 onwards, the default configuration mode is server, however, this is overridden by the desktop runtime at startup. In most environments, no Python configuration is required unless you wish to override other default settings.

See The config.py File for more information on configuration settings.

Desktop Runtime Standalone Application

The Desktop Runtime is based on Electron [https://www.electronjs.org/] which integrates a browser and the Python server creating a standalone application.

Runtime Menu Items

Use the File Menu to access the runtime menu items:

Option

Action

View logs…

Click to open the view log dialog to view the pgAdmin 4 logs.

Configure runtime…

Click to open configuration dialog to configure fixed port, port number and connection timeout.

Configuration Dialog

Use the Configure runtime… option to access the Configuration dialog:

Following are the details of the Fixed port number?, Port Number, Connection Timeout, and ‘Open Documentation in Default Browser?’ configuration parameters:

Key

Type

Purpose

FixedPort

Boolean

Use a fixed network port number rather than a random one.

PortNumber

Integer

The port number to use, if using a fixed port.

ConnectionTimeout

Integer

The number of seconds to wait for application server startup.

Open Documentation in Default Browser

Boolean

By checking this option, all documentation links will open in the default browser instead of in a new window.

Log dialog

Use the File Menu to access the View Logs dialog:

Click on the Reload button at the bottom to view the latest logs of pgAdmin 4 Server.

When executed, the runtime will automatically try to execute the pgAdmin Python application. If execution fails, it will prompt you with error message displaying a Configure button at the bottom. You can configure a fixed port number to avoid clashes of the default random port number with other applications and a connection timeout if desired.

If the error is related to Python Path or pgAdmin Python file then you need to create a file named ‘dev_config.json’ and specify the following entries:

{
    "pythonPath": "/path/to/python.exe",
    "pgadminFile": "/path/to/pgAdmin4.py"
}

Note that the dev_config.py file should only be required by developers who are working outside of a standard installation.

The configuration settings are stored in runtime_config.json file, which will be available on Unix systems (~/.local/share/pgadmin/), on Mac OS X (~/Library/Preferences/pgadmin), and on Windows (%APPDATA%/pgadmin).

Server Deployment

pgAdmin may be deployed as a web application by configuring the app to run in server mode and then deploying it either behind a webserver running as a reverse proxy, or using the WSGI interface.

When deployed in server mode, there are two notable differences for users:

Users must login before they can use pgAdmin. An initial superuser account is created when server mode is initialised, and this user can add additional superusers and non-superusers as required.

File storage is restricted to a virtual root directory for each individual user under the directory configured using the STORAGE_DIR configuration parameter. Users do not have access to the complete filesystem of the server.

The following instructions demonstrate how pgAdmin may be run as a WSGI application under Apache HTTPD, using mod_wsgi, standalone using uWSGI or Gunicorn, or under NGINX using using uWSGI or Gunicorn.

See also

For detailed instructions on building and configuring pgAdmin from scratch, please see the README file in the top level directory of the source code. For convenience, you can find the latest version of the file here [https://github.com/pgadmin-org/pgadmin4/blob/master/README.md], but be aware that this may differ from the version included with the source code for a specific version of pgAdmin.

Requirements

Important: Some components of pgAdmin require the ability to maintain affinity between client sessions and a specific database connection (for example, the Query Tool in which the user might run a BEGIN command followed by a number of DML SQL statements, and then a COMMIT). pgAdmin has been designed with built-in connection management to handle this, however it requires that only a single Python process is used because it is not easily possible to maintain affinity between a client session and one of multiple WSGI worker processes.

On Windows systems, the Apache HTTP server uses a single process, multi-threaded architecture. WSGI applications run in embedded mode, which means that only a single process will be present on this platform in all cases.

On Unix systems, the Apache HTTP server typically uses a multi-process, single threaded architecture (this is dependent on the MPM that is chosen at compile time). If embedded mode is chosen for the WSGI application, then there will be one Python environment for each Apache process, each with it’s own connection manager which will lead to loss of connection affinity. Therefore one should use mod_wsgi’s daemon mode, configured to use a single process. This will launch a single instance of the WSGI application which is utilised by all the Apache worker processes.

Whilst it is true that this is a potential performance bottleneck, in reality pgAdmin is not a web application that’s ever likely to see heavy traffic unlike a busy website, so in practice should not be an issue.

Future versions of pgAdmin may introduce a shared connection manager process to overcome this limitation, however that is a significant amount of work for little practical gain.

Configuration

In order to configure pgAdmin to run in server mode, it may be necessary to configure the Python code to run in multi-user mode, and then to configure the web server to find and execute the code.

See The config.py File for more information on configuration settings.

Python

From pgAdmin 4 v2 onwards, server mode is the default configuration. If running under the desktop runtime, this is overridden automatically. There should typically be no need to modify the configuration simply to enable server mode to work, however it may be desirable to adjust some of the paths used.

In order to configure the Python code, follow these steps:

Create a config_local.py file alongside the existing config.py file.

Edit config_local.py and add the following settings. In most cases, the default file locations should be appropriate:

NOTE: You must ensure the directories specified are writeable by the user that the web server processes will be running as, e.g. apache or www-data. You may specify DATA_DIR in order to create all required directories and files under DATA_DIR folder.

LOG_FILE = '/var/log/pgadmin4/pgadmin4.log'
SQLITE_PATH = '/var/lib/pgadmin4/pgadmin4.db'
SESSION_DB_PATH = '/var/lib/pgadmin4/sessions'
STORAGE_DIR = '/var/lib/pgadmin4/storage'
AZURE_CREDENTIAL_CACHE_DIR = '/var/lib/pgadmin4/azurecredentialcache'
KERBEROS_CCACHE_DIR = '/var/lib/pgadmin4/kerberoscache'

Run the following command to create the configuration database:

# python setup.py setup-db

Change the ownership of the configuration database to the user that the web server processes will run as, for example, assuming that the web server runs as user www-data in group www-data, and that the SQLite path is /var/lib/pgadmin4/pgadmin4.db:

# chown www-data:www-data /var/lib/pgadmin4/pgadmin4.db

Hosting

There are many possible ways to host pgAdmin in server mode. Some examples are given below:

Apache HTTPD Configuration (Windows)

Once Apache HTTP has been configured to support mod_wsgi, the pgAdmin application may be configured similarly to the example below:

<VirtualHost *>
    ServerName pgadmin.example.com
    WSGIScriptAlias / "C:\Program Files\pgAdmin4\web\pgAdmin4.wsgi"
    <Directory "C:\Program Files\pgAdmin4\web">
            Order deny,allow
            Allow from all
    </Directory>
</VirtualHost>

Now open the file C:\Program Files\pgAdmin4\web\pgAdmin4.wsgi with your favorite editor and add the code below which will activate Python virtual environment when Apache server runs.

activate_this = 'C:\Program Files\pgAdmin4\venv\Scripts\activate_this.py'
exec(open(activate_this).read())

Note: The changes made in pgAdmin4.wsgi file will revert when pgAdmin4 is either upgraded or downgraded.

Apache HTTPD Configuration (Linux/Unix)

Once Apache HTTP has been configured to support mod_wsgi, the pgAdmin application may be configured similarly to the example below:

<VirtualHost *>
    ServerName pgadmin.example.com

    WSGIDaemonProcess pgadmin processes=1 threads=25 python-home=/path/to/python/virtualenv
    WSGIScriptAlias / /opt/pgAdmin4/web/pgAdmin4.wsgi

    <Directory /opt/pgAdmin4/web>
        WSGIProcessGroup pgadmin
        WSGIApplicationGroup %{GLOBAL}
        Order deny,allow
        Allow from all
    </Directory>
</VirtualHost>

Note: If you’re using Apache HTTPD 2.4 or later, replace the lines:

Order deny,allow
Allow from all

with:

Require all granted

Adjust as needed to suit your access control requirements.

Standalone Gunicorn Configuration

pgAdmin may be hosted by Gunicorn directly simply by running a command such as the one shown below. Note that this example assumes pgAdmin was installed using the Python Wheel (you may need to adjust the path to suit your installation):

gunicorn  --bind 0.0.0.0:80 \
          --workers=1 \
          --threads=25 \
          --chdir /usr/lib/python3.7/dist-packages/pgadmin4 \
          pgAdmin4:app

Standalone uWSGI Configuration

pgAdmin may be hosted by uWSGI directly simply by running a command such as the one shown below. Note that this example assumes pgAdmin was installed using the Python Wheel (you may need to adjust the path to suit your installation):

uwsgi --http-socket 0.0.0.0:80 \
      --processes 1 \
      --threads 25 \
      --chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
      --mount /=pgAdmin4:app

NGINX Configuration with Gunicorn

pgAdmin can be hosted by Gunicorn, with NGINX in front of it. Note that these examples assume pgAdmin was installed using the Python Wheel (you may need to adjust the path to suit your installation).

To run with pgAdmin in the root directory of the server, start Gunicorn using a command similar to:

gunicorn --bind unix:/tmp/pgadmin4.sock \
         --workers=1 \
         --threads=25 \
         --chdir /usr/lib/python3.7/dist-packages/pgadmin4 \
         pgAdmin4:app

And configure NGINX:

location / {
    include proxy_params;
    proxy_pass http://unix:/tmp/pgadmin4.sock;
}

Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this case) on the server. Start Gunicorn as when using the root directory, but configure NGINX as follows:

location /pgadmin4/ {
    include proxy_params;
    proxy_pass http://unix:/tmp/pgadmin4.sock;
    proxy_set_header X-Script-Name /pgadmin4;
}

NGINX Configuration with uWSGI

pgAdmin can be hosted by uWSGI, with NGINX in front of it. Note that these examples assume pgAdmin was installed using the Python Wheel (you may need to adjust the path to suit your installation).

To run with pgAdmin in the root directory of the server, start uWSGI using a command similar to:

uwsgi --socket /tmp/pgadmin4.sock \
      --processes 1 \
      --threads 25 \
      --chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
      --manage-script-name \
      --mount /=pgAdmin4:app

And configure NGINX:

location / { try_files $uri @pgadmin4; }
location @pgadmin4 {
    include uwsgi_params;
    uwsgi_pass unix:/tmp/pgadmin4.sock;
}

Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this case) on the server. Start uWSGI, noting that the directory name is specified in the mount parameter:

uwsgi --socket /tmp/pgadmin4.sock \
      --processes 1 \
      --threads 25 \
      --chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
      --manage-script-name \
      --mount /pgadmin4=pgAdmin4:app

Then, configure NGINX:

location = /pgadmin4 { rewrite ^ /pgadmin4/; }
location /pgadmin4 { try_files $uri @pgadmin4; }
location @pgadmin4 {
  include uwsgi_params;
  uwsgi_pass unix:/tmp/pgadmin4.sock;
}

Additional Information

Note

pgAdmin will spawn additional Python processes from time to time, and relies on the sys.executable variable in Python to do this. In some cases, you may need to override that value to ensure the correct interpreter is used, instead of the WSGI host process. For example, uWSGI offers the –py-sys-executable command line option to achieve this.

Container Deployment

pgAdmin can be deployed in a container using the image at:

https://hub.docker.com/r/dpage/pgadmin4/

There are various tags that you can select from to get the version of pgAdmin that you want, using a command such as this if you’re using Docker:

docker pull dpage/pgadmin4:<tag name>

where <tag name> is one of the following:

Tag name

Description

latest

The most recent release.

8.4

A specific version (8.4 in this case).

8

the latest release of a specific major version (major version 8 in this case).

snapshot

The latest nightly test build.

PostgreSQL Utilities

The PostgreSQL utilities pg_dump, pg_dumpall, pg_restore and psql are included in the container to allow backups to be created and restored and other maintenance functions to be executed. Multiple versions are included in the following directories to allow use with different versions of the database server:

PostgreSQL 12: /usr/local/pgsql-12

PostgreSQL 13: /usr/local/pgsql-13

PostgreSQL 14: /usr/local/pgsql-14

PostgreSQL 15: /usr/local/pgsql-15

PostgreSQL 16: /usr/local/pgsql-16

The default binary paths set in the container are as follows:

DEFAULT_BINARY_PATHS = {
    'pg-16': '/usr/local/pgsql-16',
    'pg-15': '/usr/local/pgsql-15',
    'pg-14': '/usr/local/pgsql-14',
    'pg-13': '/usr/local/pgsql-13',
    'pg-12': '/usr/local/pgsql-12'
}

this may be changed in the Preferences Dialog.

Environment Variables

The container will accept the following variables at startup:

PGADMIN_DEFAULT_EMAIL

This is the email address used when setting up the initial administrator account to login to pgAdmin. This variable is required and must be set at launch time.

PGADMIN_DEFAULT_PASSWORD

This is the password used when setting up the initial administrator account to login to pgAdmin. This variable is required and must be set at launch time.

PGADMIN_DEFAULT_PASSWORD_FILE

This is the password used when setting up the initial administrator account to login to pgAdmin. This value should be set to docker secret in order to set the password. This variable is supported in docker swarm environment or while creating container with docker compose. PGADMIN_DEFAULT_PASSWORD or PGADMIN_DEFAULT_PASSWORD_FILE variable is required and must be set at launch time.

PGADMIN_DISABLE_POSTFIX

Default: <null>

If left unset, a Postfix server will be started to deliver password reset emails.

If set to any value, the Postfix server will not be started, and pgAdmin will need to be configured to use an external mail server using the PGADMIN_CONFIG_ options below.

This option is useful if you’re running in an environment that prevents the use of sudo to start Postfix, or if you wish to use an external mail server.

PGADMIN_ENABLE_TLS

Default: <null>

If left un-set, the container will listen on port 80 for connections in plain text. If set to any value, the container will listen on port 443 for TLS connections.

When TLS is enabled, a certificate and key must be provided. Typically these should be stored on the host file system and mounted from the container. The expected paths are /certs/server.cert and /certs/server.key

PGADMIN_LISTEN_ADDRESS

Default: [::]

Specify the local address that the servers listens on. The default should work for most users - in IPv4-only environments, this may need to be set to 0.0.0.0.

PGADMIN_LISTEN_PORT

Default: 80 or 443 (if TLS is enabled)

Allows the port that the server listens on to be set to a specific value rather than using the default.

PGADMIN_SERVER_JSON_FILE

Default: /pgadmin4/servers.json

Override the default file path for the server definition list. See the /pgadmin4/servers.json mapped file below for more information. See the format of the Servers JSON file [https://www.pgadmin.org/docs/pgadmin4/latest/import_export_servers.html#json-format].

PGADMIN_PREFERENCES_JSON_FILE

Default: /pgadmin4/preferences.json

Override the default file path for the preferences customization at the container creation. See the /pgadmin4/preferences.json mapped file below for more information. See the format of the Preferences JSON file [https://www.pgadmin.org/docs/pgadmin4/latest/preferences.html#json-format].

PGADMIN_CUSTOM_CONFIG_DISTRO_FILE

Default: /pgadmin4/config_distro.py

Override the default file path for the pgadmin configurations file.This can be used while provisioning container with read only root file system to achieve a more secure pgadmin4 deployment for kubernetes. Note that if you are externally mapping this file, then environment variables passed using PGADMIN_CONFIG_ suffix will be ignored.

PGPASS_FILE

Default: <null> This varible should be set to if you want to pass password using pgpass file for the servers added in pgadmin.

GUNICORN_ACCESS_LOGFILE

Default: - (stdout)

Specify an output file in which to store the Gunicorn access logs, instead of sending them to stdout.

GUNICORN_LIMIT_REQUEST_LINE

Default: 8190

Set the maximum size of HTTP request line in bytes. By default the pgAdmin container uses the maximum limited size offered by Gunicorn as some requests can be quite large. In exceptional cases this value can be set to 0 (zero) to specify “unlimited”, however this poses a potential denial of service hazard.

GUNICORN_THREADS

Default: 25

Adjust the number of threads the Gunicorn server uses to handle incoming requests. This should typically be left as-is, except in highly loaded systems where it may be increased.

PGADMIN_CONFIG_*

This is a variable prefix that can be used to override any of the configuration options in pgAdmin’s config.py file. Add the PGADMIN_CONFIG_ prefix to any variable name from config.py and give the value in the format ‘string value’ for strings, True/False for booleans or 123 for numbers. See below for an example.

Settings are written to /pgadmin4/config_distro.py within the container, which is read after /pgadmin4/config.py and before /pgadmin4/config_local.py. Any settings given will therefore override anything in config.py, but can be overridden by settings in config_local.py.

Settings are only written to /pgadmin4/config_distro.py once, typically on first launch of the container. If /pgadmin4/config_distro.py contains one or more lines, then no changes are made; for example, if the container instance is restarted, or /pgadmin4/config_distro.py is mapped to a file on persistent storage (not recommended - use /pgadmin4/config_local.py instead)!

See The config.py File for more information on the available configuration settings.

Mapped Files and Directories

The following files or directories can be mapped from the container onto the host machine to allow configuration to be customised and shared between instances.

Warning

Warning: pgAdmin runs as the pgadmin user (UID: 5050) in the pgadmin group (GID: 5050) in the container. You must ensure that all files are readable, and where necessary (e.g. the working/session directory) writeable for this user on the host machine. For example:

sudo chown -R 5050:5050 <host_directory>

On some filesystems that do not support extended attributes, it may not be possible to run pgAdmin without specifying a value for PGADMIN_LISTEN_PORT that is greater than 1024. In such cases, specify an alternate port when launching the container by adding the environment variable, for example:

-e 'PGADMIN_LISTEN_PORT=5050'

Don’t forget to adjust any host-container port mapping accordingly.

/var/lib/pgadmin

This is the working directory in which pgAdmin stores session data, user files, configuration files, and it’s configuration database. Mapping this directory onto the host machine gives you an easy way to maintain configuration between invocations of the container.

/pgadmin4/config_local.py

This file can be used to override configuration settings in pgAdmin. Settings found in config.py can be overridden with deployment specific values if required. Settings in config_local.py will also override anything specified in the container environment through PGADMIN_CONFIG_ prefixed variables.

/pgadmin4/servers.json

If this file is mapped, server definitions found in it will be loaded at launch time. This allows connection information to be pre-loaded into the instance of pgAdmin in the container. Note that server definitions are only loaded on first launch, i.e. when the configuration database is created, and not on subsequent launches using the same configuration database.

/pgadmin4/preferences.json

If this file is mapped, preferences defined in it will be updated at launch time. This allows customization of preferences settings into the instance of pgAdmin in the container. Note that preferences are only set on first launch, i.e. when the configuration database is created, and not on subsequent launches using the same configuration database.

/certs/server.cert

If TLS is enabled, this file will be used as the servers TLS certificate.

/certs/server.key

If TLS is enabled, this file will be used as the key file for the servers TLS certificate.

Examples

Run a simple container over port 80:

docker pull dpage/pgadmin4
docker run -p 80:80 \
    -e 'PGADMIN_DEFAULT_EMAIL=user@domain.com' \
    -e 'PGADMIN_DEFAULT_PASSWORD=SuperSecret' \
    -d dpage/pgadmin4

Run a simple container over port 80, setting some configuration options:

docker pull dpage/pgadmin4
docker run -p 80:80 \
    -e 'PGADMIN_DEFAULT_EMAIL=user@domain.com' \
    -e 'PGADMIN_DEFAULT_PASSWORD=SuperSecret' \
    -e 'PGADMIN_CONFIG_ENHANCED_COOKIE_PROTECTION=True' \
    -e 'PGADMIN_CONFIG_LOGIN_BANNER="Authorised users only!"' \
    -e 'PGADMIN_CONFIG_CONSOLE_LOG_LEVEL=10' \
    -d dpage/pgadmin4

Run a TLS secured container using a shared config/storage directory in /private/var/lib/pgadmin on the host, and servers pre-loaded from /tmp/servers.json on the host:

docker pull dpage/pgadmin4
docker run -p 443:443 \
    -v /private/var/lib/pgadmin:/var/lib/pgadmin \
    -v /path/to/certificate.cert:/certs/server.cert \
    -v /path/to/certificate.key:/certs/server.key \
    -v /tmp/servers.json:/pgadmin4/servers.json \
    -e 'PGADMIN_DEFAULT_EMAIL=user@domain.com' \
    -e 'PGADMIN_DEFAULT_PASSWORD=SuperSecret' \
    -e 'PGADMIN_ENABLE_TLS=True' \
    -d dpage/pgadmin4

Reverse Proxying

Sometimes it’s desirable to have users connect to pgAdmin through a reverse proxy rather than directly to the container it’s running in. The following examples show how this can be achieved. With traditional reverse proxy servers such as Nginx [https://www.nginx.com/], pgAdmin is running in a container on the same host, with port 5050 on the host mapped to port 80 on the container, for example:

docker pull dpage/pgadmin4
docker run -p 5050:80 \
    -e "PGADMIN_DEFAULT_EMAIL=user@domain.com" \
    -e "PGADMIN_DEFAULT_PASSWORD=SuperSecret" \
    -d dpage/pgadmin4

pgAdmin X-Forwarded-* Configuration

pgAdmin needs to understand how many proxies set each header so it knows what values to trust. The configuration parameters for the X-Forwarded-* options which are used for this purpose are shown below, along with their default values.

pgAdmin is configured by default to be able to run behind a reverse proxy even on a non-standard port and these config options don’t normally need to be changed. If you’re running an unusual configuration (such as multiple reverse proxies) you can adjust the configuration to suit.

# Number of values to trust for X-Forwarded-For
PROXY_X_FOR_COUNT = 1

# Number of values to trust for X-Forwarded-Proto.
PROXY_X_PROTO_COUNT = 0

# Number of values to trust for X-Forwarded-Host.
PROXY_X_HOST_COUNT = 0

# Number of values to trust for X-Forwarded-Port.
PROXY_X_PORT_COUNT = 1

# Number of values to trust for X-Forwarded-Prefix.
PROXY_X_PREFIX_COUNT = 0

HTTP via Nginx

A configuration similar to the following can be used to create a simple HTTP reverse proxy listening for all hostnames with Nginx [https://www.nginx.com/]:

server {
    listen 80;
    server_name _;

    location / {
        proxy_set_header Host $host;
        proxy_pass http://localhost:5050/;
        proxy_redirect off;
    }
}

If you wish to host pgAdmin under a subdirectory rather than on the root of the server, you must specify the location and set the X-Script-Name header which tells the pgAdmin container how to rewrite paths:

server {
    listen 80;
    server_name _;

    location /pgadmin4/ {
        proxy_set_header X-Script-Name /pgadmin4;
        proxy_set_header Host $host;
        proxy_pass http://localhost:5050/;
        proxy_redirect off;
    }
}

If Nginx is also running in a container, there is no need to map the pgAdmin port to the host, provided the two containers are running in the same Docker network. In such a configuration, the proxy_pass option would be changed to point to the pgAdmin container within the Docker network.

HTTPS via Nginx

The following configuration can be used to serve pgAdmin over HTTPS to the user whilst the backend container is serving plain HTTP to the proxy server. In this configuration we not only set X-Script-Name, but also X-Scheme to tell the pgAdmin server to generate any URLs using the correct scheme. A redirect from HTTP to HTTPS is also included. The certificate and key paths may need to be adjusted as appropriate to the specific deployment:

server {
    listen 80;
    return 301 https://$host$request_uri;
}

server {
    listen 443;
    server_name _;

    ssl_certificate /etc/nginx/server.cert;
    ssl_certificate_key /etc/nginx/server.key;

    ssl on;
    ssl_session_cache builtin:1000 shared:SSL:10m;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
    ssl_prefer_server_ciphers on;

    location /pgadmin4/ {
        proxy_set_header X-Script-Name /pgadmin4;
        proxy_set_header X-Scheme $scheme;
        proxy_set_header Host $host;
        proxy_pass http://localhost:5050/;
        proxy_redirect off;
    }
}

Traefik

Configuring Traefik [https://traefik.io/] is straightforward for either HTTP or HTTPS when running pgAdmin in a container as it will automatically configure itself to serve content from containers that are running on the local machine, virtual hosting them at <container_name>.<domain_name>, where the domain name is that specified in the Traefik configuration. The container is typically launched per the example below:

docker pull dpage/pgadmin4
docker run --name "pgadmin4" \
    -e "PGADMIN_DEFAULT_EMAIL=user@domain.com" \
    -e "PGADMIN_DEFAULT_PASSWORD=SuperSecret" \
    -d dpage/pgadmin4

Note that the TCP/IP port has not been mapped to the host as it was in the Nginx example, and the container name has been set to a known value as it will be used as the hostname and may need to be added to the DNS zone file.

The following configuration will listen on ports 80 and 443, redirecting 80 to 443, using the default certificate shipped with Traefik. See the Traefik documentation for options to use certificates from LetsEncrypt or other issuers.

defaultEntryPoints = ["http", "https"]

[entryPoints]
  [entryPoints.http]
    address = ":80"
      [entryPoints.http.redirect]
        entryPoint = "https"
  [entryPoints.https]
    address = ":443"
      [entryPoints.https.tls]

[docker]
domain = "domain_name"
watch = true

If you wish to host pgAdmin under a subdirectory using Traefik, the configuration changes are typically made to the way the container is launched and not to Traefik itself. For example, to host pgAdmin under /pgadmin4/ instead of at the root directory, the Traefik configuration above may be used if the container is launched like this while using the version v1 of Traefik:

docker pull dpage/pgadmin4
docker run --name "pgadmin4" \
    -e "PGADMIN_DEFAULT_EMAIL=user@domain.com" \
    -e "PGADMIN_DEFAULT_PASSWORD=SuperSecret" \
    -e "SCRIPT_NAME=/pgadmin4" \
    -l "traefik.frontend.rule=PathPrefix:/pgadmin4" \
    -d dpage/pgadmin4

The SCRIPT_NAME environment variable has been set to tell the container it is being hosted under a subdirectory (in the same way as the X-Script-Name header is used with Nginx), and a label has been added to tell Traefik to route requests under the subdirectory to this container.

While using the Traefik configuration for version v2 for hosting pgAdmin under subdirectory the container is typically launched per the example below:

docker pull dpage/pgadmin4
docker run --name "pgadmin4" \
    -e "PGADMIN_DEFAULT_EMAIL=user@domain.com" \
    -e "PGADMIN_DEFAULT_PASSWORD=SuperSecret" \
    -e "SCRIPT_NAME=/pgadmin4" \
    -l "traefik.frontend.pgadmin4.rule=Host(`host.example.com`) && PathPrefix(`/pgadmin4`)" \
    -d dpage/pgadmin4

Login Page

Use the Login page to log in to pgAdmin:

Use the fields in the Login page to authenticate your connection. There are two ways to authenticate your connection:

From pgAdmin version 4.21 onwards, support for LDAP authentication has been added. If LDAP authentication has been enabled for your pgAdmin application, you can use your LDAP credentials to log in to pgAdmin:

Provide the LDAP username in the Email Address/Username field.

Provide your LDAP password in the Password field.

Alternatively, you can use the following information to log in to pgAdmin:

Provide the email address associated with your account in the Email Address/Username field.

Provide your password in the Password field.

Click the Login button to securely log into pgAdmin.

Please note that if the pgAdmin server is restarted, then you will be logged out. You need to re-login to continue.

Recovering a Lost Password

If you cannot supply your password, click the Forgotten your password? button to launch a password recovery utility.

Provide the email address associated with your account in the Email Address field.

Click the Recover Password button to initiate recovery. An email, with directions on how to reset a password, will be sent to the address entered in the Email Address field.

If you have forgotten the email associated with your account, please contact your administrator.

Please note that your LDAP password cannot be recovered using this page. If you enter your LDAP username in the Email Address/Username field, and then enter your email to recover your password, an error message will be displayed asking you to contact the LDAP administrator to recover your LDAP password.

Avoiding a bruteforce attack

You have the possibility to lock an account by setting MAX_LOGIN_ATTEMPTS once it has reached the maximum number of login attempts. You can disable this feature by setting the value to zero.

Enabling two-factor authentication (2FA)

About two-factor authentication

Two-factor authentication (2FA) is an extra layer of security used when logging into websites or apps. With 2FA, you have to log in with your username and password and provide another form of authentication that only you know or have access to.

Setup two-factor authentication

To set up 2FA for pgAdmin 4, you must configure the Two-factor Authentication settings in config_local.py or config_system.py (see the config.py documentation) on the system where pgAdmin is installed in Server mode. You can copy these settings from config.py file and modify the values for the following parameters.

Parameter

Description

MFA_ENABLED

The default value for this parameter is True. To disable 2FA, set the value to False

SUPPORTED_MFA_LIST

Set the authentication methods to be supported

MFA_EMAIL_SUBJECT

<APP_NAME> - Verification Code e.g. pgAdmin 4 - Verification Code

MFA_FORCE_REGISTRATION

Force the user to configure the authentication method on login (if no authentication is already configured).

NOTE: You must set the ‘Mail server settings’ in config_local.py or config_system.py in order to use ‘email’ as two-factor authentication method (see the config.py documentation).

Configure two-factor authentication

To configure 2FA for a user, you must click on ‘Two-factor Authentication’ in the User menu in right-top corner. It will list down all the supported multi factor authentication methods. Click on ‘Setup’ of one of those methods and follow the steps for each authentication method. You will see the Delete button for the authentication method, which is already been configured. Clicking on Delete button will deregister the authentication method for the current user.

You can also force users to configure the two-factor authentication methods on login by setting MFA_FORCE_REGISTRATION parameter to True.

User Management Dialog

When invoking pgAdmin in desktop mode, a password is randomly generated, and then ignored. If you install pgAdmin in server mode, you will be prompted for an administrator email and password for the pgAdmin client.

When you authenticate with pgAdmin, the server definitions associated with that login role are made available in the tree control. An administrative user can use the User Management dialog to:

add or delete pgAdmin roles

assign privileges

manage the password associated with a role

Use the Search field to specify a criteria and review a list of users that matches with the specified criteria. You can enter a value that matches the following criteria types: Authentication source, Username, or Email. For example, you can enter ldap in the search box and only the records having ldap as authentication source will be displayed in the User Management table.

To add a user, click the Add (+) button at the top right corner.

Provide information about the new pgAdmin role in the row:

Use the drop-down list box next to Authentication source field to select the type of authentication that should be used for the user. If authentication source is only ‘internal’ then Authentication source field is disabled. Supported Authentication source are internal, ldap, kerberos, oauth2 and webserver.

Click in the Username field, and provide a username for the user. This field is enabled only when you select authentication source except internal. If you select internal as authentication source, your email address is displayed in the username field.

Click in the Email field, and provide an email address for the user.

Use the drop-down list box next to Role to select whether a user is an Administrator or a User.

Select Administrator if the user will have administrative privileges within the pgAdmin client.

Select User to create a non-administrative user account.

Move the Active switch to the No position if the account is not currently active; the default is Yes. Use this switch to disable account activity without deleting an account.

Use the New password field to provide the password associated with the user specified in the Email field. This field is disabled if you select any authentication source except internal.

Re-enter the password in the Confirm password field. This field is disabled if you select ldap as authentication source.

Locked switch is disabled by default when set to False. It is only enabled when the user is locked by trying unsuccessful login attempts. Move the switch to the False position if you want to unlock the account.

To discard a user, and revoke access to pgAdmin, click the trash icon to the left of the row and confirm deletion in the Delete user? dialog. If the user has created some shared servers, then the Change Ownership dialog will appear to change the ownership of a shared server.

Users with the Administrator role are able to add, edit and remove pgAdmin users, but otherwise have the same capabilities as those with the User role.

Click the Help button (?) to access online help.

Click the Close button to save work. You will be prompted to return to the dialog if your selections cannot be saved.

Using ‘setup.py’ command line script

Note

To manage users using setup.py script, you must use the Python interpreter that is normally used to run pgAdmin to ensure that the required Python packages are available. In most packages, this can be found in the Python Virtual Environment that can be found in the installation directory. When using platform-native packages, the system installation of Python may be the one used by pgAdmin.

When using PIP wheel package to install pgadmin, all the commands can be used without Python interpreter.

Some of the examples: pgadmin4-cli add-user user1@gmail.com password –role 1 pgadmin4-cli get-prefs

Manage Users

Add User

To add user, invoke setup.py with add-user command line option, followed by email and password. role and active will be optional fields.

/path/to/python /path/to/setup.py add-user user1@gmail.com password

# to specify a role, admin and non-admin users:

/path/to/python /path/to/setup.py add-user user1@gmail.com password --admin
/path/to/python /path/to/setup.py add-user user1@gmail.com password --nonadmin

# to specify user's status

/path/to/python /path/to/setup.py add-user user1@gmail.com password --active
/path/to/python /path/to/setup.py add-user user1@gmail.com password --inactive

Add External User

To add external authentication user, invoke setup.py with add-external-user command line option, followed by email, password and authentication source. email, role and status will be optional fields.

/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap

# to specify an email:

/path/to/python /path/to/setup.py add-external-user ldapuser ldap --email user1@gmail.com

# to specify a role, admin and non-admin user:

/path/to/python /path/to/setup.py add-external-user ldapuser ldap  --admin
/path/to/python /path/to/setup.py add-external-user ldapuser ldap  --nonadmin

# to specify user's status

/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap --active
/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap --inactive

Update User

To update user, invoke setup.py with update-user command line option, followed by email address. password, role and active are updatable fields.

 /path/to/python /path/to/setup.py update-user user1@gmail.com --password new-password

 # to specify a role, admin and non-admin user:

 /path/to/python /path/to/setup.py update-user user1@gmail.com password --role --admin
 /path/to/python /path/to/setup.py update-user user1@gmail.com password --role --nonadmin

 # to specify user's status

/path/to/python /path/to/setup.py update-user user1@gmail.com password --active
/path/to/python /path/to/setup.py update-user user1@gmail.com password --inactive

Update External User

To update the external user, invoke setup.py with update-external-user command line option, followed by username and auth source. email, password, role and active are updatable fields.

 # to change email address:

 /path/to/python /path/to/setup.py update-external-user ldap ldapuser --email newemail@gmail.com

 # to specify a role, admin and non-admin user:

 /path/to/python /path/to/setup.py update-user user1@gmail.com password --role --admin
 /path/to/python /path/to/setup.py update-user user1@gmail.com password --role --nonadmin

 # to change user's status

/path/to/python /path/to/setup.py update-user ldap ldapuser --active
/path/to/python /path/to/setup.py update-user ldap ldapuser --inactive

Delete User

To delete the user, invoke setup.py with delete-user command line option, followed by username and auth_source. For Internal users, email adress will be used instead of username. the option --yes is available to skip the confirmation prompt before deleting the user.

/path/to/python /path/to/setup.py delete-user user1@gmail.com --auth-source internal
/path/to/python /path/to/setup.py delete-user user2@gmail.com --auth-source internal --yes
/path/to/python /path/to/setup.py delete-user ldapuser --auth-source ldap

Get User

To get the user details, invoke setup.py with get-users command line option, followed by username/email address.

# to list all the users:
/path/to/python /path/to/setup.py get-users

# to get the user's details:
/path/to/python /path/to/setup.py get-users --username user1@gmail.com

Output

Each command output can be seen in the json format too by adding –json command line option.

Change Ownership Dialog

Use the Change Ownership dialog to change the ownership of the shared servers. This dialog will appear if a user has been deleted from User Management and owned some shared servers.

Choose the user who will own the shared servers from the drop-down.

Click the Change button to change the ownership.

The shared servers owned by the user will be deleted if the user is not selected from the drop-down.

Click the Change button to change the ownership; click Close to exit the dialog.

Change User Password Dialog

It is a good policy to routinely change your password to protect data, even in what you may consider a ‘safe’ environment. In the workplace, failure to apply an appropriate password policy could leave you in breach of Data Protection laws.

Please consider the following guidelines when selecting a password:

Ensure that your password is an adequate length; 6 characters should be the absolute minimum number of characters in the password.

The minimum password length is set by default to six characters. This value can be changed by setting the PASSWORD_LENGTH_MIN option to desired length in pgAdmin configuration; see The config.py File for more information.

Ensure that your password is not open to dictionary attacks. Use a mixture of upper and lower case letters and numerics, and avoid words or names. Consider using the first letter from each word in a phrase that you will remember easily but is an unfamiliar acronym.

Ensure that your password is changed regularly; at minimum, change it every ninety days.

The guidelines above should be considered a starting point: They are not a comprehensive list and they will not guarantee security.

Use the Change Password dialog to change your password:

Enter your existing password in the Current Password field.

Enter the desired password for in the New Password field.

Re-enter the new password in the Confirm Password field.

Click the Change Password button to change your password; click Close to exit the dialog.

Lock/Restore Account

Account locking/unlocking via user management dialog:

An admin can lock and unlock user from the user management dialog. This allows the admin to lock or restore the user when there are several failed login attempts. This page guides you through configuring per-user locking/restoring. For more details visit User management.

Parameter

Description

MAX_LOGIN_ATTEMPTS

Which sets the number of failed login that are allowed. If this value is exceeded, the account is locked and can be reset by an administrator. By setting the variable to the value zero this feature is deactivated.

When Administrator itself gets locked, following steps may be considered to restore it:

Increase MAX_LOGIN_ATTEMPTS, and try to successfully login to restore the account.

OR

By updating configuration database

SQLite DB (pgAdmin4.db):

Locate the pgAdmin4.db file and open it using any DB Browser (or DB Browser for SQLite)

After opening the DB file, head towards ‘Execute SQL’ section.

Run below query -

UPDATE USER SET LOCKED = false, LOGIN_ATTEMPTS = 0 WHERE USERNAME = <YOUR_EMAIL_ID>

External database:

Connect to the database.

Run below query -

UPDATE USER SET LOCKED = false, LOGIN_ATTEMPTS = 0 WHERE USERNAME = <YOUR_EMAIL_ID>

Make sure the query changes are committed.

Account locking by failed login attempts:

pgAdmin application is configured to lock a user account when a number of consecutive failed login attempts are exceeded.

MAX_LOGIN_ATTEMPTS is defaulted to 3 unsuccessful login attempts, after which the account would be locked.

The only way to restore the user account is by contacting the Administrator and ask to unlock it.

Enabling LDAP Authentication

To enable LDAP authentication for pgAdmin, you must configure the LDAP settings in the config_local.py or config_system.py file (see the config.py documentation) on the system where pgAdmin is installed in Server mode. You can copy these settings from config.py file and modify the values for the following parameters:

There are 3 ways to configure LDAP:

Bind as pgAdmin user

Anonymous bind

Dedicated user bind

Parameter

Description

AUTHENTICATION_SOURCES

The default value for this parameter is internal. To enable LDAP authentication, you must include ldap in the list of values for this parameter. you can modify the value as follows:

[‘ldap’]: pgAdmin will use only LDAP authentication.

[‘ldap’, ‘internal’]: pgAdmin will first try to authenticate the user through LDAP. If that authentication fails, then internal user entries of pgAdmin will be used for authentication.

[‘internal’, ‘ldap’]: pgAdmin will first try to authenticate the user through internal user entries. If that authentication fails, then LDAP authentication will be used.

LDAP_AUTO_CREATE_USER

Specifies if you want to automatically create a pgAdmin user corresponding to the LDAP user credentials. Please note that LDAP password is not stored in the pgAdmin database.

LDAP_CONNECTION_TIMEOUT

Specifies the connection timeout (in seconds) for LDAP authentication.

LDAP_SERVER_URI

An LDAP URI is a combination of connection protocol (ldap or ldaps), IP address/hostname and port of the directory server that you want to connect to. For example, ‘ldap://172.16.209.35:389’ is a valid LDAP_SERVER_URI where ldap is the connection protocol, 172.16.209.35 is the IP address and 389 is the port. Port 636 is used for the ldaps communication protocol.

LDAP_USERNAME_ATTRIBUTE

Specifies the LDAP attribute that contains the usernames. For LDAP authentication, you need to enter the value of that particular attribute as username. For example, if you set the value of LDAP_USERNAME_ATTRIBUTE as ‘cn’ and you have defined ‘cn=admin’ in your LDAP server entries, you should be able to authenticate by entering ‘admin’ in the Email Address / Username field and its corresponding password in the Password field.

LDAP_SEARCH_BASE_DN

Specifies the distinguished name (DN) for the top-most user directory that you want to search. You can use this parameter for limiting the search request to a specific group of users. For example, if you want to search only within the Organizational Unit named sales, you can define the value for LDAP_SEARCH_BASE_DN parameter as following: LDAP_SEARCH_BASE_DN = ‘ou=sales,dc=example,dc=com’

This is an optional parameter only while binding as pgAdmin user. If you do not specify any value for LDAP_SEARCH_BASE_DN, then the value for LDAP_BASE_DN will be considered for the same.

LDAP_SEARCH_FILTER

Defines the criteria to retrieve matching entries in an LDAP search request. For example, LDAP_SEARCH_FILTER = ‘(objectclass=HR)’ setting searches only for users having HR as their objectClass attribute.

LDAP_SEARCH_SCOPE

Indicates the set of entries at or below the Base DN that maybe considered as potential matches for a search request. You can specify the scope of a search as either a base, level, or subtree search. A base search limits the search to the base object. A level search is restricted to the immediate children of a base object, but excludes the base object itself. A subtree search includes all child objects as well as the base object.

LDAP_DN_CASE_SENSITIVE

Indicates whether the DN (Distinguished Names) are case sensitive or not. Possible values are True or False. By default is set to False.

LDAP_USE_STARTTLS

Specifies if you want to use Transport Layer Security (TLS) for secure communication between LDAP clients and LDAP servers. If you specify the connection protocol in LDAP_SERVER_URI as ldaps, this parameter is ignored.

LDAP_CA_CERT_FILE

Specifies the path to the trusted CA certificate file. This parameter is applicable only if you are using ldaps as connection protocol or you have set LDAP_USE_STARTTLS parameter to True.

LDAP_CERT_FILE

Specifies the path to the server certificate file. This parameter is applicable only if you are using ldaps as connection protocol or you have set LDAP_USE_STARTTLS parameter to True.

LDAP_KEY_FILE

Specifies the path to the server private key file. This parameter is applicable only if you are using ldaps as connection protocol or you have set LDAP_USE_STARTTLS parameter to True.

LDAP_IGNORE_MALFORMED_SCHEMA

Some flaky LDAP servers returns malformed schema. If this parameter set to True, no exception will be raised and schema is thrown away but authentication will be done. This parameter should remain False, as recommended.

Bind as pgAdmin user

LDAP_BASE_DN

Specifies the base DN from where a server will start the search for users. For example, an LDAP search for any user will be performed by the server starting at the base DN (dc=example,dc=com). When the base DN matches, the full DN (cn=admin,dc=example,dc=com) is used to bind with the supplied password.

Anonymous bind

LDAP_ANONYMOUS_BIND

Set this parameter to True for anonymous binding. After the connection is made, the pgadmin login user will be further authenticated by the username and password provided at the login screen.

Dedicated user bind

LDAP_BIND_USER

The account of the user to log in for simple bind. Set this parameter to allow the connection to bind using a dedicated user. After the connection is made, the pgadmin login user will be further authenticated by the username and password provided at the login screen. at the login screen.

LDAP_BIND_PASSWORD

Password for simple bind. Specify the value if you have set the LDAP_BIND_USER parameter.

Enabling Kerberos Authentication

Prerequisite: Kerberos understanding and setup

Reference: https://web.mit.edu/kerberos/

To configure Kerberos authentication, you must setup your Kerberos Server and obtain a ticket on the client using kinit.

Note: Active Directory users with Kerberos support do not require kinit.

To enable Kerberos authentication for pgAdmin, you must configure the Kerberos settings in config_local.py or config_system.py (see the config.py documentation) on the system where pgAdmin is installed in Server mode. You can copy these settings from config.py file and modify the values for the following parameters.

Parameter

Description

AUTHENTICATION_SOURCES

The default value for this parameter is internal. To enable Kerberos authentication, you must include kerberos in the list of values for this parameter. you can modify the value as follows:

[‘kerberos’]: pgAdmin will use only Kerberos authentication.

[‘kerberos’, ‘internal’]: pgAdmin will first try to authenticate the user through kerberos. If that authentication fails, then it will return back to the login page where you need to provide internal pgAdmin user credentials for authentication.

KERBEROS_AUTO_CREATE_USER

Set the value to True if you want to automatically create a pgAdmin user corresponding to a successfully authenticated Kerberos user. Please note that password is not stored in the pgAdmin database.

KRB_APP_HOST_NAME

Specify the name of pgAdmin webserver hostname. Please note that if it is not set, it will take the value of default_server parameter.

Keytab file for HTTP Service

Generate the Keytab file for the HTTP service principal HTTP/<host-name>@realm, and copy it to the pgAdmin webserver machine. Ensure that the operating system user owning the pgAdmin webserver is the owner of this file and should be accessible by that user.

Please note that either you should set default_keytab_name parameter in krb5.conf file or the environment variable KRB5_KTNAME. If not set then explicitly set KRB_KTNAME to the location of your Keytab file in the config_local.py or config_system.py file.

Apache HTTPD Configuration

If the pgAdmin server is under the Apache Server, then you need to add the following parameters in Directory directive of Apache HTTPD Configuration:

WSGIScriptReloading On

WSGIPassAuthorization On

Browser settings to configure Kerberos Authentication

You need to configure the browser settings on the client machine to use Kerberos authentication via SPNEGO.

For Mozilla Firefox

Open the low level Firefox configuration page by entering about:config in the address bar.

In the Search text box, enter: network.negotiate-auth.trusted-uris

Double-click the network.negotiate-auth.trusted-uris preference and enter the hostname or the domain of the web server that is protected by Kerberos HTTP SPNEGO. Separate multiple domains and hostnames with a comma.

Click OK.

For Google Chrome

On Windows:

Open the Control Panel to access the Internet Options dialog.

Select the Security tab.

Select the Local Intranet zone and click the Sites button.

Make sure that the first two options, Include all local (intranet) sites not listed in other zones and Include all sites that bypass the proxy server are checked.

Click Advanced and add the names of the domains that are protected by Kerberos HTTP SPNEGO, one at a time, to the list of websites. For example, myhost.example.com. Click Close.

Click OK to save your configuration changes.

On Linux or macOS:

Add the –auth-server-whitelist parameter to the google-chrome command. For example, to run Chrome from a Linux prompt, run the google-chrome command as follows:

google-chrome --auth-server-whitelist = "hostname/domain"

PostgreSQL Server settings to configure Kerberos Authentication

To connect the PostgreSQL server with Kerberos authentication, GSSAPI support has to be enabled when PostgreSQL is built and the necessary configuration [https://www.postgresql.org/docs/current/gssapi-auth.html] has to be in place.

In pgAdmin you need to enable Kerberos authentication for the PostgreSQL server by setting “Kerberos authentication” flag to True in the Server dialog. Once it is enabled, pgAdmin will not prompt for a password and will try to connect to the PostgreSQL server using Kerberos.

Note that, you have to login into pgAdmin with Kerberos authentication to then connect to PostgreSQL using Kerberos.

Master Password

In the multi user mode, pgAdmin uses user’s login password to encrypt/decrypt the PostgreSQL server password. In the Kerberos authentication, the pgAdmin user does not have the password, so we need an encryption key to store the PostgreSQL server password for the servers which are not configured to use the Kerberos authentication. To accomplish this, set the configuration parameter MASTER_PASSWORD to True, so upon setting the master password, it will be used as an encryption key while storing the password. If it is False, the server password can not be stored.

Enabling OAUTH2 Authentication

To enable OAUTH2 authentication for pgAdmin, you must configure the OAUTH2 settings in the config_local.py or config_system.py file (see the config.py documentation) on the system where pgAdmin is installed in Server mode. You can copy these settings from config.py file and modify the values for the following parameters:

Parameter

Description

AUTHENTICATION_SOURCES

The default value for this parameter is internal. To enable OAUTH2 authentication, you must include oauth2 in the list of values for this parameter. you can modify the value as follows:

[‘oauth2’, ‘internal’]: pgAdmin will display an additional button for authenticating with oauth2

OAUTH2_NAME

The name of the Oauth2 provider, ex: Google, Github

OAUTH2_DISPLAY_NAME

Oauth2 display name in pgAdmin

OAUTH2_CLIENT_ID

Oauth2 Client ID

OAUTH2_CLIENT_SECRET

Oauth2 Client Secret

OAUTH2_TOKEN_URL

Oauth2 Access Token endpoint

OAUTH2_AUTHORIZATION_URL

Endpoint for user authorization

OAUTH2_SERVER_METADATA_URL

Server metadata url for your OAuth2 provider

OAUTH2_API_BASE_URL

Oauth2 base URL endpoint to make requests simple, ex: https://api.github.com/

OAUTH2_USERINFO_ENDPOINT

User Endpoint, ex: user (for github) and userinfo (for google)

OAUTH2_SCOPE

Oauth scope, ex: ‘openid email profile’. Note that an ‘email’ claim is required in the resulting profile.

OAUTH2_ICON

The Font-awesome icon to be placed on the oauth2 button, ex: fa-github

OAUTH2_BUTTON_COLOR

Oauth2 button color

OAUTH2_USERNAME_CLAIM

The claim which is used for the username. If the value is empty

the email is used as username, but if a value is provided, the claim has to exist. Ex: oid (for AzureAD)

OAUTH2_AUTO_CREATE_USER

Set the value to True if you want to automatically

create a pgAdmin user corresponding to a successfully authenticated Oauth2 user. Please note that password is not stored in the pgAdmin database.

OAUTH2_ADDITIONAL_CLAIMS

If a dictionary is provided, pgAdmin will check for a matching key and value on the userinfo endpoint

and in the Id Token. In case there is no match with the provided config, the user will receive an authorization error. Useful for checking AzureAD [https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles] wids or groups, GitLab [https://docs.gitlab.com/ee/integration/openid_connect_provider.html#shared-information] owner, maintainer and reporter claims.

OAUTH2_SSL_CERT_VERIFICATION

Set this variable to False to disable SSL certificate verification for OAuth2 provider.

This may need to set False, in case of self-signed certificates.

Redirect URL

The redirect url to configure Oauth2 server is <http/https>://<pgAdmin Server URL>/oauth2/authorize After successful application authorization, the authorization server will redirect the user back to the pgAdmin url specified here. Select https scheme if your pgAdmin server serves over https protocol otherwise select http.

Master Password

In the multi user mode, pgAdmin uses user’s login password to encrypt/decrypt the PostgreSQL server password. In the Oauth2 authentication, the pgAdmin does not store the user’s password, so we need an encryption key to store the PostgreSQL server password. To accomplish this, set the configuration parameter MASTER_PASSWORD to True, so upon setting the master password, it will be used as an encryption key while storing the password. If it is False, the server password can not be stored.

Login Page

After configuration, on restart, you can see the login page with the Oauth2 login button(s).

Enabling Webserver Authentication

To configure Webserver authentication, you must setup your webserver with any authentication plug-in (such as Shibboleth, HTTP BASIC auth) as long as it sets the REMOTE_USER environment variable. To enable Webserver authentication for pgAdmin, you must configure the Webserver settings in the config_local.py or config_system.py file (see the config.py documentation) on the system where pgAdmin is installed in Server mode. You can copy these settings from config.py file and modify the values for the following parameters:

Parameter

Description

AUTHENTICATION_SOURCES

The default value for this parameter is internal. To enable OAUTH2 authentication, you must include webserver in the list of values for this parameter. you can modify the value as follows:

[‘webserver’]: pgAdmin will use only Webserver authentication.

[‘webserver’, ‘internal’]: pgAdmin will first try to authenticate the user through webserver. If that authentication fails, then it will return back to the login page where you need to provide internal pgAdmin user credentials for authentication.

WEBSERVER_AUTO_CREATE_USER

Set the value to True if you want to automatically

create a pgAdmin user corresponding to a successfully authenticated Webserver user. Please note that password is not stored in the pgAdmin database.

WEBSERVER_REMOTE_USER

To get the web server remote user details, set this variable to any header or

environment variable name which comes from the web server after webserver authentication. The default value is REMOTE_USER and the possible values are REMOTE_USER, HTTP_X_FORWARDED_USER, X-Forwarded-User.

Note

If REMOTE_USER does not work, try replacing it with either REMOTE-USER or Remote-user.

Master Password

In the multi user mode, pgAdmin uses user’s login password to encrypt/decrypt the PostgreSQL server password. In the Webserver authentication, the pgAdmin does not store the user’s password, so we need an encryption key to store the PostgreSQL server password. To accomplish this, set the configuration parameter MASTER_PASSWORD to True, so upon setting the master password, it will be used as an encryption key while storing the password. If it is False, the server password can not be stored.

User Interface

pgAdmin 4 supports all PostgreSQL features, from writing simple SQL queries to developing complex databases. It is designed to query an active database (in real-time), allowing you to stay current with modifications and implementations.

Features of pgAdmin 4 include:

auto-detection and support for objects discovered at run-time

a live SQL Query Tool with direct data editing

support for administrative queries

a syntax-highlighting SQL editor

redesigned graphical interfaces

powerful management dialogs and tools for common tasks

responsive, context-sensitive behavior

supportive error messages

helpful hints

online help and information about using pgAdmin dialogs and tools.

When pgAdmin opens, the interface features a menu bar and a window divided into two panes: the Object Explorer tree control in the left pane, and a tabbed browser in the right pane.

Select an icon from the Quick Links panel on the Dashboard tab to:

Click the Add New Server button to open the Create - Server dialog to add a new server definition.

Click the Configure pgAdmin button to open the Preferences dialog to customize your pgAdmin client.

Links in the Getting Started panel open a new browser tab that provide useful information for Postgres users:

Click the PostgreSQL Documentation link to navigate to the Documentation page for the PostgreSQL open-source project; once at the project site, you can review the manuals for the currently supported versions of the PostgreSQL server.

Click the pgAdmin Website link to navigate to the pgAdmin project website. The pgAdmin site features news about recent pgAdmin releases and other project information.

Click the Planet PostgreSQL link to navigate to the blog aggregator for Postgres related blogs.

Click the Community Support link to navigate to the Community page at the PostgreSQL open-source project site; this page provides information about obtaining support for PostgreSQL features.

Menu Bar

The pgAdmin menu bar provides drop-down menus for access to options, commands, and utilities. The menu bar displays the following selections: File, Object, Tools*, and Help. Selections may be grayed out which indicates they are disabled for the object currently selected in the pgAdmin tree control.

The File Menu

Use the File menu to access the following options:

Option

Action

Preferences

Click to open the Preferences dialog to customize your pgAdmin settings.

Reset Layout

If you have modified the workspace, click to restore the default layout.

Runtime

Click to open a submenu to Configure, View Log and Zoom settings. Only visible when pgAdmin4 runs in desktop mode. To know more about runtime menu click here

The Object Menu

The Object menu is context-sensitive. Use the Object menu to access the following options (in alphabetical order):

Option

Action

Register

Server

Deploy Cloud Instance

Click to open the Server dialog to register a server.

Click to open the Cloud Deployment dialog to deploy an cloud instance.

Change Password…

Click to open the Change Password… dialog to change your password.

Clear Saved Password

If you have saved the database server password, click to clear the saved password. Enable only when password is already saved.

Clear SSH Tunnel Password

If you have saved the ssh tunnel password, click to clear the saved password. Enable only when password is already saved.

Connect Server

Click to open the Connect to Server dialog to establish a connection with a server.

Copy Server…

Click to copy the currently selected server.

Create

Click Create to access a context menu that provides context-sensitive selections. Your selection opens a Create dialog for creating a new object.

Delete

Click to delete the currently selected object from the server.

Delete (Cascade)

Click to delete the currently selected object and all dependent objects from the server.

Delete (Force)

Click to delete the currently selected database with force option.

Disconnect from server

Click to disconnect from the currently selected server.

Properties…

Click to review or modify the currently selected object’s properties.

Refresh

Click to refresh the currently selected object.

Remove Server

Click to remove the currently selected server.

Scripts

Click to open the Query tool to edit or view the selected script from the flyout menu.

Trigger(s)

Click to Disable or Enable trigger(s) for the currently selected table. Options are displayed on the flyout menu.

Truncate

Click to remove all rows from a table (Truncate), to remove all rows from a table and its child tables (Truncate Cascade) or to remove all rows from a table and automatically restart sequences owned by columns (Truncate Restart Identity). Options are displayed on the flyout menu.

View Data

Click to access a context menu that provides several options for viewing data (see below).

ERD For Database

Click to open the ERD tool with automatically generated diagram for the database selected. This option is available only when a database is selected. Options are displayed on the flyout menu.

ERD For Table

Click to open the ERD tool with automatically generated diagram for the table selected. This option is available only when a table is selected. Options are displayed on the flyout menu.

The Tools Menu

Use the Tools menu to access the following options (in alphabetical order):

Option

Action

ERD Tool

Click to open the ERD Tool and start designing your database.

Grant Wizard…

Click to access the Grant Wizard tool.

PSQL Tool

Click to open the PSQL Tool and start PSQL in the current database context.

Query tool

Click to open the Query tool for the currently selected object.

Schema Diff

Click to open the Schema Diff and start comparing two database or two schema.

Backup Globals…

Click to open the Backup Globals… dialog to backup cluster objects.

Backup Server…

Click to open the Backup Server… dialog to backup a server.

Backup…

Click to open the Backup… dialog to backup database objects.

Restore…

Click to access the Restore dialog to restore database files from a backup.

Import/Export Data…

Click to open the Import/Export data… dialog to import or export data from a table.

Maintenance…

Click to open the Maintenance… dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER.

Search Objects…

Click to open the Search Objects… and start searching any kind of objects in a database.

Add named restore point

Click to open the Add named restore point… dialog to take a point-in-time snapshot of the current server state.

Pause replay of WAL

Click to pause the replay of the WAL log.

Resume replay of WAL

Click to resume the replay of the WAL log.

Reload Configuration…

Click to update configuration files without restarting the server.

Storage Manager

Click to open the Storage Manager to upload, delete, or download the backup files.

The Help Menu

Use the options on the Help menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order):

Option

Action

Quick Search

Type your keywords in the Quick Search field. Typing at least three characters will display all the matching possibilities under Menu items and the relevant documents under Help articles. Click on the options under Menu items to perform action of particular functionality or object. Click on any of the Help articles to open the help of that topic with highlighted text in a separate window.

Note:- If any of the option under Menu items is disabled, then it will provide information via info icon.

About pgAdmin 4

Click to open a window where you will find information about pgAdmin; this includes the current version and the current user.

Online Help

Click to open documentation support for using pgAdmin utilities, tools and dialogs. Navigate (in the newly opened tab?) help documents in the left browser pane or use the search bar to specify a topic.

pgAdmin Website

Click to open the pgAdmin.org website in a browser window.

PostgreSQL Website

Click to access the PostgreSQL core documentation hosted at the PostgreSQL site. The site also offers guides, tutorials, and resources.

Toolbar

The pgAdmin toolbar provides shortcut buttons for frequently used features like the Query Tool, View/Edit Data, Search Object and the PSQL Tool. This toolbar is visible on the Object explorer panel. Buttons get enabled/disabled based on the selected object node.

Use the Query Tool button to open the Query Tool in the current database context.

Use the View Data button to view/edit the data stored in a selected table.

Use the Filtered Rows button to access the Data Filter popup to apply a filter to a set of data for viewing/editing.

Use the Search objects button to access the search objects dialog. It helps you search any database object.

Use the PSQL Tool button to open the PSQL in the current database context.

Tabbed Browser

The right pane of the pgAdmin window features a collection of tabs that display information about the object currently selected in the pgAdmin tree control in the left window. Select a tab to access information about the highlighted object in the tree control.

The graphs and tables on the Dashboard tab provides an active analysis of system statistics and the usage statistics for the selected server or database.

Click the Activity tab to get the usage statistics for the selected server or database:

The Server sessions or Database sessions graph displays the interactions with the server or database.

The Transactions per second graph displays the commits, rollbacks, and total transactions per second that are taking place on the server or database.

The Tuples in graph displays the number of tuples inserted, updated, and deleted on the server or database.

The Tuples out graph displays the number of tuples fetched and returned from the server or database.

The Block I/O graph displays the number of blocks read from the filesystem or fetched from the buffer cache (but not the operating system’s file system cache) for the server or database.

Click the Stat tab to get the usage statistics for the selected server or database:

The Stat panel displays information about sessions, locks, prepared transactions. The information is presented in context-sensitive tables. Use controls located above the table to:

Click the Refresh button to update the information displayed in each table.

Select Active sessions only checkbox to get the information about active sessions only from the list of all the sessions.

Enter a value in the Search box to restrict the table content to one or more sessions that satisfy the search criteria. For example, you can enter a process ID to locate a specific session, or a session state (such as idle) to locate all of the sessions that are in an idle state.

You can use icons in the Sessions table to review or control the state of a session:

Use the Terminate icon (located in the first column) to stop a session and remove the session from the table. Before the server terminates the session, you will be prompted to confirm your selection.

Use the Cancel icon (located in the second column) to terminate an active query without closing the session. Before canceling the query, the server will prompt you to confirm your selection. When you cancel a query, the value displayed in the State column of the table will be updated from Active to Idle. The session will remain in the table until the session is terminated.

Use the Details icon (located in the third column) to open the Details tab; the tab displays information about the selected session.

Click the Configuration tab to get the server configuration details.

Click the Logs tab to get the server logs.

Use the Log Format switch to select the format you want. Text/Plain, JSON and CSV are supported. The enable/disable state of the log format depends on the Postgresql.conf setting.

Use the Logs in tabular format? switch if you want to see the logs in a tabular format.

Click the System Statistics tab to get the statistics for the system:

Click the Summary tab to get the summary of the system:

The OS Information table displays the basic information about the operating system.

The CPU Information table displays the information about system CPU.

The Process & Handle Count graph displays the total count of processes running and handles opened for the system.

Click the CPU tab to get the detailed usage statistics of the system CPU:

The CPU Usage graph displays the percentage of time spent by CPU for user normal process, user niced process, kernel mode process, idle mode.

The Load average graph displays the average load of the system over 1, 5, 10, and 15 minute intervals.

The Process CPU Usage table displays information about CPU for each process ID. Enter a value like process ID or name in the Search box to restrict the table content to one or more processes that satisfy the search criteria.

Click the Memory tab to get the detailed usage statistics of the system memory:

The Memory Usage graph displays the size of total, free and used memory per seconds in Gigabytes.

The Swap Memory graph displays the size of total, free and used swap memory per seconds in Gigabytes.

The Process Memory Usage table displays information about memory for each process ID. Enter a value like process ID or name in the Search box to restrict the table content to one or more processes that satisfy the search criteria.

Click the Storage tab to get the detailed information of the system storage:

The Disk Information table displays the information about the disk, such as file system type, mount point, total space, used space and free space and count of total, free, used inodes. The pie graph shows the total spaces in Gigabytes and stacked bar graph shows the used and available space in Gigabytes, for different mount points for file system.

The Swap Memory graph displays the size of total, free and used swap memory per seconds in Gigabytes.

The disk0 panel displays statistics about the only I/O block device of system:

The I/O Operations Count graph displays the count of read and write operations per second.

The Data Transfer graph displays the size of read and writes happened in Gigabytes per second.

The Time spent in I/O operations graph displays the time spent by the device for reading and writing in minutes per second.

The Properties tab displays information about the object selected.

Click the Delete icon in the toolbar under the browser tab to delete the selected objects in the Properties panel.

Click the Drop Cascade icon in the toolbar under the browser tab to delete the selected objects and all dependent objects in the Properties panel.

Click the Edit icon in the toolbar under the browser tabs to launch the Properties dialog for the selected object.

To preserve any changes to the Properties dialog, click the Save icon; your modifications will be displayed in the updated Properties tab.

Details about the object highlighted in the tree control are displayed in one or more collapsible panels. You can use the arrow to the left of each panel label to open or close a panel.

The SQL tab displays the SQL script that created the highlighted object, and when applicable, a (commented out) SQL statement that will DROP the selected object. You can copy the SQL statements to the editor of your choice using cut and paste shortcuts.

The Statistics tab displays the statistics gathered for each object on the tree control; the statistics displayed in the table vary by the type of object that is selected. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order. The following table lists some of the statistics that are available:

Panel

Description

PID

The process ID associated with the row.

User

The name of the user that owns the object.

Database

displays the database name.

Backends

displays the number of current connections to the database.

Backend start

The start time of the backend process.

Xact Committed

displays the number of transactions committed to the database within the last week.

Xact Rolled Back

displays the number of transactions rolled back within the last week.

Blocks Read

displays the number of blocks read from memory (in megabytes) within the last week.

Blocks Hit

displays the number of blocks hit in the cache (in megabytes) within the last week.

Tuples Returned

displays the number of tuples returned within the last week.

Tuples Fetched

displays the number of tuples fetched within the last week.

Tuples Inserted

displays the number of tuples inserted into the database within the last week.

Tuples Updated

displays the number of tuples updated in the database within the last week.

Tuples Deleted

displays the number of tuples deleted from the database within the last week.

Last statistics reset

displays the time of the last statistics reset for the database.

Tablespace conflicts

displays the number of queries canceled because of recovery conflict with dropped tablespaces in database.

Lock conflicts

displays the number of queries canceled because of recovery conflict with locks in database.

Snapshot conflicts

displays the number of queries canceled because of recovery conflict with old snapshots in database.

Bufferpin conflicts

displays the number of queries canceled because of recovery conflict with pinned buffers in database.

Temporary files

displays the total number of temporary files, including those used by the statistics collector.

Size of temporary files

displays the size of the temporary files.

Deadlocks

displays the number of queries canceled because of a recovery conflict with deadlocks in database.

Block read time

displays the number of milliseconds required to read the blocks read.

Block write time

displays the number of milliseconds required to write the blocks read.

Size

displays the size (in megabytes) of the selected database.

The Dependencies tab displays the objects on which the currently selected object depends. If a dependency is dropped, the object currently selected in the pgAdmin tree control will be affected. To ensure the integrity of the entire database structure, the database server makes sure that you do not accidentally drop objects that other objects depend on; you must use the DROP CASCADE command to remove an object with a dependency.

The Dependencies table displays the following information:

The Type field specifies the parent object type.

The Name field specifies the identifying name of the parent object.

The Restriction field describes the dependency relationship between the currently selected object and the parent:

If the field is auto, the selected object can be dropped separately from the parent object, and will be dropped if the parent object is dropped.

If the field is internal, the selected object was created during the creation of the parent object, and will be dropped if the parent object is dropped.

If the field is normal, the selected object can be dropped without dropping the parent object.

If the field is blank, the selected object is required by the system, and cannot be dropped.

The Dependents tab displays a table of objects that depend on the object currently selected in the pgAdmin browser. A dependent object can be dropped without affecting the object currently selected in the pgAdmin tree control.

The Type field specifies the dependent object type.

The Name field specifies the identifying name for the dependent object.

The Database field specifies the database in which the object resides.

Additional tabs open when you access the extended functionality offered by pgAdmin tools (such as the Query tool, Debugger, or SQL editor). Use the close icon (X) located in the upper-right corner of each tab to close the tab when you are finished using the tool. Like permanent tabs, these tabs may be repositioned in the pgAdmin client window.

By default, each time you open a tool, pgAdmin will open a new browser tab. You can control this behavior by modifying the Display node of the Preferences dialog for each tool. To open the Preferences dialog, select Preferences from the File menu.

Tree Control

The left pane of the main window displays a tree control (Object explorer) that provides access to the objects that reside on a server.

You can expand nodes in the tree control to view the database objects that reside on a selected server. The tree control expands to display a hierarchical view:

Use the plus sign (+) to the left of a node to expand a segment of the tree control.

Click the minus sign (-) to the left of a node to close that node.

You can also drag and drop certain objects to the Query Tool which can save time in typing long object names. Text containing the object name will be fully qualified with schema. Double quotes will be added if required. For functions and procedures, the function name along with parameter names will be pasted in the Query Tool.

Access context-sensitive menus by right-clicking on a node of the tree control to perform common tasks. Menus display options that include one or more of the following selections (options appear in alphabetical order):

Option

Action

Add named restore point

Click to create and enter the name of a restore point.

Backup…

Click to open the Backup… dialog to backup database objects.

Backup Globals…

Click to open the Backup Globals… dialog to backup cluster objects.

Backup Server…

Click to open the Backup Server… dialog to backup a server.

Connect Server…

Click to open the Connect to Server dialog to establish a connection with a server.

Create

Click to access a context menu that provides context-sensitive selections. Your selection opens a Create dialog for creating a new object.

CREATE Script

Click to open the Query tool to edit or view the CREATE script.

Debugging

Click through to open the Debug tool or to select Set breakpoint to stop or pause a script execution.

Delete

Click to delete the currently selected object from the server.

Delete (Cascade)

Click to delete the currently selected object and all dependent objects from the server.

Delete (Force)

Click to delete the currently selected database with force option.

Disconnect Database…

Click to terminate a database connection.

Disconnect from server

Click to disconnect from the currently selected server.

Debugging

Click to access the Debugger tool.

Grant Wizard

Click to access the Grant Wizard tool.

Maintenance…

Click to open the Maintenance… dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER.

Properties…

Click to review or modify the currently selected object’s properties.

Refresh…

Click to refresh the currently selected object.

Reload Configuration…

Click to update configuration files without restarting the server.

Restore…

Click to access the Restore dialog to restore database files from a backup.

View Data

Use the View Data option to access the data stored in a selected table with the Data Output tab of the Query Tool.

The context-sensitive menus associated with Tables and nested Table nodes provides additional display options (options appear in alphabetical order):

Option

Action

Import/Export Data…

Click open the Import/Export… dialog to import data to or export data from the selected table.

Reset Statistics

Click to reset statistics for the selected table.

Scripts

Click to open the Query tool to edit or view the selected script from the flyout menu.

Truncate

Click to remove all rows from a table.

Truncate Cascade

Click to remove all rows from a table and its child tables.

View First 100 Rows

Click to access a data grid that displays the first 100 rows of the selected table.

View Last 100 Rows

Click to access a data grid that displays the last 100 rows of the selected table.

View All Rows

Click to access a a data grid that displays all rows of the selected table.

View Filtered Rows…

Click to access the Data Filter popup to apply a filter to a set of data.

Preferences Dialog

Use options on the Preferences dialog to customize the behavior of the client. To open the Preferences dialog, select Preferences from the File menu. The left pane of the Preferences dialog displays a tree control; each node of the tree control provides access to options that are related to the node under which they are displayed.

Click the Reset all preferences button to restore all preferences to their default values.

The Browser Node

Use preferences found in the Browser node of the tree control to personalize your workspace.

Use the fields on the Display panel to specify general display preferences:

When the Auto-expand sole children switch is set to True, child nodes will be automatically expanded if a treeview node is expanded and has only a single child.

Use the Object explorer state saving interval field to set the treeview state saving interval. A value of -1 will disable the treeview state saving functionality.

When the Confirm before closing properties with unsaved changes switch is set to True, pgAdmin will warn you before closing the properties dialog of an object if there are any unsaved changes. On user confirmation, the properties dialog will close.

When the Confirm on close or refresh switch is set to True, pgAdmin will attempt to catch browser close or refresh events and prompt before allowing them to continue.

When the Hide shared servers? switch is set to True, the client will hide all the shared servers from the object explorer. Note: This option is visible only when pgAdmin is running in server mode.

When the Show empty object collections? switch is turned off, then all object collections which are empty will be hidden from browser tree.

When the Show system objects? switch is set to True, the client will display system objects such as system schemas (for example, pg_temp) or system columns (for example, xmin or ctid) in the tree control.

When the Show template databases? switch is set to True, the client will display template databases.

Use the fields on the Keyboard shortcuts panel to configure shortcuts for the main window navigation:

The panel displays a list of keyboard shortcuts available for the main window; select the combination of the modifier keys along with the key to configure each shortcut.

Use the fields on the Nodes panel to select the object types that will be displayed in the Browser tree control:

The panel displays a list of database objects; slide the switch located next to each object to Show or Hide the database object. When querying system catalogs, you can reduce the number of object types displayed to increase speed.

Use the fields on the Object Breadcrumbs panel to change object breadcrumbs related settings:

Use Enable object breadcrumbs? to enable or disable object breadcrumbs displayed on on object mouse hover.

Use Show comment with object breadcrumbs? to enable or disable the comment visibility which comes displayed with object breadcrumbs.

Use the fields on the Processes panel to change processes tab related settings:

Change Process details/logs retention days to the number of days, the process info and logs will be automatically cleared.

Use fields on the Properties panel to specify browser properties:

Include a value in the Count rows if estimated less than field to perform a SELECT count(*) if the estimated number of rows in a table (as read from the table statistics) is below the specified limit. After performing the SELECT count(*), pgAdmin will display the row count. The default is 2000.

Provide a value in the Maximum job history rows field to limit the number of rows to show on the statistics tab for pgAgent jobs. The default is 250.

Use field on Tab settings panel to specify the tab related properties.

Use Debugger tab title placeholder field to customize the Debugger tab title.

When the Dynamic tab size If set to True, the tabs will take full size as per the title, it will also applicable for already opened tabs

When the Open in new browser tab filed is selected for Query tool, Schema Diff or Debugger, it will open in a new browser tab when invoked.

Use the Query tool tab title placeholder field to customize the query tool tab title.

Use View/Edit tab title placeholder field to customize the View/Edit Data tab title.

The Dashboards Node

Expand the Dashboards node to specify your dashboard display preferences.

Set the warning and alert threshold value to highlight the long-running queries on the dashboard.

When the Show activity? switch is set to True, activity tables will be displayed on dashboards.

When the Show graphs? switch is set to True, graphs will be displayed on dashboards.

Use the fields on the Refresh rates panel to specify your refersh rates preferences for the graphs on the Dashboard tab:

Use the Average load statistics refresh rate field to specify the number of seconds between average load statistics samples displayed in graphs.

Use the Block I/O statistics refresh rate field to specify the number of seconds between block I/O statistic samples displayed in graphs.

Use the CPU usage per process statistics refresh rate field to specify the number of seconds between CPU usage per process statistics samples displayed in graphs.

Use the Handle & Process count statistics refresh rate field to specify the number of seconds between handle & process count statistics samples displayed in graphs.

Use the I/O analysis statistics refresh rate field to specify the number of seconds between I/O analysis statistics samples displayed in graphs.

Use the Memory usage per process statistics refresh rate field to specify the number of seconds between memory usage per process statistics samples displayed in graphs.

Use the Memory usage statistics refresh rate field to specify the number of seconds between memory usage statistics samples displayed in graphs.

Use the Percentage of CPU time used by different process modes statistics refresh rate field to specify the number of seconds between Percentage of CPU time used by different process modes samples displayed in graphs.

Use the Session statistics refresh rate field to specify the number of seconds between session statistic samples displayed in graphs.

Use the Swap memory usage statistics refresh rate field to specify the number of seconds between swap memory usage statistics samples displayed in graphs.

Use the Transaction throughput refresh rate field to specify the number of seconds between transaction throughput samples displayed in graphs.

Use the Tuples in refresh rate field to specify the number of seconds between tuples-in samples displayed in graphs.

Use the Tuples out refresh rate field to specify the number of seconds between tuples-out samples displayed in graphs.

The Debugger Node

Expand the Debugger node to specify your debugger display preferences.

Use the fields on the Keyboard shortcuts panel to configure shortcuts for the debugger window navigation:

The ERD Tool Node

Expand the ERD Tool node to specify your ERD Tool display preferences.

Use the fields on the Keyboard shortcuts panel to configure shortcuts for the ERD Tool window navigation:

Use the fields on the Options panel to manage ERD preferences.

Use Cardinality Notation to change the cardinality notation format used to present relationship links.

When the SQL With DROP Table switch is set to True, the SQL generated by the ERD Tool will add DROP table DDL before each CREATE table DDL.

Table Relation Depth is useful when generating an ERD for a table. It allows to set the limit on the depth level pgAdmin should traverse to find the relations. Use -1 to set no limit.

The Graphs Node

Expand the Graphs node to specify your Graphs display preferences.

Use the Chart line width field to specify the width of the lines on the line chart.

When the Show graph data points? switch is set to True, data points will be visible on graph lines.

When the Show mouse hover tooltip? switch is set to True, a tooltip will appear on mouse hover on the graph lines giving the data point details.

When the Use different data point styles? switch is set to True, data points will be visible in a different style on each graph lines.

The Miscellaneous Node

Expand the Miscellaneous node to specify miscellaneous display preferences.

Use the User language drop-down listbox to select the display language for the client.

Use the Themes drop-down listbox to select the theme for pgAdmin. You’ll also get a preview just below the drop down. You can also submit your own themes, check here [https://github.com/pgadmin-org/pgadmin4/blob/master/README.md] how. Currently we support Standard, Dark and High Contrast and System theme. Selecting System option will follow your computer’s settings.

The Paths Node

Expand the Paths node to specify the locations of supporting utility and help files.

Use the fields on the Binary paths panel to specify the path to the directory that contains the utility programs (pg_dump, pg_dumpall, pg_restore and psql) for monitored databases:

Use the EDB Advanced Server Binary Path grid to specify the location of the EDB Postgres Advanced Server utility programs based on the server version. If the respective path is not set, then pgAdmin will pick up the path for which ‘Set as default’ is checked else pgAdmin will attempt to find the utilities in standard locations used by EnterpriseDB.

Use the PostgreSQL Binary Path grid to specify the location of the PostgreSQL utility programs based on the server version. If the respective path is not set, then pgAdmin will pick up the path for which ‘Set as default’ is checked else pgAdmin will attempt to find the utilities in standard locations used by PostgreSQL.

Note: Use the ‘Validate path’ button to check the existence of the utility programs (pg_dump, pg_dumpall, pg_restore and psql) and there respective versions.

Use the fields on the Help panel to specify the location of help files.

Use the PostgreSQL Help Path to specify the path to PostgreSQL documentation.

Please note: the default help paths include the VERSION placeholder; the $VERSION$ placeholder will be replaced by the current database version.

The Query Tool Node

Expand the Query Tool node to access panels that allow you to specify your preferences for the Query Editor tool.

Use the fields on the Auto Completion panel to set the auto completion options.

When the Autocomplete on key press switch is set to True then autocomplete will be available on key press along with CTRL/CMD + Space. If it is set to False then autocomplete is only activated when CTRL/CMD + Space is pressed.

When the Keywords in uppercase switch is set to True then keywords are shown in upper case.

Use the fields on the CSV/TXT Output panel to control the CSV/TXT output.

Use the CSV field separator drop-down listbox to specify the separator character that will be used in CSV/TXT output.

Use the CSV quote character drop-down listbox to specify the quote character that will be used in CSV/TXT output.

Use the CSV quoting drop-down listbox to select the fields that will be quoted in the CSV/TXT output; select Strings, All, or None.

Use the Replace null values with option to replace null values with specified string in the output file. Default is set to ‘NULL’.

Use the fields on the Display panel to specify your preferences for the Query Tool display.

When the Connection status switch is set to True, each new instance of the Query Tool will display connection and transaction status.

Use the Connection status refresh rate field to specify the number of seconds between connection/transaction status updates.

When the Show query success notification? switch is set to True, the Query Tool will show notifications on successful query execution.

Use the fields on the Editor panel to change settings of the query editor.

When the Brace matching? switch is set to True, the editor will highlight pairs of matched braces.

When the Code folding? switch is set to False, the editor will disable code folding. Disabling will improve editor performance with large files.

Use the Font size field to specify the font size that will be used in text boxes and editors.

When the Insert bracket pairs? switch is set to True, the editor will automatically insert paired brackets.

When the Line wrapping switch is set to True, the editor will implement line-wrapping behavior.

When the Plain text mode? switch is set to True, the editor mode will be changed to text/plain. Keyword highlighting and code folding will be disabled. This will improve editor performance with large files.

When the Highlight selection matches? switch is set to True, the editor will highlight matched selected text.

Use the fields on the Explain panel to specify the level of detail included in a graphical EXPLAIN.

When the Show buffers? switch is set to True, graphical explain details will include information about buffer usage.

When the Show costs? switch is set to True, graphical explain details will include information about the estimated startup and total cost of each plan, as well as the estimated number of rows and the estimated width of each row.

When the Show settings? switch is set to True, graphical explain details will include the information on the configuration parameters.

When the Show summary? switch is set to True, graphical explain details will include the summary information about the query plan.

When the Show timing? switch is set to True, graphical explain details will include the startup time and time spent in each node in the output.

When the Show wal? switch is set to True, graphical explain details will include the information on WAL record generation.

When the Verbose output? switch is set to True, graphical explain details will include extended information about the query execution plan.

Use the fields on the Graph Visualiser panel to specify the settings related to graphs.

Use the Row Limit field to specify the maximum number of rows that will be plotted on a chart.

Use the fields on the Options panel to manage editor preferences.

When the Auto commit? switch is set to True, each successful query is committed after execution.

When the Auto rollback on error? switch is set to True, failed queries are rolled back.

When the Copy SQL from main window to query tool? switch is set to True, the CREATE sql of the selected object will be copied to query tool when query tool will open.

When the Prompt to save unsaved data changes? switch is set to True, the editor will prompt the user to saved unsaved data when exiting the data editor.

When the Prompt to save unsaved query changes? switch is set to True, the editor will prompt the user to saved unsaved query modifications when exiting the Query Tool.

When the Prompt to commit/rollback active transactions? switch is set to True, the editor will prompt the user to commit or rollback changes when exiting the Query Tool while the current transaction is not committed.

When the Sort View Data results by primary key columns? If set to True, data returned when using the View/Edit Data - All Rows option will be sorted by the Primary Key columns by default. When using the First/Last 100 Rows options, data is always sorted.

When the Show View/Edit Data Promotion Warning? switch is set to True View/Edit Data tool will show promote to Query tool confirm dialog on query edit.

When the Underline query at cursor? switch is set to True, query tool will parse and underline the query at the cursor position.

When the Underlined query execute warning? switch is set to True, query tool will warn upon clicking the Execute Query button in the query tool. The warning will appear only if Underline query at cursor? is set to False.

Use the fields on the Results grid panel to specify your formatting preferences for copied data.

When the Columns sized by is set to Column data, then data columns will auto-size to the maximum width of the data in the column as loaded in the first batch. If set to Column name, the column will be sized to the widest of the data type or column name.

Specify the maximum width of the column in pixels when ‘Columns sized by’ is set to Column data. If ‘Columns sized by’ is set to Column name then this setting won’t have any effect.

Specify the number of records to fetch in one batch. Changing this value will override DATA_RESULT_ROWS_PER_PAGE setting from config file.

Use the Result copy field separator drop-down listbox to select the field separator for copied data.

Use the Result copy quote character drop-down listbox to select the quote character for copied data.

Use the Result copy quoting drop-down listbox to select which type of fields require quoting; select All, None, or Strings.

When the Striped rows? switch is set to true, the result grid will display rows with alternating background colors.

Use the fields on the Keyboard shortcuts panel to configure shortcuts for the Query Tool window navigation.

Use the fields on the SQL formatting panel to specify your preferences for reformatting of SQL.

Use the Data type case option to specify whether to change data types into upper, lower, or preserve case.

Use the Expression width option to specify maximum number of characters in parenthesized expressions to be kept on single line.

Use the Function case option to specify whether to change function names into upper, lower, or preserve case.

Use the Identifier case option to specify whether to change identifiers (object names) into upper, lower, or capitalized case.

Use the Keyword case option to specify whether to change keywords into upper, lower, or preserve case.

Use Lines between queries to specify how many empty lines to leave between SQL statements. If set to zero it puts no new line.

Use Logical operator new line to specify newline placement before or after logical operators (AND, OR, XOR).

Use New line before semicolon? to specify whether to place query separator (;) on a separate line.

Use the Spaces around operators? option to specify whether or not to include spaces on either side of operators.

Use the Tab size option to specify the number of spaces per tab or indent.

Use the Use spaces? option to select whether to use spaces or tabs when indenting.

The Schema Diff Node

Expand the Schema Diff node to specify your display preferences.

Use the Ignore Grant/Revoke switch to ignores the grant and revoke command while comparing the objects.

Use the Ignore Owner switch to ignores the owner while comparing the objects.

Use the Ignore Tablespace switch to ignores the tablespace while comparing the objects.

Use the Ignore Whitespace switch to ignores the whitespace while comparing the string objects. Whitespace includes space, tabs, and CRLF.

The Storage Node

Expand the Storage node to specify your storage preferences.

Use the fields on the Options panel to specify storage preferences.

Use the File dialog view drop-down listbox to select the style of icons and display format that will be displayed when you open the file manager; select List to display a list view, or Grid to display folder icons.

Use the Last directory visited field to specify the name of the folder in which the file manager will open.

Use the Maximum file upload size(MB) field on the Options panel of the Storage node to specify the maximum file size for an upload.

When the Show hidden files and folders? switch is set to True, the file manager will display hidden files and folders.

Using ‘setup.py’ command line script

Note

To manage preferences using setup.py script, you must use the Python interpreter that is normally used to run pgAdmin to ensure that the required Python packages are available. In most packages, this can be found in the Python Virtual Environment that can be found in the installation directory. When using platform-native packages, the system installation of Python may be the one used by pgAdmin.

Manage Preferences

Get Preferences

To get all the preferences listed, invoke setup.py with get-prefs command line option. You can also get this mapping by hovering the individual preference in the Preference UI dialog.

/path/to/python /path/to/setup.py get-prefs

Save Preferences

To save the preferences, invoke setup.py with set-prefs command line option, followed by username, preference_key=value and auth_source. Multiple preference can be given too by a space separated. If auth_source is not given, Internal authentication will be consider by default.

/path/to/python /path/to/setup.py set-prefs user1@gmail.com sqleditor:editor:comma_first=true

# To specify multiple preferences options
/path/to/python /path/to/setup.py set-prefs user1@gmail.com sqleditor:editor:comma_first=true sqleditor:keyboard_shortcuts:toggle_case=true

# to specify an auth_source
/path/to/python /path/to/setup.py set-prefs user1@gmail.com sqleditor:editor:comma_first=true --auth-source=ldap

Updating Preferences preferences.json

To update preferences defined in json file, simply run setup.py `` with ``set-prefs command followed by username and JSON file containing the preferences.

/path/to/python /path/to/setup.py set-prefs user1@gmail.com --input-file /Users/yogeshmahajan/Desktop/pref.json

JSON format

The JSON file simply contains preference_key=value. Preference key value mapping can be obtained by hovering the individual preference in the Preference UI dialog.

The following is an typical example for preferences.json :

{
    "preferences":
        {
            "browser:display:show_system_objects":  true,
            "browser:display:show_user_defined_templates": true,
            "browser:display:confirm_on_refresh_close": false,
            "misc:themes:theme": "dark",

        }
}

Keyboard Shortcuts:

Keyboard shortcuts are provided in pgAdmin to allow easy access to specific functions. Alternate shortcuts can be configured through File > Preferences if desired.

Main Browser Window

When using main browser window, the following keyboard shortcuts are available:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Shift + Ctrl + a

Shift + Ctrl + a

Add grid row

Shift + Alt + b

Shift + Option + b

Object explorer

Shift + Alt + n

Shift + Option + n

Create object

Shift + Alt + d

Shift + Option + d

Delete object

Shift + Alt + g

Shift + Option + g

Direct debugging

Shift + Alt + e

Shift + Option + e

Edit object properties

Shift + Alt + f

Shift + Option + f

File main menu

Shift + Alt + h

Shift + Option + h

Help main menu

Shift + Alt + o

Shift + Option + o

Object main menu

Shift + Alt + q

Shift + Option + q

Open query tool

Shift + Ctrl + f

Shift + Ctrl + f

Quick Search

F5

F5

Refresh object explorer

Shift + Alt + s

Shift + Option + s

Search objects

Shift + Alt + [

Shift + Option + [

Tabbed panel backward

Shift + Alt + ]

Shift + Option + ]

Tabbed panel forward

Shift + Alt + w

Shift + Ctrl + w

Close tab panel

Shift + Alt + l

Shift + Option + l

Tools main menu

Shift + Alt + v

Shift + Option + v

View data

Property Grid Controls

Use the shortcuts below when working with property grid controls:

Shortcut for all platforms

Function

Ctrl + Shift + A

Add row in Grid

Tab

Move focus to the next control

Shift + Tab

Move focus to the previous control

Return

Pick the selected an item in a combo box

SQL Editors

When using the syntax-highlighting SQL editors, the following shortcuts are available:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Alt + Left

Option + Left

Move to the beginning of the line

Alt + Right

Option + Right

Move to the end of the line

Ctrl + Alt + Left

Cmd + Option + Left

Move left one word

Ctrl + Alt + Right

Cmd + Option + Right

Move right one word

Ctrl + /

Cmd + /

Comment/Uncomment code (Block)

Ctrl + a

Cmd + a

Select all

Ctrl + c

Cmd + c

Copy selected text to the clipboard

Ctrl + r

Cmd + r

Redo last edit un-done

Ctrl + v

Cmd + v

Paste text from the clipboard

Ctrl + z

Cmd + z

Undo last edit

Tab

Tab

Indent selected text

Shift + Tab

Shift + Tab

Un-indent selected text

Ctrl + l

Cmd + l

Go to line, column

Ctrl + Space

Ctrl + Space

Auto-complete

Ctrl + f

Cmd + f

Find

Ctrl + Shift + f

Option + Cmd + f

Replace

Query Tool

When using the Query Tool, the following shortcuts are available:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Ctrl + o

Cmd + o

Open file

Ctrl + s

Cmd + s

Save file

Alt + Shift + n

Option + Shift + n

Edit options

Alt + Shift + f

Option + Shift + f

Sort/Filter

Alt + Shift + i

Option + Shift + i

Filter options

Alt + Shift + q

Option + Shift + q

Cancel query

F5

F5

Execute Script

Alt + Shift + x

Option + Shift + x

Execute options

F7

F7

EXPLAIN query

Shift + F7

Shift + F7

EXPLAIN ANALYZE query

Shift + Ctrl + m

Shift + Ctrl + m

Commit

Shift + Ctrl + r

Shift + Ctrl + r

Rollback

Alt + Ctrl + a

Option + Ctrl + a

Add row

Ctrl + c

Cmd + c

Copy rows

Alt + Shift + p

Option + Shift + p

Paste rows

Alt + Shift + d

Option + Shift + d

Delete rows

F6

F6

Save data changes

Ctrl + Alt + L

Ctrl + option + L

Clear query

F8

F8

Download Results

Shift + Alt + ]

Shift + option + ]

Next tab

Shift + Alt + [

Shift + option + [

Previous tab

Shift + Alt + Tab

Shift + option + Tab

Switch Panel

Shift + Ctrl + u

Shift + Ctrl + u

Toggle case of selected text

Debugger

When using the Debugger, the following shortcuts are available:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Alt + Shift + x

Option + Shift + x

Clear all breakpoints

Alt + Shift + c

Option + Shift + c

Continue/Start

Alt + Shift + i

Option + Shift + i

Step into

Alt + Shift + o

Option + Shift + o

Step over

Alt + Shift + s

Option + Shift + s

Stop

Alt + Shift + t

Option + Shift + t

Toggle breakpoint

Alt + Shift + q

Option + Shift + q

Edit grid values

Alt + Shift + ]

Option + Shift + ]

Next tab

Alt + Shift + [

Option + Shift + ]

Previous tab

Alt + Shift + Tab

Option + Shift + Tab

Switch Panel

ERD Tool

When using the ERD Tool, the following shortcuts are available:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Ctrl + Alt + a

Ctrl + option + a

Add table

Ctrl + Alt + n

Ctrl + option + n

Add/Edit note

Ctrl + Alt + l

Ctrl + option + l

Auto align

Ctrl + Alt + c

Ctrl + option + c

Clone table

Ctrl + Alt + i

Ctrl + option + i

Download image

Ctrl + Alt + d

Ctrl + option + d

Drop table

Ctrl + Alt + e

Ctrl + option + e

Edit table

Ctrl + Alt + s

Ctrl + option + s

Generate SQL

Ctrl + Alt + m

Ctrl + option + m

Many to many link

Ctrl + Alt + o

Ctrl + option + o

One to many link

Ctrl + o

Ctrl + o

Open project

Ctrl + s

Ctrl + s

Save project

Shift + Ctrl + s

Shift + Ctrl + s

Save project as

Ctrl + Alt + t

Ctrl + option + t

Show more/fewer details

Shift + Alt + +

Shift + option + +

Zoom in

Shift + Alt + -

Shift + option + -

Zoom out

Shift + Alt + f

Shift + option + f

Zoom to fit

Inner Tab and Panel Navigation

When using the Query Tool and Debugger, the following shortcuts are available for inner panel navigation:

Shortcut (Windows/Linux)

Shortcut (Mac)

Function

Alt + Shift + ]

Option + Shift + ]

Move to next tab within a panel

Alt + Shift + [

Option + Shift + [

Move to previous tab within a panel

Alt + Shift + Tab

Option + Shift + Tab

Move between inner panels

Search objects

With this dialog, you can search for almost any kind of objects in a database.

You can access it by right clicking a database or any of its child nodes and select “Search objects”. You can also access it by hitting the shortcut (default ALT+SHIFT+S).

The minimum pattern length are 3 characters. The search performed is non-casesensitive and will find all objets whose name contains the pattern. You can only search for object names currently. Examples are: abc, %ab%, ab%c, %%%, etc.

The result is presented in the grid with object name, object type and the object path in the object explorer. You can double click on a result row to select the object in the object explorer. If the object is greyed out, this means that you have not enabled those object types in the preferences, so you can’t double click on it. You can click on the ellipsis appended to the function and procedure names to see their arguments.

You can filter based on a particular object type by selecting one from the object type dropdown. If the search button is hit when one of the object type is selected then only those types will be fetch from the database. An object type will not be visible in the dropdown if the database server does not support it or if it is not enabled from the preferences.

External database for pgAdmin user settings

The user settings used by pgAdmin are stored in a SQLite database. In this database, many settings are stored, such as preferences, user accounts, auto-discovered servers, and many more.

As SQLite is a file-based database and it can be anywhere in the file system, so it is not designed to take care of failures (no HA support). Furthermore, it isn’t designed to handle multiple connections concurrently reading/writing data to it. Example: In environments such as Kubernetes it may be useful to use an alternate backend to avoid using SQLite on non-ephemeral storage and to allow HA of the settings database.

In order to prevent this, pgAdmin now supports storing user settings in an external database using the new ‘CONFIG_DATABASE_URI’ parameter in the config.py file.

Use SQLite Database

In order to use SQLite Database, make sure CONFIG_DATABASE_URI parameter is set to an empty string like ‘’. By default it is set to an empty string in the config.py so if you would like to use SQLite database then no need to change anything.

Use External Database

In order to use an external database, make sure CONFIG_DATABASE_URI parameter is set like “dialect+driver://username:password@host:port/database”.

Note It is recommended to create the database in advance.

Use PostgreSQL Database

Following are the formats to use PostgreSQL as an external database.

Basic syntax:

postgresql://username:password@host:port/database

Using specific schema (It is recommended to create the schema in advance):

postgresql://username:password@host:port/database?options=-csearch_path=<schema name>

Using default pgpass path for the service account:

postgresql://username@host:port?options=-csearch_path=<schema name>

Specifying pgpass file path:

postgresql://username@host:port?passfile=<path of the pgpass file>&options=-csearch_path=<schema name>

Connecting To A Server

Before you can use the pgAdmin client to manage the objects that reside on your Postgres server, you must define a connection to the server. You can (optionally) use the Server Group dialog to create server groups to organize the server connections within the tree control for easier management. To open the Server Group dialog, right-click on the Servers node of the tree control, and select Server Group from the Create menu.

Server Group Dialog

Use the fields on the Server dialog to define the connection properties for each new server that you wish to manage with pgAdmin. To open the Server dialog, right-click on the Servers node of the tree control, and select Server from the Register menu.

Server Dialog

Clear Saved Passwords

Alternatively you can use the Cloud Deployment wizard to deploy a new PostgreSQL instance in the cloud, and connect to it.

PostgreSQL Cloud Deployment

Amazon RDS Cloud Deployment

EDB BigAnimal Cloud Deployment

Azure Database Cloud Deployment

Google Cloud SQL Deployment

A master password is required to secure and later unlock saved server passwords. It is set by the user and can be disabled using config.

Master Password

After defining a server connection, right-click on the server name, and select Connect to server to authenticate with the server, and start using pgAdmin to manage objects that reside on the server.

Connect to Server

Connection Error

Server definitions (and their groups) can be exported to a JSON file and re-imported to the same or a different system to enable easy pre-configuration of pgAdmin.

Import/Export Servers

Using pgAdmin 4 GUI

Using ‘setup.py’ command line script

Exporting Servers

Importing Servers

JSON format

Server Group Dialog

Use the Server Group dialog to add a new server group. Assign servers to server groups to simplify management of multiple servers. Server groups are displayed as part of the pgAdmin tree control.

Use the Name field on the Server Group dialog to specify a name that will identify the server group in the pgAdmin tree control.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

To create server connections in a server group, right click on the named server group and select the Create option to open the Create - Server dialog.

Server Dialog

Use the Server dialog to describe a connection to a server. Note: you must ensure that the pg_hba.conf file of the server from which you are connecting allows connections from the host of the client.

Use the fields in the General tab to identify the server:

Use the Name field to add a descriptive name for the server; the name specified will be displayed in the Object Explorer.

Use the drop-down list box in the Server group field to select the parent node for the server; the server will be displayed in the Object Explorer control within the specified group.

Use the color-picker in the Background field to specify the background color for the server.

Use the color-picker in the Foreground field to specify the foreground color for the server.

If the Connect now? checkbox is checked, the client will attempt a connection to the server upon completion of the dialog; this is the default

If the Shared? switch is moved to Yes then that server can be shared with all the other users. This option is available only to admin users. For more information on users see User Management Dialog. Users can access the shared servers with some restrictions - the following operations on shared servers are not permitted:

Delete the server

Rename the server

Rename the group server

Change of host, port, and maintenance database

Please note that once the server is shared, it’s icon is changed in the object explorer.

Use the Shared Username field to fill the username of the shared server connection. By default, it will take the username of the server being shared.

Provide a comment about the server in the Comments field.

Click the Connection tab to continue.

Use the fields in the Connection tab to configure a connection:

Specify the IP address of the server host, or the fully qualified domain name in the Host name/address field. If you provide a unix domain socket, the directory name must begin with a “/”.

Enter the listener port number of the server host in the Port field. The default is 5432.

Use the Maintenance database field to specify the name of the initial database to which the client will connect. If you will be using pgAgent or adminpack objects, the pgAgent schema and adminpack objects should be installed on that database.

Use the Username field to specify the name of a role that will be used when authenticating with the server.

When Kerberos authentication? is set to True, pgAdmin will try to connect the PostgreSQL server using Kerberos authentication.

Use the Password field to provide a password that will be supplied when authenticating with the server.

Check the box next to Save password? to instruct pgAdmin to save the password for future use. Use Clear Saved Password to remove the saved password.

Use the Role field to specify the name of a role that has privileges that will be conveyed to the client after authentication with the server. This selection allows you to connect as one role, and then assume the permissions of this specified role after the connection is established. Note that the connecting role must be a member of the role specified.

Use the Service field to specify the service name. For more information, see Section 33.16 of the Postgres documentation [https://www.postgresql.org/docs/current/libpq-pgservice.html].

Click the Parameters tab to continue.

Use the fields in the Parameters tab to configure a connection:

Click on the + button to add a new parameter. Some of the parameters are:

Host address using this field to specify the host IP address may save time by avoiding a DNS lookup on connection, but it may be useful to specify both a host name and address when using Kerberos, GSSAPI, or SSPI authentication methods, as well as for verify-full SSL certificate verification.

Password File field to specify the location of a password file (.pgpass). A .pgpass file allows a user to login without providing a password when they connect. For more information, see Section 33.15 of the Postgres documentation [https://www.postgresql.org/docs/current/libpq-pgpass.html].

Connection timeout field to specify the maximum wait for connection, in seconds. Zero or not specified means wait indefinitely. It is not recommended to use a timeout of less than 2 seconds. By default it is set to 10 seconds.

SSL mode field to select the type of SSL connection the server should use. For more information about using SSL encryption, see Section 33.18 of the Postgres documentation [https://www.postgresql.org/docs/current/libpq-ssl.html].

If pgAdmin is installed in Server mode (the default mode), you can use the platform-specific File manager dialog to upload files that support SSL encryption to the server. To access the File manager dialog, click the icon that is located to the right of each of the following fields.

Client certificate field to specify the file containing the client SSL certificate. This file will replace the default ~/.postgresql/postgresql.crt if pgAdmin is installed in Desktop mode, and <STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt if pgAdmin is installed in Web mode. This parameter is ignored if an SSL connection is not made.

Client certificate key field to specify the file containing the secret key used for the client certificate. This file will replace the default ~/.postgresql/postgresql.key if pgAdmin is installed in Desktop mode, and <STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key if pgAdmin is installed in Web mode. This parameter is ignored if an SSL connection is not made.

Root certificate field to specify the file containing the SSL certificate authority. This file will replace the default ~/.postgresql/root.crt. This parameter is ignored if an SSL connection is not made.

Certificate revocation list field to specify the file containing the SSL certificate revocation list. This list will replace the default list, found in ~/.postgresql/root.crl. This parameter is ignored if an SSL connection is not made.

SSL compression? is set to True, data sent over SSL connections will be compressed. The default value is False (compression is disabled). This parameter is ignored if an SSL connection is not made.

Warning

In Server mode, certificates, private keys, and the revocation list are stored in the per-user file storage area on the server, which is owned by the user account under which the pgAdmin server process is run. This means that administrators of the server may be able to access those files; appropriate caution should be taken before choosing to use this feature.

Click the SSH Tunnel tab to continue.

Use the fields in the SSH Tunnel tab to configure SSH Tunneling:

You can use the “SSH Tunnel” tab to connect pgAdmin (through an intermediary proxy host) to a server that resides on a network to which the client may not be able to connect directly.

Set “Use SSH tunneling” to Yes to specify that pgAdmin should use an SSH tunnel when connecting to the specified server.

Specify the name or IP address of the SSH host (through which client connections will be forwarded) in the Tunnel host field.

Specify the port of the SSH host (through which client connections will be forwarded) in the Tunnel port field.

Specify the name of a user with login privileges for the SSH host in the Username field.

Specify the type of authentication that will be used when connecting to the SSH host in the Authentication field:

Select the Password option to specify that pgAdmin will use a password for authentication to the SSH host. This is the default.

Select the Identity file to specify that pgAdmin will use a private key file when connecting.

If the SSH host is expecting a private key file for authentication, use the Identity file field to specify the location of the key file.

If the SSH host is expecting a password of the user name or an identity file if being used, use the Password field to specify the password.

Check the box next to Save password? to instruct pgAdmin to save the password for future use. Use Clear SSH Tunnel Password to remove the saved password.

Use the Keep alive field to specify interval in seconds defining the period in which, if no data was sent over the connection, a ‘keepalive’ packet will be sent (and ignored by the remote host). This can be useful to keep connections alive over a NAT. You can set to 0 for disable keepalive.

Click the Advanced tab to continue.

Use the fields in the Advanced tab to configure a connection:

Use the DB restriction field to provide a SQL restriction that will be used against the pg_database table to limit the databases that you see. For example, you might enter: live_db test_db so that only live_db and test_db are shown in the pgAdmin browser. Separate entries with a comma or tab as you type.

Use the Password exec command field to specify a shell command to be executed to retrieve a password to be used for SQL authentication. The stdout of the command will be used as the SQL password. This may be useful when the password should be generated as a transient authorization token instead of providing a password when connecting in PAM authentication [https://www.postgresql.org/docs/current/auth-pam.html] scenarios. You can pass server hostname, port and DB username to the password exec command as variable by providing placeholders like %HOST%, %PORT% and %USERNAME% which will be replace with the server connection information. Example: /path/to/script --hostnmae %HOST% --port %PORT% --username %USERNAME%

Use the Password exec expiration field to specify a maximum age, in seconds, of the password generated with a Password exec command. If not specified, the password will not expire until your pgAdmin session does. Zero means the command will be executed for each new connection or reconnection that is made. If the generated password is not valid indefinitely, set this value to slightly before it will expire.

Use the Prepare threshold field to specify the number of times a query is executed before it is prepared. If it is set to 0, every query is prepared the first time it is executed. If it is set to blank, prepared statements are disabled on the connection. This is particularly useful with external connection poolers, such as PgBouncer, which is not compatible with prepared statements. Set this to blank in such cases.

Note

The password file option is only supported when pgAdmin is using libpq v10.0 or later to connect to the server.

Note

The Password exec option is only supported when pgAdmin is run in desktop mode.

Click the Save button to save your work.

Click the Close button to exit without saving your work.

Click the Reset button to return the values specified on the Server dialog to their original condition.

Clear Saved Passwords

Click the Tags tab to continue.

Use the table in the Tags tab to add tags. The tags will be shown on the right side of a server node label in the object explorer tree.

Click on the + button to add a new tag. Some of the parameters are:

Text field to specify the tag name.

Color field to select the accent color of the tag.

Clear Saved Passwords

Use Clear Saved Password functionality to clear the saved password for the database server.

Clear Saved Password shows in the context menu for the selected server as well as under the Object menu on the top menu bar.

Use Clear SSH Tunnel Password functionality to clear the saved password of SSH Tunnel to connect to the database server.

Clear SSH Tunnel Password shows in the context menu for the selected server as well as under the Object menu on the top menu bar.

Note: It will be enabled/visible when the password for the selected database server is already saved.

PostgreSQL Cloud Deployment

A PostgreSQL server can be deployed on the Amazon, EDB BigAnimal, Azure, Google cloud using this module. In future more cloud provider options will be available.

To launch the Cloud Deployment… tool, right click on the Server Group or Server of the tree control, and select Deploy a Cloud Instance from the Register menu.

Amazon RDS Cloud Deployment

EDB BigAnimal Cloud Deployment

Azure Database Cloud Deployment

Google Cloud SQL Deployment

Amazon RDS Cloud Deployment

To deploy a PostgreSQL server on the Amazon cloud, follow the below steps.

Once you launch the tool, select the Amazon RDS option. Click on the Next button to proceed further.

In the Credentials dialog, provide the region in which you want to deploy the instance along with the AWS access key and AWS secret access key. Provide AWS session token only if your AWS session is temporary.

To proceed further, click on the next button. Before going further, pgAdmin will validate your credentials.

Use the fields from the Instance Specification tab to specify the Instance details.

Use the Instance name field to add an instance name for the PostgreSQL server; the name specified will be displayed in the Object Explorer too.

Use the Public IP field to specify the IP Address range for permitting the inbound traffic.

Use the Database version field to specify the PostgreSQL version to deploy.

Use the Instance class field to allocate the computational, network, and memory capacity required by planned workload of this DB instance.

Use the Instance type field to select the instance type.

Use the Storage type field to select the instance storage type. Three options are available. General Purpose (SSD) storage, Provisioned IOPS (SSD) and Magnetic storage.

Use the Allocated storage field to specify the storage capacity in GiB.

Use the Provisioned IOPS in case of Provisioned IOPS (SSD) storage type.

Use the High Availability option to specify High Availability option. This option creates a standby in a different Availability Zone(AZ).

Use the fields from the Database Details tab to specify the Instance details.

Use the drop-down list box in the Server group field to select the parent node for the server; the server will be displayed in the Object Explorer within the specified group.

Use the Database name field to add the database name for the PostgreSQL server.

Use the Username field to specify the name of a role that will be used when authenticating with the server.

Use the Password field to provide a password that will be supplied when authenticating with the server.

Use the Confirm password field to repeat the password.

Enter the listener port number of the server host in the Port field.

At the end, review the Instance details that you provided. Click on Finish button to deploy the instance on Amazon RDS.

Once you click on the finish, one background process will start which will deploy the instance in the cloud and monitor the progress of the deployment. You can view all the background process with there running status and logs on the Processes tab

The Server will be added to the tree with the cloud deployment icon. Once the deployment is done, the server details will be updated.

EDB BigAnimal Cloud Deployment

To deploy a PostgreSQL server on the EDB BigAnimal cloud, follow the below steps.

Once you launch the tool, select the EDB BigAnimal option. Click on the Next button to proceed further.

The next steps is to authenticate the user to EDB BigAninal. Click the given button to authenticate, by clicking the button, the user will be redirected to the new tab for the verification. Once you confirm the one time code, the pgAdmin will automatically detect it and the next button will be enabled. To proceed further, click on the next button.

Use the Project field to choose a project in your Biganimal account.

Use the Cluster type field to choose a cluster type.

Use the No. of Standby Replicas field to specify the replicas if you have selected the High Availability cluster.

Use the Cluster provider field to choose the provider.

Use the fields from the Instance Specification tab to specify the Instance details.

Use the Cluster name field to add a cluster name for the PostgreSQL server; the name specified will be displayed in the Object Explorer too.

Use the Region field to select the region.

Use the Public IP range field to specify the IP Address range for permitting the inbound traffic. Leave it blank for 0.0.0.0/0

Use the Instance type field to select the instance type.

Use the Instance series field to select the instance series.

Use the Instance size field to allocate the computational, network, and memory capacity required by planned workload of this DB instance.

Use the Volume type field to select the instance storage type.

Use the Volume properties field to specify the storage capacity. This field is specific to Azure.

Use the Volume size field to specify the storage size. This field is specific to AWS.

Use the Volume IOPS field to specify the storage IOPS. This field is specific to AWS.

Use the Disk throughput field to specify the disk throughput. This field is specific to AWS.

Use the fields from the Database Details tab to specify the Instance details.

Use the drop-down list box in the Server group field to select the parent node for the server; the server will be displayed in the Object Explorer within the specified group.

Use the Database type field to specify the PostgreSQL type, EnterpriseDB PostgreSQL Advanced Server or PostgreSQL.

Use the PostgreSQL version field to select the database version.

Use the Database Password field to provide a password that will be supplied when authenticating with the server.

Use the Confirm password field to repeat the password.

At the end, review the Cluster details that you provided. Click on Finish button to deploy the instance on EDB BigAnimal.

Once you click on the finish, one background process will start which will deploy the instance in the cloud and monitor the progress of the deployment. You can view all the background process with there running status and logs on the Processes tab

The Server will be added to the tree with the cloud deployment icon. Once the deployment is done, the server details will be updated.

Azure Database Cloud Deployment

To deploy a PostgreSQL server on the Azure Database, follow the below steps.

Once you launch the tool, select the Azure Database option. Click on the Next button to proceed further.

In the Credentials dialog, select authentication method either interactive browser or Azure CLI. Azure CLI will use the currently logged in identity through the Azure CLI on the local machine. Interactive Browser will open a browser window to authenticate a user interactively.

Use the Azure tenant id to specify Azure tenant ID against which user is authenticated.

Clicking the Click here to authenticate yourself to Microsoft Azure button, user will be redirected to the Microsoft Azure authentication page in a new browser tab if the Interactive Browser option is selected. Azure CLI authentication can be used only in Desktop mode.

Once authentication is completed, click on the next button to proceed.

Use the fields from the Instance Specification tab to specify the Instance details.

Use the Cluster name field to add a name for the PostgreSQL server; the name specified will be displayed in the Object Explorer too.

Select a subscription from the Subscription options which are populated based on user access levels in Azure portal.

Select the resource group from Resource Group dropdown under which the PostgreSQL instance will be created.

Select the location to deploy PostgreSQL instance from Location options.

Select the availability zone in specified region to deploy PostgreSQL instance from Availability zone options.

Use Database version options to specify PostgreSQL database version.

Use the Instance class field to allocate the computational, network, and memory capacity required by planned workload of this DB instance.

Use the Instance type field to select the instance type.

Use the Storage size option to specify the storage capacity.

Use the Public IP field to specify the List of IP Addresses or range of IP Addresses (start IP Address - end IP address) from which inbound traffic should be accepted. Add multiple IP addresses/ranges separated with commas, for example: “192.168.0.50, 192.168.0.100 - 192.168.0.200”

Use Zone redundant high availability option to specify High Availability option. Zone redundant high availability deploys a standby replica in a different zone. The Burstable instance type does not support high availability.

Use the fields from the Database Details tab to specify the PostgreSQL database details.

Use the drop-down list in the pgAdmin server group field to select the parent node for the server; the server will be displayed in the Object Explorer within the specified group.

Use the Admin username field to add the database name for the PostgreSQL server.

Use the Password field to provide a password that will be supplied when authenticating with the server.

Use the Confirm password field to repeat the password.

Click on the next button to proceed.

At the end, review the instance details that you provided. Click on Finish button to deploy the instance on Azure Database.

Once you click on the finish, one background process will start which will deploy the instance in the cloud and monitor the progress of the deployment. You can view all the background process with there running status and logs on the Processes tab

The Server will be added to the tree with the cloud deployment icon. Once the deployment is done, the server details will be updated.

Google Cloud SQL Deployment

To deploy a PostgreSQL server on the Google Cloud SQL, follow the below steps.

Once you launch the tool, select the Google Cloud SQL option. Click on the Next button to proceed further.

In the Credentials dialog, select client secret file to authenticate using google.You can download a client secret which is json formatted file from google cloud console once OAuth2 client ID is created.

Note

While creating client OAuth client ID, select Desktop App as application type. Refer this [https://support.google.com/cloud/answer/6158849?hl=en/] link for creating client secret.

Clicking the Click here to authenticate yourself to Google button, user will be redirected to the Google authentication page in a new browser tab.

Once authentication is completed, click on the next button to proceed.

Use the fields from the Instance Specification tab to specify the Instance details.

Use the Cluster name field to add a name for the PostgreSQL server; the name specified will be displayed in the Object Explorer too.

Select the project from project dropdown under which the PostgreSQL instance will be created.

Select the location to deploy PostgreSQL instance from Location options.

Select the availability zone in specified region to deploy PostgreSQL instance from Availability zone options.

Use Database version options to specify PostgreSQL database version.

Use the Instance class field to allocate the computational and memory capacity required by planned workload of this DB instance.

Use the Instance type field to select the instance type.

Specify storage type by selecting option from Storage type.

Use the Storage capacity option to specify the storage capacity.

Use the Public IP field to specify the list of IP address range for allowed inbound traffic, for example: 127.0.0.1/32. Add multiple IP addresses/ranges separated with commas.

Use the High Availability option to specify High Availability option. This option creates a standby in a select Secondary Availability Zone.

Select the secondary availability zone for high availability from Secondary Availability zone options.

Use the fields from the Database Details tab to specify the PostgreSQL database details.

Use the drop-down list in the pgAdmin server group field to select the parent node for the server; the server will be displayed in the Object Explorer within the specified group.

Admin username field will be default to postgres. server.

Use the Password field to provide a password that will be supplied when authenticating with the server.

Use the Confirm password field to repeat the password.

Click on the next button to proceed.

At the end, review the instance details that you provided. Click on Finish button to deploy the instance on Azure PostgreSQL.

Once you click on the finish, one background process will start which will deploy the instance in the cloud and monitor the progress of the deployment. You can view all the background process with there running status and logs on the Processes tab

The Server will be added to the tree with the cloud deployment icon. Once the deployment is done, the server details will be updated.

Master Password

Note

pgAdmin 4 uses the operating system password store by default to store the saved server passwords in desktop mode from version 7.2 onwards and Master password will not be required. If the operating system password store is not available then pgAdmin 4 will continue to use a master password as per the configuration settings.

A master password is required to secure and later unlock the saved server passwords. This is applicable for desktop mode and in server mode if authentication source contains OAuth2 or Kerberos or Webserver.

You are prompted to enter the master password when you open the window for the first time after starting the application.

Once you set the master password, all the existing saved passwords will be re-encrypted using the master password.

The server passwords which are saved in the SQLite DB file or External Database are encrypted and decrypted using the master password.

Note

pgAdmin aims to be secure by default, however, you can disable the master password by setting the configuration parameter MASTER_PASSWORD_REQUIRED=False. See The config.py File for more information on configuration parameters and how they can be changed or enforced across an organisation.

Note

If the master password is disabled, then all the saved passwords will be removed.

Warning

If the master password is disabled, then the saved passwords will be encrypted using a key which is derived from information within the configuration database. Use of a master password ensures that the encryption key does not need to be stored anywhere, and thus prevents possible access to server credentials if the configuration database becomes available to an attacker.

It is strongly recommended that you use the master password if you use the Save Password option.

The master password is not stored anywhere on the physical storage. It is temporarily stored in the application memory and it does not get saved when the application is restarted.

You are prompted to enter the master password when pgAdmin server is restarted.

If you forget the master password, you can use the Reset Master Password button to reset the password.

Warning

Resetting the master password will also remove all saved passwords and close all existing established connections.

Connect to Server

Use the Connect to Server dialog to authenticate with a defined server and access the objects stored on the server through the pgAdmin tree control. To access the dialog, right click on the server name in the pgAdmin tree control, and select Connect Server… from the context menu.

Provide authentication information for the selected server:

Use the Password field to provide the password of the user that is associated with the defined server.

Check the box next to Save Password to instruct the server to save the password for future connections; if you save the password, you will not be prompted when reconnecting to the database server with this server definition.

When using SSH Tunneling, the Connect to Server dialog will prompt for the SSH Tunnel and Database server passwords if not already saved.

Provide authentication information for the selected server:

Use the Password field to provide the password of the user that is associated with the defined server.

Check the box next to respective Save Password to instruct the server to save the password for future connections; if you save the password, you will not be prompted when reconnecting to the database server with this server definition.

The pgAdmin client displays a message in a green status bar in the lower right corner when the server connects successfully.

If you receive an error message while attempting a connection, verify that your network is allowing the pgAdmin host and the host of the database server to communicate. For detailed information about a specific error message, please see the Connection Error help page.

To review or modify connection details, right-click on the name of the server, and select Properties… from the context menu.

Connection Error

When connecting to a PostgreSQL server, you may get an error message. If you encounter an error message, please review the message carefully; each error message attempts to incorporate the information you’ll need to resolve the problem. For more details about specific errors, please locate the error message in the list below:

Connection to the server has been lost

This error message indicates that the connection attempt has taken longer than the specified threshold; there may be a problem with the connection properties provided on the Server dialog, network connectivity issues, or the server may not be running.

could not connect to Server: Connection refused

If pgAdmin displays this message, there are two possible reasons for this:

the database server isn’t running - simply start it.

the server isn’t configured to accept TCP/IP requests on the address shown.

For security reasons, a PostgreSQL server “out of the box” doesn’t listen on TCP/IP ports. Instead, it must be enabled to listen for TCP/IP requests. This can be done by adding listen_addresses=’*’; this will make the server accept connections on any IP interface.

For further information, please refer to the PostgreSQL documentation about runtime configuration [https://www.postgresql.org/docs/current/runtime-config.html].

FATAL: no pg_hba.conf entry

If pgAdmin displays this message when connecting, your server can be contacted correctly over the network, but is not configured to accept your connection. Your client has not been detected as a legal user for the database.

To connect to a server, the pg_hba.conf file on the database server must be configured to accept connections from the host of the pgAdmin client. Modify the pg_hba.conf file on the database server host, and add an entry in the form:

host template1 postgres 192.168.0.0/24 md5 for an IPV4 network

host template1 postgres ::ffff:192.168.0.0/120 md5 for an IPV6 network

For more information, please refer to the PostgreSQL documentation about client authentication [https://www.postgresql.org/docs/current/client-authentication.html].

FATAL: password authentication failed

The password authentication failed for user error message indicates there may be a problem with the password you entered. Retry the password to confirm you entered it correctly. If the error message returns, make sure that you have the correct password, that you are authorized to access the server, and that the access has been correctly configured in the server’s postgresql.conf configuration file.

Import/Export Servers

Server definitions (and their groups) can be exported to a JSON file and re-imported to the same or a different system to enable easy pre-configuration of pgAdmin.

Using pgAdmin 4 GUI

To launch the Import/Export Servers… tool, navigate through Tools on the menu bar to click on the Import/Export Servers option.

Use the Import/Export field to select the Server Groups/Servers to be imported or exported.

Use the Filename field to select the JSON file to import servers or create the new file in case of Export where the servers to be exported in the JSON format.

Use the Remove all the existing servers? field to specify whether to remove all the existing servers or not before importing the new selected servers. This field is applicable only in case of Import Servers.

Click the Next button to continue, or the X button to close the wizard.

Select the Server Groups/ Servers to be imported/exported.

Click the Next button to continue, or the X button to close the wizard.

Check the summary of the servers that are going to be imported/exported on the Summary page.

Click the Finish button to close the wizard.

Using ‘setup.py’ command line script

Note

To export or import servers using setup.py script, you must use the Python interpreter that is normally used to run pgAdmin to ensure that the required Python packages are available. In most packages, this can be found in the Python Virtual Environment that can be found in the installation directory. When using platform-native packages, the system installation of Python may be the one used by pgAdmin.

Exporting Servers

To export the servers defined in an installation, simply invoke setup.py with the dump-servers command line option, followed by the name (and if required, path) to the desired output file. By default, servers owned by the desktop mode user will be dumped (pgadmin4@pgadmin.org by default - see the DESKTOP_USER setting in config.py). This can be overridden with the --user command line option. There can be multiple configurations of pgAdmin on the same system. To dump the servers from specific pgAdmin config DB file, --sqlite-path option can be used. It is also recommended to use this option when running pgAdmin in desktop mode. By default SQLITE_PATH setting in config.py is taken. For example:

/path/to/python /path/to/setup.py dump-servers output_file.json

# or, to specify a non-default user name and auth source (the default is Internal):

/path/to/python /path/to/setup.py dump-servers output_file.json --user user@example.com --auth_source ldap

# to specify a pgAdmin config DB file:

/path/to/python /path/to/setup.py dump-servers output_file.json --sqlite-path /path/to/pgadmin4.db

To export only certain servers, use the --server option and list one or more server IDs. For example:

/path/to/python /path/to/setup.py dump-servers output_file.json --server 1 --server 2 --server 5

Importing Servers

To import the servers defined in a JSON file, simply invoke setup.py with the load-servers command line option, followed by the name (and if required, path) of the JSON file containing the server definitions. Servers will be owned by the desktop mode user (pgadmin4@pgadmin.org by default - see the DESKTOP_USER setting in config.py). This can be overridden with the --user command line option. There can be multiple configurations of pgAdmin on the same system. The default behaviour is for the imported servers to be added to the existent list, which might lead to duplicates. This can be overridden with the --replace command line option, which will replace the list of servers with the newly imported one. To load the servers into a specific pgAdmin config DB file, --sqlite-path option can be used. It is also recommended to use this option when running pgAdmin in desktop mode. By default SQLITE_PATH setting in config.py is taken. For example:

/path/to/python /path/to/setup.py load-servers input_file.json

# or, to replace the list of servers with the newly imported one:

/path/to/python /path/to/setup.py load-servers input_file.json --replace

# or, to specify a non-default user name and auth source (the default is Internal) to own the new servers:

/path/to/python /path/to/setup.py load-servers input_file.json --user user@example.com

# to specify a pgAdmin config DB file:

/path/to/python /path/to/setup.py load-servers input_file.json --sqlite-path /path/to/pgadmin4.db

If any Servers are defined with a Server Group that is not already present in the configuration database, the required Group will be created.

JSON format

The JSON file format used when importing or exporting servers is quite straightforward and simply contains a list of servers, with a number of attributes. The following attributes are required to be present in every server definition: Name, Group, Port, Username, SSLMode, MaintenanceDB and one of Host, HostAddr or Service.

Password fields cannot be imported or exported.

The following example shows both a minimally defined and a fully defined server:

{
    "Servers": {
        "1": {
            "Name": "Minimally Defined Server",
            "Group": "Server Group 1",
            "Port": 5432,
            "Username": "postgres",
            "Host": "localhost",
            "SSLMode": "prefer",
            "MaintenanceDB": "postgres"
        },
        "2": {
            "Name": "Fully Defined Server",
            "Group": "Server Group 2",
            "Host": "host.domain.com",
            "HostAddr": "192.168.1.2",
            "Port": 5432,
            "MaintenanceDB": "postgres",
            "Username": "postgres",
            "Role": "my_role_name",
            "SSLMode": "require",
            "Comment": "This server has every option configured in the JSON",
            "DBRestriction": "live_db test_db",
            "PassFile": "/path/to/pgpassfile",
            "SSLCert": "/path/to/sslcert.crt",
            "SSLKey": "/path/to/sslcert.key",
            "SSLRootCert": "/path/to/sslroot.crt",
            "SSLCrl": "/path/to/sslcrl.crl",
            "SSLCompression": 1,
            "Shared": false,
            "SharedUsername": "postgres",
            "BGColor": "#ff9900",
            "FGColor": "#000000",
            "Service": "postgresql-10",
            "Timeout": 60,
            "UseSSHTunnel": 1,
            "TunnelHost": "192.168.1.253",
            "TunnelPort": 22,
            "TunnelUsername": "username",
            "TunnelAuthentication": 0,
            "PasswordExecCommand": "echo 'test'",
            "PasswordExecExpiration": 100
        }
    }
}

Managing Cluster Objects

Some object definitions reside at the cluster level; pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the Create option for that object. For example, to create a new database, right-click on the Databases node, and select Create Database…

Database Dialog

Example

Resource Group Dialog

Example

Login/Group Role Dialog

Example

Tablespace Dialog

Example

Replica Node Dialog

PGD Replication Group Node Dialog

PGD Replication Server Node Dialog

Role Reassign/Drop Own Dialog

Database Dialog

Use the Database dialog to define or modify a database. To create a database, you must be a database superuser or have the CREATE privilege.

The Database dialog organizes the development of a database through the following dialog tabs: General, Definition, Security, and Parameters. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the database:

Use the Database field to add a descriptive name for the database. The name will be displayed in the pgAdmin tree control.

Use the OID field to specify the object identifier to be used for the new database. Users can specify the value greater than 16383. This option is available from v15 and above.

Select the owner of the database from the drop-down listbox in the Owner field.

Store notes about the database in the Comment field.

Click the Definition tab to continue.

Use the Definition tab to set properties for the database:

Select a character set from the drop-down listbox in the Encoding field. The default is UTF8.

Select a template from the drop-down listbox in the Template field. If you do not specify a template, the database will use template1.

Select a tablespace from the drop-down listbox in the Tablespace field. The selected tablespace will be the default tablespace used to contain database objects.

Select the strategy from the drop-down listbox in the Strategy field while creating a new database. This option is available from v15 and above.

Select the locale provider from the drop-down listbox in the Locale Provider field to set the default collation for this database. Possible values are: icu, libc and builtin. This option is available from v15 and above. Note: The icu and libc options are available from v15 and builtin option is available from v17 onwards.

Select the collation order from the drop-down listbox in the Collation field.

Select the character classification from the drop-down listbox in the Character Type field. This affects the categorization of characters, e.g. lower, upper and digit. The default, or a blank field, uses the character classification of the template database.

Select the icu locale from the drop-down listbox in the ICU Locale to specifies the ICU locale ID if the ICU locale provider is used. This option is available from v15 and above.

Specify the icu rules in the ICU Rules field as additional collation rules to customize the behavior of the default collation of this database. This option is available from v16 and above.

Select the builtin locale from the drop-down listbox in the Builtin Locale if the builtin locale provider is used. This option is available from v17 and above.

Specify a connection limit in the Connection Limit field to configure the maximum number of connection requests. The default value (-1) allows unlimited connections to the database.

If the templates? is set to true, then database will be a template database.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for database objects:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click add to set additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the database. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

To discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Parameters tab to continue.

Use the Parameters tab to set parameters for the database. Click the Add icon (+) to add each parameter:

Use the drop-down listbox in the Name field to select a parameter.

Use the Value field to set a value for the parameter.

Use the drop-down listbox next to Role to select a role to which the parameter setting specified will apply.

Follow these steps to add additional parameter value definitions; to discard a parameter, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Advanced tab to continue.

Use the Advanced tab to set advanced parameters for the database.

Use Schema restriction field to provide a SQL restriction that will be used against the pg_namespace table to limit the schemas that you see. For example, you might enter: public so that only public are shown in the pgAdmin browser.Separate entries with a comma or tab as you type.

Click the SQL tab to continue.

Your entries in the Database dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Database dialog:

The example creates a database named hr that is owned by postgres. It allows unlimited connections, and is available to all authenticated users.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Resource Group Dialog

Use the Resource Group dialog to create a resource group and set values for its resources. A resource group is a named, global group on which various resource usage limits can be defined. The resource group is accessible from all databases in the cluster. To use the Resource Group dialog, you must have superuser privileges. Please note that resource groups are supported when connected to EDB Postgres Advanced Server; for more information about using resource groups, please see the EDB Postgres Advanced Server Guide, available at:

http://www.enterprisedb.com/

Fields used to create a resource group are located on the General tab. The SQL tab displays the SQL code generated by your selections on the Resource Group dialog.

Use the fields on the General tab to specify resource group attributes:

Use the Name field to add a descriptive name for the resource group. This name will be displayed in the tree control.

Use the CPU rate limit (%) field to set the value of the CPU rate limit resource type assigned to the resource group. The valid range for a CPU rate limit is from 0 to 1.67772e+07. The default value is 0.

Use the Dirty rate limit (KB) field to set the value of the dirty rate limit resource type assigned to the resource group. The valid range for a dirty rate limit is from 0 to 1.67772e+07. The default value is 0.

Click the SQL tab to continue.

Your entries in the Resource Group dialog generate a SQL command. Use the SQL tab for review; revisit the General tab to make any changes to the SQL command.

Example

The following is an example of the sql command generated by selections made in the Resource Group dialog:

The example creates a resource group named acctg that sets cpu_rate_limit to 2, and dirty_rate_limit to 6144.

Click the Info button (i) to access online SQL syntax reference material.

Click the Help button (?) to access online documentation about Resource Groups.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Login/Group Role Dialog

Use the Login/Group Role dialog to define a role. A role may be an individual user (with or without login privileges) or a group of users. Note that roles defined at the cluster level are shared by all databases in the cluster.

The Login/Group Role dialog organizes the creation and management of roles through the following dialog tabs: General, Definition, Privileges, Memberships Parameters, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields on the General tab to identify the role.

Use the Name field to provide the name of the role. The name will be displayed in the tree control.

Provide a note about the role in the Comments field.

Click the Definition tab to continue.

Use the Definition tab to set a password and configure connection rules:

Provide a password that will be associated with the role in the Password field.

Provide an expiration date for the password in the Account Expires field (the role does not expire). The expiration date is not enforced when a user logs in with a non-password-based authentication method.

If the role is a login role, specify how many concurrent connections the role can make in the Connection Limit field. The default value (-1) allows unlimited connections.

Click the Privileges tab to continue.

Use the Privileges tab to grant privileges to the role.

Move the Can login? switch to the Yes position if the role has login privileges. The default value is No.

Move the Superuser switch to the Yes position if the role is a superuser within the database. The default value is No.

Move the Create roles? switch to the Yes position to specify whether a role is permitted to create roles. A role with this privilege can alter and drop roles. The default value is No.

Move the Create databases switch to the Yes position to control whether a role can create databases. The default value is No.

Move the Inherit rights from the parent roles? switch to the No position if a role does not inherit privileges. The default value is Yes.

Move the Can initiate streaming replication and backups? switch to the Yes position to control whether a role can initiate streaming replication or put the system in and out of backup mode. The default value is No.

Move the Bypass RLS? switch to the Yes position to control whether a role can bypasses every row-level security (RLS) policy. The default value is No.

Specify member of the role in the Member of field and specify the members in the Member field. Confirm each selection by checking the checkbox to the right of the role name; delete a selection by clicking the x to the left of the role name. Membership conveys the privileges granted to the specified role to each of its members.

Click the Parameters tab to continue.

Use the fields on the Parameters tab to set session defaults for a selected configuration parameter when the role is connected to a specified database. This tab invokes the ALTER ROLE… SET configuration_parameter syntax. Click the Add icon (+) to assign a value for a parameter.

Use the drop-down listbox in the Name field to select a parameter.

Use the Value field to specify a value for the parameter.

Use the drop-down listbox in the Database field to select a database.

Click the Add icon (+) to specify each additional parameter; to discard a parameter, click the trash icon to the left of the row and confirm the deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to define security labels applied to the role. Click the Add icon (+) to add each security label selection.

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

To discard a security label, click the trash icon to the left of the row and confirm the deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Login/Group Role dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Login/Group Role dialog:

The example creates a login role named alice with pg_signal_backend privileges; the role can make unlimited connections to the server at any given time.

Click the Info button (i) to access online SQL help.

Click the Help button (?) to access the documentation for the dialog.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Tablespace Dialog

Use The Tablespace dialog to define a tablespace. A tablespace allows superusers to define an alternative location on the file system where the data files containing database objects (such as tables and indexes) reside. Tablespaces are only supported on systems that support symbolic links. Note that a tablespace cannot be used independently of the cluster in which it is defined.

The Tablespace dialog organizes the definition of a tablespace through the following tabs: General, Definition, Parameters, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the Name field to identify the tablespace with a descriptive name. The name cannot begin with pg_; these names are reserved for system tablespaces.

Select the owner of the tablespace from the drop-down listbox in the Owner field.

Store notes about the tablespace in the Comment field.

Click the Definition tab to continue.

Use the Location field to specify an absolute path to a directory that will contain the tablespace.

Click the Parameters tab to continue.

Use the Parameters tab to set parameters for the tablespace. Click the Add icon (+) to add a row to the table below.

Use the drop-down listbox next to Name to select a parameter.

Use the Value field to set a value for the parameter.

Click the Add icon (+) to specify each additional parameter; to discard a parameter, click the trash icon to the left of the row and confirm deletion in the Delete Row dialog.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels for the tablespace.

Use the Privileges panel to assign security privileges. Click the Add icon (+) to assign a set of privileges:

Select the name of the role from the drop-down listbox in the Grantee field.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user.

Click the Add icon to assign additional sets of privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the tablespace. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

To discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Tablespace dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Tablespace dialog:

The example shown demonstrates creating a tablespace named space_01. It has a random_page_cost value equal to 1.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Replica Node Dialog

Use The Replica Node dialog to view a standby instance being replicated using log based streaming replication. Streaming replication allows a standby server to stay more up-to-date than is possible with file-based log shipping. The standby connects to the primary, which streams WAL records to the standby as they’re generated, without waiting for the WAL file to be filled.

The Replica Node dialog organizes the information through the following tabs: General, Replication Slot

The PID field is the process ID of a WAL sender process.

The Username field is the name of the user logged into this WAL sender process.

The App Name field is the name of the application that is connected to this WAL sender.

The Client Address field is the IP address of the client connected to this WAL sender. If this field is null, it indicates that the client is connected via a Unix socket on the server machine.

The Client Hostname field is the host name of the connected client, as reported by a reverse DNS lookup of client_addr.This field will only be non-null for IP connections, and only when log_hostname is enabled.

The Client Port field is the TCP port number that the client is using for communication with this WAL sender, or -1 if a Unix socket is used.

The State field is the current WAL sender state.

Click the Replication Slot tab to continue.

The Slot Name field is a unique, cluster-wide identifier for the replication slot.

The Slot Type field is the slot type - physical or logical

The Active field is True if this slot is currently actively being used.

Other buttons:

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

PGD Replication Group Node Dialog

Use the Replication Group Node dialog to view a PGD group/sub-group. A PGD cluster’s nodes are gathered in groups. A group can also contain zero or more subgroups. Subgroups can be used to represent data centers or locations allowing commit scopes to refer to nodes in a particular region as a whole.

The dialog organizes the information through the following tabs: General

The ID field is the ID of the node group.

The Name field is the name of the node group.

The Location field is the name of the location associated with the node group.

The Type field is the type of the node group, one of “global”, “data”, “shard” or “subscriber-only”.

The Streaming Mode field is the transaction streaming setting of the node group, one of “off”, “file”, “writer”, “auto” or “default”

The Enable Proxy Routing? field tells whether the node group allows routing from pgd-proxy.

The Enable Raft? field tells whether the node group allows Raft Consensus.

Other buttons:

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

A group can have multiple servers and will be visible in the object explorer tree.

PGD Replication Server Node Dialog

PGD Replication Server Node Dialog

Use The Replication Server Node dialog to view an element that run databases and participate in the PGD cluster. A typical PGD node runs a Postgres database, the BDR extension, and optionally a PGD Proxy service.

The dialog organizes the information through the following tabs: General

The Sequence ID field is the identifier of the node used for generating unique sequence numbers.

The ID field is the OID of the node.

The Name field is the name of the node.

The Kind field is the node kind name.

The Group Name field is the PGD group the node is part of.

The Local DB Name field is the database name of the node.

Other buttons:

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Role Reassign/Drop Own Dialog

Use the Reassign/Drop Own dialog to change the ownership of database objects owned by a database role. This dialog instructs the system to change the ownership of database objects owned by any of the old_roles to new_role.

The Reassign/Drop Own dialog organizes the Reassign & Drop role through General tab.

Use the Operation field to provide Reassign option.

Provide a new role in the Reassign Objects to field; The ownership of all the objects within the selected database, and of all shared objects (databases, tablespaces), owned by the old_role will be reassigned to new_role.

Provide a database on which the reassignment is to be carried out.

The above example demonstrates reassigning old_role to new_role.

Click the SQL tab to continue.

Removing database objects owned by a database role.

Use the Operation field to provide Drop option.

Use the Cascade? field to provide Yes, No is default.

Provide a database on which the drop of objects is to be carried out.

Click the SQL tab to continue.

The above examples demonstrates drop owned by role.

Click the Help button (?) to access online help.

Click the OK button to save work.

Click the Cancel button to exit without saving work.

Managing Database Objects

pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object.

To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the Create option for that object. For example, to create a new cast, right-click on the Casts node, and select Create Cast…

Cast Dialog

Using EDB Job Scheduler

Collation Dialog

Domain Dialog

Domain Constraints Dialog

Event Trigger Dialog

Extension Dialog

Foreign Data Wrapper Dialog

Foreign Server Dialog

Foreign Table Dialog

FTS Configuration Dialog

FTS Dictionary Dialog

FTS Parser Dialog

FTS Template Dialog

Function Dialog

Language Dialog

Materialized View Dialog

Package Dialog

Procedure Dialog

Publication Dialog

Schema Dialog

Sequence Dialog

Subscription Dialog

Synonym Dialog

Trigger Function Dialog

Type Dialog

User Mapping Dialog

View Dialog

Cast Dialog

Use the Cast dialog to define a cast. A cast specifies how to convert a value from one data type to another.

The Cast dialog organizes the development of a cast through the following dialog tabs: General and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the cast:

The Name field is disabled. The name that will be displayed in the pgAdmin tree control is the Source type concatenated with the Target type, and is generated automatically when you make selections on the Cast dialog Definition tab.

Store notes about the cast in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define parameters:

Use the drop-down listbox next to Source type to select the name of the source data type of the cast.

Use the drop-down listbox next to Target type to select the name of the target data type of the cast.

Use the drop-down listbox next to Function to select the function used to perform the cast. The function’s result data type must match the target type of the cast.

Select Context toggle to Implicit if the cast is implicit. By default, a cast can be invoked only by an explicit cast request. If the cast is marked Implicit then it can be invoked implicitly in any context, whether by assignment or internally in an expression.

Click the SQL tab to continue.

Your entries in the Cast dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Cast dialog:

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Using EDB Job Scheduler

In the past versions of EPAS, DBMS_SCHEDULER or DBMS_JOBS required the configuration of pgAgent, an essential service for their functionality. Maintaining pgAgent in a production environment is cumbersome. The need for correct configuration, regular updates, and ensuring the service’s health added complexity.

EPAS 16 revolutionizes job scheduling by eliminating the need for the pgAgent component. The new version introduces EDB Job Scheduler which is an extension that runs the job scheduler as a background process for the DBMS_SCHEDULER and DBMS_JOB packages.

The EDB Job Scheduler has a scheduler process that starts when the database cluster starts. To start the scheduler process, load the EDB Job Scheduler extension using the shared_preload_libraries parameter. After you load the extension, create the extension ‘edb_job_scheduler’ and ‘dbms_scheduler’ using the CREATE EXTENSION command. The database in which you’re creating the extension must be listed in the edb_job_scheduler.database_list parameter.

Instructions for configuring the EDB Job Scheduler can be found in the Configuring EDB Job Scheduler [https://www.enterprisedb.com/docs/pg_extensions/edb_job_scheduler/configuring/].

Check the status of all the jobs

To check the running status of all the jobs select the ‘DBMS Job Scheduler’ collection node from the object explorer and select the Properties tab.

DBMS Job

DBMS Program

DBMS Schedule

DBMS Job

Use the DBMS Job dialog to create a DBMS Job.

Use the fields in the General tab to create job:

Use the Name field to add a descriptive name for the job. The name will be displayed in the pgAdmin object explorer.

Use the Enabled? switch to indicate that job should be enabled or disabled.

Use the Job Type field to select the type of the job. Type could be SELF-CONTAINED or PRE-DEFINED. If the Job Type is Self-Contained you need to specify the action and repeat interval in the Action and Repeat tabs respectively. If the Job Type is Pre-Defined you need to specify the existing Program and Schedule names in the Pre-Defined tab.

Store notes about the job in the Comment field.

Click the Action tab to continue.

Use the Action tab to select the action for the job. This tab is only enabled when the job type is ‘SELF-CONTAINED’.

Use the Type field to select the type of the job. Type could be PLSQL BLOCK or STORED PROCEDURE.

Use the Procedure field to select an existing procedure that executes when the job is invoked.

Number of Arguments field is read-only and indicates the quantity of arguments necessary for the chosen procedure.

Click the Code tab to continue.

Use the Code field to write the code that executes when the job is invoked. This tab is only enabled when the job type is ‘SELF-CONTAINED’ and type of the action is set to ‘PLSQL BLOCK’.

Click the Arguments tab to continue.

Arguments tab outlines the arguments required by the selected procedure in the ‘Action’ tab. This tab is only enabled when the job type is ‘SELF-CONTAINED’.

Click the Repeat tab to continue.

Use the Repeat tab to select the repeat interval for the job. This tab is only enabled when the job type is ‘SELF-CONTAINED’.

Use the calendar selector in the Start field to specify the starting date and time for the job.

Use the calendar selector in the End field to specify the ending date and time for the job.

Use the Frequency field to select the frequency. Frequency is one of the following: YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY.

Use the Date field to select the date on which job will execute.Date is YYYYMMDD.

Use the Months field to select the months in which the job will execute.

Use the Week Days field to select the days on which the job will execute.

Use the Month Days field to select the numeric days on which the job will execute.

Use the Hours field to select the hour at which the job will execute.

Use the Minutes field to select the minute at which the job will execute.

Click the Pre-Defined tab to continue.

Use the Pre-Defined tab to select the existing program and schedule to create the job. This tab is only enabled when the job type is ‘PRE-DEFINED’.

Use the Program Name field to select the existing program.

Use the Schedule Name field to select an existing schedule.

Click the SQL tab to continue.

Your entries in the DBMS Job dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the DBMS Job dialog:

Click the Info button (i) to access online help.

Click the Help button (?) to access dialog help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

DBMS Program

Use the DBMS Program dialog to create a DBMS Program.

Use the fields in the General tab to create program:

Use the Name field to add a descriptive name for the program. The name will be displayed in the pgAdmin object explorer.

Use the Enabled? switch to indicate that program should be enabled or disabled.

Store notes about the program in the Comment field.

Click the Action tab to continue.

Use the Action tab to select the action for the program:

Use the Type field to select the type of the program. Type could be PLSQL BLOCK or STORED PROCEDURE.

Use the Procedure field to select an existing procedure that executes when the program is invoked.

Number of Arguments field is read-only and indicates the quantity of arguments necessary for the chosen procedure.

Click the Code tab to continue.

Use the Code field to write the code that executes when the program is invoked. This tab is only enabled when the type of the program is set to ‘PLSQL BLOCK’.

Click the Arguments tab to continue.

Arguments tab is a read-only section that outlines the arguments required by the selected procedure in the ‘Action’ tab.

Click the SQL tab to continue.

Your entries in the DBMS Program dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the DBMS Program dialog:

Click the Info button (i) to access online help.

Click the Help button (?) to access dialog help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

DBMS Schedule

Use the DBMS Schedule dialog to create a DBMS Schedule.

Use the fields in the General tab to create schedule:

Use the Name field to add a descriptive name for the schedule. The name will be displayed in the pgAdmin object explorer.

Store notes about the schedule in the Comment field.

Click the Repeat tab to continue.

Use the Repeat tab to select the repeat interval for the schedule:

Use the calendar selector in the Start field to specify the starting date and time for the schedule.

Use the calendar selector in the End field to specify the ending date and time for the schedule.

Use the Frequency field to select the frequency. Frequency is one of the following: YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY.

Use the Date field to select the date on which schedule will execute.Date is YYYYMMDD.

Use the Months field to select the months in which the schedule will execute.

Use the Week Days field to select the days on which the schedule will execute.

Use the Month Days field to select the numeric days on which the schedule will execute.

Use the Hours field to select the hour at which the schedule will execute.

Use the Minutes field to select the minute at which the schedule will execute.

Click the SQL tab to continue.

Your entries in the DBMS Schedule dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the DBMS Schedule dialog:

Click the Info button (i) to access online help.

Click the Help button (?) to access dialog help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Collation Dialog

Use the Collation dialog to define a collation. A collation is an SQL schema object that maps a SQL name to operating system locales. To create a collation, you must have a CREATE privilege on the destination schema.

The Collation dialog organizes the development of a collation through the following dialog tabs: General and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the collation:

Use the Name field to provide a name for the collation. The collation name must be unique within a schema. The name will be displayed in the pgAdmin tree control.

Select the name of the owner from the drop-down listbox in the Owner field.

Select the name of the schema in which the collation will reside from the drop-down listbox in the Schema field.

Store notes about the collation in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to specify the operating system locale settings:

Use the drop-down listbox next to Copy collation to select the name of an existing collation to copy. The new collation will have the same properties as the existing one, but will be an independent object. If you choose to copy an existing collation, you cannot modify the collation properties displayed on this tab.

Use the Locale field to specify a locale; a locale specifies language and language formatting characteristics. If you specify this, you cannot specify either of the following parameters. To view a list of locales supported by your Linux system use the command locale -a.

Use the LC_COLLATE field to specify a locale with specified string sort order. The locale must be applicable to the current database encoding. (See CREATE DATABASE for details.)

Use the LC_CTYPE field to specify a locale with specified character classification. The locale must be applicable to the current database encoding. (See CREATE DATABASE for details.)

Use the drop-down listbox next to Locale Provider to select a locale services associated with the collation. Possible values are: icu, libc. libc is the default.

Move the switch next to Deterministic to YES to specify whether the collation should use deterministic comparisons. By default, this option is set to true. In a deterministic comparison, strings that are not byte-wise equal are considered unequal, even if they are considered logically equal in the comparison.

Use the Rules field to specify a rules for customizing the behavior of the collation. It includes considerations such as character ordering, case sensitivity, and accent sensitivity.

Use the Version field to specify version string to store with the collation object.

Click the SQL tab to continue.

Your entries in the Collation dialog generate a SQL command (see an example b elow). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Collation dialog:

The example shown demonstrates creating a collation named french that uses the rules specified for the locale, fr-BI-x-icu. The collation is owned by *postgres.

Click the Info button (i) to access online help. For more information about setting a locale, see Chapter 22.1 Locale Support of the PostgreSQL core documentation:

https://www.postgresql.org/docs/current/locale.html

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Domain Dialog

Use the Domain dialog to define a domain. A domain is a data type definition that may constrain permissible values. Domains are useful when you are creating multiple tables that contain comparable columns; you can create a domain that defines constraints that are common to the columns and re-use the domain definition when creating the columns, rather than individually defining each set of constraints.

The Domain dialog organizes the development of a domain through the following tabs: General, Definition, Constraints, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields on the General tab to identify a domain:

Use the Name field to add a descriptive name for the domain. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select a role that will own the domain.

Select the name of the schema in which the domain will reside from the drop-down listbox in the Schema field.

Store notes about the domain in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to describe the domain:

Use the drop-down listbox next to Base type to specify a data type.

Use the context-sensitive Length field to specify a numeric length for a numeric type.

Use the context-sensitive Precision field to specify the total count of significant digits for a numeric type.

Specify a default value for the domain data type in the Default field. The data type of the default expression must match the data type of the domain. If no default value is specified, then the default value is the null value.

Move the Not Null switch to specify the values of this domain are prevented from being null.

Use the drop-down listbox next to Collation to apply a collation cast. If no collation is specified, the underlying data type’s default collation is used. The underlying type must be collatable if COLLATE is specified.

Click the Constraints tab to continue.

Use the fields in the Constraints tab to specify rules for the domain. Click the Add icon (+) to set constraints:

Use the Name field to specify a name for the constraint.

Use the Check field to provide an expression for the constraint.

Use the Validate checkbox to determine whether the constraint will be validated. The default checkbox is checked and sets a validation requirement.

A CHECK clause specifies an integrity test which values of the domain must satisfy. Each constraint must be an expression that produces a Boolean result. Use the key word VALUE to refer to the value being tested. Expressions evaluating to TRUE or UNKNOWN succeed. If the expression produces a FALSE result, an error is reported and the value is not allowed to be converted to the domain type. A CHECK expression cannot contain subqueries nor refer to variables other than VALUE. If a domain has multiple CHECK constraints, they will be tested in alphabetical order by name.

Click the Add icon (+) to set additional constraints; to discard a constraint, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security Labels panel to assign security labels. Click the Add icon (+) to add a label:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to specify each additional label; to discard a label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Domain dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by selections made in the Domain dialog:

The example shown demonstrates creating a domain named postal_code that confirms that the value entered is in proper format.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Domain Constraints Dialog

Use the Domain Constraints dialog to create or modify a domain constraint. A domain constraint confirms that the values provided for a domain meet a defined criteria. The Domain Constraints dialog implements options of the ALTER DOMAIN command.

The Domain Constraints dialog organizes the development of a domain constraint through the following dialog tabs: General and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the domain constraint:

Use the Name field to add a descriptive name for the constraint. The name will be displayed in the pgAdmin tree control.

Store notes about the constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the domain constraint:

Use the Check field to provide a CHECK expression. A CHECK expression specifies a constraint that the domain must satisfy. A constraint must produce a Boolean result; include the key word VALUE to refer to the value being tested. Only those expressions that evaluate to TRUE or UNKNOWN will succeed. A CHECK expression cannot contain subqueries or refer to variables other than VALUE. If a domain has multiple CHECK constraints, they will be tested in alphabetical order.

Move the Validate? switch to the No position to mark the constraint NOT VALID. If the constraint is marked NOT VALID, the constraint will not be applied to existing column data. The default value is Yes.

Click the SQL tab to continue.

Your entries in the Domain Constraints dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Domain Constraints dialog:

The example shown demonstrates creating a domain constraint on the domain timesheets named weekday. It constrains a value equal to Friday.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Event Trigger Dialog

Use the Event Trigger dialog to define an event trigger. Unlike regular triggers, which are attached to a single table and capture only DML events, event triggers are global to a particular database and are capable of capturing DDL events. Like regular triggers, event triggers can be written in any procedural language that includes event trigger support, or in C, but not in SQL.

The Event Trigger dialog organizes the development of a event trigger through the following dialog tabs: General, Definition, and Security Labels. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the event trigger:

Use the Name field to add a descriptive name for the event trigger. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to specify the owner of the event trigger.

Store notes about the event trigger in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the event trigger:

Select a value from the drop down of Trigger Enabled field to specify a status for the trigger: Enable Disable, Replica Always.

Use the drop-down listbox next to Trigger function to specify an existing function. A trigger function takes an empty argument list, and returns a value of type event_trigger.

Select a value from the drop down of Events field to specify when the event trigger will fire: DDL COMMAND START, DDL COMMAND END, or SQL DROP.

Use the When TAG in field to enter filter values for TAG for which the trigger will be executed. The values must be in single quotes separated by comma.

Click the Security Labels tab to continue.

Use the Security tab to define security labels applied to the trigger. Click the Add icon (+) to add each security label.

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Event Trigger dialog generate a generate a SQL command. Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Event Trigger dialog:

The command creates an event trigger named accounts that invokes the procedure named evt_tri_fun.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Extension Dialog

Use the Extension dialog to install a new extension into the current database. An extension is a collection of SQL objects that add targeted functionality to your Postgres installation. The Extension dialog adds the functionality of an extension to the current database only; you must register the extension in each database that use the extension. Before you load an extension into a database, you should confirm that any pre-requisite files are installed.

The Extension dialog allows you to implement options of the CREATE EXTENSION command through the following dialog tabs: General and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify an extension:

Use the drop-down listbox in the Name field to select the extension. Each extension must have a unique name.

Move the switch next to Cascade? towards right position to automatically install any extensions that this extension depends on that are not already installed.

Store notes about the extension in the Comment field.

Click the Definition tab to continue.

Use the Definition tab to select the Schema and Version:

Use the drop-down listbox next to Schema to select the name of the schema in which to install the extension’s objects.

Use the drop-down listbox next to Version to select the version of the extension to install.

Click the SQL tab to continue.

Your entries in the Extension dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Extension dialog:

The command creates the adminpack extension in the public schema. It is version 2.0 of adminpack.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Foreign Data Wrapper Dialog

Use the Foreign Data Wrapper dialog to create or modify a foreign data wrapper. A foreign data wrapper is an adapter between a Postgres database and data stored on another data source.

You must be a superuser to create a foreign data wrapper.

The Foreign Data Wrapper dialog organizes the development of a foreign data wrapper through the following dialog tabs: General, Definition, Options, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the foreign data wrapper:

Use the Name field to add a descriptive name for the foreign data wrapper. A foreign data wrapper name must be unique within the database. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the name of the role that will own the foreign data wrapper.

Store notes about the foreign data wrapper in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to set parameters:

Select the name of the handler function from the drop-down listbox in the Handler field. This is the name of an existing function that will be called to retrieve the execution functions for foreign tables.

Select the name of the validator function from the drop-down listbox in the Validator field. This is the name of an existing function that will be called to check the generic options given to the foreign data wrapper, as well as options for foreign servers, user mappings and foreign tables using the foreign data wrapper.

Click the Options tab to continue.

Use the fields in the Options tab to specify options:

Click the Add icon (+) button to add an option/value pair for the foreign data wrapper. Supported option/value pairs will be specific to the selected foreign data wrapper.

Specify the option name in the Option field and provide a corresponding value in the Value field.

Click the Add icon (+) to specify each additional pair; to discard an option, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to assign security privileges. Click the Add icon (+) to assign a set of privileges.

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click add to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Foreign Data Wrapper dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Foreign Data Wrapper dialog:

The example creates a foreign data wrapper named lib_qp_debug that uses pre-existing validator and handler functions, dblink_fdw_validator and libpg_fdw_handler. Selections on the Options tab set debug equal to true. The foreign data wrapper is owned by postgres.

Click the Help button (?) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Foreign Server Dialog

Use the Foreign Server dialog to create a foreign server. A foreign server typically encapsulates connection information that a foreign-data wrapper uses to access an external data resource. Each foreign data wrapper may connect to a different foreign server; in the pgAdmin tree control, expand the node of the applicable foreign data wrapper to launch the Foreign Server dialog.

The Foreign Server dialog organizes the development of a foreign server through the following dialog tabs: General, Definition, Options, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the foreign server:

Use the Name field to add a descriptive name for the foreign server. The name will be displayed in the pgAdmin tree control. It must be unique within the database.

Use the drop-down listbox next to Owner to select a role.

Store notes about the foreign server in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to set parameters:

Use the Type field to specify a server type.

Use the Version field to specify a server version.

Click the Options tab to continue.

Use the fields in the Options tab to specify options. Click the Add button to create an option clause for the foreign server.

Specify the option name in the Option field.

Provide a corresponding value in the Value field.

Click Add to create each additional clause; to discard an option, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to assign security privileges to the foreign server. Click Add before you assign a set of privileges.

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click Add to assign a new set of privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row dialog.

Click the SQL tab to continue.

Your entries in the Foreign Server dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Foreign Server dialog:

The example shown demonstrates creating a foreign server for the foreign data wrapper hdfs_fdw. It has the name hdfs_server; its type is hiveserver2. Options for the foreign server include a host and a port.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Foreign Table Dialog

Use the Foreign Table dialog to define a foreign table in the current database. Foreign tables define the structure of an external data source that resides on a foreign server.

The Foreign Table dialog organizes the development of a foreign table through the following dialog tabs: General, Definition, Columns, Constraints, Options, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the foreign table:

Use the Name field to add a descriptive name for the foreign table. The name of the foreign table must be distinct from the name of any other foreign table, table, sequence, index, view, existing data type, or materialized view in the same schema. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the name of the role that will own the foreign table.

Select the name of the schema in which the foreign table will reside from the drop-down listbox in the Schema field.

Store notes about the foreign table in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the external data source:

Use the drop-down listbox next to Foreign server to select a foreign server. This list is populated with servers defined through the Foreign Server dialog.

Use the drop-down listbox next to Inherits to specify a parent table. The foreign table will inherit all of its columns. This field is optional.

Click the Columns tab to continue.

Use the fields in the Columns tab to add columns and their attributes to the table. Click the Add icon (+) to define a column:

Use the Name field to add a descriptive name for the column.

Use the drop-down listbox in the Data Type field to select a data type for the column. This can include array specifiers. For more information on which data types are supported by PostgreSQL, refer to Chapter 8 of the core documentation.

Click the Add icon (+) to specify each additional column; to discard a column, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Constraints tab to continue.

Use the fields in the Constraints tab to apply a table constraint to the foreign table. Click the Add icon (+) to define a constraint:

Use the Name field to add a descriptive name for the constraint. If the constraint is violated, the constraint name is present in error messages, so constraint names like col must be positive can be used to communicate helpful information.

Use the Check field to write a check expression producing a Boolean result. Each row in the foreign table is expected to satisfy the check expression.

Check the No Inherit checkbox to specify that the constraint will not propagate to child tables.

Uncheck the Validate checkbox to disable validation. The database will not assume that the constraint holds for all rows in the table.

Click the Add icon (+) to specify each additional constraint; to discard a constraint, click the trash icon to the left of the row and confirm deletion in he Delete Row popup.

Click the Options tab to continue.

Use the fields in the Options tab to specify options to be associated with the new foreign table or one of its columns; the accepted option names and values are specific to the foreign data wrapper associated with the foreign server. Click the Add icon (+) to add an option/value pair.

Specify the option name in the Option field. Duplicate option names are not allowed.

Provide a corresponding value in the Value field.

Click the Add icon (+) to specify each additional option/value pair; to discard an option, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for database objects:

Select the name of the role to which privileges will be assigned from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the function. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Foreign Table dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Foreign Table dialog:

The example shown demonstrates creating a foreign table weblogs with multiple columns.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

FTS Configuration Dialog

Use the FTS Configuration dialog to configure a full text search. A text search configuration specifies a text search parser that can divide a string into tokens, along with dictionaries that can identify searchable tokens.

The FTS Configuration dialog organizes the development of a FTS configuration through the following dialog tabs: “General, Definition, and Tokens. The SQL tab displays the SQL code generated by dialog selections.

Click the General tab to begin.

Use the fields in the General tab to identify a FTS configuration:

Use the Name field to add a descriptive name for the FTS configuration. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to specify the role that will own the configuration.

Select the name of the schema in which the FTS configuration will reside from the drop-down listbox in the Schema field.

Store notes about the FTS configuration in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define parameters:

Select the name of the text search parser from the drop-down listbox in the Parser field.

Select a language from the drop-down listbox in the Copy Config field.

Click the Tokens tab to continue.

Use the fields in the Tokens tab to add a token:

Use the Tokens field to specify the name of a token.

Click the Add button to create a token.

Use the Dictionaries field to specify a dictionary.

Repeat these steps to add additional tokens; to discard a token, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the FTS Configuration dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the FTS Configuration dialog:

The example shown demonstrates creating a FTS configuration named english_phrases. It uses the default parser.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

FTS Dictionary Dialog

Use the FTS Dictionary dialog to create a full text search dictionary. You can use a predefined templates or create a new dictionary with custom parameters.

The FTS Dictionary dialog organizes the development of a FTS dictionary through the following dialog tabs: General, Definition, and Options. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the dictionary:

Use the Name field to add a descriptive name for the dictionary. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the role that will own the FTS Dictionary.

Select the name of the schema in which the dictionary will reside from the drop-down listbox in the Schema field.

Store notes about the dictionary in the Comment field.

Click the Definition tab to continue.

Use the field in the Definition tab to choose a template from the drop-down listbox:

Select ispell to select the Ispell template. The Ispell dictionary template supports morphological dictionaries, which can normalize many different linguistic forms of a word into the same lexeme. For example, an English Ispell dictionary can match all declensions and conjugations of the search term bank, e.g., banking, banked, banks, banks’, and bank’s. Ispell dictionaries usually recognize a limited set of words, so they should be followed by another broader dictionary; for example, a Snowball dictionary, which recognizes everything.

Select simple to select the simple template. The simple dictionary template operates by converting the input token to lower case and checking it against a file of stop words. If it is found in the file then an empty array is returned, causing the token to be discarded. If not, the lower-cased form of the word is returned as the normalized lexeme. Alternatively, the dictionary can be configured to report non-stop-words as unrecognized, allowing them to be passed on to the next dictionary in the list.

Select snowball to select the Snowball template. The Snowball dictionary template is based on a project by Martin Porter, inventor of the popular Porter’s stemming algorithm for the English language. Snowball now provides stemming algorithms for many languages (see the Snowball site for more information). Each algorithm understands how to reduce common variant forms of words to a base, or stem, spelling within its language. A Snowball dictionary recognizes everything, whether or not it is able to simplify the word, so it should be placed at the end of the dictionary list. It is useless to have it before any other dictionary because a token will never pass through it to the next dictionary.

Select synonym to select the synonym template. This dictionary template is used to create dictionaries that replace a word with a synonym. Phrases are not supported (use the thesaurus template (Section 12.6.4) for that). A synonym dictionary can be used to overcome linguistic problems, for example, to prevent an English stemmer dictionary from reducing the word Paris to pari.

Select thesaurus to select the thesaurus template. A thesaurus dictionary replaces all non-preferred terms by one preferred term and, optionally, preserves the original terms for indexing as well. PostgreSQL’s current implementation of the thesaurus dictionary is an extension of the synonym dictionary with added phrase support.

Click the Options tab to continue.

Use the fields in the Options tab to provide template-specific options. Click the Add icon (+) to add an option clause:

Specify the name of an option in the Option field

Provide a value for the option in the Value field.

Click the Add icon (+) to specify each additional option/value pair; to discard an option, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the FTS Dictionary dialog generate a generate a SQL command. Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the FTS Dictionary dialog:

The example shown demonstrates creating a custom dictionary named more_stopwords which is based on the simple template and is configured to use standard English.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

FTS Parser Dialog

Use the FTS Parser dialog to create a new text search parser. A text search parser defines a method for splitting a text string into tokens and assigning types (categories) to the tokens.

The FTS Parser dialog organizes the development of a text search parser through the following dialog tabs: General, and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a text search parser:

Use the Name field to add a descriptive name for the parser. The name will be displayed in the pgAdmin tree control.

Select the name of the schema in which the parser will reside from the drop-down listbox in the Schema field.

Store notes about the domain in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define parameters:

Use the drop-down listbox next to Start function to select the name of the function that will initialize the parser.

Use the drop-down listbox next to Get next token function to select the name of the function that will return the next token.

Use the drop-down listbox next to End function to select the name of the function that is called when the parser is finished.

Use the drop-down listbox next to Lextypes function to select the name of the lextypes function for the parser. The lextypes function returns an array that contains the id, alias, and a description of the tokens used by the parser.

Use the drop-down listbox next to Headline function to select the name of the headline function for the parser. The headline function returns an excerpt from the document in which the terms of the query are highlighted.

Click the SQL tab to continue.

Your entries in the FTS Parser dialog generate a generate a SQL command. Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

FTS Template Dialog

Use the FTS Template dialog to create a new text search template. A text search template defines the functions that implement text search dictionaries.

The FTS Template dialog organizes the development of a text search Template through the following dialog tabs: General, and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a template:

Use the Name field to add a descriptive name for the template. The name will be displayed in the pgAdmin tree control.

Select the name of the schema in which the template will reside from the drop-down listbox in the Schema field.

Store notes about the template in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define function parameters:

Use the drop-down listbox next to Init function to select the name of the init function for the template. The init function is optional.

Use the drop-down listbox next to Lexize function to select the name of the lexize function for the template. The lexize function is required.

Click the SQL tab to continue.

Your entries in the FTS Template dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the FTS Template dialog:

The example shown demonstrates creating a fts template named eng.template that uses the ispell dictionary.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Function Dialog

Use the Function dialog to define a function. If you drop and then recreate a function, the new function is not the same entity as the old; you must drop existing rules, views, triggers, etc. that refer to the old function.

The Function dialog organizes the development of a function through the following dialog tabs: General, Definition, Code, Options, Parameters, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a function:

Use the Name field to add a descriptive name for the function. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the name of the role that will own the function.

Use the drop-down listbox next to Schema to select the schema in which the function will be created.

Store notes about the function in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the function:

Move the Custom return type? switch to provide a user defined return type.

Use the drop-down listbox next to Return type to select the data type returned by the function, if any. If Custom return type? is enabled this field will change to an input text field.

Use the drop-down listbox next to Language to select the implementation language. The default is sql.

Use the fields in the Arguments to define an argument. Click the Add icon (+) to set parameters and values for the argument:

Use the drop-down listbox in the Data type field to select a data type.

Use the drop-down listbox in the Mode field to select a mode. Select IN for an input parameter; select OUT for an output parameter; select INOUT for both an input and an output parameter; or, select VARIADIC to specify a VARIADIC parameter.

Provide a name for the argument in the Argument Name field.

Specify a default value for the argument in the Default Value field.

Click the Add icon (+) to define another argument; to discard an argument, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Code tab to continue.

Use the Code field to write the code that will execute when the function is called.

Click the Options tab to continue.

Use the fields in the Options tab to describe or modify the action of the function:

Use the drop-down listbox next to Volatility to select one of the following. VOLATILE is the default value.

VOLATILE indicates that the function value can change even within a single table scan, so no optimizations can be made.

STABLE indicates that the function cannot modify the database, and that within a single table scan it will consistently return the same result for the same argument values.

IMMUTABLE indicates that the function cannot modify the database and always returns the same result when given the same argument values.

Move the Returns a Set? switch to indicate if the function returns a set that includes multiple rows. The default is No.

Move the Strict? switch to indicate if the function always returns NULL whenever any of its arguments are NULL. If Yes, the function is not executed when there are NULL arguments; instead a NULL result is assumed automatically. The default is No.

Move the Security of definer? switch to specify that the function is to be executed with the privileges of the user that created it. The default is No.

Move the Window? switch to indicate that the function is a window function rather than a plain function. The default is No. This is currently only useful for functions written in C. The WINDOW attribute cannot be changed when replacing an existing function definition. For more information about the CREATE FUNCTION command, see the PostgreSQL core documentation available at:

https://www.postgresql.org/docs/current/functions-window.html

Use the Estimated cost field to specify a positive number representing the estimated execution cost for the function, in units of cpu_operator_cost. If the function returns a set, this is the cost per returned row.

Use the Estimated rows field to specify a positive number giving the estimated number of rows that the query planner should expect the function to return. This is only allowed when the function is declared to return a set. The default assumption is 1000 rows.

Move the Leak proof? switch to indicate whether the function has side effects. The default is No. This option can only be set by the superuser.

Use the Support function field to specify a planner support function to use for the function.

Click the Parameters tab to continue.

Use the fields in the Parameters tab to specify settings that will be applied when the function is invoked. Click the Add icon (+) to add a Name/Value field in the table.

Use the drop-down listbox in the Name column in the Parameters panel to select a parameter.

Use the Value field to specify the value that will be associated with the selected variable. This field is context-sensitive.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign usage privileges for the function to a role.

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the function. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Function dialog generate a generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by selections made in the Function dialog:

The example demonstrates creating an plpgsql function named hire_salesmen. The function have three columns (p_ename, p_sal and p_comm).

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Language Dialog

Use the CREATE LANGUAGE dialog to register a new procedural language.

The Language dialog organizes the registration of a procedural language through the following dialog tabs: General, Definition, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a language:

Use the drop-down listbox next to Name to select a language script.

Use the drop-down listbox next to Owner to select a role.

Store notes about the language in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define parameters:

Move the Trusted? switch to the No position to specify only users with PostgreSQL superuser privilege can use this language. The default is Yes.

When enabled, use the drop-down listbox next to Handler Function to select the function that will be called to execute the language’s functions.

When enabled, use the drop-down listbox next to Inline Function to select the function that will be called to execute an anonymous code block (DO command) in this language.

When enabled, use the drop-down listbox next to Validator Function to select the function that will be called when a new function in the language is created, to validate the new function.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for database objects:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the function. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Language dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Language dialog:

The example shown demonstrates creating the trusted procedural language named mylan.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Materialized View Dialog

Use the Materialized View dialog to define a materialized view. A materialized view is a stored or cached view that contains the result set of a query. Use the REFRESH MATERIALIZED VIEW command to update the content of a materialized view.

The Materialized View dialog organizes the development of a materialized_view through the following dialog tabs: General, Definition, Storage, Parameter, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the materialized view:

Use the Name field to add a descriptive name for the materialized view. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the role that will own the materialized view.

Select the name of the schema in which the materialized view will reside from the drop-down listbox in the Schema field.

Store notes about the materialized view in the Comment field.

Click the Definition tab to continue.

Use the fields in the Storage tab to maintain the materialized view:

Move the With Data switch to the Yes position to specify the materialized view should be populated at creation time. If not, the materialized view cannot be queried until you invoke REFRESH MATERIALIZED VIEW.

Use the drop-down listbox next to Tablespace to select a location for the materialized view.

Use the drop-down list box next to Access Method to specify the table access method to use to store the contents for the new materialized view; the method needs to be an access method of type TABLE. This field is optional. This option is available from v12 and above.

Use the Fill Factor field to specify a fill factor for the materialized view. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Click the Code tab to continue.

Use the text editor field in the Code tab to provide the query that will populate the materialized view. Please note that updating the definition of existing materialized view would result in loss of Parameter(Table, Toast), Security(Privileges & Security labels), Indexes and other dependent objects.

Click the Parameter tab to continue.

Use the tabs nested inside the Parameter tab to specify VACUUM and ANALYZE thresholds; use the Table tab and the Toast Table tab to customize values for the table and the associated toast table. To change the default values:

Move the Custom auto-vacuum? switch to the Yes position to perform custom maintenance on the materialized view and to select values in the Vacuum table. The Vacuum Table provides default values for maintenance operations.

Changing Autovacuum enabled? to Not set will reset autovacuum_enabled.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for the materialized view:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the materialized view. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Materialized View dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Materialized View dialog:

The example shown creates a query named new_hires that stores the result of the displayed query in the pg_default tablespace.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Package Dialog

Use the Package dialog to create a (user-defined) package specification.

The Package dialog organizes the management of a package through the following dialog tabs: General, Header, Body, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the package:

Use the Name field to add a descriptive name for the package. The name of a new package must not match any existing package in the same schema.

Select the schema in which the package will reside from the drop-down listbox in the Schema field.

Store notes about the package in the Comment field.

Click the Header tab to continue.

Use the Header field to define the public interface for the package.

Click the Body tab to continue.

Use the Body field to provide the code that implements each package object.

Click the Security tab to continue.

Use the fields in the Security tab to assign EXECUTE privileges for the package to a role. Click the Add icon (+) to set privileges for the package:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of a privilege to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row, and confirm the deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Package dialog generate a SQL command that creates or modifies a package definition:

The example shown demonstrates creating a package named empinfo that includes two function and two procedure.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to delete any changes to the dialog.

Procedure Dialog

Use the Procedure dialog to create a procedure; procedures are supported by PostgreSQL v11+ and EDB Postgres Advanced Server. The Procedure dialog allows you to implement options of the CREATE PROCEDURE command.

The Procedure dialog organizes the development of a procedure through the following dialog tabs: General, Definition, Code, Options, Arguments, Parameters, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a procedure:

Use the Name field to add a descriptive name for the procedure. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select a role.

Select the name of the schema in which the procedure will reside from the drop-down listbox in the Schema field.

Store notes about the procedure in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the procedure:

Use the drop-down listbox next to Language to select a language. The default is edbspl.

Use the fields in the Arguments section to define an argument. Click Add to set parameters and values for the argument:

Use the drop-down listbox next to Data type to select a data type.

Use the drop-down listbox next to Mode to select a mode. Select IN for an input parameter; select OUT for an output parameter; select INOUT for both an input and an output parameter; or, select VARIADIC to specify a VARIADIC parameter.

Write a name for the argument in the Argument Name field.

Specify a default value for the argument in the Default Value field.

Click Add to define another argument; to discard an argument, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Code tab to continue.

Use the Code field to specify the code that will execute when the procedure is called.

Click the Options tab to continue.

Use the fields in the Options tab to describe or modify the behavior of the procedure:

Use the drop-down listbox under Volatility to select one of the following. VOLATILE is the default value.

VOLATILE indicates that the value can change even within a single table scan, so no optimizations can be made.

STABLE indicates that the procedure cannot modify the database, and that within a single table scan it will consistently return the same result for the same argument values, but that its result could change across SQL statements.

IMMUTABLE indicates that the procedure cannot modify the database and always returns the same result when given the same argument values.

Move the Strict? switch to indicate if the procedure always returns NULL whenever any of its arguments are NULL. If Yes, the procedure is not executed when there are NULL arguments; instead a NULL result is assumed automatically. The default is No.

Move the Security of definer? switch to specify that the procedure is to be executed with the privileges of the user that created it. The default is No.

Use the Estimated cost field to specify a positive number representing the estimated execution cost for the procedure, in units of cpu_operator_cost. If the procedure returns a set, this is the cost per returned row.

Move the Leak proof? switch to indicate whether the procedure has side effects — it reveals no information about its arguments other than by its return value. The default is No.

Click the Parameters tab to continue.

Use the fields in the Parameters tab to specify settings that will be applied when the procedure is invoked:

Use the drop-down listbox next to Parameter Name in the Parameters panel to select a parameter.

Click the Add button to add the variable to Name field in the table.

Use the Value field to specify the value that will be associated with the selected variable. This field is context-sensitive.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign execute privileges for the procedure to a role:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click Add to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the procedure. Click Add to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click Add to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Procedure dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by selections made in the Procedure dialog:

The example demonstrates creating a procedure that returns a list of employees from a table named emp. The procedure is a SECURITY DEFINER, and will execute with the privileges of the role that defined the procedure.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Publication Dialog

Logical replication [https://www.postgresql.org/docs/15/logical-replication.html] uses a publish and subscribe model with one or more subscribers subscribing to one or more publications on a publisher node.

Use the publication dialog to create a publication. A publication is a set of changes generated from a table or a group of tables or a schema or a group of schemas, and might also be described as a change set or replication set.

The publication dialog organizes the development of a publication through the following dialog tabs: General, Tables and Options. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the publication:

Use the Name field to add a descriptive name for the publication. The name will be displayed in the pgAdmin tree control.

The Owner field takes the name of the user automatically as current connected user. You can change the owner after creating publication using alter publication.

Click the Tables tab to continue.

Tables tab for PostgreSQL version <= 14

Tables tab for PostgreSQL version >= 15

Use the Tables tab to set table properties for the publication:

Move the switch next to All tables? to Yes to replicate all the tables of the database, including tables created in the future.

Move the switch next to Only table? to Yes to replicate only the listed tables excluding all its descendant tables.

Specify a table or list of tables separated by a comma in Tables field to replicate all the listed table. With PostgreSQL 15 forward, specify a table or list of tables to replicate all the listed tables along with specific columns and/or WHERE clause to filter rows.

With PostgreSQL 15 forward, specify a schema or list of schemas separated by a comma in Tables In Schema field to replicate all the listed schemas. This field will be disabled if any columns are selected for tables.

Click the Options tab to continue.

Use the Options tab to set option properties for the publication:

Use the With section to determine which DML operations will be published by the new publication to the subscribers. Move the switch next to INSERT, UPDATE, DELETE, or TRUNCATE to No if you do not want to replicate any of these DML operations from Publication to Subscription. By default, all the switches are set to Yes allowing all the DML operations.

Note

A published table must have a “replica identity” configured in order to be able to replicate UPDATE and DELETE operations. You can change with ALTER TABLE statement. For more information on replica identity see Logical Replication Publication [https://www.postgresql.org/docs/15/logical-replication-publication.html].

Click the SQL tab to continue.

Your entries in the Publication dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Publication dialog:

The example creates a publication named pub1 that is owned by postgres. It allows replication of all the DML operations.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore all the default settings.

Schema Dialog

Use the Schema dialog to define a schema. A schema is the organizational workhorse of a database, similar to directories or namespaces. To create a schema, you must be a database superuser or have the CREATE privilege.

The Schema dialog organizes the development of schema through the following dialog tabs: General and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields on the General tab to identify the schema.

Use the Name field to add a descriptive name for the schema. The name will be displayed in the pgAdmin tree control.

Select the owner of the schema from the drop-down listbox in the Owner field.

Store notes about the schema in the Comment field.

Click the Security tab to continue.

Use the Security tab to assign privileges and security labels for the schema.

Click the Add icon (+) to assign a set of privileges in the Privileges panel:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional sets of privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Add icon (+) to assign a security label in the Security Labels panel:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Default Privileges tab to continue.

Use the Default Privileges tab to grant privileges for tables, sequences, functions and types. Use the tabs nested inside the Default Privileges tab to specify the database object and click the Add icon (+) to assign a set of privileges:

Select the name of a role that will be granted privileges in the schema from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the SQL tab to continue.

Your entries in the Schema dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by selections made in the Schema dialog:

The example creates a schema named hr; the command grants USAGE privileges to public and assigns the ability to grant privileges to alice.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Sequence Dialog

Use the Sequence dialog to create a sequence. A sequence generates unique values in a sequential order (not necessarily contiguous).

The Sequence dialog organizes the development of a sequence through the following dialog tabs: General, Definition, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify a sequence:

Use the Name field to add a descriptive name for the sequence. The name will be displayed in the pgAdmin tree control. The sequence name must be distinct from the name of any other sequence, table, index, view, or foreign table in the same schema.

Use the drop-down listbox next to Owner to select the name of the role that will own the sequence.

Use the drop-down listbox next to Schema to select the schema in which the sequence will reside.

Store notes about the sequence in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the sequence:

Use the Increment field to specify which value is added to the current sequence value to create a new value.

Provide a value in the Start field to specify the beginning value of the sequence. The default starting value is MINVALUE for ascending sequences and MAXVALUE for descending ones.

Provide a value in the Minimum field to specify the minimum value a sequence can generate. If this clause is not supplied or NO MINVALUE is specified, then defaults will be used. The defaults are 1 and -263-1 for ascending and descending sequences, respectively.

Provide a value in the Maximum field to specify the maximum value for the sequence. If this clause is not supplied or NO MAXVALUE is specified, then default values will be used. The defaults are 263-1 and -1 for ascending and descending sequences, respectively.

Provide a value in the Cache field to specify how many sequence numbers are to be preallocated and stored in memory for faster access. The minimum value is 1 (only one value can be generated at a time, i.e., no cache), and this is also the default.

Move the switch next to Cycled towards the right position to allow the sequence to wrap around when the MAXVALUE or the MINVALUE has been reached by an ascending or descending sequence respectively. If the limit is reached, the next number generated will be the MINVALUE or MAXVALUE, respectively. The default is No.

Move the switch next to Unlogged? towards the right position to make the sequence Unlogged. The default is No. This option is available only on PostgreSQL 15 and above.

The OWNED BY option causes the sequence to be associated with a specific table column, such that if that column (or its whole table) is dropped, the sequence will be automatically dropped as well. The specified table must have the same owner and be in the same schema as the sequence.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels for the sequence.

Use the Privileges panel to assign privileges. Click the Add icon (+) to set privileges:

Select the name of a role that will be granted privileges from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the sequence. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Sequence dialog generate a generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Sequence dialog:

The example shown demonstrates a sequence named seconds. The sequence will increase in 5 second increments, and stop when it reaches a maximum value equal of 60.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Subscription Dialog

Use the Subscription dialog to create a subscription. A subscription defines the connection to another database and set of publications (one or more) to which it wants to subscribe.

The subscription dialog organizes the development of a subscription through the following dialog tabs: General, Connection, SSL and With. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the subscription:

Use the Name field to add a descriptive name for the subscription. The name will be displayed in the pgAdmin tree control.

The Owner field takes the name of the user automatically as current connected user. You can change the owner after creating subscription using alter subscription. Please note that owner of the subscription has superuser privileges.

Click the Connection tab to continue.

Use the Connection tab to define the connection string to the publisher:

Use the Host name/address field to provide the valid hostname or ip address of the publication.

Use the Port field to provide port number to connect at Postgres Server in which publication is residing.

Use the Username field to provide the name of the user to connect to the publication.

Use the Password to provide the password of the user.

Use the Database field to connect to the database in which publication is residing.

Use the Connection timeout field to specify the maximum wait for connection, in seconds. Zero or not specified means wait indefinetly. It is not recommended to use a timeout of less than 2 seconds.

Use the Passfile field to specify the location of a password file (.pgpass). A .pgpass file allows a user to login without providing a password when they connect. For more information, see Section 33.15 of the Postgres documentation [https://www.postgresql.org/docs/current/libpq-pgpass.html].

Use the Publication field to specify the publication name on the publishers to subscribe to. Click on the refresh button at the end to load the names of the existing publications and then select from the list. You can also write the name of the known publication in the field.

Click the SSL tab to continue.

Use the fields in the SSL tab to configure SSL:

Use the drop-down list box in the SSL field to select the type of SSL connection the server should use. For more information about using SSL encryption, see Section 33.18 of the Postgres documentation [https://www.postgresql.org/docs/current/libpq-ssl.html].

If pgAdmin is installed in Server mode (the default mode), you can use the platform-specific File manager dialog to upload files that support SSL encryption to the server. To access the File manager dialog, click the icon that is located to the right of each of the following fields.

Use the Client certificate field to specify the file containing the client SSL certificate. This file will replace the default ~/.postgresql/postgresql.crt if pgAdmin is installed in Desktop mode, and <STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.crt if pgAdmin is installed in Web mode. This parameter is ignored if an SSL connection is not made.

Use the Client certificate key field to specify the file containing the secret key used for the client certificate. This file will replace the default ~/.postgresql/postgresql.key if pgAdmin is installed in Desktop mode, and <STORAGE_DIR>/<USERNAME>/.postgresql/postgresql.key if pgAdmin is installed in Web mode. This parameter is ignored if an SSL connection is not made.

Use the Root certificate field to specify the file containing the SSL certificate authority. This file will replace the default ~/.postgresql/root.crt. This parameter is ignored if an SSL connection is not made.

Use the Certificate revocation list field to specify the file containing the SSL certificate revocation list. This list will replace the default list, found in ~/.postgresql/root.crl. This parameter is ignored if an SSL connection is not made.

When SSL compression? is set to True, data sent over SSL connections will be compressed. The default value is False (compression is disabled). This parameter is ignored if an SSL connection is not made.

Warning

In Server mode, certificates, private keys, and the revocation list are stored in the per-user file storage area on the server, which is owned by the user account under which the pgAdmin server process is run. This means that administrators of the server may be able to access those files; appropriate caution should be taken before choosing to use this feature.

Click the With tab to continue.

Use the With tab to define some parameters for a subscription:

The Copy data? switch specifies whether the existing data in the publications that are being subscribed to should be copied once the replication starts. By default it is set to Yes.

The Create slot? switch specifies whether the command should create the replication slot on the publisher. By default it is set to Yes. Please note: if your publisher and subscriber both are inside same PostgreSQL server then is is set to No by default.

The Enabled? switch specifies whether the subscription should be actively replicating, or whether it should be just setup but not started yet. By default it is set to Yes.

The Connect? specifies whether the CREATE SUBSCRIPTION should connect to the publisher at all. By default, it is set to Yes. Setting this to No will change default values of enabled, create_slot and copy_data to No.

Use the Slot Name field to specify the name of the replication slot to use. By default, it uses the name of the subscription for the slot name.

Use the Synchronous commit field to override the synchronous_commit setting. By default, it is set to off. It is safe to use off for logical replication: If the subscriber loses transactions because of missing synchronization, the data will be sent again from the publisher.

Use the Streaming field to specify whether to enable streaming of in-progress transactions for this subscription. The default value is off, meaning all transactions are fully decoded on the publisher and only then sent to the subscriber as a whole. This option is available only on PostgreSQL 14 and above.

Use the Binary? switch to specify whether the subscription will request the publisher to send the data in binary format (as opposed to text). The default is false. This option is available only on PostgreSQL 14 and above.

Use the Two phase? switch to specify whether two-phase commit is enabled for this subscription. The default is false. This option is available only on PostgreSQL 15 and above.

Use the Disable on error? switch to specify whether the subscription should be automatically disabled if any errors are detected by subscription workers during data replication from the publisher. The default is false. This option is available only on PostgreSQL 15 and above.

Move the Run as owner? switch to true position to specify all replication actions are performed as the subscription owner. If false, replication workers will perform actions on each table as the owner of that table. The default is false. This option is available only on PostgreSQL 16 and above.

Use the Password required? to specify whether connections to the publisher made as a result of this subscription must use password authentication. This setting is ignored when the subscription is owned by a superuser. The default is true. Only superusers can set this value to false. This option is available only on PostgreSQL 16 and above.

Use the Origin to specify whether the subscription will request the publisher to only send changes that don’t have an origin or send changes regardless of origin. The default is any. This option is available only on PostgreSQL 16 and above.

Click the SQL tab to continue.

Your entries in the Subscription dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Subscription dialog:

The example creates a subscription named sub1 that is owned by postgres. It will replicate the data from the publication pub1.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore all the default settings.

Synonym Dialog

Use the Synonym dialog to substitute the name of a target object with a user-defined synonym.

The Synonym dialog organizes the development of a synonym through the General tab. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the synonym:

Use the Name field to specify the name of synonym. The name will be displayed in the pgAdmin tree control.

Select the name of the schema in which the synonym will reside from the drop-down listbox in the Schema field.

In the definition panel, identify the target:

Use the drop-down listbox next to Target Type to select the type of object referenced by the synonym.

Use the drop-down listbox next to Target Schema to select the name of the schema in which the object resides.

Use the drop-down listbox next to Target Object to select the name of the object referenced by the synonym.

Click the SQL tab to continue.

Your selections and entries in the Synonym dialog generate a SQL command.

The example creates a synonym for the emp table named emp_hist.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Trigger Function Dialog

Use the Trigger function dialog to create or manage a trigger_function. A trigger function defines the action that will be invoked when a trigger fires.

The Trigger function dialog organizes the development of a trigger function through the following dialog tabs: General, Definition, Code, Options, Parameters and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the trigger function:

Use the Name field to add a descriptive name for the trigger function. The name will be displayed in the pgAdmin tree control. Please note that trigger functions will be invoked in alphabetical order.

Use the drop-down listbox next to Owner to select the role that will own the trigger function.

Select the name of the schema in which the trigger function will reside from the drop-down listbox in the Schema field.

Store notes about the trigger function in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the trigger function:

Use the drop-down listbox next to Return type to specify the pseudotype that is associated with the trigger function:

Select trigger if you are creating a DML trigger.

Select event_trigger if you are creating a DDL trigger.

Use the drop-down listbox next to Language to select the implementation language. The default is plpgsql.

Click the Code tab to continue.

Use the Code field to write the code that will execute when the trigger function is called.

Click the Options tab to continue.

Use the fields in the Options tab to describe or modify the action of the trigger function:

Use the drop-down listbox next to Volatility to select one of the following:

VOLATILE indicates that the trigger function value can change even within a single table scan.

STABLE indicates that the trigger function cannot modify the database, and that within a single table scan it will consistently return the same result for the same argument values.

IMMUTABLE indicates that the trigger function cannot modify the database and always returns the same result when given the same argument values.

Move the Returns a Set? switch to indicate if the trigger function returns a set that includes multiple rows. The default is No.

Move the Strict? switch to indicate if the trigger function always returns NULL whenever any of its arguments are NULL. If Yes, the function is not executed when there are NULL arguments; instead a NULL result is assumed automatically. The default is No.

Move the Security of definer? switch to specify that the trigger function is to be executed with the privileges of the user that created it. The default is No.

Move the Window? switch to indicate that the trigger function is a window function rather than a plain function. The default is No. This is currently only useful for trigger functions written in C.

Use the Estimated cost field to specify a positive number representing the estimated execution cost for the trigger function, in units of cpu_operator_cost. If the function returns a set, this is the cost per returned row.

Use the Estimated rows field to specify a positive number giving the estimated number of rows that the query planner should expect the trigger function to return. This is only allowed when the function is declared to return a set. The default assumption is 1000 rows.

Move the Leak proof? switch to indicate whether the trigger function has side effects. The default is No. This option can only be set by the superuser.

Click the Parameters tab to continue.

Use the fields in the Parameters tab to specify settings that will be applied when the trigger function is invoked. Click the Add icon (+) to add a Name/Value pair to the table below.

Use the drop-down listbox in the Name field to select a parameter.

Use the Value field to specify the value that will be associated with the selected parameter. This field is context-sensitive.

Click the Add icon (+) to set additional parameters; to discard a parameter, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign usage privileges for the trigger function to a role. Click the Add icon (+) to add a role to the table.

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the trigger function. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Trigger function dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit other tabs to modify the SQL command.

Example

The following is an example of the sql command generated by user selections in the Trigger function dialog:

The example shown demonstrates creating a trigger function named emp_stamp.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Type Dialog

Use the Type dialog to register a custom data type.

The Type dialog organizes the development of a data type through the following dialog tabs: General, Definition, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the custom data type:

Use the Name field to add a descriptive name for the type. The name will be displayed in the pgAdmin tree control. The type name must be distinct from the name of any existing type, domain, or table in the same schema.

Use the drop-down listbox next to Owner to select the role that will own the type.

Select the name of the schema in which the type will reside from the drop-down listbox in the Schema field.

Store notes about the type in the Comments field.

Click the Definition tab to continue.

Select a data type from the drop-down listbox next to Type on the Definition tab; the panel below changes to display the options appropriate for the selected data type. Use the fields in the panel to define the data type.

There are five data types:

Composite Type

Enumeration Type

Range Type

External Type (or Base Type)

Shell Type

If you select Composite in the Type field, the Definition tab displays the Composite Type panel:

Click the Add icon (+) to provide attributes of the type. Fields on the General panel are context sensitive and may be disabled.

Use the Member Name field to add an attribute name.

Use the drop-down listbox in the Type field to select a datatype.

Use the Length/Precision field to specify the maximum length of a non-numeric type, or the total count of significant digits in a numeric type.

Use the Scale field to specify the number of digits to the right of the decimal point.

Use the drop-down listbox in the Collation field to select a collation (if applicable).

Click the Add icon (+) to define an additional member; click the trash icon to the left of the row to discard a row.

If you select the Enumeration in the Type field, the Definition tab displays the Enumeration Type panel:

Click the Add icon (+) to provide a label for the type.

Use the Label field to add a label, which must be less than 64 bytes long.

Click the Add icon (+) after each selection to create additional labels; to discard a label, click the trash icon to the left of the row.

If you select External, the Definition tab displays the External Type panel:

On the Required tab:

Use the drop-down listbox next to the Input function field to add an input_function. The input_function converts the type’s external textual representation to the internal representation used by the operators and functions defined for the type.

Use the drop-down listbox next to the Output function field to add an output_function. The output_function converts the type’s internal representation used by the operators and functions defined for the type to the type’s external textual representation.

On the Optional-1 tab:

Use the drop-down listbox next to the optional Receive Function field to select a receive_function. The optional receive_function converts the type’s external binary representation to the internal representation. If this function is not supplied, the type cannot participate in binary input.

Use the drop-down listbox next to the optional Send function field to select a send_function. The optional send_function converts from the internal representation to the external binary representation. If this function is not supplied, the type cannot participate in binary output.

Use the drop-down listbox next to the optional Typmod in function field tab to select a type_modifier_input_function.

Use the drop-down listbox next to the optional Typmod out function field tab to select a type_modifier_output_function. It is allowed to omit the type_modifier_output_function, in which case the default display format is the stored typmod integer value enclosed in parentheses.

Use the optional Internal length to specify a value for internal representation.

Move the Variable? switch to specify the internal representation is of variable length (VARIABLE). The default is a fixed length positive integer.

Specify a default value in the optional Default field in cases where a column of the data type defaults to something other than the null value. Specify the default with the DEFAULT key word. (A default can be overridden by an explicit DEFAULT clause attached to a particular column.)

Use the drop-down listbox next to the optional Analyze function field to select a function for performing type-specific statistics collection for columns of the data type.

Use the drop-down listbox next to the optional Category type field to help control which implicit cast will be applied in ambiguous situations.

Move the Preferred? switch to Yes to specify the selected category type is preferred. The default is No.

On the Optional-2 tab:

Use the drop-down listbox next to the optional Element type field to specify a data type.

Use the optional Delimiter field to indicate the delimiter to be used between values in the external representation of arrays for this data type. The default delimiter is the comma (,). Note that the delimiter is associated with the array element type, not the array type itself.

Use the drop-down listbox next to Alignment type to specify the storage alignment required for the data type. The allowed values (char, int2, int4, and double) correspond with alignment on 1, 2, 4, or 8 byte boundaries.

Use the drop-down listbox next to optional Storage type to select a strategy for storing data.

Move the Passed by value? switch to Yes to override the existing data type value. The default is No.

Move the Collatable? switch to Yes to specify column definitions and expressions of the type may carry collation information through use of the COLLATE clause. The default is No.

If you select Range in the Type field, the Definition tab displays the Range panel. Fields on the Range panel are context-sensitive and may be disabled.

Use the drop-down listbox next to Sub-type to select an associated b-tree operator class (to determine the ordering of values for the range type).

Use the drop-down listbox next to Sub-type operator class to use a non-default operator class.

Use the drop-down listbox next to Collation to use a non-default collation in the range’s ordering if the sub-type is collatable.

Use the drop-down listbox next to Canonical function to convert range values to a canonical form.

Use the drop-down listbox next to Sub-type diff function to select a user-defined subtype_diff function.

If you select Shell in the Type field, the Definition tab displays the Shell panel:

A shell type is a placeholder for a type and has no parameters.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges for the type; click the Add icon (+) to grant privileges:

Select the name of the role that will be granted privileges on the type from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the type. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Type dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of a sql command generated by user selections made in the Type dialog:

The example shown demonstrates creating a data type named work_order. The data type is an enumerated type with three labels: new, open and closed.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

User Mapping Dialog

Use the User Mapping dialog to define a new mapping of a user to a foreign server.

The User Mapping dialog organizes the development of a user mapping through the following dialog tabs: General and Options. The SQL tab displays the SQL code generated by dialog selections.

Use the drop-down listbox in the User field in the General tab to identify the connecting role:

Select CURRENT_USER to use the name of the current role.

Select PUBLIC if no other user-specific mapping is applicable.

Select a pre-defined role name to specify the name of an existing user.

Click the Options tab to continue.

Use the fields in the Options tab to specify connection options; the accepted option names and values are specific to the foreign data wrapper associated with the server specified in the user mapping. Click the Add button to add an option/value pair.

Specify the option name in the Option field.

Provide a corresponding value in the Value field.

Click Add to specify each additional option/value pair; to discard an option, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the User Mapping dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the User Mapping dialog:

The example shown demonstrates a user mapping for the hdfs_server. The user is CURRENT_USER with a password secret.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

View Dialog

Use the View dialog to define a view. The view is not physically materialized; the query is executed each time the view is referenced in a query.

The View dialog organizes the development of a View through the following dialog tabs: General, Definition, Code and Security”. The SQL tab displays the SQL code generated by dialog selections.

Click the General tab to begin.

Use the fields in the General tab to identify a view:

Use the Name field to add a descriptive name for the view. The name of the view must be distinct from the name of any other view, table, sequence, index or foreign table in the same schema. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Owner to select the role that will own the view.

If applicable, select the name of the schema in which the view will reside from the drop-down listbox in the Schema field.

Store notes about the view in the Comments field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define properties of the view:

Set the Security Barrier switch to Yes to indicate that the view is to act as a security barrier. For more information about defining and using a security barrier rule, see Rules and Privileges of the PostgreSQL documentation.

Set the Security Invoker switch to Yes to indicate that the underlying base relations are to be checked against the privileges of the user of the view rather than the view owner. This option is available from PostgreSQL 15 onwards.

Use the drop-down listbox next to Check options to select from No, Local or Cascaded:

The Local option specifies that new rows are only checked against the conditions defined in the view. Any conditions defined on underlying base views are not checked (unless you specify the CHECK OPTION).

The Cascaded option specifies new rows are checked against the conditions of the view and all underlying base views.

Click the Code tab to continue.

Use the workspace in the Code tab to write a query to create a view.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for the view:

Select the name of the role that will be granted privileges from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the view. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the View dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the View dialog:

The example shown demonstrates creating a view named distributor_code.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Creating or Modifying a Table

pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes.

To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the Create option for that object. For example, to create a new table, Select a database from the tree control, select the schema under the database, right-click on the Tables node, and select Create Table…

Check Dialog

Column Dialog

Compound Trigger Dialog

Exclusion Constraint Dialog

Foreign key Dialog

Index Dialog

Primary key Dialog

RLS Policy Dialog

Rule Dialog

Table Dialog

Trigger Dialog

Unique Constraint Dialog

Check Dialog

Use the Check dialog to define or modify a check constraint. A check constraint specifies an expression that produces a Boolean result that new or updated rows must satisfy for an insert or update operation to succeed.

The Check dialog organizes the development of a check constraint through the General and Definition tabs. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the check constraint:

Use the Name field to provide a descriptive name for the check constraint that will be displayed in the pgAdmin tree control. With PostgreSQL 9.5 forward, when a table has multiple check constraints, they will be tested for each row in alphabetical order by name and after NOT NULL constraints.

Store notes about the check constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the check constraint:

Provide the expression that a row must satisfy in the Check field.

Move the No Inherit? switch to the Yes position to specify that this constraint is not automatically inherited by a table’s children. The default is No, meaning that the constraint will be inherited by any children.

Move the Don’t validate? switch to the No position to skip validation of existing data; the constraint may not hold for all rows in the table. The default is Yes.

Click the SQL tab to continue.

Your entries in the Check dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Check dialog:

The example shown demonstrates creating a check constraint named jobhist_date_chk on the startdate column of the jobhist table.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Column Dialog

Use the Column dialog to add a column to an existing table or modify a column definition.

The Column dialog organizes the development of a column through the following dialog tabs: General, Definition, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the column:

Use the Name field to add a descriptive name for the column. The name will be displayed in the pgAdmin tree control. This field is required.

Store notes about the column in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to add parameters for the column. (Fields are disabled if inapplicable.)

Use the drop-down listbox next to Data Type to select a data type for the column. For more information on the data types that are supported by PostgreSQL, refer to Chapter 8 of the Postgres core documentation. This field is required.

Use the Length/Precision and Scale fields to specify the maximum number of significant digits in a numeric value, or the maximum number of characters in a text value.

Use the drop-down listbox next to Collation to apply a collation setting to the column.

Use the drop-down listbox next to Compression to set the compression method for the column. Compression is supported only for variable-width data types, and is used only when the column’s storage mode is main or extended. This option is available from v14 and above.

Use the drop-down listbox next to Storage to set the storage mode for the column. This option is available from v16 and above.

Click the Constraints tab to continue.

Use the fields in the Constraints tab to specify constraints for the column. (Fields are disabled if inapplicable.)

Use the Default Value field to specify a default data value.

Move the Not Null switch to the Yes position to specify the column may not contain null values. The default is No.

Use the Type field to specify the column type (NONE/IDENTITY/GENERATED). The default is NONE.

Click the IDENTITY type to create Identity column.

Use the following fields to create IDENTITY column. Identity columns are applicable for PG/EPAS version 10 and above.

Use the Identity field to specify ALWAYS or BY DEFAULT. This clause is used to determine how the sequence value is given precedence over a user-specified value in an INSERT statement.

Use the Increment field to specify which value is added to the current sequence value to create a new value.

Provide a value in the Start field to specify the beginning value of the sequence. The default starting value is MINVALUE for ascending sequences and MAXVALUE for descending ones.

Provide a value in the Minimum field to specify the minimum value a sequence can generate. If this clause is not supplied or NO MINVALUE is specified, then defaults will be used. The defaults are 1 and -263-1 for ascending and descending sequences, respectively.

Provide a value in the Maximum field to specify the maximum value for the sequence. If this clause is not supplied or NO MAXVALUE is specified, then default values will be used. The defaults are 263-1 and -1 for ascending and descending sequences, respectively.

Provide a value in the Cache field to specify how many sequence numbers are to be preallocated and stored in memory for faster access. The minimum value is 1 (only one value can be generated at a time, i.e., no cache), and this is also the default.

Move the Cycled switch to the Yes position to allow the sequence to wrap around when the MAXVALUE or the MINVALUE has been reached by an ascending or descending sequence respectively. If the limit is reached, the next number generated will be the MINVALUE or MAXVALUE, respectively. The default is No.

Click the GENERATED type to create Generated column.

Use the following fields to create GENERATED column. Generated columns are applicable for PG/EPAS version 12 and above.

Use the Expression field to specify the generation expression. It can refer to other columns in the table, but not other generated columns. Any functions and operators used must be immutable. References to other tables are not allowed.

Click the Variables tab to continue.

Use the Variables tab to specify the number of distinct values that may be present in the column; this value overrides estimates made by the ANALYZE command. Click the Add icon (+) to add a Name/Value pair:

Select the name of the variable from the drop-down listbox in the Name field.

Select n_distinct to specify the number of distinct values for the column.

Select n_distinct_inherited to specify the number of distinct values for the table and its children.

Specify the number of distinct values in the Value field. For more information, see the documentation for ALTER TABLE [https://www.postgresql.org/docs/current/sql-altertable.html].

Click the Add icon (+) to specify each additional Name/Value pair; to discard a variable, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Security tab to continue.

Use the Security tab to assign attributes and define security labels. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Column dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Column dialog:

The example shown demonstrates creating a column named sal in the table named jobhist.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Compound Trigger Dialog

Use the Compound Trigger dialog to create a compound trigger or modify an existing compound trigger. Compound Trigger is supported only for EPAS server 12 and above. A compound trigger executes a specified code when certain events occur.

The Compound Trigger dialog organizes the development of a compound trigger through the following dialog tabs: General, Events, and Code. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the compound trigger:

Use the Name field to add a descriptive name for the compound trigger. This must be distinct from the name of any other compound trigger for the same table. The name will be displayed in the pgAdmin tree control.

Store notes about the compound trigger in the Comment field.

Trigger enabled field is available in compound trigger dialog once the trigger is created. You can select one of the four options available.

Click the Events tab to continue.

Use the fields in the Events tab to specify how and when the compound trigger fires:

Select the type of event(s) that will invoke the compound trigger; to select an event type, move the switch next to the event to the YES position. The supported event types are INSERT, UPDATE, DELETE and TRUNCATE. Views cannot have TRUNCATE triggers.

Use the When field to provide a boolean condition that will invoke the compound trigger.

If defining a column-specific compound trigger, use the Columns field to specify the columns or columns that are the target of the compound trigger.

Click the Code tab to continue.

Use the Code field to specify the code for the five timing events BEFORE STATEMENT, AFTER STATEMENT, BEFORE EACH ROW, AFTER EACH ROW, INSTEAD OF EACH ROW that will be invoked when the compound trigger fires. Basic template is provided with place holders.

Click the SQL tab to continue.

Your entries in the Compound Trigger dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Compound Trigger dialog:

The example demonstrates creating a compound trigger named test_ct.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Exclusion Constraint Dialog

Use the Exclusion constraint dialog to define or modify the behavior of an exclusion constraint. An exclusion constraint guarantees that if any two rows are compared on the specified column or expression (using the specified operator), at least one of the operator comparisons will return false or null.

The Exclusion constraint dialog organizes the development of an exclusion constraint through the following dialog tabs: General, Definition, and Columns. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the exclusion constraint:

Use the Name field to provide a descriptive name for the exclusion constraint. The name will be displayed in the pgAdmin tree control.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the exclusion constraint:

Use the drop-down listbox next to Tablespace to select the tablespace in which the index associated with the exclude constraint will reside.

Use the drop-down listbox next to Access method to specify the type of index that will be used when implementing the exclusion constraint:

Select gist to specify a GiST index.

Select spgist to specify a space-partitioned GiST index.

Select btree to specify a B-tree index.

Select hash to specify a hash index.

Use the Fill Factor field to specify a fill factor for the table and associated index. The fill factor is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify that the timing of the constraint is deferrable, and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Use the Constraint field to provide a condition that a row must satisfy to be included in the table.

Click the Columns tab to continue.

Use the fields in the Columns tab to specify the column(s) or expression(s) to which the constraint applies. Use the Is expression ? switch to enable expression text input. Use the drop-down listbox next to Column to select a column. Once the Column is selected or the Expression is entered then click the Add icon (+) to provide details of the action on the column/expression:

The Col/Exp field is populated with the selection made in the Column drop-down listbox or the Expression entered.

If applicable, use the drop-down listbox in the Operator class to specify the operator class that will be used by the index for the column.

Move the DESC switch to DESC to specify a descending sort order. The default is ASC which specifies an ascending sort order.

Use the NULLs order column to specify the placement of NULL values (when sorted). Specify FIRST or LAST.

Use the drop-down list next to Operator to specify a comparison or conditional operator.

Use Include columns field to specify columns for INCLUDE clause of the constraint. This option is available in Postgres 11 and later.

Click the SQL tab to continue.

Your entries in the Exclusion Constraint dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Exclusion Constraint dialog:

The example shown demonstrates creating an exclusion constraint named ex_dept_no. The constraint uses a btree index.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Foreign key Dialog

Use the Foreign key dialog to specify the behavior of a foreign key constraint. A foreign key constraint maintains referential integrity between two tables. A foreign key constraint cannot be defined between a temporary table and a permanent table.

The Foreign key dialog organizes the development of a foreign key constraint through the following dialog tabs: General, Definition, Columns, and Action. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the foreign key constraint:

Use the Name field to add a descriptive name for the foreign key. The name will be displayed in the pgAdmin tree control.

Store notes about the foreign key constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the foreign key constraint:

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Move the Match type switch specify the type of matching that is enforced by the constraint:

Select Full to indicate that all columns of a multicolumn foreign key must be null if any column is null; if all columns are null, the row is not required to have a match in the referenced table.

Select Simple to specify that a single foreign key column may be null; if any column is null, the row is not required to have a match in the referenced table.

Move the Validated switch to the Yes position to instruct the server to validate the existing table content (against a foreign key or check constraint) when you save modifications to this dialog.

Move the Auto FK Index switch to the No position to disable the automatic index feature.

The field next to Covering Index generates the name of an index if the Auto FK Index switch is in the Yes position; or, this field is disabled.

Click the Columns tab to continue.

Use the fields in the Columns tab to specify one or more reference column(s). A Foreign Key constraint requires that one or more columns of a table must only contain values that match values in the referenced column(s) of a row of a referenced table:

Use the drop-down listbox next to Local column to specify the column in the current table that will be compared to the foreign table.

Use the drop-down listbox next to References to specify the name of the table in which the comparison column(s) resides.

Use the drop-down listbox next to Referencing to specify a column in the foreign table.

Click the Add icon (+) to add a column to the list; repeat the steps above and click the Add icon (+) to add additional columns. To discard an entry, click the trash icon to the left of the entry and confirm deletion in the Delete Row popup.

Click the Action tab to continue.

Use the drop-down listboxes on the Action tab to specify behavior related to the foreign key constraint that will be performed when data within the table is updated or deleted:

Use the drop-down listbox next to On update to select an action that will be performed when data in the table is updated.

Use the drop-down listbox next to On delete to select an action that will be performed when data in the table is deleted.

The supported actions are:

NO ACTION

Produce an error indicating that the deletion or update will create a foreign key constraint violation. If the constraint is deferred, this error will be produced at constraint check time if any referencing rows still exist. This is the default.

RESTRICT

Throw an error indicating that the deletion or update would create a foreign key constraint violation. This is the same as NO ACTION except that the check is not deferrable.

CASCADE

Delete any rows referencing the deleted row, or update the values of the referencing column(s) to the new values of the referenced columns, respectively.

SET NULL

Set the referencing column(s) to null.

SET DEFAULT

Set the referencing column(s) to their default values. There must be a row in the referenced table that matches the default values (if they are not null), or the operation will fail.

Click the SQL tab to continue.

Your entries in the Foreign key dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Foreign key dialog:

The example shown demonstrates creating a foreign key constraint named jobhist_ref_dept_fk that matches values in the jobhist table dept_no column with those of the dept table deptno column.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Index Dialog

Use the Index dialog to create an index on a specified table or materialized view.

The Index dialog organizes the development of a index through the following dialog tabs: General, Definition, and Columns. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the index:

Use the Name field to add a descriptive name for the index. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Tablespace to select the tablespace in which the index will reside.

Store notes about the index in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the index:

Use the drop-down listbox next to Access Method to select an index type:

Select btree to create a B-tree index. A B-tree index may improve performance when managing equality and range queries on data that can be sorted into some ordering (the default).

Select hash to create a hash index. A hash index may improve performance when managing simple equality comparisons.

Select gist to create a GiST index. A GiST index may improve performance when managing two-dimensional geometric data types and nearest-neighbor searches.

Select gin to create a GIN index. A GIN index may improve performance when managing values with more than one key.

Select spgist to create a space-partitioned GiST index. A SP-GiST index may improve performance when managing non-balanced data structures.

Select brin to create a BRIN index. A BRIN index may improve performance when managing minimum and maximum values and ranges.

Use the Fill Factor field to specify a fill factor for the index. The fill factor specifies how full the selected method will try to fill each index page.

Use the Gin pending list limit field to specify the maximum size of a GIN index’s pending list, which is used when fastupdate is enabled. This value is specified in kilobytes.

Use the Pages per range field to specify the number of table blocks that make up one block range for each entry of a BRIN index.

Select Buffering to specify whether the buffering build technique is used to build the index. The default is Auto

Move the switch next to Deduplicate items? towards the right position to control usage of the B-tree deduplication technique. The default is Yes. This option is available only on PostgreSQL 13 and above.

Move the switch next to Fast update? towards the right position to control usage of the fast update technique. The default is Yes.

Move the switch next to Autosummarize towards the right position to define whether a summarization run is queued for the previous page range whenever an insertion is detected on the next one. The default is No

Move the switch next to Unique? towards the right position to check for duplicate values in the table when the index is created and when data is added. The default is No.

Move the switch next to NULLs not distinct? towards the right position to treat null values as not distinct. The default is*No*. This option is available only on PostgreSQL 15 and above.

Move the Clustered? switch to the Yes position to instruct the server to cluster the table.

Move the Concurrent build? switch to the Yes position to build the index without taking any locks that prevent concurrent inserts, updates, or deletes on the table.

Use the Constraint field to provide a constraint expression; a constraint expression limits the entries in the index to those rows that satisfy the constraint.

Click the Columns tab to continue.

Use the fields in the Columns tab to specify which column(s) or expression(s) the index queries. Use the Is expression ? switch to enable expression sql input. Use the drop-down listbox next to Column to select a column. Once the Column is selected or the Expression is entered then click the Add icon (+) to provide details of the action on the column/expression:

The Col/Exp field is populated with the selection made in the Column drop-down listbox or the Expression entered.

If enabled, use the drop-down listbox to select an available Operator class to specify the type of action performed on the column.

If enabled, use the drop-down listbox to select Sort order:

Select ASC to specify an ascending sort order (the default);

Select DESC to specify a descending sort order.

If enabled, use the drop-down listbox to select Nulls:

Select First to specify nulls sort before non-nulls;

Select Last to specify nulls sort after non-nulls (the default).

Use the drop-down listbox in the Collation field to select a collation to use for the index.

Use Include columns field to specify columns for INCLUDE clause of the constraint. This option is available in Postgres 11 and later.

Click the SQL tab to continue.

Your entries in the Index dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Index dialog:

The example shown demonstrates creating an index named index_sal that indexes the values in the job column of the jobhist table.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Primary key Dialog

Use the Primary key dialog to create or modify a primary key constraint. A primary key constraint indicates that a column, or group of columns, uniquely identifies rows in a table. This requires that the values in the selected column(s) be both unique and not null.

The Primary key dialog organizes the development of a primary key constraint through the General and Definition tabs. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the primary key:

Use the Name field to add a descriptive name for the primary key constraint. The name will be displayed in the pgAdmin tree control.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the primary key constraint:

Click inside the Columns field and select one or more column names from the drop-down listbox. To delete a selection, click the x to the left of the column name. The primary key constraint should be different from any unique constraint defined for the same table; the selected column(s) for the constraints must be distinct.

Use Include columns field to specify columns for INCLUDE clause of the index. This option is available in Postgres 11 and later.

Select the name of the tablespace in which the primary key constraint will reside from the drop-down listbox in the Tablespace field.

Select the name of an index from the drop-down listbox in the Index field. This field is optional. Adding a primary key will automatically create a unique B-tree index on the column or group of columns listed in the primary key, and will force the column(s) to be marked NOT NULL.

Use the Fill Factor field to specify a fill factor for the table and index. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Click the SQL tab to continue.

Your entries in the Primary key dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Primary key dialog:

The example shown demonstrates creating a primary key constraint named jobhist_pk on the empno column of the jobhist table.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

RLS Policy Dialog

Use the RLS Policy dialog to Create a Row Level Security Policy.

Note

If the Row Level Security is enabled at table level and no policy is created then by default Deny Policy is applied. That means, no rows are visible or can be modified for that table.

The RLS Policy dialog creates a Row Level Security Policy through the following dialog tabs: General, and Commands. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to define the RLS Policy:

Use the Name field to add a descriptive name for the RLS Policy. The name will be displayed in the pgAdmin tree control.

Use the drop-down listbox next to Role to select the Role to which the RLS Policy is to be applied.

Use the drop-down listbox next to Type to select the type of the policy.

Store notes about the policy in the Comment field.

Click the Commands tab to continue.

Use the fields in the Commands tab to define the RLS Policy:

Use the drop-down listbox next to Event to select the command to which policy applies. Valid options are ALL, SELECT, INSERT, UPDATE, and DELETE. Default is ALL.

Use the Using field to add a SQL conditional expression returning boolean. This expression will be added to queries that refer to the table if row level security is enabled.

Use the With check field to add a SQL conditional expression returning boolean. This expression will be used in INSERT and UPDATE queries against the table if row level security is enabled.

Click the SQL tab to continue.

Your entries in the RLS Policy dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the RLS Policy dialog:

The example shown demonstrates creating a RLS Policy named jobhist_rls that applies the Row Level Security on the jobhist table.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Rule Dialog

Use the Rule dialog to define or modify a rule for a specified table or view. A PostgreSQL rule allows you to define an additional action that will be performed when a SELECT, INSERT, UPDATE, or DELETE is performed against a table.

The Rule dialog organizes the development of a rule through the General, Definition, Condition, Commands tabs. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the rule:

Use the Name field to add a descriptive name for the rule. The name will be displayed in the pgAdmin tree control. Multiple rules on the same table are applied in alphabetical name order.

Store notes about the rule in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to write parameters:

Click inside the Event field to select the type of event that will invoke the rule; event may be Select, Insert, Update, or Delete.

Move the Do Instead switch to Yes indicate that the commands should be executed instead of the original command; if Do Instead specifies No, the rule will be invoked in addition to the original command.

Rule enabled field is available in rule dialog once the rule is created. You can select one of the four options available.

Click the Condition tab to continue.

Specify a SQL conditional expression that returns a boolean value in the editor.

Click the Commands tab to continue.

Provide a command in the editor that defines the action performed by the rule.

Click the SQL tab to continue.

Your entries in the Rule dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Rule dialog:

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Table Dialog

Use the Table dialog to create or modify a table.

The Table dialog organizes the development of a table through the following dialog tabs: General, Columns, Constraints, Advanced, Parition, Parameter, and Security. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the table:

Use the Name field to add a descriptive name for the table. A table cannot have the same name as any existing table, sequence, index, view, foreign table, or data type in the same schema. The name specified will be displayed in the pgAdmin tree control. This field is required.

Select the owner of the table from the drop-down listbox in the Owner field. By default, the owner of the table is the role that creates the table.

Select the name of the schema in which the table will reside from the drop-down listbox in the Schema field.

Use the drop-down listbox in the Tablespace field to specify the tablespace in which the table will be stored.

Move the Partitioned Table? switch to the Yes in case you want to create a partitioned table. Option is available for PostgreSQL 10 and above.

Store notes about the table in the Comment field.

Click the Columns tab to continue.

Use the drop-down listbox next to Inherited from table(s) to specify any parent table(s); the table will inherit columns from the selected parent table(s). Click inside the Inherited from table(s) field to select a table name from a drop-down list. Repeat to add any other parent tables. Delete a selected table by clicking the x to the left of the parent name. Note that inherited column names and datatypes are not editable in the current dialog; they must be modified at the parent level.

Click the Add icon (+) to specify the names of columns and their datatypes in the Columns table:

Use the Name field to add a descriptive name for the column.

Use the drop-down listbox in the Data type field to select a data type for the column. This can include array specifiers. For more information on the data types supported by PostgreSQL, refer to Chapter 8 of the core documentation.

If enabled, use the Length/Precision and Scale fields to specify the maximum number of significant digits in a numeric value, or the maximum number of characters in a text value.

Move the Not NULL? switch to the Yes position to require a value in the column field.

Move the Primary key? switch to the Yes position to specify the column is the primary key constraint.

Click the Add icon (+) to add additional columns; to discard a column, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the Constraints tab to continue.

Use the fields in the Constraints tab to provide a table or column constraint. Optional constraint clauses specify constraints (tests) that new or updated rows must satisfy for an INSERT or UPDATE operation to succeed. Select the appropriate constraint type by selecting one of the following tabs on the Constraints panel:

Tab Name

Constraint

Primary Key

Provides a unique identifier for each row in the table.

Foreign Key

Maintains referential integrity between two tables.

Check

Requires data satisfies an expression or condition before insertion or modification.

Unique

Ensures that the data contained in a column, or a group of columns, is unique among all the rows in the table.

Exclude

Guarantees that if any two rows are compared on the specified column or expression (using the specified operator), at least one of the operator comparisons will return false or null.

To add a primary key for the table, select the Primary Key tab, and click the Add icon (+). To define the primary key, click the Edit icon to the left of the Trash icon. A dialog similar to the Primary key dialog (accessed by right clicking on Constraints in the pgAdmin tree control) opens.

Use the fields in the General tab to identify the primary key:

Use the Name field to add a descriptive name for the primary key constraint. The name will be displayed in the pgAdmin tree control.

Provide notes about the primary key in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the primary key constraint:

Click inside the Columns field and select one or more column names from the drop-down listbox. To delete a selection, click the x to the left of the column name. The primary key constraint should be different from any unique constraint defined for the same table; the selected column(s) for the constraints must be distinct.

Select the name of the tablespace in which the primary key constraint will reside from the drop-down listbox in the Tablespace field.

Use the Fill Factor field to specify a fill factor for the table and index. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

To add a foreign key constraint, select the Foreign Key tab, and click the Add icon (+). To define the constraint, click the Edit icon to the left of the Trash icon. A dialog similar to the Foreign key dialog (accessed by right clicking on Constraints in the pgAdmin tree control) opens.

Use the fields in the General tab to identify the foreign key constraint:

Use the Name field to add a descriptive name for the foreign key constraint. The name will be displayed in the pgAdmin tree control.

Provide notes about the foreign key in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the foreign key constraint:

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Move the Match type switch specify the type of matching that is enforced by the constraint:

Select Full to indicate that all columns of a multicolumn foreign key must be null if any column is null; if all columns are null, the row is not required to have a match in the referenced table.

Select Simple to specify that a single foreign key column may be null; if any column is null, the row is not required to have a match in the referenced table.

Move the Validated switch to the Yes position to instruct the server to validate the existing table content (against a foreign key or check constraint) when you save modifications to this dialog.

Move the Auto FK Index switch to the No position to disable the automatic index feature.

The field next to Covering Index generates the name of an index if the Auto FK Index switch is in the Yes position; or, this field is disabled.

Click the Columns tab to continue.

Use the fields in the Columns tab to specify one or more reference column(s).

A Foreign Key constraint requires that one or more columns of a table must only contain values that match values in the referenced column(s) of a row of a referenced table:

Use the drop-down listbox next to Local column to specify the column in the current table that will be compared to the foreign table.

Use the drop-down listbox next to References to specify the name of the table in which the comparison column(s) resides.

Use the drop-down listbox next to Referencing to specify a column in the foreign table.

Click the Add icon (+) to add a column to the list; repeat the steps above and click the Add icon (+) to add additional columns. To discard an entry, click the trash icon to the left of the entry and confirm deletion in the Delete Row popup.

Click the Action tab to continue.

Use the drop-down listboxes on the Action tab to specify behavior related to the foreign key constraint that will be performed when data within the table is updated or deleted:

Use the drop-down listbox next to On update to select an action that will be performed when data in the table is updated.

Use the drop-down listbox next to On delete to select an action that will be performed when data in the table is deleted.

The supported actions are:

NO ACTION

Produce an error indicating that the deletion or update will create a foreign key constraint violation. If the constraint is deferred, this error will be produced at constraint check time if any referencing rows still exist. This is the default.

RESTRICT

Throw an error indicating that the deletion or update would create a foreign key constraint violation. This is the same as NO ACTION except that the check is not deferrable.

CASCADE

Delete any rows referencing the deleted row, or update the values of the referencing column(s) to the new values of the referenced columns, respectively.

SET NULL

Set the referencing column(s) to null.

SET DEFAULT

Set the referencing column(s) to their default values. There must be a row in the referenced table that matches the default values (if they are not null), or the operation will fail.

To add a check constraint, select the Check tab on the panel, and click the Add icon (+). To define the check constraint, click the Edit icon to the left of the Trash icon. A dialog similar to the Check dialog (accessed by right clicking on Constraints in the pgAdmin tree control) opens.

Use the fields in the General tab to identify the check constraint:

Use the Name field to add a descriptive name for the check constraint. The name will be displayed in the pgAdmin tree control. With PostgreSQL 9.5 forward, when a table has multiple check constraints, they will be tested for each row in alphabetical order by name and after NOT NULL constraints.

Provide notes about the check constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the check constraint:

Provide the expression that a row must satisfy in the Check field. This field is required.

Move the No Inherit? switch to the Yes position to specify that this constraint is not automatically inherited by a table’s children. The default is No, meaning that the constraint will be inherited by any children.

Move the Don’t validate? switch to the No position to skip validation of existing data; the constraint may not hold for all rows in the table. The default is Yes.

To add a unique constraint, select the Unique tab on the panel, and click the Add icon (+). To define the constraint, click the Edit icon to the left of the Trash icon. A dialog similar to the Unique constraint dialog (accessed by right clicking on Constraints in the pgAdmin tree control) opens.

Use the fields in the General tab to identify the unique constraint:

Use the Name field to add a descriptive name for the unique constraint. The name will be displayed in the pgAdmin tree control.

Provide notes about the unique constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the unique constraint:

Click inside the Columns field and select one or more column names from the drop-down listbox. To delete a selection, click the x to the left of the column name. The unique constraint should be different from the primary key constraint defined for the same table; the selected column(s) for the constraints must be distinct.

Select the name of the tablespace in which the unique constraint will reside from the drop-down listbox in the Tablespace field.

Use the Fill Factor field to specify a fill factor for the table and index. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

To add an exclusion constraint, select the Exclude tab on the panel, and click the Add icon (+). To define the constraint, click the Edit icon to the left of the Trash icon. A dialog similar to the Exclusion constraint dialog (accessed by right clicking on Constraints in the pgAdmin tree control) opens.

Use the fields in the General tab to identify the exclusion constraint:

Use the Name field to provide a descriptive name for the exclusion constraint. The name will be displayed in the pgAdmin tree control.

Provide notes about the exclusion constraint in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the exclusion constraint:

Use the drop-down listbox next to Tablespace to select the tablespace in which the index associated with the exclude constraint will reside.

Use the drop-down listbox next to Access method to specify the type of index that will be used when implementing the exclusion constraint:

Select gist to specify a GiST index (the default).

Select spgist to specify a space-partitioned GiST index.

Select btree to specify a B-tree index.

Select hash to specify a hash index.

Use the Fill Factor field to specify a fill factor for the table and associated index. The fill factor is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify that the timing of the constraint is deferrable, and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Use the Constraint field to provide a condition that a row must satisfy to be included in the table.

Click the Columns tab to continue.

Use the fields in the Columns tab to specify the column(s) to which the constraint applies. Use the drop-down listbox next to Column to select a column and click the Add icon (+) to provide details of the action on the column:

The Column field is populated with the selection made in the Column drop-down listbox.

If applicable, use the drop-down listbox in the Operator class to specify the operator class that will be used by the index for the column.

Move the DESC switch to DESC to specify a descending sort order. The default is ASC which specifies an ascending sort order.

Move the NULLs order switch to LAST to define an ascending sort order for NULLs. The default is FIRST which specifies a descending order.

Use the drop-down list next to Operator to specify a comparison or conditional operator.

Click the Advanced tab to continue.

Use the fields in the Advanced tab to define advanced features for the table:

Move the RLS Policy? switch to the Yes position to enable the Row Level Security.

Move the Force RLS Policy? to the Yes position to force the policy on the owner of the table.

Use the drop-down listbox next to Of type to copy the table structure from the specified composite type. Please note that a typed table will be dropped if the type is dropped (with DROP TYPE … CASCADE).

Use the drop-down list box next to Access Method to specify the table access method to use to store the contents for the new table; the method needs to be an access method of type TABLE. This field is optional. This option is available from v12 and above.

Use the Fill Factor field to specify a fill factor for the table. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Use the Toast tuple target field to set toast_tuple_target storage parameter of the table. The toast_tuple_target value is in bytes and has minimum value of 128. This field will be enabled only for PostgreSQL version >= 11

Use the Parallel workers field to set parallel_workers storage parameter of the table. The parallel_workers sets the number of workers that should be used to assist a parallel scan of the table. This field will be enabled only for PostgreSQL version >= 9.6

Move the Has OIDs? switch to the Yes position to specify that each row within a table has a system-assigned object identifier. The default is No.

Move the Unlogged? switch to the Yes position to disable logging for the table. Data written to an unlogged table is not written to the write-ahead log. Any indexes created on an unlogged table are automatically unlogged as well. The default is No.

Use the fields in the Like box to specify which attributes of an existing table from which a table will automatically copy column names, data types, and not-null constraints; after saving the new or modified table, any changes to the original table will not be applied to the new table.

Use the drop-down listbox next to Relation to select a reference table.

Move the switch next to With default values? towards the right position to copy default values.

Move the switch next to With constraints? towards the right position to copy table and column constraints.

Move the switch next to With indexes? towards the right position to copy indexes.

Move the switch next to With storage? towards the right position to copy storage settings.

Move the switch next to With comments? towards the right position to copy comments.

Move the switch next to With compression? towards the right position to copy compression method. This option is available only on PostgreSQL 14 and above.

Move the switch next to With generated? towards the right position to copy generation expressions of copied column. This option is available only on PostgreSQL 12 and above.

Move the switch next to With identity? towards the right position to copy any identity specifications of copied column.

Move the switch next to With statistics? towards the right position to copy extended statistics.

With PostgreSQL 10 forward, the Partition tab will be visible.

Click the Partition tab to continue.

Use the fields in the partition tab to create the partitions for the table:

Select a partition type from the Partition Type selection box. There are 3 options available; Range, List and Hash. Hash option will only enable for PostgreSQL version >= 11.

Use the Partition Keys panel to define the partition keys. Click the Add icon (+) to add each partition keys selection:

Select a partition key type in the Keytype field.

Select a partition column in the Column field if Column option selected for Keytype field .

Specify the expression in the Expression field if Expression option selected for the Keytype field.

Use the Partitions panel to define the partitions of a table. Click the Add icon (+) to add each partition:

Move the Operation switch to attach to attach the partition, by default it is create.

Use the Name field to add the name of the partition.

If partition type is Range or List then Default field will be enabled.

If partition type is Range then From and To fields will be enabled.

If partition type is List then In field will be enabled.

If partition type is Hash then Modulus and Remainder fields will be enabled.

Users can create a partition and define them as a partitioned table. Click the Edit icon to expand the properties of a partition. Use the Partition tab to create that partition as a partitioned table.

Move the Partitioned Table? switch to the Yes in case you want to create a partitioned table.

Select a partition type from the Partition Type selection box.

Use the Partition Keys panel to define the partition keys.

View of multi level Partitioned Table in object explorer:

Click the Parameter tab to continue.

Use the tabs nested inside the Parameter tab to specify VACUUM and ANALYZE thresholds; use the Table tab and the Toast Table tab to customize values for the table and the associated toast table:

Move the Custom auto-vacuum? switch to the Yes position to perform custom maintenance on the table and to select values in the Vacuum table. The Vacuum Table provides default values for maintenance operations.

Changing Autovacuum enabled? to Not set will reset autovacuum_enabled.

Provide a custom value in the Value column for each metric listed in the Label column.

Click the Security tab to continue.

Use the Security tab to assign privileges and define security labels.

Use the Privileges panel to assign privileges to a role. Click the Add icon (+) to set privileges for database objects:

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Use the Security Labels panel to define security labels applied to the function. Click the Add icon (+) to add each security label selection:

Specify a security label provider in the Provider field. The named provider must be loaded and must consent to the proposed labeling operation.

Specify a a security label in the Security Label field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.

Click the Add icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the Delete Row popup.

Click the SQL tab to continue.

Your entries in the Table dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Table dialog:

The example shown demonstrates creating a table named jobhist. It has six columns and a primary key constraint on the empno and startdate column.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Trigger Dialog

Use the Trigger dialog to create a trigger or modify an existing trigger. A trigger executes a specified function when certain events occur.

The Trigger dialog organizes the development of a trigger through the following dialog tabs: General, Definition, Events, and Code. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the trigger:

Use the Name field to add a descriptive name for the trigger. This must be distinct from the name of any other trigger for the same table. The name will be displayed in the pgAdmin tree control. Note that if multiple triggers of the same kind are defined for the same event, they will be fired in alphabetical order by name.

Store notes about the trigger in the Comment field.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the trigger:

Move the Row trigger? switch to the No position to disassociate the trigger from firing on each row in a table. The default is Yes.

Move the Constraint trigger? switch to the Yes position to specify the trigger is a constraint trigger.

If enabled, move the Deferrable? switch to the Yes position to specify the timing of the constraint trigger is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint trigger is deferred to the end of the statement causing the triggering event. The default is No.

Use the drop-down listbox next to Trigger Function to select a trigger function or procedure.

Use the Arguments field to provide an optional (comma-separated) list of arguments to the function when the trigger is executed. The arguments are literal string constants.

Trigger enabled field is available in trigger dialog once the trigger is created. You can select one of the four options available.

Click the Events tab to continue.

Use the fields in the Events tab to specify how and when the trigger fires:

Use the drop-down listbox next to the Fires fields to determine if the trigger fires BEFORE or AFTER a specified event. The default is BEFORE.

Select the type of event(s) that will invoke the trigger; to select an event type, move the switch next to the event to the YES position. The supported event types are INSERT, UPDATE, DELETE, and TRUNCATE.

Use the When field to provide a boolean condition that will invoke the trigger.

If defining a column-specific trigger, use the Columns field to specify the columns or columns that are the target of the trigger.

Click the Code tab to continue.

Use the Code field to specify any additional code that will be invoked when the trigger fires.

Click the SQL tab to continue.

Your entries in the Trigger dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Trigger dialog:

The example demonstrates creating a trigger named emp_trigger.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Unique Constraint Dialog

Use the Unique constraint dialog to define a unique constraint for a specified table. Unique constraints ensure that the data contained in a column, or a group of columns, is unique among all the rows in the table.

The Unique constraint dialog organizes the development of a unique constraint through the following dialog tabs: General and Definition. The SQL tab displays the SQL code generated by dialog selections.

Use the fields in the General tab to identify the unique constraint:

Use the Name field to add a descriptive name for the unique constraint. The name will be displayed in the pgAdmin tree control.

Click the Definition tab to continue.

Use the fields in the Definition tab to define the unique constraint:

Click inside the Columns field and select one or more column names from the drop-down listbox. To delete a selection, click the x to the left of the column name. The unique constraint should be different from the primary key constraint defined for the same table; the selected column(s) for the constraints must be distinct.

Use Include columns field to specify columns for INCLUDE clause of the constraint. This option is available in Postgres 11 and later.

Select the name of the tablespace in which the unique constraint will reside from the drop-down listbox in the Tablespace field.

Select the name of an index from the drop-down listbox in the Index field. This field is optional. Adding a unique constraint will automatically create a unique B-tree index on the column or group of columns listed in the constraint, and will force the column(s) to be marked NOT NULL.

Use the Fill Factor field to specify a fill factor for the table and index. The fill factor for a table is a percentage between 10 and 100. 100 (complete packing) is the default.

Move the Deferrable? switch to the Yes position to specify the timing of the constraint is deferrable and can be postponed until the end of the statement. The default is No.

If enabled, move the Deferred? switch to the Yes position to specify the timing of the constraint is deferred to the end of the statement. The default is No.

Move the NULLs not distinct? switch to the Yes position to treat null values as not distinct. The default is No. This option is available only on PostgreSQL 15 and above.

Click the SQL tab to continue.

Your entries in the Unique constraint dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Unique constraint dialog:

The example shown demonstrates creating a unique constraint named jobhist_unique on the empno column of the jobhist table.

Click the Info button (i) to access online help.

Click the Save button to save work.

Click the Close button to exit without saving work.

Click the Reset button to restore configuration parameters.

Management Basics

pgAdmin provides point and click dialogs that help you perform server management functions. Dialogs simplify tasks such as managing named restore points, granting user privileges, and performing VACUUM, ANALYZE and REINDEX functions.

Add Named Restore Point Dialog

Change Password Dialog

Grant Wizard

Import/Export Data Dialog

Maintenance Dialog

Storage Manager

Add Named Restore Point Dialog

Use the Add named restore point dialog to take a named snapshot of the state of the server for use in a recovery file. To create a named restore point, the server’s postgresql.conf file must specify a wal_level value of replica, logical, or minimal. You must be a database superuser to create a restore point.

When the Restore point name window launches, use the field Enter the name of the restore point to add to provide a descriptive name for the restore point.

For more information about using a restore point as a recovery target, please see the PostgreSQL documentation [https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET].

Click the OK button to save the restore point.

Click the Cancel button to exit without saving work.

Change Password Dialog

It is a good policy to routinely change your password to protect data, even in what you may consider a ‘safe’ environment. In the workplace, failure to apply an appropriate password policy could leave you in breach of Data Protection laws.

Please consider the following guidelines when selecting a password:

Ensure that your password is an adequate length; 6 characters should be the absolute minimum number of characters in the password.

The minimum password length is set by default to six characters. This value can be changed by setting the PASSWORD_LENGTH_MIN option to desired length in pgAdmin configuration; see The config.py File for more information.

Ensure that your password is not open to dictionary attacks. Use a mixture of upper and lower case letters and numerics, and avoid words or names. Consider using the first letter from each word in a phrase that you will remember easily but is an unfamiliar acronym.

Ensure that your password is changed regularly; at minimum, change it every ninety days.

The guidelines above should be considered a starting point: They are not a comprehensive list and they will not guarantee security.

Use the Change Password dialog to change your password:

The name displayed in the User field is the role for which you are modifying the password; it is the role that is associated with the server connection that is highlighted in the tree control.

Enter the password associated with the role in the Current Password field.

Enter the desired password for in the New Password field.

Re-enter the new password in the Confirm Password field.

Click the Save button to change your password.

Click the Close button to exit without changing your password.

Click the Reset button to reset the values.

Grant Wizard

The Grant Wizard tool is a graphical interface that allows you to manage the privileges of one or more database objects in a point-and-click environment. A search box, dropdown lists, and checkboxes facilitate quick selections of database objects, roles and privileges.

The wizard organizes privilege management through a sequence of windows: Object Selection, Privileges Selection and Review Selection. The Review Selection window displays the SQL code generated by wizard selections.

To launch the Grant Wizard tool, select a database object in the pgAdmin tree control, then navigate through Tools on the menu bar to click on the Grant Wizard option.

Use the fields in the Object Selection window to select the object or objects on which you are modifying privileges. Use the Search by object type or name field to locate a database object, or use the scrollbar to scroll through the list of all accessible objects.

Each row in the table lists object identifiers; check the checkbox in the left column to include an object as a target of the Grant Wizard. The table displays:

The object type in the Object Type field

The schema in which the object resides in the Schema field

The object name in the Name field.

Click the Next button to continue, or the X button to close the wizard without modifying privileges.

Use the fields in the Privileges Selection window to grant privileges. If you grant a privilege WITH GRANT OPTION, the Grantee will have the right to grant privileges on the object to others. If WITH GRANT OPTION is subsequently revoked, any role who received access to that object from that Grantee (directly or through a chain of grants) will lose thier privileges on the object.

Click the Add icon (+) to assign a set of privileges.

Select the name of the role from the drop-down listbox in the Grantee field.

Click inside the Privileges field. Check the boxes to the left of one or more privileges to grant the selected privileges to the specified user. If privileges have previously been granted on a database object, unchecking a privilege for a group or user will result in revoking that privilege.

The current user, who is the default grantor for granting the privilege, is displayed in the Grantor field.

Click the Add icon (+) to assign a set of privileges to another role; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the Delete Row dialog.

For more information about granting privileges on database objects, see the PostgreSQL core documentation [https://www.postgresql.org/docs/current/sql-grant.html].

Click the Next button to continue, the Back button to select or deselect additional database objects, or the X button to close the wizard without modifying privileges.

Your entries in the Grant Wizard tool generate a SQL command; you can review the command in the Review Selection window (see an example below).

Example

The following is an example of the sql command generated by user selections in the Grant Wizard tool:

Click the Back button to select or deselect additional database objects, roles and privileges.

Click the Finish button to save selections and exit the wizard.

Import/Export Data Dialog

Use the Import/Export data dialog to copy data from a table to a file, or copy data from a file into a table.

The Import/Export data dialog organizes the import/export of data through the General, Options and Columns tabs.

Use the fields in the General tab to specify import and export preferences:

Move the Import/Export switch to the Import position to specify that the server should import data to a table from a file. The default is Import.

Enter the name of the source or target file in the Filename field. Optionally, select the Browse icon (ellipsis) to the right to navigate into a directory and select a file.

Use the drop-down listbox in the Format field to specify the file type. Select:

binary for a .bin file.

csv for a .csv file.

text for a .txt file.

Use the drop-down listbox in the Encoding field to specify the type of character encoding.

Use the fields in the Options tab to specify additional information:

Move the OID switch to the Yes position to include the OID column. The OID is a system-assigned value that may not be modified. The default is No.

Move the Header switch to the Yes position to include the table header with the data rows. If you include the table header, the first row of the file will contain the column names.

If you are exporting data, specify the delimiter that will separate the columns within the target file in the Delimiter field. The separating character can be a colon, semicolon, a vertical bar, or a tab.

Specify a quoting character used in the Quote field. Quoting can be applied to string columns only (i.e. numeric columns will not be quoted) or all columns regardless of data type. The character used for quoting can be a single quote or a double quote.

Specify a character that should appear before a data character that matches the QUOTE value in the Escape field.

Use the NULL Strings field to specify a string that will represent a null value within the source or target file.

Click the Columns tab to continue.

Use the fields in the Columns tab to select the columns that will be imported or exported:

Click inside the Columns to export/import field to deselect one or more columns from the drop-down listbox. To delete a selection, click the x to the left of the column name. Click an empty spot inside the field to access the drop-down list.

If enabled, click inside the NOT NULL columns field to select one or more columns that will not be checked for a NULL value. To delete a column, click the x to the left of the column name.

After completing the Import/Export data dialog, click the OK button to perform the import or export. pgAdmin will inform you when the background process completes:

Use the Stop Process button to stop the Import/Export process.

Use the Click here for details link on the notification to open the Process Watcher and review detailed information about the execution of the command that performed the import or export:

Note

If you are running pgAdmin in Server Mode you can click on the sm_icon icon in the process watcher window to open the file location in the Storage Manager. You can use the Storage Manager to download the backup file on the client machine .

Maintenance Dialog

Use the Maintenance dialog to VACUUM, ANALYZE, REINDEX or CLUSTER a database or selected database objects.

While this utility is useful for ad-hoc maintenance purposes, you are encouraged to perform automatic VACUUM jobs on a regular schedule.

Select a button next to Maintenance operation to specify the type of maintenance:

Click VACUUM to scan the selected database or table to reclaim storage used by dead tuples.

Move the FULL switch to the Yes position to compact tables by writing a completely new version of the table file without dead space.

Move the FREEZE switch to the Yes position to freeze data in a table when it will have no further updates.

Move the ANALYZE switch to the Yes position to issue ANALYZE commands whenever the content of a table has changed sufficiently.

Move the DISABLE PAGE SKIPPING switch to the Yes position to disables all page-skipping behavior.

Move the SKIP LOCKED switch to the Yes position to specifies that VACUUM should not wait for any conflicting locks to be released when beginning work on a relation. This option is available from v12 onwards.

Move the TRUNCATE switch to the Yes position to specifies that VACUUM should attempt to truncate off any empty pages at the end of the table and allow the disk space for the truncated pages to be returned to the operating system. This option is available from v12 onwards.

Move the PROCESS TOAST switch to the Yes position to specifies that VACUUM should attempt to process the corresponding TOAST table for each relation, if one exists. This option is available from v14 onwards.

Move the PROCESS MAIN switch to the Yes position to specifies that VACUUM should attempt to process the main relation. This option is available from v16 onwards.

Move the SKIP DATABASE STATS switch to the Yes position to specifies that VACUUM should skip updating the database-wide statistics about oldest unfrozen XIDs. This option is available from v16 onwards.

Move the ONLY DATABASE STATS switch to the Yes position to specifies that VACUUM should do nothing except update the database-wide statistics about oldest unfrozen XIDs . This option is available from v16 onwards.

Use the INDEX CLEANUP field to force VACUUM to process indexes when there are more than zero dead tuples.

Use the PARALLEL field to specify index vacuum and index cleanup phases of VACUUM in parallel using integer background workers. This option is available from v13 onwards.

Use the BUFFER USAGE LIMIT field to specifies the Buffer Access Strategy ring buffer size for VACUUM. This size is used to calculate the number of shared buffers which will be reused as part of this strategy. This option is available from v16 onwards

Click ANALYZE to update the stored statistics used by the query planner. This enables the query optimizer to select the fastest query plan for optimal performance.

Move the SKIP LOCKED switch to the Yes position to specifies that ANALYZE should not wait for any conflicting locks to be released when beginning work on a relation. This option is available from v12 onwards.

Use the BUFFER USAGE LIMIT field to specifies the Buffer Access Strategy ring buffer size for ANALYZE. This size is used to calculate the number of shared buffers which will be reused as part of this strategy. This option is available from v16 onwards

Click REINDEX to rebuild any index in case it has degenerated due to the insertion of unusual data patterns. This happens, for example, if you insert rows with increasing index values, and delete low index values.

Move the SYSTEM switch to the Yes position to recreate all indexes on system catalogs within the current database. This option is enabled only when database object is selected.

Move the CONCURRENTLY switch to the Yes position to rebuild the index without taking any locks that prevent concurrent inserts, updates, or deletes on the table. This option is available from v12 onwards.

Use the TABLESPACE field to specifies that indexes will be rebuilt on a new tablespace. This option is available from v14 onwards.

Click CLUSTER to instruct PostgreSQL to cluster the selected table.

To exclude status messages from the process output, move the Verbose Messages switch to the No position; by default, status messages are included.

When you’ve completed the dialog, click OK to start the background process; to exit the dialog without performing maintenance operations, click Cancel.

pgAdmin will run the maintenance process in background. You can view all the background process with there running status and logs on the Processes tab.

Storage Manager

Storage Manager is a feature that helps you manage your systems storage device. You can use Storage Manager to:

Download, upload, or manage operating system files. To use this feature, pgAdmin must be running in Server Mode on your client machine.

The shared storage option allows users to access the shared storages that are shared by admin users.

Download backup or export files (custom, tar and plain text format) on a client machine.

Download export dump files of tables.

You can access Storage Manager from the Tools Menu.

Use icons on the top of the Storage Manager window to manage storage:

Use the Folder icon Shared Storage to access shared storage. In order to enable shared storage, admins need to add the SHARED_STORAGE variable to the config file. Users can access the shared storage with this and share files with one another.

Use the Home icon home to return to the home directory.

Use the Up Arrow icon uparrow to return to the previous directory.

Use the Refresh icon refresh to display the most-recent files available.

Select the Download icon download to download the selected file.

Use the New Folder icon folder to add a new folder.

Use the Format drop down list to select the format of the files to be displayed; choose from sql, csv, or All Files.

Shared Storage

In the storage manager, My Storage is the pgAdmin user’s storage directory, and other listed directories are shared storages set by the pgAdmin server administrator. Using these, pgAdmin users can have common storages to share files. pgAdmin server administrator can configure the shared storages using the config file. Storages can be marked as restricted to give read-only access to non-admin pgAdmin users.

Note

You must ensure the directories specified are writeable by the user that the web server processes will be running as, e.g. apache or www-data.*

Other Options

Menu

Behavior

Rename

Click the Rename option to rename a file/folder.

Delete

Click the Delete option to rename a file/folder.

Upload

Click the Upload option to upload multiple files to the current folder.

List View

Click the List View option to to display all the files and folders in a list view.

Grid View

Click the Grid View option to to display all the files and folders in a grid view.

Show Hidden Files

Click the Show Hidden Files option to view hidden files and folders.

You can also download backup files through Storage Manager at the successful completion of the backups taken through Backup Dialog, Backup Global Dialog, or Backup Server Dialog.

At the successful completion of a backup, click on the icon to open the current backup file in Storage Manager on the process watcher window.

Backup and Restore

A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment.

Backup Dialog

Backup Globals Dialog

Backup Server Dialog

Restore Dialog

Backup Dialog

pgAdmin uses the pg_dump utility to provide an easy way to create a backup in a plain-text or archived format. You can then use a client application (like psql or the Query Tool) to restore a plain-text backup file, or use the Postgres pg_restore utility to restore an archived backup. The pg_dump utility must have read access to all database objects that you want to back up.

You can backup a single table, a schema, or a complete database. Select the name of the backup source in the pgAdmin tree control, right click to open the context menu, and select Backup… to open the Backup dialog. The name of the object selected will appear in the dialog title bar.

Use the fields in the General tab to specify parameters for the backup:

Enter the name of the backup file in the Filename field. Optionally, select the Browser icon (…) to the right to navigate into a directory and select a file that will contain the archive.

Use the drop-down listbox in the Format field to select the format that is best suited for your application. Each format has advantages and disadvantages:

Select Custom to create a custom archive file that you can use with pg_restore to create a copy of a database. Custom archive file formats must be restored with pg_restore. This format offers the opportunity to select which database objects to restore from the backup file. Custom archive format is recommended for medium to large databases as it is compressed by default.

Select Tar to generate a tar archive file that you can restore with pg_restore. The tar format does not support compression.

Select Plain to create a plain-text script file. A plain-text script file contains SQL statements and commands that you can execute at the psql command line to recreate the database objects and load the table data. A plain-text backup file can be edited in a text editor, if desired, before using the psql program to restore database objects. Plain format is normally recommended for smaller databases; script dumps are not recommended for blobs. The SQL commands within the script will reconstruct the database to the last saved state of the database. A plain-text script can be used to reconstruct the database on another machine, or (with modifications) on other architectures.

Select Directory to generate a directory-format archive suitable for use with pg_restore. This file format creates a directory with one file for each table and blob being dumped, plus a Table of Contents file describing the dumped objects in a machine-readable format that pg_restore can read. This format is compressed by default.

Use the Compression Ratio field to select a compression level for the backup. Specify a value of zero to mean use no compression; specify a maximum compression value of 9. Please note that tar archives do not support compression.

Use the Encoding drop-down listbox to select the character encoding method that should be used for the archive.

Use the Number of Jobs field (when applicable) to specify the number of tables that will be dumped simultaneously in a parallel backup.

Use the dropdown listbox next to Rolename to specify the role that owns the backup.

Click the Data Options tab to continue. Use the fields in the Data Options tab to provide options related to data or pgAdmin objects that correspond to pg_dump.

Move switches in the Sections field box to select a portion of the object that will be backed up.

Move the switch next to Pre-data towards right position to include all data definition items not included in the data or post-data item lists.

Move the switch next to Data towards right position to backup actual table data, large-object contents, and sequence values.

Move the switch next to Post-data towards right position to include definitions of indexes, triggers, rules, and constraints other than validated check constraints.

Move switches in the Type of objects field box to specify details about the type of objects that will be backed up.

Move the switch next to Only data towards right position to limit the back up to data.

Move the switch next to Only schemas to limit the back up to schema-level database objects.

Move the switch next to Blobs towards left position to exclude large objects in the backup.

Move switches in the Do not save field box to select the objects that will not be included in the backup.

Move the switch next to Owner towards right position to exclude commands that set object ownership.

Move the switch next to Privileges towards right position to exclude commands that create access privileges.

Move the switch next to Tablespaces towards right position to exclude tablespaces.

Move the switch next to Unlogged table data towards right position to exclude the contents of unlogged tables.

Move the switch next to Comments towards right position to exclude commands that set the comments. Note: This option is visible only for database server greater than or equal to 11.

Move the switch next to Publications towards right position to exclude publications.

Move the switch next to Subscriptions towards right position to exclude subscriptions.

Move the switch next to Security labels towards right position to exclude Security labels.

Move the switch next to Toast compressions towards right position to exclude Toast compressions. Note: This option is visible only for database server greater than or equal to 14.

Move the switch next to Table access methods towards right position to exclude Table access methods. Note: This option is visible only for database server greater than or equal to 15.

Click the Query Options tab to continue. Use these additional fields to specify the type of statements that should be included in the backup.

Move the switch next to Use INSERT commands towards right position to dump the data in the form of INSERT statements rather than using a COPY command. Please note: this may make restoration from backup slow.

Use the Maximum rows per INSERT command field to controls the maximum number of rows per INSERT command. Note: This option is visible only for database server greater than or equal to 12.

Move the switch next to On conflict do nothing to INSERT command towards right position to add ON CONFLICT DO NOTHING to INSERT command. This option is not valid unless Use INSERT commands, Use Column INSERTS or Maximum rows per INSERT command is also specified. Note: This option is visible only for database server greater than or equal to 12.

Move the switch next to Include CREATE DATABASE statement towards right position to include a command in the backup that creates a new database when restoring the backup.

Move the switch next to Include DROP DATABASE statement towards right position to include a command in the backup that will drop any existing database object with the same name before recreating the object during a backup.

Move the switch next to Include IF EXISTS clause towards right position to add an IF EXISTS clause to drop databases and other objects. This option is not valid unless Include DROP DATABASE statement is also set.

Click the Table Options tab to continue. Use the fields in the Table Options tab related to tables that should be included in the backup.

Move the switch next to Use Column INSERTS towards right position to dump the data in the form of INSERT statements and include explicit column names. Please note: this may make restoration from backup slow.

Move the switch next to Load via partition root towards right position, so when dumping a COPY or INSERT statement for a partitioned table, target the root of the partitioning hierarchy which contains it rather than the partition itself. Note: This option is visible only for database server greater than or equal to 11.

Move the switch next to Enable row security towards right position to set row_security to on instead, allowing the user to dump the parts of the contents of the table that they have access to. This option is relevant only when dumping the contents of a table which has row security.

Use the Include table(s) and Children field to dump the tables and any partitions or inheritance child tables of the tables matching the pattern. Note: This option is visible only for database server greater than or equal to 16.

The Exclude patterns field is utilized to exclude patterns in the following manner:

Use the Table(s) field to not dump the tables matching the pattern. Multiple patterns can be given separated by space.

Use the Table(s) data field to not dump data for any tables matching the pattern. Multiple patterns can be given separated by spaces.

Use the Table(s) and children field to not dump the tables and any partitions or inheritance child tables of the tables matching the pattern. Note: This option is visible only for database server greater than or equal to 16.

Use the Table(s) data and children field to not dump data for the tables and any partitions or inheritance child tables of the tables matching the table pattern. Note: This option is visible only for database server greater than or equal to 16.

Click the Options tab to continue. Use the fields in the Options tab to provide other backup options.

Move switches in the Disable field box to specify the type of statements that should be excluded from the backup.

Move the switch next to Triggers (active when creating a data-only backup) towards right position to include commands that will disable triggers on the target table while the data is being loaded.

Move the switch next to $ quoting towards right position to enable dollar quoting within function bodies; if disabled, the function body will be quoted using SQL standard string syntax.

Move switches in the Miscellaneous field box to specify miscellaneous backup options.

Move the switch next to Verbose messages towards left position to instruct pg_dump to exclude verbose messages.

Move the switch next to Force double quotes on identifiers towards right position to force the quoting of all identifiers.

Move the switch next to Use SET SESSION AUTHORIZATION towards right position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command).

Use the Exclude schema field to not dump schemas whose name matches pattern.

Use the Extra float digits field to use the specified value when dumping floating-point data, instead of the maximum available precision.

Use the Lock wait timeout field to do not wait forever to acquire shared table locks at the beginning of the dump. Instead, fail if unable to lock a table within the specified timeout.

Click the Objects tab to continue.

Select the objects from tree to take backup of selected objects only.

If Schema is selected then it will take the backup of that selected schema only.

If any Table, View, Materialized View, Sequences, or Foreign Table is selected then it will take the backup of those selected objects.

When you’ve specified the details that will be incorporated into the pg_dump command:

Click the Backup button to build and execute a command that builds a backup based on your selections on the Backup dialog.

Click the Cancel button to exit without saving work.

pgAdmin will run the backup process in background. You can view all the background process with there running status and logs on the Processes tab

Backup Globals Dialog

Use the Backup Globals dialog to create a plain-text script that recreates all of the database objects within a cluster, and the global objects that are shared by those databases. Global objects include tablespaces, roles, and object properties. You can use the pgAdmin Query Tool to play back a plain-text script, and recreate the objects in the backup.

Use the fields in the General tab to specify the following:

Enter the name of the backup file in the Filename field. Optionally, select the Browser icon (ellipsis) to the right to navigate into a directory and select a file that will contain the archive.

Use the drop-down listbox next to Role name to specify a role with connection privileges on the selected server. The role will be used for authentication during the backup.

Move switches in the Miscellaneous field box to specify the type of statements that should be included in the backup.

Move the Verbose messages switch to the No position to exclude status messages from the backup. The default is Yes.

Move the Force double quote on identifiers switch to the Yes position to name identifiers without changing case. The default is No.

Click the Backup button to build and execute a command based on your selections; click the Cancel button to exit without saving work.

pgAdmin will run the backup process in background. You can view all the background process with there running status and logs on the Processes tab

Backup Server Dialog

Use the Backup Server dialog to create a plain-text script that will recreate the selected server. You can use the pgAdmin Query Tool to play back a plain-text script, and recreate the server.

Use the fields in the General tab to specify the following:

Enter the name of the backup file in the Filename field. Optionally, select the Browser icon (ellipsis) to the right to navigate into a directory and select a file that will contain the archive.

Use the Encoding drop-down listbox to select the character encoding method that should be used for the archive. Note: This option is visible only for database server greater than or equal to 11.

Use the drop-down listbox next to Role name to specify a role with connection privileges on the selected server. The role will be used for authentication during the backup.

Click the Data Options tab to continue. Use the fields in the Data Options tab to provide options related to data or pgAdmin objects that correspond to pg_dumpall.

Move switches in the Type of objects field box to specify details about the type of objects that will be backed up.

Move the switch next to Only data towards right position to limit the back up to data.

Move the switch next to Only schemas to limit the back up to schema-level database objects.

Move the switch next to Only tablespaces to limit the back up to tablespaces only.

Move the switch next to Only roles to limit the back up to roles only.

Move switches in the Do not save field box to select the objects that will not be included in the backup.

Move the switch next to Owner towards right position to exclude commands that set object ownership.

Move the switch next to Role passwords towards right position to exclude passwords for roles.

Move the switch next to Privileges towards right position to exclude commands that create access privileges.

Move the switch next to Tablespaces towards right position to exclude tablespaces.

Move the switch next to Unlogged table data towards right position to exclude the contents of unlogged tables.

Move the switch next to Comments towards right position to exclude commands that set the comments. Note: This option is visible only for database server greater than or equal to 11.

Move the switch next to Publications towards right position to exclude publications.

Move the switch next to Subscriptions towards right position to exclude subscriptions.

Move the switch next to Security labels towards right position to exclude Security labels.

Move the switch next to Toast compressions towards right position to exclude Toast compressions. Note: This option is visible only for database server greater than or equal to 14.

Move the switch next to Table access methods towards right position to exclude Table access methods. Note: This option is visible only for database server greater than or equal to 15.

Click the Query Options tab to continue. Use these additional fields to specify the type of statements that should be included in the backup.

Move the switch next to Use INSERT commands towards right position to dump the data in the form of INSERT statements rather than using a COPY command. Please note: this may make restoration from backup slow.

Use the Maximum rows per INSERT command field to controls the maximum number of rows per INSERT command. Note: This option is visible only for database server greater than or equal to 12.

Move the switch next to On conflict do nothing to INSERT command towards right position to add ON CONFLICT DO NOTHING to INSERT command. This option is not valid unless Use INSERT commands, Use Column INSERTS or Maximum rows per INSERT command is also specified. Note: This option is visible only for database server greater than or equal to 12.

Move the switch next to Include DROP DATABASE statement towards right position to include a command in the backup that will drop any existing database object with the same name before recreating the object during a backup.

Move the switch next to Include IF EXISTS clause towards right position to add an IF EXISTS clause to drop databases and other objects. This option is not valid unless Include DROP DATABASE statement is also set.

Click the Table Options tab to continue. Use the fields in the Table Options tab related to tables that should be included in the backup.

Move the switch next to Use Column INSERTS towards right position to dump the data in the form of INSERT statements and include explicit column names. Please note: this may make restoration from backup slow.

Move the switch next to Load via partition root towards right position, so when dumping a COPY or INSERT statement for a partitioned table, target the root of the partitioning hierarchy which contains it rather than the partition itself. Note: This option is visible only for database server greater than or equal to 11.

Click the Options tab to continue. Use the fields in the Options tab to provide other backup options.

Move switches in the Disable field box to specify the type of statements that should be excluded from the backup.

Move the switch next to Triggers (active when creating a data-only backup) towards right position to include commands that will disable triggers on the target table while the data is being loaded.

Move the switch next to $ quoting towards right position to enable dollar quoting within function bodies; if disabled, the function body will be quoted using SQL standard string syntax.

Move switches in the Miscellaneous field box to specify miscellaneous backup options.

Move the switch next to Verbose messages towards left position to instruct pg_dumpall to exclude verbose messages.

Move the switch next to Force double quotes on identifiers towards right position to force the quoting of all identifiers.

Move the switch next to Use SET SESSION AUTHORIZATION towards right position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command).

Use the Exclude database field to not dump databases whose name matches pattern.

Use the Extra float digits field to use the specified value when dumping floating-point data, instead of the maximum available precision.

Use the Lock wait timeout field to do not wait forever to acquire shared table locks at the beginning of the dump. Instead, fail if unable to lock a table within the specified timeout.

When you’ve specified the details that will be incorporated into the pg_dumpall command:

Click the Backup button to build and execute a command that builds a backup based on your selections on the Backup Server dialog.

Click the Cancel button to exit without saving work.

pgAdmin will run the backup process in background. You can view all the background process with there running status and logs on the Processes tab

Restore Dialog

The Restore dialog provides an easy way to use a Custom, tar, or Directory format backup taken with the pgAdmin Backup dialog to recreate a database or database object. The Backup dialog invokes options of the pg_dump client utility; the Restore dialog invokes options of the pg_restore client utility.

You can use the Query Tool to play back the script created during a plain-text backup made with the Backup dialog. For more information about backing up or restoring, please refer to the documentation for pg_dump [https://www.postgresql.org/docs/current/app-pgdump.html] or pg_restore [https://www.postgresql.org/docs/current/app-pgrestore.html].

Use the fields on the General tab to specify general information about the restore process:

Use the drop-down listbox in the Format field to select the format of your backup file.

Select Custom or tar to restore from a custom archive file to create a copy of the backed-up object.

Select Directory to restore from a compressed directory-format archive.

Enter the complete path to the backup file in the Filename field. Optionally, select the Browse icon (ellipsis) to the right to navigate into a directory and select the file that contains the archive.

Use the Number of Jobs field to specify if pg_restore should use multiple (concurrent) jobs to process the restore. Each job uses a separate connection to the server.

Use the drop-down listbox next to Rolename to specify the role that will be used to authenticate with the server during the restore process.

Click the Data Options tab to continue. Use the fields in the Data Options tab to provide options related to data or pgAdmin objects that correspond to pg_restore.

Move switches in the Sections field box to specify the content that will be restored:

Move the switch next to Pre-data towards right position to restore all data definition items not included in the data or post-data item lists.

Move the switch next to Data towards right position to restore actual table data, large-object contents, and sequence values.

Move the switch next to Post-data towards right position position to restore definitions of indexes, triggers, rules, and constraints (other than validated check constraints).

Move switches in the Type of objects field box to specify the objects that will be restored:

Move the switch next to Only data towards right position to limit the restoration to data.

Move the switch next to Only schema to limit the restoration to schema-level database objects.

Move switches in the Do not save box to specify which objects will not be restored:

Move the switch next to Owner towards right position to exclude commands that set object ownership.

Move the switch next to Privileges towards right position to exclude commands that create access privileges.

Move the switch next to Tablespaces towards right position to exclude tablespaces.

Move the switch next to Comments towards right position to exclude commands that set the comments. Note: This option is visible only for database server greater than or equal to 11.

Move the switch next to Publications towards right position to exclude publications.

Move the switch next to Subscriptions towards right position to exclude subscriptions.

Move the switch next to Security labels towards right position to exclude Security labels.

Move the switch next to Table access methods towards right position to exclude Table access methods. Note: This option is visible only for database server greater than or equal to 15.

Click the Query Options tab to continue. Use these additional fields to specify the type of statements that should be included in the restore:

Move the switch next to Include CREATE DATABASE statement towards right position to include a command that creates a new database before performing the restore.

Move the switch next to Clean before restore towards right position to drop each existing database object (and data) before restoring.

Move the switch next to Include IF EXISTS clause towards right position to add an IF EXISTS clause to drop databases and other objects. This option is not valid unless Clean before restore is also set.

Move the switch next to Single transaction towards right position to execute the restore as a single transaction (that is, wrap the emitted commands in BEGIN/COMMIT). This ensures that either all the commands complete successfully, or no changes are applied. This option implies –exit-on-error.

Click the Table Options tab to continue. Use the fields in the Table Options tab related to tables that should be included in the backup.

Move the switch next to Enable row security towards right position to set row_security to on instead, allowing the user to dump the parts of the contents of the table that they have access to. This option is relevant only when dumping the contents of a table which has row security.

Move the switch next to No data for failed tables towards right position to ignore data that fails a trigger.

Click the Options tab to continue. Use the fields in the Options tab to provide other restore options.

Move switches in the Disable box to specify the type of statements that should be excluded from the restore:

Move the switch next to Triggers (active when creating a data-only restore) towards right position to include commands that will disable triggers on the target table while the data is being loaded.

Move switches in the Miscellaneous/Behavior box to specify miscellaneous restore options:

Move the switch next to Verbose messages towards left to instruct pg_restore to exclude verbose messages.

Move the switch next to Use SET SESSION AUTHORIZATION towards right position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command).

Move the switch next to Exit on error towards right position to instruct pg_restore to exit restore if there is an error in sending SQL commands. The default is to continue and to display a count of errors at the end of the restore.

Use the Exclude schema field to not dump schemas whose name matches pattern.

When you’ve specified the details that will be incorporated into the pg_restore command, click the Restore button to start the process, or click the Cancel button to exit without saving your work. A popup will confirm if the restore is successful.

pgAdmin will run the restore process in background. You can view all the background process with there running status and logs on the Processes tab

Developer Tools

The pgAdmin Tools menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code.

Debugger

In-context Debugging

Direct Debugging

Using the Debugger

Query Tool

Toolbar

The SQL Editor Panel

Query History Panel

The Data Output Panel

Explain Panel

Messages Panel

Notifications Panel

Graph Visualiser Panel

Connection Status

Change connection

Macros

View/Edit Data

The View/Edit Data Toolbar

The Data Grid

Sort/Filter options dialog

Promote View/Edit Data to Query Tool

Schema Diff

The Schema Diff Object Comparison Panel

Schema Diff DDL Comparison Panel

ERD Tool

Toolbar

File Options

Export Options

Editing Options

Table Relationship Options

Node Color Options

Utility Options

Zoom Options

Table Dialog

Table Node

The One to Many Link Dialog

The Many to Many Link Dialog

The Table Link

The Table Notes

PSQL Tool

Debugger

The debugger may be used to debug PL/pgSQL functions in PostgreSQL, as well as EDB-SPL functions, stored procedures and packages in EDB Postgres Advanced Server. The Debugger is available as an extension for your PostgreSQL installation, and is distributed as part of Advanced Server. You must have superuser privileges to use the debugger.

Before using the debugger, you must modify the postgresql.conf file, adding the server-side debugger components to the value of the shared_preload_libraries parameter, for example:

shared_preload_libraries = ‘$libdir/plugin_debugger’

After modifying the shared_preload_libraries parameter, restart the server to apply the changes.

The debugger may be used for either in-context debugging or direct debugging of a target function or procedure. When you use the debugger for in-context debugging, you set a breakpoint at the first line of a program; when a session invokes the target, control is transferred to the debugger. When using direct debugging, the debugger prompts you for any parameters required by the target, and then allows you to step through the code.

In-context Debugging

To set a breakpoint at the first line of a program, right-click the name of the object you would like to debug, and select Set breakpoint from the Debugging sub-menu. The debugger window will open, waiting for another session to invoke the program.

When another session invokes the target, the debugger will display the code, allowing you to add break points, or step through line-by-line. The other session is suspended until the debugging completes; then control is returned to the session.

Direct Debugging

To use the debugger for direct debugging, right click on the name of the object that you wish to debug in the pgAdmin tree control and select Debug from the Debugging sub-menu. The debugger window will open, prompting you for any values required by the program:

Use the fields on the Debugger dialog to provide a value for each parameter:

The Name field contains the formal parameter name.

The Type field contains the parameter data type.

Check the Null? checkbox to indicate that the parameter is a NULL value.

Check the Expression? checkbox if the Value field contains an expression.

Use the Value field to provide the parameter value that will be passed to the program. When entering parameter values, type the value into the appropriate cell on the grid, or, leave the cell empty to represent NULL, enter ‘’ (two single quotes) to represent an empty string, or to enter a literal string consisting of just two single quotes, enter ''. PostgreSQL 8.4 and above supports variadic function parameters. These may be entered as a comma-delimited list of values, quoted and/or cast as required.

Check the Use default? checkbox to indicate that the program should use the value in the Default Value field.

The Default Value field contains the default value of the parameter.

Provide values required by the program, and click the Debug button to start stepping through the program. The values of the arguments provided here are saved. The values will be pre-filled next time the dialog opens. To clear the values, use the Clear All button.

Using the Debugger

The main debugger window consists of two panels and a context-sensitive toolbar. Use toolbar icons to manage breakpoints and step into or through code; hover over an icon for a tooltip that identifies the option associated with the icon. The toolbar options are:

Option

Action

Shortcut

Step into

Click the Step into icon to execute the currently highlighted line of code.

Option/Alt + Shift + I

Step over

Click the Step over icon to execute a line of code, stepping over any sub-functions invoked by the code. The sub-function executes, but is not debugged unless it contains a breakpoint.

Option/Alt + Shift + O

Continue/Start

Click the Continue/Start icon to execute the highlighted code, and continue until the program encounters a breakpoint or completes.

Option/Alt + Shift + C

Toggle breakpoint

Use the Toggle breakpoint icon to enable or disable a breakpoint (without removing the breakpoint).

Option/Alt + Shift + T

Clear all breakpoints

Click the Clear all breakpoints icon to remove all breakpoints from the program.

Option/Alt + Shift + X

Stop

Click the Stop icon to halt the execution of a program.

Option/Alt + Shift + S

Help

Click the Help icon to open debugger documentation.

The top panel of the debugger window displays the program body; click in the grey margin next to a line number to add a breakpoint. The highlighted line in the top panel is the line that is about to execute.

The lower panel of the debugger window provides a set of tabs that allow you to review information about the program:

The Parameters tab displays the value of each parameter.

The Local variables tab displays the current value of the program variables.

The Messages tab displays any messages returned by the server (errors, warnings and informational messages).

The Results tab displays the server message when the program completes.

The Stack tab displays the list of functions that have been invoked, but which have not yet completed.

As you step through a program, the Local variables tab displays the current value of each variable:

When you step into a subroutine, the Stack tab displays the call stack, including the name of each caller, the parameter values for each caller (if any), and the line number within each caller:

Select a caller to change focus to that stack frame and display the state of the caller in the upper panel.

When the program completes, the Results tab displays the message returned by the server. If the program encounters an error, the Messages tab displays details:

Query Tool

The Query Tool is a powerful, feature-rich environment that allows you to execute arbitrary SQL commands and review the result set. You can access the Query Tool via the Query Tool menu option on the Tools menu, or through the context menu of select nodes of the Object explorer control. The Query Tool allows you to:

Issue ad-hoc SQL queries.

Execute arbitrary SQL commands.

Edit the result set of a SELECT query if it is updatable.

Displays current connection and transaction status as configured by the user.

Save the data displayed in the output panel to a CSV file.

Review the execution plan of a SQL statement in either a text, a graphical format or a table format (similar to https://explain.depesz.com).

View analytical information about a SQL statement.

You can open multiple copies of the Query tool in individual tabs simultaneously. To close a copy of the Query tool, click the X of the tab.

The Query Tool features two panels:

The upper panel displays the SQL Editor. You can use the panel to enter, edit, or execute a query or a script. It also shows the History tab which can be used to view the queries that have been executed in the session, and a Scratch Pad which can be used to hold text snippets during editing. If the Scratch Pad is closed, it can be re-opened (or additional ones opened) by right-clicking in the SQL Editor and other panels and adding a new panel.

The lower panel displays the Data Output panel. The tabbed panel displays the result set returned by a query, information about a query’s execution plan, server messages related to the query’s execution and any asynchronous notifications received from the server.

Toolbar

The toolbar is described in the following subsections.

Query Tool Toolbar

File Options

Filter/Limit Options

Query Editing Options

Query Execution

Data Editing Options

Pagination Options

Status Bar

The SQL Editor Panel

The SQL editor panel is a workspace where you can manually provide a query, copy a query from another source, or read a query from a file. The SQL editor features syntax coloring and autocompletion.

To use autocomplete, begin typing your query; when you would like the Query editor to suggest object names or commands that might be next in your query, press the Control+Space key combination. For example, type “SELECT * FROM” (without quotes, but with a trailing space), and then press the Control+Space key combination to select from a popup menu of autocomplete options.

After entering a query, select the Execute script icon from the toolbar. The complete contents of the SQL editor panel will be sent to the database server for execution. To execute only a section of the code that is displayed in the SQL editor, highlight the text that you want the server to execute, and click the Execute script icon.

You can also execute a query based on cursor position. Query tool will detect a query and underline it when cursor position changes. Now, to execute the current underlined query, hit the Execute query button on the toolbar. If a section is highlighted then it will behave like normal execute.

The warning will appear only if Underline query at cursor? is set to False and the Underlined query execute warning? switch is set to True Preferences Query tool’s Options.

The message returned by the server when a command executes is displayed on the Messages tab. If the command is successful, the Messages tab displays execution details.

Options on the Edit menu offer functionality that helps with code formatting and commenting:

The auto-indent feature will automatically indent text to the same depth as the previous line when you press the Return key.

Block indent text by selecting two or more lines and pressing the Tab key.

Implement or remove SQL style or toggle C style comment notation within your code.

You can also drag and drop certain objects from the treeview which can save time in typing long object names. Text containing the object name will be fully qualified with schema. Double quotes will be added if required. For functions and procedures, the function name along with parameter names will be pasted in the Query Tool.

Query History Panel

Use the Query History tab to review activity for the current session:

The Query History tab displays information about recent commands:

The date and time that a query was invoked.

The text of the query.

The number of rows returned by the query.

The amount of time it took the server to process the query and return a result set.

Messages returned by the server (not noted on the Messages tab).

The source of the query (indicated by icons corresponding to the toolbar).

You can show or hide the queries generated internally by pgAdmin (during ‘View/Edit Data’ or ‘Save Data’ operations).

You can remove a single query by selecting it and clicking on the Remove button. If you would like to remove all of the histories from the Query History tab, then click on the Remove All button.

By using the Copy button, you can copy a particular query to the clipboard, and with the Copy to Query Editor button, you can copy a specific query to the Query Editor tab. During this operation, all existing content in the Query Editor is erased.

Query History is maintained across sessions for each database on a per-user basis when running in Query Tool mode. In View/Edit Data mode, history is not retained. By default, the last 20 queries are stored for each database. This can be adjusted in config_local.py or config_system.py (see the config.py documentation) by overriding the MAX_QUERY_HIST_STORED value. See the Deployment section for more information.

The Data Output Panel

The Data Output panel displays data and statistics generated by the most recently executed query.

The Data Output tab displays the result set of the query in a table format. You can:

Select and copy from the displayed result set.

Use the Save results to file icon to save the content of the Data Output tab as a comma-delimited file.

Edit the data in the result set of a SELECT query if it is updatable.

Move between pages of data result.

A result set is updatable if:

All columns are either selected directly from a single table, or are not table columns at all (e.g. concatenation of 2 columns). Only columns that are selected directly from the table are editable, other columns are read-only.

All the primary key columns or OIDs of the table are selected in the result set.

Any columns that are renamed or selected more than once are also read-only.

Editable and read-only columns are identified using pencil and lock icons (respectively) in the column headers.

The psycopg2 driver version should be equal to or above 2.8 for updatable query result sets to work.

An updatable result set is identical to the Data Grid in View/Edit Data mode, and can be modified in the same way.

If Auto-commit is off, the data changes are made as part of the ongoing transaction, if no transaction is ongoing a new one is initiated. The data changes are not committed to the database unless the transaction is committed.

If any errors occur during saving (for example, trying to save NULL into a column with NOT NULL constraint) the data changes are rolled back to an automatically created SAVEPOINT to ensure any previously executed queries in the ongoing transaction are not rolled back.

All rowsets from previous queries or commands that are displayed in the Data Output panel will be discarded when you invoke another query; open another Query Tool tab to keep your previous results available.

Explain Panel

To generate the Explain or Explain Analyze plan of a query, click on Explain or Explain Analyze button in the toolbar.

More options related to Explain and Explain Analyze can be selected from the drop down on the right side of Explain Analyze button in the toolbar.

Please note that pgAdmin generates the Explain [Analyze] plan in JSON format.

On successful generation of Explain plan, it will create three tabs/panels under the Explain panel.

Graphical

Please note that EXPLAIN VERBOSE cannot be displayed graphically. Click on a node icon on the Graphical tab to review information about that item; a popup window will display on the right side with the information about the selected object. For information on JIT statistics, triggers and a summary, click on the button on top-right corner; a similar popup window will be displayed when appropriate.

Use the download button on top left corner of the Explain canvas to download the plan as an SVG file.

Note: Download as SVG is not supported on Internet Explorer.

Note that the query plan that accompanies the Explain analyze is available on the Data Output tab.

Table

Table tab shows the plan details in table format, it generates table format similar to explain.depesz.com. Each row of the table represent the data for a Explain Plan Node. It may contain the node information, exclusive timing, inclusive timing, actual vs planned rows differences, actual rows, planned rows, loops.

background color of the exclusive, inclusive, and Rows X columns may vary based on the difference between actual vs planned.

If percentage of the exclusive/inclusive timings of the total query time is: > 90 - Red color > 50 - Orange (between red and yellow) color > 10 - Yellow color

If planner mis-estimated number of rows (actual vs planned) by 10 times - Yellow color 100 times - Orange (between Red and Yellow) color 1000 times - Red color

Statistics

Statistics tab shows two tables: 1. Statistics per Plan Node Type 2. Statistics per Table

Messages Panel

Use the Messages tab to view information about the most recently executed query:

If the server returns an error, the error message will be displayed on the Messages tab, and the syntax that caused the error will be underlined in the SQL editor. If a query succeeds, the Messages tab displays how long the query took to complete and how many rows were retrieved:

Notifications Panel

Use the Notifications tab to view the notifications using PostgreSQL Listen/ Notify feature. For more details see PostgreSQL documentation [https://www.postgresql.org/docs/current/sql-listen.html].

Example:

Execute LISTEN “foo” in first Query Tool session

2. In the another Query Tool session, execute Notify command or pg_notify function to send the notification of the event together with the payload.

3. You can observe the Notification tab in the first Query Tool session where it shows the Recorded time, Event, Process ID, and the Payload of the particular channel.

Graph Visualiser Panel

Click the Graph Visualiser button in the toolbar to generate the Graphs of the query results. The graph visualiser supports Line Charts, Stacked Line Charts, Bar Charts, Stacked Bar Charts, and Pie Charts.

Graph Type

Choose the type of the graph that you would like to generate.

X Axis

Choose the column whose value you wish to display on X-axis from the X Axis dropdown. Select the <Row Number> option to use the number of rows as labels on the X-axis.

Y Axis

Choose the columns whose value you wish to display on Y-axis from the Y Axis dropdown. Users can choose multiple columns. Choose the <Select All> option from the drop-down menu to select all the columns.

Download and Zoom button

Zooming is performed by clicking and selecting an area over the chart with the mouse. The Zoom to original button will bring you back to the original zoom level.

Click the Download button on the button bar to download the chart.

Line Chart

The Line Chart can be generated by selecting the ‘Line Chart’ from the Graph Type drop-down, selecting the X-axis and the Y-axis, and clicking on the ‘Generate’ button. Below is an example of a chart of employee names and their salaries.

Set Use different data point styles? option to true in the Preferences Dialog, to show data points in a different style on each graph lines.

Stacked Line Chart

The Stacked Line Chart can be generated by selecting the ‘Stacked Line Chart’ from the Graph Type drop-down, selecting the X-axis and the Y-axis, and clicking on the ‘Generate’ button.

Bar Chart

The Bar Chart can be generated by selecting the ‘Bar Chart’ from the Graph Type drop-down, selecting the X-axis and the Y-axis, and clicking on the ‘Generate’ button.

Stacked Bar Chart

The Stacked Bar Chart can be generated by selecting the ‘Stacked Bar Chart’ from the Graph Type drop-down, selecting the X-axis and the Y-axis, and clicking on the ‘Generate’ button.

Pie Chart

The Pie Chart can be generated by selecting the ‘Pie Chart’ from the Graph Type drop-down, selecting the Label and Value, and clicking on the ‘Generate’ button.

Connection Status

Use the Connection status feature to view the current connection and transaction status by clicking on the status icon in the Query Tool:

Change connection

User can connect to another server or database from existing open session of query tool.

Click on the connection link next to connection status.

Now click on the <New Connection> option from the dropdown.

Now select server, database, user, and role to connect and click on the ‘Save’ button.

A newly created connection will now get listed in the options.

To connect, select the newly created connection from the dropdown list.

Macros

Query Tool Macros enable you to execute pre-defined SQL queries with a single key press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.

To create a macro, select the Manage Macros option from the Macros menu on the Query Tool. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the Save button to store the macro.

To add a query to macros, write and select your query, then go to the Macros menu in the Query Tool and click Add to macros. Your query will be automatically saved to macros.

To delete a macro, select the macro on the Manage Macros dialogue, and then click the Delete button. The server will prompt you for confirmation to delete the macro.

To execute a macro, simply select the appropriate shortcut keys, or select it from the Macros menu.

Query Tool Toolbar

The Query Tool toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled.

Note

The Query Tool and View/Edit Data tools are actually different operating modes of the same tool. Some controls will be disabled in either mode.

Hover over an icon in pgAdmin to display a tooltip that describes the icon’s functionality.

File Options

Icon

Behavior

Shortcut

Open File

Click the Open File icon to display a previously saved query in the SQL Editor.

Cmd/Ctrl + O

Save File

Click the Save icon to perform a quick-save of a previously saved query, or to access the Save menu:

Select Save to save the selected content of the SQL Editor panel in a file.

Select Save As to open a new browser dialog and specify a new location to which to save the selected content of the SQL Editor panel.

Cmd/Ctrl + S

Filter/Limit Options

Icon

Behavior

Shortcut

Filter

Click the Filter icon to set filtering and sorting criteria for the data when in View/Edit data mode. Click the down arrow to access other filtering and sorting options:

In the SQL Filter, you can enter a SQL query as filtering criteria. In Data Sorting, you can select the column and specify the order for sorting.

Click Filter by Selection to show only the rows containing the values in the selected cells.

Click Exclude by Selection to show only the rows that do not contain the values in the selected cells.

Click Remove Sort/Filter to remove any previously selected sort or filtering options.

Option/Alt + F

Limit Selector

Select a value in the Limit Selector to limit the size of the dataset to a number of rows.

Option/Alt + R

Query Editing Options

Icon

Behavior

Shortcut

Edit

Use the Edit menu to search, replace, or navigate the code displayed in the SQL Editor:

Option/Alt + Shift + N

Select Find to provide a search target, and search the SQL Editor contents.

Cmd/Ctrl + F

Select Replace to locate and replace (with prompting) individual occurrences of the target.

Option + Cmd + F (MAC) Ctrl + Shift + F (Others)

Select Go to Line/Column to go to specified line number and column position

Cmd/Ctrl + L

Select Indent Selection to indent the currently selected text.

Tab

Select Unindent Selection to remove indentation from the currently selected text.

Shift + Tab

Select Toggle Comment to comment/uncomment any lines that contain the selection in SQL style.

Cmd/Ctrl + /

Select Clear Query to clear the query editor window.

Option/Alt + Ctrl + L

Select Format SQL to format the selected SQL or all the SQL if none is selected

Cmd/Ctrl + K

Query Execution

Icon

Behavior

Shortcut

Stop

Click the Stop icon to cancel the execution of the currently running query.

Option + Shift + Q

Execute script

Click the Execute script icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:

Add a check next to Auto rollback on error? to instruct the server to automatically roll back a transaction if an error occurs during the transaction.

Add a check next to Auto commit? to instruct the server to automatically commit each transaction. Any changes made by the transaction will be visible to others, and durable in the event of a crash.

F5

Execute query

Click the Execute query icon to either execute the query where the cursor is present or refresh the query highlighted in the SQL editor panel.

Option+F5 (MAC) Alt+F5 (Others)

Explain

Click the Explain icon to view an explanation plan for the current query. The result of the EXPLAIN is displayed graphically on the Explain tab of the output panel, and in text form on the Data Output tab.

F7

Explain analyze

Click the Explain analyze icon to invoke an EXPLAIN ANALYZE command on the current query.

Navigate through the Explain Options menu to select options for the EXPLAIN command:

Select Verbose to display additional information regarding the query plan.

Select Costs to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.

Select Buffers to include information on buffer usage.

Select Timing to include information about the startup time and the amount of time spent in each node of the query.

Select Summary to include the summary information about the query plan.

Select Settings to include the information on the configuration parameters.

Select Wal to include the information on WAL record generation.

Shift + F7

Commit

Click the Commit icon to commit the transaction.

Shift + Ctrl + M

Rollback

Click the Rollback icon to rollback the transaction.

Shift + Ctrl + R

Macros

Click the Macros icon to manage the macros. You can create, edit or clear the macros through the Manage Macros option.

Data Editing Options

Icon

Behavior

Shortcut

Add row

Click the Add row icon to add a new row

Copy

Click the Copy icon to copy the content with or without header:

Click the Copy icon to copy the content that is currently highlighted in the Data Output

panel.

Click Copy with headers to copy the highlighted content along with the header.

Cmd/Ctrl + C

Paste

Click the Paste icon to paste a previously copied row with or without serial/identity values:

Click the Paste icon to paste a previously copied row into a new row.

Click the Paste with SERIAL/IDENTITY values? if you want to paste the copied column values in the serial/identity columns.

Note that copied row having Bytea datatype cell will be pasted as Null.

Option/Alt + Shift + P

Delete

Click the Delete icon to mark the selected rows for deletion. These marked rows get deleted

when you click the Save Data Changes icon.

Option/Alt + Shift + D

Save Data Changes

Click the Save Data Changes icon to save data changes (insert, update, or delete) in the Data Output Panel to the server.

F6

Save results to file

Click the Save results to file icon to save the result set of the current query as a delimited text file (CSV, if the field separator is set to a comma). This button will only be enabled when a query has been executed and there are results in the data grid. You can specify the CSV/TXT settings in the Preference Dialogue under SQL Editor -> CSV/TXT output.

F8

Graph Visualiser

Use the Graph Visualiser button to generate graphs of the query results.

SQL

Use the SQL button to check the current query that gave the data.

Pagination Options

Icon

Behavior

Shortcut

Rows Range

Show the current row numbers visible in the data grid.

Edit Range

Click to open the from and to rows range inputs to allow setting them.

Page No

Enter the page no you want to jump to out of total shown next to this input

First Page

Click to go to the first page.

Previous Page

Click to go to the previous page.

Next Page

Click to go to the next page.

Last Page

Click to go to the last page.

One can click the edit range button to open rows range editor:

From and to range should be between 1 and total rows.

The range can be applied by clicking the Apply button or by pressing enter in the range inputs.

Once the range is applied, pgAdmin will recalculate the rows per page. The pagination will then behave based on the new rows per page.

It may be possible that on pressing next page button, the new rows range is not next to manually enterred range.

Status Bar

The status bar shows the following information:

Total rows: The total number of rows returned by the query.

Query complete: The time is taken by the query to complete.

Rows selected: The number of rows selected in the data output panel.

Changes staged: This information shows the number of rows added, deleted, and updated.

LF/CRLF: It shows the end of line sequence to be used for the editor. When opening an empty editor, it will be decided based on OS. And when opening an existing file, it will be based on file end of lines. One can change the EOL by clicking on any of the options.

Ln: In the Query tab, it is the line number at which the cursor is positioned.

Col: In the Query tab, it is the column number at which the cursor is positioned

View/Edit Data

To view or modify data, right click on a table or view name in the Object Explorer. When the context menu opens, use the View/Edit Data menu to specify the number of rows you would like to display in the editor panel.

To modify the content of a table, each row in the table must be uniquely identifiable. If the table definition does not include an OID or a primary key, the displayed data is read only. Note that views cannot be edited; updatable views (using rules) are not supported.

The editor features a toolbar that allows quick access to frequently used options, and a work environment divided into two panels:

The upper panel displays the SQL command that was used to select the content displayed in the lower panel.

The lower panel (the Data Grid) displays the data selected from the table or view.

The View/Edit Data Toolbar

The Query Tool and View/Edit Data tools are actually different operating modes of the same tool. Some controls will be disabled in either mode. Please see The Query Tool Toolbar for a description of the available controls.

The Data Grid

The top row of the data grid displays the name of each column, the data type, and if applicable, the number of characters allowed. A column that is part of the primary key will additionally be marked with [PK].

To modify the displayed data:

To change a numeric value within the grid, double-click the value to select the field. Modify the content in the square in which it is displayed.

To change a non-numeric value within the grid, double-click the content to access the edit bubble. After modifying the contentof the edit bubble, click the Ok button to display your changes in the data grid, or Cancel to exit the edit bubble without saving.

To enter a newline character, click Ctrl-Enter or Shift-Enter. Newline formatting is only displayed when the field content is accessed via an edit bubble.

To add a new row to the table, enter data into the last (unnumbered) row of the table. As soon as you store the data, the row is assigned a row number, and a fresh empty line is added to the data grid.

To write a SQL NULL to the table, simply leave the field empty. When you store the new row, the will server fill in the default value for that column. If you store a change to an existing row, the value NULL will explicitly be written.

To write an empty string to the table, enter the special string ‘’ (two single quotes) in the field. If you want to write a string containing solely two single quotes to the table, you need to escape these quotes, by typing ''

To delete a row, press the Delete toolbar button. A popup will open, asking you to confirm the deletion.

To commit the changes to the server, select the Save Data toolbar button.

Geometry Data Viewer

If PostGIS is installed, you can view GIS objects in a map by selecting row(s) and clicking the ‘View Geometry’ button in the column. If no rows are selected, the entire data set will be rendered:

You can adjust the layout by dragging the title of the panel. To view the properties of the geometries directly in map, just click the specific geometry:

Note

Supported data types: The Geometry Viewer supports 2D and 3DM geometries in EWKB format including Point, LineString, Polygon MultiPoint, MultiLineString, MultiPolygon and GeometryCollection.

SRIDs: If there are geometries with different SRIDs in the same column, the viewer will render geometries with the same SRID in the map. If SRID=4326 the OSM tile layer will be added into the map.

Data size: For performance reasons, the viewer will render no more than 100000 geometries, totaling up to 20MB.

Internet access: An internet connection is required for the Geometry Viewer to function correctly.

JSON Data Editor

A built in json editor is provided for JSON/JSONB Data.Double clicking on json/jsonb data type cell in data grid will open JSON Editor.Editor provides different mode to view and edit json data.

Code Mode: Provides way to format & compact json data.Also provides ability to repair json data by fixing quotes and escape characters, removing comments and JSONP notation and turn JavaScript objects into JSON.

Tree Mode: Enabled to change, add, move, remove, and duplicate fields and values.Provides ability to searh & hilight data.

Form Mode: Allows only to edit values in json data there by providing ability to keep data structure unchanged while editing.

Preview Mode: Provides ability to check data before saving and also shows size of current json data. Format and compact json data as well.

Editor Toolbar

Different options are provided to manipulate json data.

Code/Preview mode:

Tree/Form mode:

Icon

Behavior

Available in mode

Format Json

Click to Format Json format json data with proper indentation.

Code, Preview

Compact Json

Click to Compact Json get compacted json data.

Code, Preview

Sort

Click to Sort icon to set sorting criteria for the data using file values.

Code, Preview, Tree

Transform

Click to Transform to filter data using JSME query language.

Code, Preview, Tree

Undo

Click to Undo to undo last action performed on data .

Code, Preview, Tree, From

Redo

Click to Redo to repat last action performed on data .

Code, Preview, Tree, From

Mode

Click to Mode dropdown to change dipaly mode of editor.Different modes avaialble are Code, Preview, Tree, From.

Code, Tree, From, Preview

Expand All

Click to Expand All to expand json data.

Tree, From

Collapse All

Click to Redo to collapse json data.

Tree, From

Search Box

Enter partial/complete string to search in data.

Tree, From

Sort/Filter options dialog

You can access Sort/Filter options dialog by clicking on Sort/Filter button. This allows you to specify an SQL Filter to limit the data displayed and data sorting options in the edit grid window:

Use SQL Filter to provide SQL filtering criteria. These will be added to the “WHERE” clause of the query used to retrieve the data. For example, you might enter:

id > 25 AND created > '2018-01-01'

Use Data Sorting to sort the data in the output grid

To add new column(s) in data sorting grid, click on the [+] icon.

Use the drop-down Column to select the column you want to sort.

Use the drop-down Order to select the sort order for the column.

Use the drop-down NULLs to select the NULL values order for the column.

To delete a row from the grid, click the trash icon.

Click the Save button to save work.

Click the Close button to discard current changes and close the dialog.

View/Edit Data Filter

Promote View/Edit Data to Query Tool

A View/Edit Data tab can be converted to a Query Tool Tab just by editing the query. Once you start editing, it will ask if you really want to move away from View/Edit.

You can disable the dialog by selecting the “Don’t Ask again” checkbox. If you wish to resume the confirmation dialog, you can do it from “Prefrences -> Query Tool -> Editor -> Show View/Edit Data Promotion Warning?”

Once you chose to continue, you won’t be able to use the features of View/Edit mode like the filter and sorting options, limit, etc. It is a one-way conversion. It will be a query tool now.

View/Edit Data Filter

You can access Data Filter dialog by clicking on Filtered Rows toolbar button visible on the Browser panel or by selecting View/Edit Data -> Filtered Rows context menu option.

This allows you to specify an SQL Filter to limit the data displayed in the edit grid window:

Schema Diff

Schema Diff is a feature that allows you to compare objects between two databases or two schemas. Use the Tools menu to access Schema Diff.

The Schema Diff feature allows you to:

Compare and synchronize the database objects (from source to target).

Visualize the differences between database objects.

List the differences in SQL statement for target database objects.

Generate synchronization scripts.

Note:

The source and target database servers must be of the same major version.

If you compare two schemas then dependencies won’t be resolved.

Click on Schema Diff under the Tools menu to open a selection panel. To compare databases choose the source and target servers, and databases. To compare schemas choose the source and target servers, databases, and schemas. After selecting the objects, click on the Compare button.

You can open multiple copies of Schema Diff in individual tabs simultaneously. To close a copy of Schema Diff, click the X in the upper-right hand corner of the tab bar. You can rename the panel title by right-clicking and select the “Rename Panel” option.

Use the Preferences dialog to specify following:

Schema Diff should open in a new browser tab. Set Open in new browser tab option to true.

Schema Diff should ignore the whitespaces while comparing string objects. Set Ignore whitespaces option to true.

Schema Diff should ignore the owner while comparing objects. Set Ignore owner option to true.

The Schema Diff panel is divided into two panels; an Object Comparison panel and a DDL Comparison panel.

The Schema Diff Object Comparison Panel

In the object comparison panel, you can select the source and target servers of the same major version, and databases to be compared. You can select any server listed under the object explorer whether it is connected or disconnected. If you select a server that is not connected then it will prompt you for the password before using the server.

Next, select the databases that will be compared. The databases can be the same or different (and within the same server or from different servers).

Use the drop-down near to Compare button to ignore owner, whitespace, tablespace and grants.

Ignore Owner – Select to ignores the owner while comparing the objects.

Ignore Whitespace – Select to ignores the whitespace while comparing the string objects. Whitespace includes space, tabs, and CRLF.

Ignore Tablespace – Select to ignores the tablespace while comparing the objects.

Ignore Grant/Revoke – Select to ignores the grant and revoke command while comparing the objects.

After you select servers, and databases, click on the Compare button to obtain the Comparison Result.

Use the drop-down lists of Database Objects to view the DDL statements.

In the upper-right hand corner of the object comparison panel is a Filter option that you can use to filter the database objects based on the following comparison criteria:

Identical – If the object is found in both databases with the same SQL statement, then the comparison result is identical.

Different – If the object is found in both databases but have different SQL statements, then the comparison result is different.

Source Only – If the object is found in source database only and not in target database, then the comparison result is source only.

Target Only – If the object is found in target database only and not in source database, then the comparison result is target only.

Click on any of the database objects in the object comparison panel to display the DDL Statements of that object in the DDL Comparison panel.

Click the Help icon to open Schema Diff documentation.

Schema Diff DDL Comparison Panel

The DDL Comparison panel displays three columns:

The first column displays the DDL statement of the object from the source database.

The second column displays the DDL statement of the object from the target database.

The third column displays the difference in the SQL statement of the target database object.

You can review the DDL statements of all the database objects to check for the differences in the SQL statements.

Also, you can generate the SQL script of the differences found in the target database object based on the SQL statement of the source database object. To generate the script, select the checkboxes of the database objects in the object comparison panel and then click on the Generate Script button in the upper-right hand corner of the object comparison panel.

Select the database objects and click on the Generate Script button to open the Query Tool in a new tab, with the difference in the SQL statement displayed in the Query Editor.

If you have clicked on the database object to check the difference generated in the DDL Comparison Panel, and you have not selected the checkbox of the database object, pgAdmin will open the Query Tool in a new tab, with the differences in the SQL statements displayed in the Query Editor.

You can also use the Copy button to copy the difference generated in the DDL Comparison panel.

Apply the SQL Statement in the target database to synchronize the databases.

ERD Tool

The Entity-Relationship Diagram (ERD) tool is a database design tool that provides a graphical representation of database tables, columns, and inter-relationships. ERD can give sufficient information for the database administrator to follow when developing and maintaining the database. The ERD Tool allows you to:

Design and visualize the database tables and their relationships.

Add notes to the diagram.

Auto-align the tables and links for cleaner visualization.

Save the diagram and open it later to continue working on it.

Generate ready to run SQL from the database design.

Generate the database diagram for an existing database.

Drag and drop tables from object explorer to the diagram.

You can open multiple copies of the ERD tool in individual tabs simultaneously. You can also generate an ERD from a database, schema or a table.

The ERD for database will fetch all the tables from all the schemas of the database and plot them with foreign key links.

The ERD for schema will fetch all the tables from a schema and plot them with foreign key links. If any table refers to a table in another schema, then that link/foreign key will be removed.

The ERD for table will fetch all the tables linked directly or indirectly to mentioned table. You can change the depth of traversal from Preferences.

Toolbar

The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. The option is enabled for the highlighted icon and is disabled for the grayed-out icon.

Hover over an icon on Toolbar to display a tooltip that describes the icon’s functionality.

File Options

Icon

Behavior

Shortcut

Open File

Click the Open File icon to load a previously saved diagram.

Cmd/Ctrl + O

Save

Click the Save icon to perform a quick-save of a previously saved diagram, or to save the diagram to a file.

Cmd/Ctrl + S

Save as

Click the Save As to open a new browser dialog and specify a new location to save the diagram. You need to click the down arrow beside the save button to see Save As.

Ctrl + Shift + S

Export Options

Icon

Behavior

Shortcut

Generate SQL

Click the Generate SQL icon to generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. You can select the option With DROP Table if you wish to have DROP Table DDL statements before each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button.

Option/Alt + Ctrl + S

Download image

Click the Download image icon to save the ERD diagram in a image formate

Option/Alt + Ctrl + I

Editing Options

Icon

Behavior

Shortcut

Add table

Click this button to add a new table to the diagram. On clicking, this will open a table dialog where you can put the table details.

Option/Alt + Ctrl + A

Edit table

Click this button to edit a table on the diagram. On clicking, this will open a table dialog where you can change table details. This will enable when a table is selected.

Option/Alt + Ctrl + E

Clone table

Click this button to clone the complete table structure, name it with a auto generated name and put it in the diagram.

Option/Alt + Ctrl + C

Drop table/link

You can drop a table or link using this button. You need to select a table or link and click on this button to drop it.

Option/Alt + Ctrl + D

Table Relationship Options

Icon

Behavior

Shortcut

1M

Click this button to open a one-to-many relationship dialog to add a relationship between the two tables. The selected table becomes the referencing table and will have the many endpoint of the link.

Option/Alt + Ctrl + O

MM

Click this button to open a many-to-many relationship dialog to add a relationship between the two tables. This option will create a new table based on the selected columns for the two relating tables and link them.

Option/Alt + Ctrl + M

Node Color Options

Icon

Behavior

Fill Color

Use Fill Color to change the background color of a table node. This is helpful if you want to identify a of group tables. Once set, all the newly added tables will take the same color.

Text Color

Use Text Color to change the text color of a table node based on the fill color to make text easily readable.

Utility Options

Icon

Behavior

Shortcut

Add/Edit note

Click this button to make notes on tables nodes while designing the database.

Option/Alt + Ctrl + N

Auto align

Click this button to auto align all tables and links to make it look more cleaner.

Option/Alt + Ctrl + L

Show details

Click this button to toggle the column details visibility. It allows you to show few or more column details.

Option/Alt + Shift + D

Cardinality Notation

Change the cardinality notation format used to present relationship links. Options available are - Crow’s Foot Notation and Chen Notation.

Zoom Options

Icon

Behavior

Shortcut

Zoom to fit

Click this button to zoom in/out automatically and fit all the tables to the view.

Option/Alt + Shift + F

Zoom in

Click this button to zoom in the diagram.

Option/Alt + Shift + “+”

Zoom out

Click this button to zoom out the diagram.

Option/Alt + Shift + “-”

Table Dialog

The table dialog allows you to:

Change the table structure details.

It can be used edit an existing table or add a new one.

Refer table dialog for information on different fields.

Table Node

The table node shows table details in a graphical representation:

The top bar has a details toggle button that is used to toggle column details visibility. There is also a note button that is visible only if there is some note added. you can click on this button to quickly change the note.

The first row shows the schema name of the table. Eg. public in above image.

The second row shows the table name. Eg. users in above image.

All other rows below the table name are the columns of the table along with data type. If the column is a primary key then it will have lock key icon eg. id is the primary key in above image. Otherwise, it will have column icon.

you can click on the node and drag to move on the canvas.

Upon double click on the table node or by clicking the edit button from the toolbar, the table dialog opens where you can change the table details. Refer table dialog for information on different fields.

The One to Many Link Dialog

The one to many link dialog allows you to:

Add a foreign key relationship between two tables.

Local Table is the table that references a table and has the many end point.

Local Column the column that references.

Referenced Table is the table that is being referred and has the one end point.

Referenced Column the column that is being referred.

The Many to Many Link Dialog

The many to many link dialog allows you to:

Add a many to many relationship between two tables.

It creates a relationship tables having columns derived from the two tables and link them to the tables.

Left Table is the first table that is to be linked. It will receive the one endpoint of the link with the new relation table.

Left Column the column of the first table, that will always be a primary key.

Right Table is the second table that is to be linked. It will receive the one endpoint of the link with the new relation table.

Right Column the column of the second table, that will always be a primary key.

The Table Link

The table link shows relationship between tables:

The single line endpoint of the link shows the column that is being referred.

The three line endpoint of the link shows the column that refers.

If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.

you can click on the link and drag to move on the canvas.

The Table Notes

You can use the notes popup to mark some notes while designing the database.

You open the pop-up using the toolbar note button.

If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes.

PSQL Tool

The PSQL tool allows users to connect to PostgreSQL or EDB Advanced server using the psql command line interface through their browser.

Open the PSQL tool from the Tools or object explorer context menu, or use PSQL tool button at the top of the object explorer.

PSQL will connect to the current connected database from the object explorer.

You can open multiple instances of the PSQL tool in individual tabs simultaneously. To close the PSQL tool, click the X in the upper-right hand corner of the tab bar.

Note: On the Windows platform, this feature is available on Windows 10 (1809 version), and Windows Server 2019 and onwards.

Note: The PSQL tool is always available when pgAdmin is running in Desktop mode, but is disabled by default in Server mode. This is because users can run arbitrary shell commands through psql which may be considered a security risk in some deployments. System Administrators can enable the use of the PSQL tool in the pgAdmin configuration by setting the ENABLE_PSQL option to True; see The config.py File for more information.

Processes

There are certain tasks which pgAdmin runs in the background. The processes running in the background can be viewed in the processes tab. It shows the process details of Backup, Restore, Maintenance, Import/Export and Cloud instance creation.

The columns of the processes table shows:

The PID of the forked OS process.

The Type of the task being performed.

The Server name for which the task is.

The Object can be a database, table, mview or anything which gives more info.

The Start Time of the process, sorted descending by default.

The current Status of the process. It can be Running, Finished, Failed, Terminated.

The Time Taken to complete. It will keep updating if it is running.

There are two action buttons on each row:

The Stop Process button allows you to kill a running process.

The More details button allows you to open the process watcher which shows the process logs and other details.

You can also select the checkboxes and click on Delete and Acknowledge button on the top to clear the process info and logs.

Process Watcher

The Process Watcher logs all the activity associated with the process/task and provides additional information for troubleshooting Use the Stop Process button to stop the Backup process.

Note

If you are running pgAdmin in Server Mode you can click on the sm_icon icon in the process watcher window to open the file location in the Storage Manager. You can use the Storage Manager to download the backup file on the client machine .

Watch the demo

https://youtu.be/jjP6O_xuHxE

pgAgent

pgAgent is a job scheduling agent for Postgres databases, capable of running multi-step batch or shell scripts and SQL tasks on complex schedules.

pgAgent is distributed independently of pgAdmin. You can download pgAgent from the download area [https://www.pgadmin.org/download] of the pgAdmin website.

Using pgAgent

Security Concerns

Installing pgAgent

Database setup

Daemon installation on Unix

Service installation on Windows

Creating a pgAgent Job

Using pgAgent

pgAgent is a scheduling agent that runs and manages jobs; each job consists of one or more steps and schedules. If two or more jobs are scheduled to execute concurrently, pgAgent will execute the jobs in parallel (each with its own thread).

A step may be a series of SQL statements or an operating system batch/shell script. Each step in a given job is executed when the previous step completes, in alphanumeric order by name. Switches on the pgAgent Job dialog (accessed through the Properties context menu) allow you to modify a job, enabling or disabling individual steps as needed.

Each job is executed according to one or more schedules. Each time the job or any of its schedules are altered, the next runtime of the job is re-calculated. Each instance of pgAgent periodically polls the database for jobs with the next runtime value in the past. By polling at least once every minute, all jobs will normally start within one minute of the specified start time. If no pgAgent instance is running at the next runtime of a job, it will run as soon as pgAgent is next started, following which it will return to the normal schedule.

When you highlight the name of a defined job in the pgAdmin tree control, the Properties tab of the main pgAdmin window will display details about the job, and the Statistics tab will display details about the job’s execution.

Security Concerns

pgAgent is a very powerful tool, but does have some security considerations that you should be aware of:

Database password - DO NOT be tempted to include a password in the pgAgent connection string - on Unix systems it may be visible to all users in ps output, and on Windows systems it will be stored in the registry in plain text. Instead, use a libpq ~/.pgpass file to store the passwords for every database that pgAgent must access. Details of this technique may be found in the PostgreSQL documentation on .pgpass file [https://www.postgresql.org/docs/current/libpq-pgpass.html].

System/database access - all jobs run by pgAgent will run with the security privileges of the pgAgent user. SQL steps will run as the user that pgAgent connects to the database as, and batch/shell scripts will run as the operating system user that the pgAgent service or daemon is running under. Because of this, it is essential to maintain control over the users that are able to create and modify jobs. By default, only the user that created the pgAgent database objects will be able to do this - this will normally be the PostgreSQL superuser.

Installing pgAgent

pgAgent runs as a daemon on Unix systems, and a service on Windows systems. In most cases it will run on the database server itself - for this reason, pgAgent is not automatically configured when pgAdmin is installed. In some cases however, it may be preferable to run pgAgent on multiple systems, against the same database; individual jobs may be targeted at a particular host, or left for execution by any host. Locking prevents execution of the same instance of a job by multiple hosts.

Database setup

Before using pgAdmin to manage pgAgent, you must create the pgAgent extension in the maintenance database registered with pgAdmin. To install pgAgent on a PostgreSQL host, connect to the postgres database, and navigate through the Tools menu to open the Query tool. For server versions 9.1 or later, and pgAgent 3.4.0 or later, enter the following command in the query window, and click the Execute icon:

CREATE EXTENSION pgagent;

This command will create a number of tables and other objects in a schema called ‘pgagent’.

The database must also have the pl/pgsql procedural language installed - use the PostgreSQL CREATE LANGUAGE command to install pl/pgsql if necessary. To install pl/pgsql, enter the following command in the query window, and click the Execute icon:

CREATE LANGUAGE plpgsql;

Daemon installation on Unix

Note

pgAgent is available in Debian/Ubuntu (DEB) and Redhat/Fedora (RPM) packages for Linux users, as well as source code. See the pgAdmin Website [https://www.pgadmin.org/download/]. for more information.

To install the pgAgent daemon on a Unix system, you will normally need to have root privileges to modify the system startup scripts. Modifying system startup scripts is quite system-specific so you should consult your system documentation for further information.

The program itself takes few command line options, most of which are only needed for debugging or specialised configurations:

Usage:
  /path/to/pgagent [options] <connect-string>

options:
  -f run in the foreground (do not detach from the terminal)
  -t <poll time interval in seconds (default 10)>
  -r <retry period after connection abort in seconds (>=10, default 30)>
  -s <log file (messages are logged to STDOUT if not specified)>
  -l <logging verbosity (ERROR=0, WARNING=1, DEBUG=2, default 0)>

The connection string is a standard PostgreSQL libpq connection string (see the PostgreSQL documentation on the connection string [https://www.postgresql.org/docs/current/libpq.html#libpq-connect] for further details). For example, the following command line will run pgAgent against a server listening on the localhost, using a database called ‘pgadmin’, connecting as the user ‘postgres’:

/path/to/pgagent hostaddr=127.0.0.1 dbname=postgres user=postgres

Service installation on Windows

Note

pgAgent is available in a pre-built installer if you use EnterpriseDB’s PostgreSQL Installers [https://www.enterprisedb.com/downloads/postgres-postgresql-downloads]. Use the StackBuilder application to download and install it. If installed in this way, the service will automatically be created and the instructions below can be ignored.

pgAgent can install itself as a service on Windows systems. The command line options available are similar to those on Unix systems, but include an additional parameter to tell the service what to do:

Usage:
  pgAgent REMOVE <serviceName>
  pgAgent INSTALL <serviceName> [options] <connect-string>
  pgAgent DEBUG [options] <connect-string>

  options:
    -u <user or DOMAIN\user>
    -p <password>
    -d <displayname>
    -t <poll time interval in seconds (default 10)>
    -r <retry period after connection abort in seconds (>=10, default 30)>
    -l <logging verbosity (ERROR=0, WARNING=1, DEBUG=2, default 0)>

The service may be quite simply installed from the command line as follows (adjust the path as required):

"C:\Program Files\pgAgent\bin\pgAgent" INSTALL pgAgent -u postgres -p secret hostaddr=127.0.0.1 dbname=postgres user=postgres

You can then start the service at the command line using net start pgAgent, or from the Services control panel applet. Any logging output or errors will be reported in the Application event log. The DEBUG mode may be used to run pgAgent from a command prompt. When run this way, log messages will output to the command window.

Creating a pgAgent Job

pgAgent is a scheduling agent that runs and manages jobs; each job consists of steps and schedules.

To create or manage a job, use the pgAdmin tree control to browse to the server on which the pgAgent database objects were created. The tree control will display a pgAgent Jobs node, under which currently defined jobs are displayed. To add a new job, right click on the pgAgent Jobs node, and select Create pgAgent Job… from the context menu.

When the pgAgent dialog opens, use the tabs on the pgAgent Job dialog to define the steps and schedule that make up a pgAgent job.

Use the fields on the General tab to provide general information about a job:

Provide a name for the job in the Name field.

Move the Enabled switch to the Yes position to enable a job, or No to disable a job.

Use the Job Class drop-down to select a class (for job categorization).

Use the Host Agent field to specify the name of a machine that is running pgAgent to indicate that only that machine may execute the job. Leave the field blank to specify that any machine may perform the job.

Note

It is not always obvious what value to specify for the Host Agent in order to target a job step to a specific machine. With pgAgent running on the required machines and connected to the scheduler database, you can use the following query to view the hostnames as reported by each agent:

SELECT jagstation FROM pgagent.pga_jobagent

Use the hostname exactly as reported by the query in the Host Agent field.

Use the Comment field to store notes about the job.

Use the Steps tab to define and manage the steps that the job will perform. Click the Add icon (+) to add a new step; then click the compose icon (located at the left side of the header) to open the step definition dialog:

Use fields on the step definition dialog to define the step:

Provide a name for the step in the Name field; please note that steps will be performed in alphanumeric order by name.

Use the Enabled switch to include the step when executing the job (True) or to disable the step (False).

Use the Kind switch to indicate if the job step invokes SQL code (SQL) or a batch script (Batch).

If you select SQL, use the Code tab to provide SQL code for the step.

If you select Batch, use the Code tab to provide the batch script that will be executed during the step.

Note

The fields Connection type, Database and Connection string are only applicable when SQL is selected because Batch cannot be run on remote servers.

Use the Connection type switch to indicate if the step is performed on a local server (Local) or on a remote host (Remote). If you specify a remote connection should be used for the step, the Connection string field will be enabled, and you must provide a libpq-style connection string.

Use the Database drop-down to select the database on which the job step will be performed.

Use the Connection string field to specify a libpq-style connection string to the remote server on which the step will be performed. For more information about writing a connection string, please see the PostgreSQL documentation [https://www.postgresql.org/docs/current/libpq.html#libpq-connect].

Use the On error drop-down to specify the behavior of pgAgent if it encounters an error while executing the step. Select from:

Fail - Stop the job if you encounter an error while processing this step.

Success - Mark the step as completing successfully, and continue.

Ignore - Ignore the error, and continue.

Use the Comment field to provide a comment about the step.

Use the context-sensitive field on the step definition dialog’s Code tab to provide the SQL code or batch script that will be executed during the step:

If the step invokes SQL code, provide one or more SQL statements in the SQL query field.

If the step performs a batch script, provide the script in the Script field. If you are running on a Windows server, standard batch file syntax must be used. When running on a Linux server, any shell script may be used, provided that a suitable interpreter is specified on the first line (e.g. #!/bin/sh).

When you’ve provided all of the information required by the step, click the compose icon to close the step definition dialog. Click the add icon (+) to add each additional step, or select the Schedules tab to define the job schedule.

Click the Add icon (+) to add a schedule for the job; then click the compose icon (located at the left side of the header) to open the schedule definition dialog:

Use the fields on the schedule definition tab to specify the days and times at which the job will execute.

Provide a name for the schedule in the Name field.

Use the Enabled switch to indicate that pgAgent should use the schedule (Yes) or to disable the schedule (No).

Use the calendar selector in the Start field to specify the starting date and time for the schedule.

Use the calendar selector in the End field to specify the ending date and time for the schedule.

Use the Comment field to provide a comment about the schedule.

Select the Repeat tab to define the days on which the schedule will execute.

Use the fields on the Repeat tab to specify the details about the schedule in a cron-style format. The job will execute on each date or time element selected on the Repeat tab.

Click within a field to open a list of valid values for that field; click on a specific value to add that value to the list of selected values for the field. To clear the values from a field, click the X located at the right-side of the field.

Use the fields within the Days box to specify the days on which the job will execute:

Use the Week Days field to select the days on which the job will execute.

Use the Month Days field to select the numeric days on which the job will execute. Specify the Last Day to indicate that the job should be performed on the last day of the month, irregardless of the date.

Use the Months field to select the months in which the job will execute.

Use the fields within the Times box to specify the times at which the job will execute:

Use the Hours field to select the hour at which the job will execute.

Use the Minutes field to select the minute at which the job will execute.

Select the Exceptions tab to specify any days on which the schedule will not execute.

Use the fields on the Exceptions tab to specify days on which you wish the job to not execute; for example, you may wish for jobs to not execute on national holidays.

Click the Add icon (+) to add a row to the exception table, then:

Click within the Date column to open a calendar selector, and select a date on which the job will not execute. Specify <Any> in the Date column to indicate that the job should not execute on any day at the time selected.

Click within the Time column to open a time selector, and specify a time on which the job will not execute. Specify <Any> in the Time column to indicate that the job should not execute at any time on the day selected.

When you’ve finished defining the schedule, you can use the SQL tab to review the code that will create or modify your job.

Click the Save button to save the job definition, or Close to exit the job without saving. Use the Reset button to remove your unsaved entries from the dialog.

After saving a job, the job will be listed under the pgAgent Jobs node of the pgAdmin tree control of the server on which it was defined. The Properties tab in the main pgAdmin window will display a high-level overview of the selected job, and the Statistics tab will show the details of each run of the job.

To modify an existing job or to review detailed information about a job, right-click on a job name, and select Properties from the context menu.

pgAdmin Project Contributions

pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list pgadmin-hackers@postgresql.org to discuss any ideas you might have for enhancements or bug fixes.

In the following sections, you’ll find detailed information about the development process used to develop, improve, and maintain the pgAdmin client.

Submitting Pull Requests

Code Overview

Runtime

Web Application

Configuration

User Settings

pgAdmin Core

Modules

Nodes

Front End

Coding Standards

General

CSS 3

HTML 5

Javascript

Python

Code Snippets

PgAdminModule

NodeView

BaseDriver

BaseConnection

Code Review Notes

Translations

Translation Marking

Updating and Merging

Adding a New Language

Submitting Pull Requests

Before developing a feature or bug fix for pgAdmin you should always contact the developers on the mailing list pgadmin-hackers@postgresql.org to discuss your plans. This ensures that others know what you are doing and can then avoid duplicating your work, and in the case of large changes, gives the community the chance to discuss and refine your ideas before investing too much time writing code that may later be rejected.

You should always develop changes against a checkout of the source code from the GIT source code repository, and not a release tarball. This ensures that you’re working with the latest code on the branch and makes it easier to generate Pull Requests correctly.

As of September 2022, the pgAdmin source repository can found at https://github.com/pgadmin-org/pgadmin4. A typical workflow for a relatively simple change might look as follows:

Visit the pgAdmin 4 project on GitHub, and click the Fork button to create your own development repository in your GitHub account.

Checkout a local copy of the source code with a command like:

$ git clone https://github.com/<your GitHub username>/pgadmin4.git

Develop and test your change in your local development environment.

Review your changes and check them thoroughly to ensure they meet the pgAdmin Coding Standards, and review them against the Code Review Notes to minimise the chances of them being rejected.

Once you’re happy with your change, commit it with a suitable message. Include a one-line summary at the top, and if appropriate, further paragraphs following a blank line after the summary.

Push your changes to your fork of the repository.

Back in GitHub, create a new Pull Request against the pgadmin-org/pgadmin4 master branch.

Note

Each Pull Request should encompass a single bug fix or feature as a single commit. If necessary, you should squash multiple commits for larger changes or features into a single commit before submitting.

Your Pull Request will be reviewed by one or more members of the development team and either accepted or sent back with requested changes. In some cases it may be rejected if the change is not considered appropriate - this is why it’s important to discuss your work with the team before spending any significant time on it.

For more complex changes, you may wish to use a Feature Branch in your fork of the pgAdmin repository, and use that to create the Pull Request.

Note

This is a simple example of a workflow. You may choose to use other tools such as the GitHub CLI [https://cli.github.com] instead; documenting such tools and workflows is outside the scope of the pgAdmin documentation however.

Code Overview

The bulk of pgAdmin is a Python web application written using the Flask framework on the backend, and HTML5 with CSS3,ReactJS on the front end. A desktop runtime is also included for users that prefer a desktop application to a web application, which is written using Electron.

Runtime

The runtime is based on Electron which integrates a browser and the Python server creating a standalone application. The source code can be found in the /runtime directory in the source tree.

Web Application

The web application forms the bulk of pgAdmin and can be found in the /web directory in the source tree. The main file is pgAdmin4.py which can be used to run the built-in standalone web server, or as a WSGI application for production use.

Configuration

The core application configuration is found in config.py. This file includes all configurable settings for the application, along with descriptions of their use. It is essential that various settings are configured prior to deployment on a web server; these can be overridden in config_local.py or config_system.py (see the config.py documentation) to avoid modifying the main configuration file.

User Settings

When running in desktop mode, pgAdmin has a single, default user account that is used for the desktop user. When running in server mode, there may be unlimited users who are required to login prior to using the application. pgAdmin utilised the Flask-Security module to manage application security and users, and provides options for self-service password reset and password changes etc.

Whether in desktop or server mode, each user’s settings are stored in a SQLite OR external database which is also used to store the user accounts. This is initially created using the setup.py script which will create the database file and schema within it, and add the first user account (with administrative privileges) and a default server group for them. A settings table is also used to store user configuration settings in a key-value fashion. Although not required, setting keys (or names) are typically formatted using forward slashes to artificially namespace values, much like the pgAdmin 3 settings files on Linux or Mac.

Note that the local configuration must be setup prior to setup.py being run. The local configuration will determine how the script sets up the database, particularly with regard to desktop vs. server mode.

pgAdmin Core

The heart of pgAdmin is the pgadmin package. This contains the globally available HTML templates used by the Jinja engine, as well as any global static files such as images, Javascript and CSS files that are used in multiple modules.

The work of the package is handled in it’s constructor, __init__.py. This is responsible for setting up logging and authentication, dynamically loading other modules, and a few other tasks.

Modules

Units of functionality are added to pgAdmin through the addition of modules. Theses are Python object instance of classes, inherits the PgAdminModule class (a Flask Blueprint implementation), found in web/pgadmin/utils.py. It provide various hook points for other modules to utilise (primarily the default module - the browser).

To be recognised as a module, a Python package must be created. This must:

Be placed within the web/pgadmin/ directory, and

Implements pgadmin.utils.PgAdminModule class

An instance variable (generally - named blueprint) representing that particular class in that package.

Each module may define a template and static directory for the Blueprint that it implements. To avoid name collisions, templates should be stored under a directory within the specified template directory, named after the module itself. For example, the browser module stores it’s templates in web/pgadmin/browser/templates/browser/. This does not apply to static files which may omit the second module name.

In addition to defining the Blueprint, the views module is typically responsible for defining all the views that will be rendered in response to client requests, we must provide a REST API url(s) for these views. These must include appropriate route and security decorators. Take a look at the NodeView class, which uses the same approach as Flask’s MethodView, it can be found in web/pgadmin/browser/utils.py. This specific class is used by browser nodes for creating REST API url(s) for different operation on them. i.e. list, create, update, delete, fetch children, get statistics/reversed SQL/dependencies/dependents list for that node, etc. We can use the same class for other purpose too. You just need to inherit that class, and overload the member variables operations, parent_ids, ids, node_type, and then register it as node view with PgAdminModule instance.

Most pgAdmin modules will also implement the hooks provided by the PgAdminModule class. This is responsible for providing hook points to integrate the module into the rest of the application - for example, a hook might tell the caller what CSS files need to be included on the rendered page, or what menu options to include and what they should do. Hook points need not exist if they are not required. It is the responsibility of the caller to ensure they are present before attempting to utilise them.

Hooks currently implemented are:

class MyModule(PgAdminModule):
    """
    This is class implements the pgadmin.utils.PgAdminModule, and
    implements the hooks
    """

    ...

    def get_own_stylesheets(self):
        """
        Returns:
            list: the stylesheets used by this module, not including any
                  stylesheet needed by the submodules.
        """
        return [url_for('static', 'css/mymodule.css')]

    def get_own_javascripts(self):
        """
        Returns:
            list of dict:
            - contains the name (representation for this javascript
              module), path (url for it without .js suffix), deps (array of
              dependents), exports window object by the javascript module,
              and when (would you like to load this javascript), etc
              information for this module, not including any script needed
              by submodules.
        """
        return [
            {
                'name': 'pgadmin.extension.mymodule',
                'path': url_for('static', filename='js/mymodule'),
                'exports': None,
                'when': 'server'
                }
            ]

    def get_own_menuitems(self):
        """
        Returns:
            dict: the menuitems for this module, not including
                  any needed from the submodules.
        """
        return {
            'help_items': [
                MenuItem(
                    name='mnu_mymodule_help',
                    priority=999,
                    # We need to create javascript, which registers itself
                    # as module
                    module="pgAdmin.MyModule",
                    callback='about_show',
                    icon='fa fa-info-circle',
                    label=gettext('About MyModule'
                    )
                ]
            }
    def get_panels(self):
        """
        Returns:
            list: a list of panel objects to add implemented in javascript
                  module
        """
        return []
    ...

blueprint = MyModule('mymodule', __name__, static_url_path='/static')

pgAdmin Modules may include any additional Python modules that are required to fulfill their purpose, as required. They may also reference other dynamically loaded modules, but must use the defined hook points and fail gracefully in the event that a particular module is not present.

Nodes

Nodes are very similar to modules, it represents an individual node or, collection object on the object explorer treeview. To recognised as a node module, a Python package (along with javascript modules) must be created. This must:

Be placed within the web/pgadmin/browser/ directory, and

Implements the BrowserPluginModule, and registers the node view, which exposes required the REST APIs

An instance of the class object

Front End

pgAdmin uses javascript extensively for the front-end implementation. It uses require.js to allow the lazy loading (or, say load only when required), ReactJS with CSS and MaterialUI for UI look and feel. We have divided each module in small chunks as much as possible. Not all javascript modules are required to be loaded (i.e. loading a javascript module for database will make sense only when a server node is loaded completely.) Please look at the javascript files node.js, browser.js, menu.js, panel.js, etc for better understanding of the code.

Coding Standards

pgAdmin uses multiple technologies and multiple languages, each of which have their own coding standards.

General

In all languages, indentations should be made with 4 spaces, and excessively long lines wrapped where appropriate to ensure they can be read on smaller displays (80 characters is used in many places, but this is not a required maximum size as it’s quite wasteful on modern displays). Typically lines should not be longer than 120 characters.

Comments should be included in all code where required to explain its purpose or how it works if not obvious from a quick review of the code itself.

CSS 3

CSS3 is used for styling and layout throughout the application.

Most custom styling comes from individual modules which may advertise static stylesheets to be included in the module that is loading them via hooks.

Styling overrides (for example, to alter the look and feel) will typically be found in the overrides.css file in the main static file directory for the application.

Styling should never be applied inline in HTML, always through an external stylesheet, which should contain comments as appropriate to explain the usage or purpose for the style.

Styles should be specified clearly, one per line. For example:

/* iFrames should have no border */
iframe {
    border-width: 0;
}

/* Ensure the codemirror editor displays full height gutters when resized */
.CodeMirror, .CodeMirror-gutters {
    height: 100% !important;
}

All stylesheets must be CSS3 compliant.

HTML 5

HTML 5 is used for page structure throughout the application, in most cases being rendered from templates by the Jinja2 template engine in Flask.

All HTML must be HTML 5 compliant.

Javascript

Client-side code is written in Javascript using ReactJS and various plugins. Whilst much of the code is rendered from static files, there is also code that is rendered from templates using Jinja2 (often to inject the users settings) or constructed on the fly from module hooks.

A typical Javascript function might be formatted like this (this snipped is from a template):

// Delete a server group
function delete_server_group(item) {
    alertify.confirm(
        'Delete server group?',
        'Are you sure you wish to delete the server group "{0}"?'.replace('{0}', tree.getLabel(item)),
        function() {
            var id = tree.getId(item)
            $.post("{{ url_for('NODE-server-group.delete') }}", { id: id })
                .done(function(data) {
                    if (data.success == 0) {
                        report_error(data.errormsg, data.info);
                    } else {
                        var next = tree.next(item);
                        var prev = tree.prev(item);
                        tree.remove(item);
                        if (next.length) {
                            tree.select(next);
                        } else if (prev.length) {
                            tree.select(prev);
                        }
                    }
                }
            )
        },
        null
    )
}

Note the use of a descriptive function name, using the underscore character to separate words in all lower case, and short but descriptive lower case variable names.

Note

From version 3.0 onwards, new or refactored code should be written using ES6 features and conventions.

Python

Python is used for the backend web server. All code must be compatible with Python 2.7 and should include PyDoc comments whilst following the official Python coding standards defined in PEP 8 [https://www.python.org/dev/peps/pep-0008/]. An example function along with the required file header is shown below:

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2024, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################

"""Integration hooks for server groups."""

from flask import render_template, url_for
from flask.ext.security import current_user

from pgadmin.settings.settings_model import db, ServerGroup

def get_nodes():
    """Return a JSON document listing the server groups for the user"""
    groups = ServerGroup.query.filter_by(user_id=current_user.id)

    value = ''
    for group in groups:
        value += '{"id":%d,"label":"%s","icon":"icon-server-group","inode":true},' \
                 % (group.id, group.name)

    value = value[:-1]

    return value

Code Snippets

This document contains code for some of the important classes, listed as below:

PgAdminModule

NodeView

BaseDriver

BaseConnection

PgAdminModule

PgAdminModule is inherited from Flask.Blueprint module. This module defines a set of methods, properties and attributes, that every module should implement.

class PgAdminModule(Blueprint):
    """
    Base class for every PgAdmin Module.

    This class defines a set of method and attributes that
    every module should implement.
    """

    def __init__(self, name, import_name, **kwargs):
        kwargs.setdefault('url_prefix', '/' + name)
        kwargs.setdefault('template_folder', 'templates')
        kwargs.setdefault('static_folder', 'static')
        self.submodules = []
        self.parentmodules = []

        super().__init__(name, import_name, **kwargs)

    def register_preferences(self):
        # To be implemented by child classes
        pass

    def register(self, app, options):
        """
        Override the default register function to automagically register
        sub-modules at once.
        """

        super().register(app, options)

        def create_module_preference():
            # Create preference for each module by default
            if hasattr(self, 'LABEL'):
                self.preference = Preferences(self.name, self.LABEL)
            else:
                self.preference = Preferences(self.name, None)

            self.register_preferences()

        # Create and register the module preference object and preferences for
        # it just before starting app
        app.register_before_app_start(create_module_preference)

        for module in self.submodules:
            module.parentmodules.append(self)
            if app.blueprints.get(module.name) is None:
                app.register_blueprint(module)
                app.register_logout_hook(module)

    def get_own_messages(self):
        """
        Returns:
            dict: the i18n messages used by this module, not including any
                messages needed by the submodules.
        """
        return dict()

    def get_own_menuitems(self):
        """
        Returns:
            dict: the menuitems for this module, not including
                any needed from the submodules.
        """
        return defaultdict(list)

    def get_exposed_url_endpoints(self):
        """
        Returns:
            list: a list of url endpoints exposed to the client.
        """
        return []

    @property
    def messages(self):
        res = self.get_own_messages()

        for module in self.submodules:
            res.update(module.messages)
        return res

    @property
    def menu_items(self):
        menu_items = self.get_own_menuitems()
        for module in self.submodules:
            for key, value in module.menu_items.items():
                menu_items[key].extend(value)
        menu_items = dict((key, sorted(value, key=attrgetter('priority')))
                          for key, value in menu_items.items())
        return menu_items

    @property
    def exposed_endpoints(self):
        res = self.get_exposed_url_endpoints()

        for module in self.submodules:
            res += module.exposed_endpoints

        return res

NodeView

The NodeView class exposes basic REST APIs for different operations used by the pgAdmin Browser. The basic idea has been taken from Flask’s MethodView [http://flask.pocoo.org/docs/1.0/api/#flask.views.MethodView] class. Because we need a lot more operations (not, just CRUD), we can not use it directly.

class NodeView(View, metaclass=type(MethodView)):
    """
    A PostgreSQL Object has so many operaions/functions apart from CRUD
    (Create, Read, Update, Delete):
    i.e.
    - Reversed Engineered SQL
    - Modified Query for parameter while editing object attributes
      i.e. ALTER TABLE ...
    - Statistics of the objects
    - List of dependents
    - List of dependencies
    - Listing of the children object types for the certain node
      It will used by the browser tree to get the children nodes

    This class can be inherited to achieve the diffrent routes for each of the
    object types/collections.

       OPERATION   |             URL             | HTTP Method |    Method
    ---------------+-----------------------------+-------------+--------------
    List           | /obj/[Parent URL]/          | GET         | list
    Properties     | /obj/[Parent URL]/id        | GET         | properties
    Create         | /obj/[Parent URL]/          | POST        | create
    Delete         | /obj/[Parent URL]/id        | DELETE      | delete
    Update         | /obj/[Parent URL]/id        | PUT         | update

    SQL (Reversed  | /sql/[Parent URL]/id        | GET         | sql
    Engineering)   |
    SQL (Modified  | /msql/[Parent URL]/id       | GET         | modified_sql
    Properties)    |

    Statistics     | /stats/[Parent URL]/id      | GET         | statistics
    Dependencies   | /dependency/[Parent URL]/id | GET         | dependencies
    Dependents     | /dependent/[Parent URL]/id  | GET         | dependents

    Nodes          | /nodes/[Parent URL]/        | GET         | nodes
    Current Node   | /nodes/[Parent URL]/id      | GET         | node

    Children       | /children/[Parent URL]/id   | GET         | children

    NOTE:
    Parent URL can be seen as the path to identify the particular node.

    i.e.
    In order to identify the TABLE object, we need server -> database -> schema
    information.
    """
    operations = dict({
        'obj': [
            {'get': 'properties', 'delete': 'delete', 'put': 'update'},
            {'get': 'list', 'post': 'create'}
        ],
        'nodes': [{'get': 'node'}, {'get': 'nodes'}],
        'sql': [{'get': 'sql'}],
        'msql': [{'get': 'modified_sql'}],
        'stats': [{'get': 'statistics'}],
        'dependency': [{'get': 'dependencies'}],
        'dependent': [{'get': 'dependents'}],
        'children': [{'get': 'children'}]
    })

    @classmethod
    def generate_ops(cls):
        cmds = []
        for op in cls.operations:
            idx = 0
            for ops in cls.operations[op]:
                meths = []
                for meth in ops:
                    meths.append(meth.upper())
                if len(meths) > 0:
                    cmds.append({
                        'cmd': op, 'req': (idx == 0),
                        'with_id': (idx != 2), 'methods': meths
                    })
                idx += 1
        return cmds

    # Inherited class needs to modify these parameters
    node_type = None
    # Inherited class needs to modify these parameters
    node_label = None
    # This must be an array object with attributes (type and id)
    parent_ids = []
    # This must be an array object with attributes (type and id)
    ids = []

    @classmethod
    def get_node_urls(cls):
        assert cls.node_type is not None, \
            "Please set the node_type for this class ({0})".format(
                str(cls.__class__.__name__))
        common_url = '/'
        for p in cls.parent_ids:
            common_url += '<{0}:{1}>/'.format(str(p['type']), str(p['id']))

        id_url = None
        for p in cls.ids:
            id_url = '{0}<{1}:{2}>'.format(
                common_url if not id_url else id_url,
                p['type'], p['id'])

        return id_url, common_url

    def __init__(self, **kwargs):
        self.cmd = kwargs['cmd']

    # Check the existance of all the required arguments from parent_ids
    # and return combination of has parent arguments, and has id arguments
    def check_args(self, **kwargs):
        has_id = has_args = True
        for p in self.parent_ids:
            if p['id'] not in kwargs:
                has_args = False
                break

        for p in self.ids:
            if p['id'] not in kwargs:
                has_id = False
                break

        return has_args, has_id and has_args

    def dispatch_request(self, *args, **kwargs):
        http_method = flask.request.method.lower()
        if http_method == 'head':
            http_method = 'get'

        assert self.cmd in self.operations, \
            'Unimplemented command ({0}) for {1}'.format(
                self.cmd,
                str(self.__class__.__name__)
            )

        has_args, has_id = self.check_args(**kwargs)

        assert (
            self.cmd in self.operations and
            (has_id and len(self.operations[self.cmd]) > 0 and
             http_method in self.operations[self.cmd][0]) or
            (not has_id and len(self.operations[self.cmd]) > 1 and
             http_method in self.operations[self.cmd][1]) or
            (len(self.operations[self.cmd]) > 2 and
             http_method in self.operations[self.cmd][2])
        ), \
            'Unimplemented method ({0}) for command ({1}), which {2} ' \
            'an id'.format(http_method,
                           self.cmd,
                           'requires' if has_id else 'does not require')
        meth = None
        if has_id:
            meth = self.operations[self.cmd][0][http_method]
        elif has_args and http_method in self.operations[self.cmd][1]:
            meth = self.operations[self.cmd][1][http_method]
        else:
            meth = self.operations[self.cmd][2][http_method]

        method = getattr(self, meth, None)

        if method is None:
            return make_json_response(
                status=406,
                success=0,
                errormsg=gettext(
                    'Unimplemented method ({0}) for this url ({1})').format(
                        meth, flask.request.path
                )
            )

        return method(*args, **kwargs)

    @classmethod
    def register_node_view(cls, blueprint):
        cls.blueprint = blueprint
        id_url, url = cls.get_node_urls()

        commands = cls.generate_ops()

        for c in commands:
            cmd = c['cmd'].replace('.', '-')
            if c['with_id']:
                blueprint.add_url_rule(
                    '/{0}{1}'.format(
                        c['cmd'], id_url if c['req'] else url
                    ),
                    view_func=cls.as_view(
                        '{0}{1}'.format(
                            cmd, '_id' if c['req'] else ''
                        ),
                        cmd=c['cmd']
                    ),
                    methods=c['methods']
                )
            else:
                blueprint.add_url_rule(
                    '/{0}'.format(c['cmd']),
                    view_func=cls.as_view(
                        cmd, cmd=c['cmd']
                    ),
                    methods=c['methods']
                )

    def children(self, *args, **kwargs):
        """Build a list of treeview nodes from the child nodes."""
        children = self.get_children_nodes(*args, **kwargs)

        # Return sorted nodes based on label
        return make_json_response(
            data=sorted(
                children, key=lambda c: c['label']
            )
        )

    def get_children_nodes(self, *args, **kwargs):
        """
        Returns the list of children nodes for the current nodes. Override this
        function for special cases only.

        :param args:
        :param kwargs: Parameters to generate the correct set of tree node.
        :return: List of the children nodes
        """
        children = []

        for module in self.blueprint.submodules:
            children.extend(module.get_nodes(*args, **kwargs))

        return children

BaseDriver

class BaseDriver(metaclass=DriverRegistry):
    """
    class BaseDriver():

    This is a base class for different server types.
    Inherit this class to implement different type of database driver
    implementation.

    (For PostgreSQL/EDB Postgres Advanced Server, we will be using psycopg)

    Abstract Properties:
    -------- ----------
    * Version (string):
        Current version string for the database server

    * libpq_version (string):
        Current version string for the used libpq library

    Abstract Methods:
    -------- -------
    * get_connection(*args, **kwargs)
    - It should return a Connection class object, which may/may not be
      connected to the database server.

    * release_connection(*args, **kwargs)
    - Implement the connection release logic

    * gc()
    - Implement this function to release the connections assigned in the
      session, which has not been pinged from more than the idle timeout
      configuration.
    """

    @property
    @abstractmethod
    def version(cls):
        pass

    @property
    @abstractmethod
    def libpq_version(cls):
        pass

    @abstractmethod
    def get_connection(self, *args, **kwargs):
        pass

    @abstractmethod
    def release_connection(self, *args, **kwargs):
        pass

    @abstractmethod
    def gc_timeout(self):
        pass

BaseConnection

class BaseConnection(metaclass=ABCMeta):
    """
    class BaseConnection()

        It is a base class for database connection. A different connection
        drive must implement this to expose abstract methods for this server.

        General idea is to create a wrapper around the actual driver
        implementation. It will be instantiated by the driver factory
        basically. And, they should not be instantiated directly.

    Abstract Methods:
    -------- -------
    * connect(**kwargs)
      - Define this method to connect the server using that particular driver
        implementation.

    * execute_scalar(query, params, formatted_exception_msg)
      - Implement this method to execute the given query and returns single
        datum result.

    * execute_async(query, params, formatted_exception_msg)
      - Implement this method to execute the given query asynchronously and
      returns result.

    * execute_void(query, params, formatted_exception_msg)
      - Implement this method to execute the given query with no result.

    * execute_2darray(query, params, formatted_exception_msg)
      - Implement this method to execute the given query and returns the result
        as a 2 dimensional array.

    * execute_dict(query, params, formatted_exception_msg)
      - Implement this method to execute the given query and returns the result
        as an array of dict (column name -> value) format.

    * def async_fetchmany_2darray(records=-1, formatted_exception_msg=False):
      - Implement this method to retrieve result of asynchronous connection and
        polling with no_result flag set to True.
        This returns the result as a 2 dimensional array.
        If records is -1 then fetchmany will behave as fetchall.

    * connected()
      - Implement this method to get the status of the connection. It should
        return True for connected, otherwise False

    * reset()
      - Implement this method to reconnect the database server (if possible)

    * transaction_status()
      - Implement this method to get the transaction status for this
        connection. Range of return values different for each driver type.

    * ping()
      - Implement this method to ping the server. There are times, a connection
        has been lost, but - the connection driver does not know about it. This
        can be helpful to figure out the actual reason for query failure.

    * _release()
      - Implement this method to release the connection object. This should not
        be directly called using the connection object itself.

      NOTE: Please use BaseDriver.release_connection(...) for releasing the
            connection object for better memory management, and connection pool
            management.

    * _wait(conn)
      - Implement this method to wait for asynchronous connection to finish the
        execution, hence - it must be a blocking call.

    * _wait_timeout(conn, time)
      - Implement this method to wait for asynchronous connection with timeout.
        This must be a non blocking call.

    * poll(formatted_exception_msg, no_result)
      - Implement this method to poll the data of query running on asynchronous
        connection.

    * cancel_transaction(conn_id, did=None)
      - Implement this method to cancel the running transaction.

    * messages()
      - Implement this method to return the list of the messages/notices from
        the database server.

    * rows_affected()
      - Implement this method to get the rows affected by the last command
        executed on the server.
    """

    ASYNC_OK = 1
    ASYNC_READ_TIMEOUT = 2
    ASYNC_WRITE_TIMEOUT = 3
    ASYNC_NOT_CONNECTED = 4
    ASYNC_EXECUTION_ABORTED = 5
    ASYNC_TIMEOUT = 0.2
    ASYNC_WAIT_TIMEOUT = 2
    ASYNC_NOTICE_MAXLENGTH = 100000

    @abstractmethod
    def connect(self, **kwargs):
        pass

    @abstractmethod
    def execute_scalar(self, query, params=None,
                       formatted_exception_msg=False):
        pass

    @abstractmethod
    def execute_async(self, query, params=None,
                      formatted_exception_msg=True):
        pass

    @abstractmethod
    def execute_void(self, query, params=None,
                     formatted_exception_msg=False):
        pass

    @abstractmethod
    def execute_2darray(self, query, params=None,
                        formatted_exception_msg=False):
        pass

    @abstractmethod
    def execute_dict(self, query, params=None,
                     formatted_exception_msg=False):
        pass

    @abstractmethod
    def async_fetchmany_2darray(self, records=-1,
                                formatted_exception_msg=False):
        pass

    @abstractmethod
    def connected(self):
        pass

    @abstractmethod
    def reset(self):
        pass

    @abstractmethod
    def transaction_status(self):
        pass

    @abstractmethod
    def ping(self):
        pass

    @abstractmethod
    def _release(self):
        pass

    @abstractmethod
    def _wait(self, conn):
        pass

    @abstractmethod
    def _wait_timeout(self, conn, time):
        pass

    @abstractmethod
    def poll(self, formatted_exception_msg=True, no_result=False):
        pass

    @abstractmethod
    def status_message(self):
        pass

    @abstractmethod
    def rows_affected(self):
        pass

    @abstractmethod
    def cancel_transaction(self, conn_id, did=None):
        pass

Code Review Notes

This document lists a number of standard items that will be checked during the review process for any changes submitted for inclusion in pgAdmin.

Ensure all code follows the pgAdmin Coding Standards.

Ensure all code has unit test coverage and API/feature test coverage where appropriate.

Copyright years must be correct and properly formatted (to make it easy to make bulk updates every year). The start date should always be 2013, and the end year the current year, e.g.

Copyright (C) 2013 - 2024, The pgAdmin Development Team

Ensure there’s a blank line immediately following any copyright headers.

Include PyDoc comments for functions, classes and modules. Node modules should be “””Implements the XXXX node”””.

Ensure that any generated SQL does not have any leading or trailing blank lines and consistently uses 4 space indents for nice formatting.

Don’t special-case any Slony objects. pgAdmin 4 will have no direct knowledge of Slony, unlike pgAdmin 3.

If you copy/paste modules, please ensure any comments are properly updated.

Read all comments, and ensure they make sense and provide useful commentary on the code.

Ensure that field labels both use PostgreSQL parlance, but also are descriptive. A good example is the “Init” field on an FTS Template - Init is the PG term, but adding the word “Function” after it makes it much more descriptive.

Re-use code whereever possible, but factor it out into a suitably central location - don’t copy and paste it unless modifications are required!

Format code nicely to make it readable. Break up logical chunks of code with blank lines, and comment well to describe what different sections of code are for or pertain to.

Ensure that form validation works correctly and is consistent with other dialogues in the way errors are displayed.

On dialogues with Schema or Owner fields, pre-set the default values to the current schema/user as appropriate. In general, if there are common or sensible default values available, put them in the fields for the user.

1 Pull Request == 1 feature. If you need to fix/update existing infrastructure in your change, it’s usually easier if it’s in a separate Pull Request. Pull Requests containing multiple new features or unrelated changes are likely to be rejected.

Ensure the change is fully functional, and works! If you wish to send a work in progress (WIP) change that is not intended for commit, instead of submitting a Pull Request, send either as a link to a repository fork or a patch to the pgadmin-hackers@postgresql.org mailing list, clearly stating that it’s a WIP, and noting what does or does not yet work.

Translations

pgAdmin supports multiple languages using the Flask-Babel [https://pythonhosted.org/Flask-Babel/] Python module. A list of supported languages is included in the web/config.py configuration file and must be updated whenever languages are added or removed with ISO 639-1 [https://en.wikipedia.org/wiki/ISO_639-1] (two letter) language codes. The codes are named $LANG in this document.

Translation Marking

Strings can be marked for translation in either Python code (using gettext()) or Jinja templates (using _()). Here are some examples that show how this is achieved.

Python:

errormsg = gettext('No server group name was specified')

Jinja:

<input type="submit" value="{{ _('Change Password') }}">

<title>{{ _('%(appname)s Password Change', appname=config.APP_NAME) }}</title>

define(['sources/gettext', ...], function(gettext, ...){
    ...
    var alert = alertify.prompt(
        gettext('Password Change'),
        gettext('New password for %(userName)s', {userName: 'jsmith' }),
        ...
    )
})

Updating and Merging

Whenever new strings are added to the application, the template catalogue (web/pgadmin/messages.pot) and the existing translation catalogues (web/pgadmin/translations/$LANG/LC_MESSAGES/messages.po) must be updated and compiled. This can be achieved using the following commands from the web directory in the Python virtual environment for pgAdmin:

(pgadmin4) user$ pybabel extract -F babel.cfg -o pgadmin/messages.pot pgadmin

Once the template has been updated it needs to be merged into the existing message catalogues:

(pgadmin4) user$ pybabel update -i pgadmin/messages.pot -d pgadmin/translations

Finally, the message catalogues can be compiled for use:

(pgadmin4) user$ pybabel compile -d pgadmin/translations

Adding a New Language

Adding a new language is simple. First, add the language name and identifier to web/config.py:

# Languages we support in the UI
LANGUAGES = {
    'en': 'English',
    'zh': 'Chinese (Simplified)',
    'de': 'German',
    'pl': 'Polish'
}

Then, create the new message catalogue from the web directory in the source tree in the Python virtual environment for pgAdmin:

(pgadmin4) user$ pybabel init -i pgadmin/messages.pot -d pgadmin/translations -l $LANG

Release Notes

pgAdmin release notes provide information on the features and improvements in each release. This page includes release notes for major releases and minor (bugfix) releases. Select your version from the list below to see the release notes for it.

Version 8.14

Version 8.13

Version 8.12

Version 8.11

Version 8.10

Version 8.9

Version 8.8

Version 8.7

Version 8.6

Version 8.5

Version 8.4

Version 8.3

Version 8.2

Version 8.1

Version 8.0

Version 7.8

Version 7.7

Version 7.6

Version 7.5

Version 7.4

Version 7.3

Version 7.2

Version 7.1

Version 7.0

Version 6.21

Version 6.20

Version 6.19

Version 6.18

Version 6.17

Version 6.16

Version 6.15

Version 6.14

Version 6.13

Version 6.12

Version 6.11

Version 6.10

Version 6.9

Version 6.8

Version 6.7

Version 6.6

Version 6.5

Version 6.4

Version 6.3

Version 6.2

Version 6.1

Version 6.0

Version 5.7

Version 5.6

Version 5.5

Version 5.4

Version 5.3

Version 5.2

Version 5.1

Version 5.0

Version 4.30

Version 4.29

Version 4.28

Version 4.27

Version 4.26

Version 4.25

Version 4.24

Version 4.23

Version 4.22

Version 4.21

Version 4.20

Version 4.19

Version 4.18

Version 4.17

Version 4.16

Version 4.15

Version 4.14

Version 4.13

Version 4.12

Version 4.11

Version 4.10

Version 4.9

Version 4.8

Version 4.7

Version 4.6

Version 4.5

Version 4.4

Version 4.3

Version 4.2

Version 4.1

Version 4.0

Version 3.6

Version 3.5

Version 3.4

Version 3.3

Version 3.2

Version 3.1

Version 3.0

Version 2.1

Version 2.0

Version 1.6

Version 1.5

Version 1.4

Version 1.3

Version 1.2

Version 1.1

Version 1.0

Version 8.14

Release date: 2024-12-12

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.13.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, 16 and 17

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 17.0

New features

Issue #3317 [https://github.com/pgadmin-org/pgadmin4/issues/3317] - Allow setting NULL ordering for columns in view/edit data filter dialog.

Issue #3751 [https://github.com/pgadmin-org/pgadmin4/issues/3751] - Show auto-complete column names in filtered rows dialog of table and filter options of view/edit data tool.

Issue #5786 [https://github.com/pgadmin-org/pgadmin4/issues/5786] - Allow the use of a pgpass file in the pgAdmin container via Docker secrets.

Issue #6592 [https://github.com/pgadmin-org/pgadmin4/issues/6592] - Fixed multiple issues and improved ERD auto-layout.

Issue #6794 [https://github.com/pgadmin-org/pgadmin4/issues/6794] - Add support for passing connection details as placeholders in the passexec command.

Issue #7330 [https://github.com/pgadmin-org/pgadmin4/issues/7330] - Add support to deploy pgAdmin in a container with readOnlyRootFilesystem to true.

Issue #8095 [https://github.com/pgadmin-org/pgadmin4/issues/8095] - Added support for a builtin locale provider in the Database dialog.

Issue #8192 [https://github.com/pgadmin-org/pgadmin4/issues/8192] - Added support for adding tags on a server node.

Housekeeping

Bug fixes

Issue #5099 [https://github.com/pgadmin-org/pgadmin4/issues/5099] - Fixed an issue where Ctrl/Cmd + A was not selecting all data in query tool data grid.

Issue #7384 [https://github.com/pgadmin-org/pgadmin4/issues/7384] - Fixed an issue where querying a foreign table gives the error ‘ForeignTableCommand’ object has no attribute ‘auto_commit’.

Issue #7486 [https://github.com/pgadmin-org/pgadmin4/issues/7486] - Fixed an issue where indent with space was not aligning to next tab position.

Issue #7809 [https://github.com/pgadmin-org/pgadmin4/issues/7809] - Fixed an issue where pgAdmin crashes on accessing the dashboard state tab when database is super busy.

Issue #7865 [https://github.com/pgadmin-org/pgadmin4/issues/7865] - Fixed an issue related to the query tool update connection after the server disconnected from the object explorer.

Issue #7892 [https://github.com/pgadmin-org/pgadmin4/issues/7892] - Fixed an issue where a column name change in the edit dialog of the table node does not show the updated column name.

Issue #8010 [https://github.com/pgadmin-org/pgadmin4/issues/8010] - Fixed an issue where query tool should show results and messages only from the last executed query.

Issue #8028 [https://github.com/pgadmin-org/pgadmin4/issues/8028] - Fixed an issue where query tool throws syntax error if a newly added row is untouched and saved.

Issue #8065 [https://github.com/pgadmin-org/pgadmin4/issues/8065] - Ensure the crypt key is retrieved correctly on backend server restart.

Issue #8098 [https://github.com/pgadmin-org/pgadmin4/issues/8098] - Fixed an issue in schema diff where an error message popup was showing some garbage without any info.

Issue #8127 [https://github.com/pgadmin-org/pgadmin4/issues/8127] - Fixed an issue where query tool should not prompt for unsaved changes when there are no changes.

Issue #8134 [https://github.com/pgadmin-org/pgadmin4/issues/8134] - Add a user preference to enable/disable alternating row background colors in the data output of query tool.

Issue #8157 [https://github.com/pgadmin-org/pgadmin4/issues/8157] - Fixed an issue where doing Ctrl/Cmd+C on a selected text in a cell editor of data output in the query tool copied the complete text.

Issue #8158 [https://github.com/pgadmin-org/pgadmin4/issues/8158] - Fixed an issue where auto-width of wide columns in data output is incorrectly calculated.

Issue #8215 [https://github.com/pgadmin-org/pgadmin4/issues/8215] - Ensure correct custom SSL certificate passed in connection string.

Version 8.13

Release date: 2024-11-14

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.12.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, 16 and 17

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 17.0

New features

Issue #1780 [https://github.com/pgadmin-org/pgadmin4/issues/1780] - Replace infinite scrolling with pagination in query tool data output for better UX and performance.

Issue #1984 [https://github.com/pgadmin-org/pgadmin4/issues/1984] - Add an object menu option to disconnect all server and database connections.

Issue #2874 [https://github.com/pgadmin-org/pgadmin4/issues/2874] - Alternate the background color of rows to enhance readability.

Issue #5869 [https://github.com/pgadmin-org/pgadmin4/issues/5869] - Allow to pass PGADMIN_CONFIG_CONFIG_DATABASE_URI from docker secrets.

Issue #6016 [https://github.com/pgadmin-org/pgadmin4/issues/6016] - Format dashboard graph metrics for better readability.

Issue #7393 [https://github.com/pgadmin-org/pgadmin4/issues/7393] - Added support for auto-detecting and setting the End-of-line character (LF/CRLF) in the query tool editor.

Issue #7863 [https://github.com/pgadmin-org/pgadmin4/issues/7863] - Make the background color for the serial number and header cells distinct.

Housekeeping

Issue #8061 [https://github.com/pgadmin-org/pgadmin4/issues/8061] - Updated the react-menu library from v2 to v4.

Issue #8077 [https://github.com/pgadmin-org/pgadmin4/issues/8077] - Remove bootstrap from the runtime code.

Issue #8102 [https://github.com/pgadmin-org/pgadmin4/issues/8077] - Remove the dependency on python packages eventlet and greenlet.

Bug fixes

Issue #5307 [https://github.com/pgadmin-org/pgadmin4/issues/5307] - Fixed an issue to allow the Enter key to save data in the result grid text editor.

Issue #7289 [https://github.com/pgadmin-org/pgadmin4/issues/7289] - Move ‘About pgAdmin 4’ to app menu on macOS.

Issue #7655 [https://github.com/pgadmin-org/pgadmin4/issues/7655] - Fixed an issue where the query tool was crashing when an empty geometry was being rendered.

Issue #7837 [https://github.com/pgadmin-org/pgadmin4/issues/7837] - Fixed an issue where role properties were not loading.

Issue #7883 [https://github.com/pgadmin-org/pgadmin4/issues/7883] - Fix multiple issues related to debugger params dialog input.

Issue #7919 [https://github.com/pgadmin-org/pgadmin4/issues/7919] - Fixed an issue where the dock layout was not saved upon closing a tab.

Issue #7920 [https://github.com/pgadmin-org/pgadmin4/issues/7920] - Fixed an issue where the copy shortcut CTRL +C was not working in the Query Tool data grid.

Issue #7955 [https://github.com/pgadmin-org/pgadmin4/issues/7955] - Fixed an issue where Dashboard tab showing ‘Something went wrong’.

Issue #7957 [https://github.com/pgadmin-org/pgadmin4/issues/7957] - Fixed an issue where cursor selection is not visible in the PSQL tool.

Issue #7965 [https://github.com/pgadmin-org/pgadmin4/issues/7965] - Allow OAuth2 params OAUTH2_NAME, OAUTH2_DISPLAY_NAME, OAUTH2_ICON, OAUTH2_BUTTON_COLOR to be optional.

Issue #7988 [https://github.com/pgadmin-org/pgadmin4/issues/7988] - Add appropriate minimum width and height setting for desktop apps to avoid app accidentally going below visibility levels.

Issue #7993 [https://github.com/pgadmin-org/pgadmin4/issues/7993] - Fixed an issue where graphical explain keeps the node details open even after plan changed.

Issue #8007 [https://github.com/pgadmin-org/pgadmin4/issues/8007] - Fixed an issue in the debugger where function arguments of the character data type were being truncated.

Issue #8013 [https://github.com/pgadmin-org/pgadmin4/issues/8013] - Fix the issue where rows do not retain shading when scrolling.

Issue #8022 [https://github.com/pgadmin-org/pgadmin4/issues/8022] - Use PG17 as the default in the container.

Version 8.12

Release date: 2024-09-23

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.11.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, 16 and 17

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.4

New features

Issue #1900 [https://github.com/pgadmin-org/pgadmin4/issues/1900] - Added feature to restore preferences to their default values.

Issue #6222 [https://github.com/pgadmin-org/pgadmin4/issues/6222] - Add a new config variable - ALLOW_SPECIAL_EMAIL_DOMAINS to allow special domains for pgAdmin user emails.

Issue #7293 [https://github.com/pgadmin-org/pgadmin4/issues/7293] - Allow running non-continuous selected SQL code blocks in the query tool.

Housekeeping

Issue #7884 [https://github.com/pgadmin-org/pgadmin4/issues/7884] - Improved the extendability of the SchemaView and DataGridView.

Bug fixes

Issue #6502 [https://github.com/pgadmin-org/pgadmin4/issues/6502] - Fix the query tool restore connection issue on the server disconnection from the left side object explorer.

Issue #7076 [https://github.com/pgadmin-org/pgadmin4/issues/7076] - Revamp the current password saving implementation to a keyring and reduce repeated OS user password prompts.

Issue #7571 [https://github.com/pgadmin-org/pgadmin4/issues/7571] - Fixed an issue where users could not use pgAdmin if they did not have access to the management database.

Issue #7811 [https://github.com/pgadmin-org/pgadmin4/issues/7811] - Fixed an issue where servers listed in the servers.json file were being reimported upon container restart.

Issue #7839 [https://github.com/pgadmin-org/pgadmin4/issues/7839] - Added support for OIDC based OAuth2 authentication.

Issue #7878 [https://github.com/pgadmin-org/pgadmin4/issues/7878] - Fixed an issue where cursor moves to end of line when editing input fields.

Issue #7890 [https://github.com/pgadmin-org/pgadmin4/issues/7890] - Fixed an issue where “Quit App” confirmation modal in desktop app is not respecting “Confirm on close or refresh?”.

Issue #7895 [https://github.com/pgadmin-org/pgadmin4/issues/7895] - Fixed an issue where different client backend shows all SQL are same.

Issue #7945 [https://github.com/pgadmin-org/pgadmin4/issues/7945] - Fixed a security issue where the OAuth2 client ID and secret exposed through the web browser (CVE-2024-9014).

Version 8.11

Release date: 2024-08-22

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.10.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, 16 and 17

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.3

New features

Issue #2046 [https://github.com/pgadmin-org/pgadmin4/issues/2046] - Add a home button to the geometry viewer to set original zoom level when the viewer was opened.

Housekeeping

Issue #7705 [https://github.com/pgadmin-org/pgadmin4/issues/7705] - Upgrade react-data-grid fork to latest and change pgAdmin accordingly.

Issue #7776 [https://github.com/pgadmin-org/pgadmin4/issues/7776] - Introduce custom React Hook useSchemaState to simplify SchemaView component.

Bug fixes

Issue #7499 [https://github.com/pgadmin-org/pgadmin4/issues/7499] - Fixed an issue where refreshing the Schema Diff tool opened in a new tab caused an error.

Issue #7540 [https://github.com/pgadmin-org/pgadmin4/issues/7540] - Fix server heartbeat logging error after deleting the server.

Issue #7682 [https://github.com/pgadmin-org/pgadmin4/issues/7682] - Fixed an issue where the Generate Script ignored filter conditions when a parent node was selected.

Issue #7683 [https://github.com/pgadmin-org/pgadmin4/issues/7683] - Fixed an issue where delete object(shortcut key) affecting both text and Object Explorer items.

Issue #7688 [https://github.com/pgadmin-org/pgadmin4/issues/7688] - Fix an issue where ERD tool should to be able to open saved pgerd file when using keyboard shortcuts.

Issue #7728 [https://github.com/pgadmin-org/pgadmin4/issues/7728] - Updated the documentation for web server authentication.

Issue #7737 [https://github.com/pgadmin-org/pgadmin4/issues/7737] - Fixed an issue where the REVOKE statement in the create script was throwing an error if the role contained special characters.

Issue #7748 [https://github.com/pgadmin-org/pgadmin4/issues/7748] - Improve code highlighting in query editor.

Issue #7754 [https://github.com/pgadmin-org/pgadmin4/issues/7754] - Fix an issue where the wheel package is not getting installed on the arm64-based macOS version < 14.

Issue #7772 [https://github.com/pgadmin-org/pgadmin4/issues/7772] - Fixed an issue where column resizing is not working in search objects dialog.

Issue #7775 [https://github.com/pgadmin-org/pgadmin4/issues/7775] - Fixed an issue where the value in the find box is not updating with selected text in editor if find is already open and re-triggered.

Issue #7793 [https://github.com/pgadmin-org/pgadmin4/issues/7793] - Fixed paths for Flatpak broken after Electron changes.

Version 8.10

Release date: 2024-07-29

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.9.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, 16 and 17

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.3

New features

Issue #3981 [https://github.com/pgadmin-org/pgadmin4/issues/3981] - Add support for Postgres Server Logs for Text, CSV and JSON format in plain and tabular formats. Upgrade React to version 18.

Issue #6572 [https://github.com/pgadmin-org/pgadmin4/issues/6572] - Add a keyboard shortcut to close active tab panel.

Issue #7530 [https://github.com/pgadmin-org/pgadmin4/issues/7530] - Add support for highlighting selection matches in the query editor.

Housekeeping

Issue #7494 [https://github.com/pgadmin-org/pgadmin4/issues/7494] - Replace pgAdmin NW.js container with Electron container.

Issue #7501 [https://github.com/pgadmin-org/pgadmin4/issues/7501] - Updated to the latest version of the Notistack library.

Issue #7537 [https://github.com/pgadmin-org/pgadmin4/issues/7537] - Ensure that pgAdmin 4 is compatible with PostgreSQL v17.

Issue #7607 [https://github.com/pgadmin-org/pgadmin4/issues/7607] - Automatically apply virtualization in the DataGridView of SchemaView if the schema contains only one collection.

Issue #7623 [https://github.com/pgadmin-org/pgadmin4/issues/7623] - Add the git commit hash details to the About dialog.

Bug fixes

Issue #3199 [https://github.com/pgadmin-org/pgadmin4/issues/3199] - Fixed an issue where paste operation in query tool data grid should skip bytea columns and put the value as NULL instead.

Issue #4165 [https://github.com/pgadmin-org/pgadmin4/issues/4165] - Fixed an issue where the taskbar icon appeared as a red square for the query tool and schema diff when opened in a new window.

Issue #5345 [https://github.com/pgadmin-org/pgadmin4/issues/5345] - Fix issue with missing new added records in download file.

Issue #5610 [https://github.com/pgadmin-org/pgadmin4/issues/5610] - Fixed an issue where the File Open dialog did not show files without a dot extension.

Issue #6548 [https://github.com/pgadmin-org/pgadmin4/issues/6548] - Ensure pgAdmin never makes network requests to Google etc.

Issue #6571 [https://github.com/pgadmin-org/pgadmin4/issues/6571] - Fixed an issue where pop-up notifications from Object Explorer wouldn’t get dismissed automatically if the Query Tool was opened.

Issue #7035 [https://github.com/pgadmin-org/pgadmin4/issues/7035] - Fixed the permission denied issue for functions of the pgstattuple extension when accessing statistics with a non-admin user.

Issue #7219 [https://github.com/pgadmin-org/pgadmin4/issues/7219] - Ensure processes related notifiers disappears.

Issue #7297 [https://github.com/pgadmin-org/pgadmin4/issues/7297] - Updated entrypoint.sh to utilize the email-validator package for email validation.

Issue #7511 [https://github.com/pgadmin-org/pgadmin4/issues/7511] - Fixed an issue where users could not insert characters at the desired location, as it was added to the end of the line.

Issue #7554 [https://github.com/pgadmin-org/pgadmin4/issues/7554] - Fixed an issue where sorting the database activity table on the dashboard by any column caused the details to expand in the wrong position.

Issue #7618 [https://github.com/pgadmin-org/pgadmin4/issues/7618] - Fix an issue where the preferences JSON file has no effect when an external database is used.

Issue #7626 [https://github.com/pgadmin-org/pgadmin4/issues/7626] - Fixed an issue where theme preview under theme options was broken in pgAdmin server mode.

Issue #7627 [https://github.com/pgadmin-org/pgadmin4/issues/7627] - Fixed an issue where users could not autofill their saved passwords in the connect server dialog in the browser.

Issue #7638 [https://github.com/pgadmin-org/pgadmin4/issues/7638] - Fixed an issue where Generate Script button should be disabled if no objects are selected in the schema diff result.

Issue #7639 [https://github.com/pgadmin-org/pgadmin4/issues/7639] - Fixed an issue where ERD Open/Save shorcuts were not working on Windows/Linux.

Issue #7660 [https://github.com/pgadmin-org/pgadmin4/issues/7660] - Add a precautionary check for the query tool connection cursor to fix the error ‘NoneType’ object has no attribute ‘_query’.

Issue #7662 [https://github.com/pgadmin-org/pgadmin4/issues/7662] - Fixed an issue where boolean values in node details of graphical explain plan were not interpreted correctly.

Issue #7663 [https://github.com/pgadmin-org/pgadmin4/issues/7663] - Fixed an issue where Reassign/Drop Owned dialog not opening for Role.

Issue #7679 [https://github.com/pgadmin-org/pgadmin4/issues/7679] - Ensure pgadmin does not try to connect to the server if saved password is not available.

Issue #7681 [https://github.com/pgadmin-org/pgadmin4/issues/7681] - Ensure that pgAdmin works when opened in an iframe.

Version 8.9

Release date: 2024-06-27

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.8.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.3

New features

Issue #5932 [https://github.com/pgadmin-org/pgadmin4/issues/5932] - Provide option to set theme based on OS theme preference.

Housekeeping

Issue #7363 [https://github.com/pgadmin-org/pgadmin4/issues/7363] - Remove the usage of MUI makeStyles as it doesn’t support React 18.

Bug fixes

Issue #6357 [https://github.com/pgadmin-org/pgadmin4/issues/6357] - Disable the query tool editor input if any SQL is being loaded to prevent users from typing.

Issue #7241 [https://github.com/pgadmin-org/pgadmin4/issues/7241] - Fixed an issue where resizable data editors in query tool should not be allowed to resize beyond the app window bounds.

Issue #7295 [https://github.com/pgadmin-org/pgadmin4/issues/7295] - Fixed new line indentation in query editor and add a user preference to disable it.

Issue #7306 [https://github.com/pgadmin-org/pgadmin4/issues/7306] - Ensure that a user can connect to a server using SSL certificates and identity files from a shared storage.

Issue #7316 [https://github.com/pgadmin-org/pgadmin4/issues/7316] - Fixed an issue where object explorer toolbar button not showing shortcut in the tooltip.

Issue #7414 [https://github.com/pgadmin-org/pgadmin4/issues/7414] - Add support for comments on RLS policy object.

Issue #7476 [https://github.com/pgadmin-org/pgadmin4/issues/7476] - Fixed an issue where changing a column name should reflect in all the constraints in table object dialog and ERD table dialog.

Issue #7481 [https://github.com/pgadmin-org/pgadmin4/issues/7481] - Fixed an issue where dark theme shows white background when all tabs are closed.

Issue #7516 [https://github.com/pgadmin-org/pgadmin4/issues/7516] - Ensure preferences can be loaded using preferences.json.

Issue #7523 [https://github.com/pgadmin-org/pgadmin4/issues/7523] - Fixed an issue where the schema diff incorrectly marked tables as different due to schema-qualified trigger functions in the trigger definitions.

Issue #7528 [https://github.com/pgadmin-org/pgadmin4/issues/7528] - Fixed an issue where backslash breaks syntax highlighting.

Issue #7536 [https://github.com/pgadmin-org/pgadmin4/issues/7536] - Search Objects dialog should focus on search input on open.

Issue #7542 [https://github.com/pgadmin-org/pgadmin4/issues/7542] - Fixed incorrect sorting of size in statistics tab.

Issue #7555 [https://github.com/pgadmin-org/pgadmin4/issues/7555] - Fixed an issue where query tool shortcuts for find/replace are not working.

Issue #7556 [https://github.com/pgadmin-org/pgadmin4/issues/7556] - Fixed migration failure while using external database.

Issue #7593 [https://github.com/pgadmin-org/pgadmin4/issues/7593] - Fixed an issue where query tool auto-complete stops working after connection change.

Issue #7605 [https://github.com/pgadmin-org/pgadmin4/issues/7605] - Fix the permissions issue in the pgAdmin installation directory on Debian and RHEL-8 platforms (CVE-2024-6238).

Issue #7616 [https://github.com/pgadmin-org/pgadmin4/issues/7616] - Fixed an issue where delete button in Users data was enabled for incorrect rows.

Version 8.8

Release date: 2024-06-06

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.7.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.3

New features

Housekeeping

Bug fixes

Issue #5785 [https://github.com/pgadmin-org/pgadmin4/issues/5785] - Fix an issue where user authentication fails with special characters in password.

Issue #7480 [https://github.com/pgadmin-org/pgadmin4/issues/7480] - Fixed an issue where canceling a query without privilege does not display any message on query tool.

Issue #7520 [https://github.com/pgadmin-org/pgadmin4/issues/7520] - Fix the issue where docker with SSL v8.7 fails to start.

Issue #7524 [https://github.com/pgadmin-org/pgadmin4/issues/7524] - Fixed an issue where the size displayed as ‘NaN B’ for all databases in the statistics tab.

Issue #7526 [https://github.com/pgadmin-org/pgadmin4/issues/7526] - Fixed an issue where backup and restore operations failed with the error ‘This build does not support compression with gzip’.

Version 8.7

Release date: 2024-05-30

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.6.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.3

New features

Issue #4735 [https://github.com/pgadmin-org/pgadmin4/issues/4735] - Added support for the ‘Add to macros’ feature and fixed various usability issues.

Issue #6841 [https://github.com/pgadmin-org/pgadmin4/issues/6841] - Added support for executing the query at the cursor position in the query tool.

Issue #7192 [https://github.com/pgadmin-org/pgadmin4/issues/7192] - Changes in Query Tool, Debugger, and ERD Tool shortcuts to remove the use of Accesskey which will allow them to be customized.

Issue #7215 [https://github.com/pgadmin-org/pgadmin4/issues/7215] - Added support for viewing PGD Clusters.

Issue #7411 [https://github.com/pgadmin-org/pgadmin4/issues/7411] - Enhance the Delete dialog by highlighting the names of the objects to be deleted in bold.

Issue #7437 [https://github.com/pgadmin-org/pgadmin4/issues/7437] - Added support for platform Ubuntu 24.04 and Fedora 40.

Housekeeping

Issue #7419 [https://github.com/pgadmin-org/pgadmin4/issues/7419] - Upgrade react-table from v7 to v8.

Issue #7472 [https://github.com/pgadmin-org/pgadmin4/issues/7472] - Replace the current FontAwesome based PSQL tool icon with MUI Terminal icon.

Bug fixes

Issue #5762 [https://github.com/pgadmin-org/pgadmin4/issues/5762] - Ensure that Schema Diff does not indicate a table as different when the trigger names are the same but the trigger function body is different.

Issue #5849 [https://github.com/pgadmin-org/pgadmin4/issues/5849] - Disable ERD for system catalogs.

Issue #6060 [https://github.com/pgadmin-org/pgadmin4/issues/6060] - Disable Debugger for system catalogs.

Issue #6086 [https://github.com/pgadmin-org/pgadmin4/issues/6086] - Fixed an issue where drag and drop publication and subscription name in SQL editors was not working.

Issue #6464 [https://github.com/pgadmin-org/pgadmin4/issues/6464] - Fixed an issue of the pgAdmin window size increasing each time it was reopened.

Issue #7349 [https://github.com/pgadmin-org/pgadmin4/issues/7349] - Update the documentation for preferences dialog and keyboard shortcuts.

Issue #7439 [https://github.com/pgadmin-org/pgadmin4/issues/7439] - Fixed an issue where pgAdmin fails to start when Ubuntu OS is upgraded to a major version.

Issue #7458 [https://github.com/pgadmin-org/pgadmin4/issues/7458] - Remove query info notifier timeout field from Query Tool Preferences Dialog.

Issue #7485 [https://github.com/pgadmin-org/pgadmin4/issues/7485] - Fixed incorrect highlighting for C-Style escape strings in SQL editor.

Issue #7487 [https://github.com/pgadmin-org/pgadmin4/issues/7487] - Fixed an issue where the recover password button was enabled even when no email was provided.

Issue #7500 [https://github.com/pgadmin-org/pgadmin4/issues/7500] - Fixed an issue where resetting the password from the password reset link was not working.

Version 8.6

Release date: 2024-05-02

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.5.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.1

New features

Issue #6728 [https://github.com/pgadmin-org/pgadmin4/issues/6728] - Added the new columns “last_seq_scan” and “last_idx_scan” from the pg_stat_all_tables and pg_stat_all_indexes tables respectively to the Statistics tab.

Issue #7163 [https://github.com/pgadmin-org/pgadmin4/issues/7163] - Added support for excluding multiple tables while taking Backup.

Housekeeping

Issue #7213 [https://github.com/pgadmin-org/pgadmin4/issues/7213] - Update UI library MUI from v4 to v5, more details here [https://github.com/pgadmin-org/pgadmin4/commit/102e0a983956be57fdb63abb356b5b8fcb8b74ba]

Issue #7362 [https://github.com/pgadmin-org/pgadmin4/issues/7362] - Upgraded Flask, Flask-Security-Too, Werkzeug, and other dependencies, ensuring compatibility with Python 3.7.

Bug fixes

Issue #2410 [https://github.com/pgadmin-org/pgadmin4/issues/2410] - Fixed all input boxes in pgAdmin to show browser auto-fill only where it is relevant.

Issue #7173 [https://github.com/pgadmin-org/pgadmin4/issues/7173] - Install dbus-python, an in-direct dependency of the Keyring package as a system package for Debian platforms.

Issue #7275 [https://github.com/pgadmin-org/pgadmin4/issues/7275] - Fixed an issue where debugger was not scrolling automatically on stepping.

Issue #7282 [https://github.com/pgadmin-org/pgadmin4/issues/7282] - Fixed an XSS vulnerability in the /settings/store endpoint (CVE-2024-4216).

Issue #7294 [https://github.com/pgadmin-org/pgadmin4/issues/7294] - Fixed an issue where double dollar quoted code is treated as string in syntax highlighter.

Issue #7317 [https://github.com/pgadmin-org/pgadmin4/issues/7317] - Fixed an issue where pressing backspace should remove the spaces and not the entire tab width, on enabling ‘Use spaces?’ in the preferences.

Issue #7334 [https://github.com/pgadmin-org/pgadmin4/issues/7334] - Fixed an issue where incorrect select/exec scripts were generated for functions/procedures.

Issue #7372 [https://github.com/pgadmin-org/pgadmin4/issues/7372] - Fixed an issue where connection to the database is not automatically re-established after connectivity drop.

Issue #7384 [https://github.com/pgadmin-org/pgadmin4/issues/7384] - Fixed an issue when closing the view data second tab; it raises the error that the ‘ViewCommand’ object has no attribute ‘auto_commit’.

Issue #7390 [https://github.com/pgadmin-org/pgadmin4/issues/7390] - Fixed violates check constraint issue when creating a pgAgent schedule.

Issue #7425 [https://github.com/pgadmin-org/pgadmin4/issues/7425] - Fixed Multi-Factor Authentication bypass vulnerability (CVE-2024-4215).

Version 8.5

Release date: 2024-04-04

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.5.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.1

New features

Issue #5611 [https://github.com/pgadmin-org/pgadmin4/issues/5611] - Added support for provider, deterministic, version and RULES parameter while creating collation.

Issue #7098 [https://github.com/pgadmin-org/pgadmin4/issues/7098] - Added support for EDB Job Scheduler.

Issue #7216 [https://github.com/pgadmin-org/pgadmin4/issues/7216] - Added support for viewing Log Streaming replication Based Clusters.

Issue #7221 [https://github.com/pgadmin-org/pgadmin4/issues/7221] - Added support for UNIX socket in entrypoint.sh for Docker implementation.

Housekeeping

Bug fixes

Issue #4413 [https://github.com/pgadmin-org/pgadmin4/issues/4413] - Fixed an issue in Schema Diff where Columns with sequences get altered unnecessarily.

Issue #7111 [https://github.com/pgadmin-org/pgadmin4/issues/7111] - Fixed an issue where user was unable to share a newly registered server.

Issue #7116 [https://github.com/pgadmin-org/pgadmin4/issues/7116] - Bug fixes and improvements in pgAdmin CLI.

Issue #7139 [https://github.com/pgadmin-org/pgadmin4/issues/7139] - Fixed an issue where the ‘Save Password’ option for SSH tunneling password was consistently disabled.

Issue #7165 [https://github.com/pgadmin-org/pgadmin4/issues/7165] - Fixed schema diff wrong query generation for table, foreign table and sequence.

Issue #7210 [https://github.com/pgadmin-org/pgadmin4/issues/7210] - Fixed an issue where table properties were not updating from properties dialog.

Issue #7218 [https://github.com/pgadmin-org/pgadmin4/issues/7218] - Fixed an issue where maximize icon is missing from query tool panel.

Issue #7229 [https://github.com/pgadmin-org/pgadmin4/issues/7229] - Fix an issue in table dialog where changing column name was not syncing table constraints appropriately.

Issue #7248 [https://github.com/pgadmin-org/pgadmin4/issues/7248] - Fixed rollback and commit button activation on execute button click.

Issue #7255 [https://github.com/pgadmin-org/pgadmin4/issues/7255] - Fixed an issue where taking backup of a shared server was using server owner’s user name.

Issue #7262 [https://github.com/pgadmin-org/pgadmin4/issues/7262] - Fix an issue in editor where replace option in query tool edit menu is not working on non-Mac OS.

Issue #7268 [https://github.com/pgadmin-org/pgadmin4/issues/7268] - Fix an issue in editor where Format SQL shortcut and multiline selection are not working.

Issue #7269 [https://github.com/pgadmin-org/pgadmin4/issues/7269] - Fix an issue in editor where “Use Spaces?” Preference of Editor is not working.

Issue #7271 [https://github.com/pgadmin-org/pgadmin4/issues/7271] - Fixed an issue where Triggers, Rules, Indexes were absent from the Schema Diff when comparing views.

Issue #7277 [https://github.com/pgadmin-org/pgadmin4/issues/7277] - Fix an issue in query tool where toggle case of selected text loses selection.

Issue #7299 [https://github.com/pgadmin-org/pgadmin4/issues/7299] - Fix query tool autocomplete results when cursor is in between the SQL query.

Issue #7305 [https://github.com/pgadmin-org/pgadmin4/issues/7305] - Fix an issue in query tool where custom keyboard shortcuts are not working for some.

Issue #7304 [https://github.com/pgadmin-org/pgadmin4/issues/7304] - Fixed the issue where the update-user CLI command doesn’t change the password.

Issue #7308 [https://github.com/pgadmin-org/pgadmin4/issues/7308] - Fixed issue related to email authentication of Two-factor authentication.

Issue #7326 [https://github.com/pgadmin-org/pgadmin4/issues/7326] - Fixed a remote code execution issue in the validate binary path (CVE-2024-3116).

Version 8.4

Release date: 2024-03-07

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.3.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.1

New features

Issue #6058 [https://github.com/pgadmin-org/pgadmin4/issues/6058] - Allow preferences customization using a configuration file.

Issue #7138 [https://github.com/pgadmin-org/pgadmin4/issues/7138] - Add support for JSON log format.

Issue #7204 [https://github.com/pgadmin-org/pgadmin4/issues/7204] - Add –yes option for skipping the confirmation prompt while deleting the user via CLI for scripting purpose.

Housekeeping

Issue #7097 [https://github.com/pgadmin-org/pgadmin4/issues/7097] - Upgrade CodeMirror from version 5 to 6.

Issue #7148 [https://github.com/pgadmin-org/pgadmin4/issues/7148] - Added documentation for Dashboard’s System Statistics tab.

Issue #7187 [https://github.com/pgadmin-org/pgadmin4/issues/7187] - Separate the application name, branding & version information from the configuration file.

Issue #7234 [https://github.com/pgadmin-org/pgadmin4/issues/7234] - Upgrade python packages cryptography to 42.0.x and Flask-Security-Too to 5.3.x.

Bug fixes

Issue #6792 [https://github.com/pgadmin-org/pgadmin4/issues/6792] - Fix multiple issues where PasswordExecCommand was not working in server mode and PasswordExecCommand was not loaded when importing servers.

Issue #6808 [https://github.com/pgadmin-org/pgadmin4/issues/6808] - Fix the tabbed panel backward/forward shortcut for tabs.

Issue #7027 [https://github.com/pgadmin-org/pgadmin4/issues/7027] - Fixed an issue where dependencies and dependents were not showing if a composite type is used as an attribute in another composite type.

Issue #7164 [https://github.com/pgadmin-org/pgadmin4/issues/7164] - Fix an issue where constraint check control is enabled in the edit table dialog.

Issue #7165 [https://github.com/pgadmin-org/pgadmin4/issues/7165] - Fix an issue where the scripts created by generate script of Schema diff for Table with sequence was not working earlier.

Issue #7193 [https://github.com/pgadmin-org/pgadmin4/issues/7193] - Ensure that the OAuth2 session is logged out when users log out from pgAdmin.

Issue #7217 [https://github.com/pgadmin-org/pgadmin4/issues/7217] - Remove role related checks on the UI dashboard when terminating session/query and let PostgreSQL take care of it.

Issue #7225 [https://github.com/pgadmin-org/pgadmin4/issues/7225] - Fix an issue where type column in dependents/dependencies tab is not showing correct label.

Issue #7258 [https://github.com/pgadmin-org/pgadmin4/issues/7258] - Unsafe Deserialization and Remote Code Execution by an Authenticated user in pgAdmin 4 (CVE-2024-2044).

Version 8.3

Release date: 2024-02-09

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.2.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.0

New features

Issue #4419 [https://github.com/pgadmin-org/pgadmin4/issues/4419] - Allow drag-n-drop columns collection tree node as comma separated columns.

Issue #6380 [https://github.com/pgadmin-org/pgadmin4/issues/6380] - Added support to rename columns in Views.

Issue #6392 [https://github.com/pgadmin-org/pgadmin4/issues/6392] - Added BYPASSRLS|NOBYPASSRLS option while creating a Role.

Issue #6450 [https://github.com/pgadmin-org/pgadmin4/issues/6450] - Added support for column storage syntax while creating table.

Issue #6557 [https://github.com/pgadmin-org/pgadmin4/issues/6557] - Use COOKIE_DEFAULT_PATH or SCRIPT_NAME in session cookie path.

Issue #6792 [https://github.com/pgadmin-org/pgadmin4/issues/6792] - Added configurable parameter to enable support for PasswordExecCommand in server mode.

Housekeeping

Bug fixes

Issue #5083 [https://github.com/pgadmin-org/pgadmin4/issues/5083] - Fixed an issue where format sql was messing up operator. Included many other feature changes, more details here [https://github.com/pgadmin-org/pgadmin4/commit/f7045b58d4d1b98b6a2f035267d2dd01c7235aa6]

Issue #6785 [https://github.com/pgadmin-org/pgadmin4/issues/6785] - Fixed an issue where formatting inserts empty lines in specific case.

Issue #7053 [https://github.com/pgadmin-org/pgadmin4/issues/7053] - Add support for selecting a schema in the backup database dialog with no tables, mviews, views or foreign tables.

Issue #7055 [https://github.com/pgadmin-org/pgadmin4/issues/7055] - Fixed a UI border issue on the dependencies tab for columns with icon.

Issue #7073 [https://github.com/pgadmin-org/pgadmin4/issues/7073] - Fixed an issue where multiple errors were showing if user does not have connect privileges.

Issue #7085 [https://github.com/pgadmin-org/pgadmin4/issues/7085] - Fixed an issue where group membership information was displayed incorrectly.

Issue #7113 [https://github.com/pgadmin-org/pgadmin4/issues/7113] - Ensure that the correct SQL is generated when changing the column data type to “char”.

Issue #7153 [https://github.com/pgadmin-org/pgadmin4/issues/7153] - Fixed an issue pgAdmin fails to launch due to inconsistent PATH variable name on windows.

Issue #7166 [https://github.com/pgadmin-org/pgadmin4/issues/7166] - Fix a backend server error when creating a named restore point.

Issue #7175 [https://github.com/pgadmin-org/pgadmin4/issues/7175] - Fix wrong default for FORCE_LOWER in the FLASK_GRAVATAR module.

Version 8.2

Release date: 2024-01-11

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.1.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.0

New features

Issue #2483 [https://github.com/pgadmin-org/pgadmin4/issues/2483] - Administer pgAdmin Users and Preferences Using the Command Line Interface (CLI).

Issue #5908 [https://github.com/pgadmin-org/pgadmin4/issues/5908] - Allow users to convert View/Edit table into a Query tool to enable editing the SQL generated.

Issue #6085 [https://github.com/pgadmin-org/pgadmin4/issues/6085] - Added copy server support, allowing the duplication of existing servers with the option to make certain modifications.

Issue #7016 [https://github.com/pgadmin-org/pgadmin4/issues/7016] - Added keep-alive support for SSH sessions when connecting to a PostgreSQL server via an SSH tunnel.

Housekeeping

Issue #6926 [https://github.com/pgadmin-org/pgadmin4/issues/6926] - Ensure that eventlet’s subprocess should be used following the resolution of an issue with Python 3.12 by eventlet.

Bug fixes

Issue #6193 [https://github.com/pgadmin-org/pgadmin4/issues/6193] - Fixed an issue where query tool title did not change after “Save As” until any new change is made.

Issue #6781 [https://github.com/pgadmin-org/pgadmin4/issues/6781] - Fixed an issue where export servers was not adding extension if not specified.

Issue #6815 [https://github.com/pgadmin-org/pgadmin4/issues/6815] - Fixed an issue where pgAdmin imports servers to the wrong accounts for the external authentication.

Issue #7002 [https://github.com/pgadmin-org/pgadmin4/issues/7002] - Fixed an issue where an error occurred in the SQL tab when using an extended index(pgroonga).

Issue #7041 [https://github.com/pgadmin-org/pgadmin4/issues/7041] - Fixed an issue where changes done to a node using edit dialog are not reflecting on the properties tab if the properties tab is active.

Issue #7059 [https://github.com/pgadmin-org/pgadmin4/issues/7059] - Fixed an issue where DB Restrictions were not visible on the server dialog.

Issue #7061 [https://github.com/pgadmin-org/pgadmin4/issues/7061] - Ensure that the ‘Dbo’ schema is displayed as a regular schema rather than a system catalog schema.

Issue #7062 [https://github.com/pgadmin-org/pgadmin4/issues/7062] - Introduce LDAP configuration parameter LDAP_IGNORE_MALFORMED_SCHEMA to ignore fetching schema from the LDAP server.

Issue #7064 [https://github.com/pgadmin-org/pgadmin4/issues/7064] - Fixed an error-‘amname’ when generating ERD for database containing partition tables.

Issue #7066 [https://github.com/pgadmin-org/pgadmin4/issues/7066] - Fixed an issue where object explorer last tree state was not saving.

Issue #7070 [https://github.com/pgadmin-org/pgadmin4/issues/7070] - Fixed an issue where pgAgent job schedule dialog is not opening for edit.

Issue #7078 [https://github.com/pgadmin-org/pgadmin4/issues/7078] - Fixed an issue where user is not able to cancel or terminate active queries from dashboard.

Issue #7082 [https://github.com/pgadmin-org/pgadmin4/issues/7082] - Fixed browser autocomplete related issues on pgAdmin authentication related pages.

Issue #7091 [https://github.com/pgadmin-org/pgadmin4/issues/7091] - Fixed an issue where auto commit/rollback setting not persisting across query tool connection change.

Issue #7104 [https://github.com/pgadmin-org/pgadmin4/issues/7104] - Fixed an issue where Schema Diff not generating difference for missing columns.

Version 8.1

Release date: 2023-12-14

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.0.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.0

New features

Issue #4580 [https://github.com/pgadmin-org/pgadmin4/issues/4580] - Add support for generating ERD for a schema.

Issue #6854 [https://github.com/pgadmin-org/pgadmin4/issues/6854] - Add support for creating a function with custom return type.

Housekeeping

Issue #6991 [https://github.com/pgadmin-org/pgadmin4/issues/6991] - Fixed several accessibility-related issues for enhanced usability.

Bug fixes

Issue #5471 [https://github.com/pgadmin-org/pgadmin4/issues/5471] - Ensure focus is not changed to ssh tunnel password input when user explicitly focus on server password input.

Issue #6095 [https://github.com/pgadmin-org/pgadmin4/issues/6095] - Provide a way to bypass the SSL cert verification for OAuth2 provider.

Issue #6488 [https://github.com/pgadmin-org/pgadmin4/issues/6488] - Fixed an issue where database name was missing in an error message if name contains any special characters.

Issue #6717 [https://github.com/pgadmin-org/pgadmin4/issues/6717] - Ensure that indexes created by constraints are visible in the object explorer when “Show system objects” is enabled.

Issue #6803 [https://github.com/pgadmin-org/pgadmin4/issues/6803] - Fixed an issue where reading process logs throws an error when DATA_DIR is moved to a networked drive.

Issue #6814 [https://github.com/pgadmin-org/pgadmin4/issues/6814] - Remove the ‘Close Window’ submenu specifically for OSX to prevent unintended closure of the entire application.

Issue #6842 [https://github.com/pgadmin-org/pgadmin4/issues/6842] - Rename all references of ‘Execute query’ to ‘Execute script’ to be more relevant.

Issue #6887 [https://github.com/pgadmin-org/pgadmin4/issues/6887] - Fixed an issue where syntax error was not highlighting in query tool.

Issue #6921 [https://github.com/pgadmin-org/pgadmin4/issues/6921] - Fixed an issue where on entering full screen, the option label is not changed to ‘Exit Full Screen’ in desktop mode.

Issue #6950 [https://github.com/pgadmin-org/pgadmin4/issues/6950] - Ensure that the Authentication Source in the drop-down of the UserManagement dialog aligns with the entries specified for AUTHENTICATION_SOURCES in the configuration file.

Issue #6958 [https://github.com/pgadmin-org/pgadmin4/issues/6958] - Reverse engineer serial columns when generating ERD for database/table.

Issue #6964 [https://github.com/pgadmin-org/pgadmin4/issues/6964] - Fixed an issue where the Schema was not visible in the dropdown for table properties or when creating a new table.

Issue #6968 [https://github.com/pgadmin-org/pgadmin4/issues/6968] - Fixed an issue where option key was not registering in PSQL tool.

Issue #6984 [https://github.com/pgadmin-org/pgadmin4/issues/6984] - Fixed an issue where the Vacuum option INDEX_CLEANUP have an incorrect value (‘AUTO’) for database versions < 14.

Issue #6989 [https://github.com/pgadmin-org/pgadmin4/issues/6989] - Fixed an issue where the pgAdmin page went blank when clicking the delete button in the User Management dialog.

Issue #7000 [https://github.com/pgadmin-org/pgadmin4/issues/7000] - Ensure that correct timezone is set for Docker deployments.

Issue #7011 [https://github.com/pgadmin-org/pgadmin4/issues/7011] - Fixed an issue where all rows and filter rows buttons of object explorer toolbar were disabled for views and other supported nodes.

Issue #7017 [https://github.com/pgadmin-org/pgadmin4/issues/7017] - Fixed an issue where schema diff tool is not loading preferences on start.

Version 8.0

Release date: 2023-11-23

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.8.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14, 15, and 16

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.0

New features

Issue #2821 [https://github.com/pgadmin-org/pgadmin4/issues/2821] - Have close buttons on individual panel tabs instead of common.

Issue #4733 [https://github.com/pgadmin-org/pgadmin4/issues/4733] - Allow closing all the tabs, including SQL and Properties.

Issue #5394 [https://github.com/pgadmin-org/pgadmin4/issues/5394] - Changes in the context menu on panel tabs - Add close, close all and close others menu items.

Housekeeping

Issue #6441 [https://github.com/pgadmin-org/pgadmin4/issues/6441] - Update app bundle built to use notarytool instead of altool.

Issue #6479 [https://github.com/pgadmin-org/pgadmin4/issues/6479] - Replace the current layout library wcDocker with ReactJS based rc-dock.

Issue #6850 [https://github.com/pgadmin-org/pgadmin4/issues/6850] - Upgrade Flask, Werkzeug and other modules depends on the latest version of Flask.

Bug fixes

Issue #2986 [https://github.com/pgadmin-org/pgadmin4/issues/2986] - Fix an issue where the scroll position of panels was not remembered on Firefox.

Issue #5770 [https://github.com/pgadmin-org/pgadmin4/issues/5770] - Add DROP SQL for foreign keys in SQL generated by ERD when using WITH DROP option.

Issue #5807 [https://github.com/pgadmin-org/pgadmin4/issues/5807] - Fixed an issue where psql was not taking the role used to connect in server properties.

Issue #6017 [https://github.com/pgadmin-org/pgadmin4/issues/6017] - Fixed an issue where Geometry Viewer renders geometry incorrectly after trying to view 3D or non-4326 SRID geometry.

Issue #6459 [https://github.com/pgadmin-org/pgadmin4/issues/6459] - Fix the sorting of size on the statistics panel.

Issue #6487 [https://github.com/pgadmin-org/pgadmin4/issues/6487] - Fixed restoration of query tool database connection after dropping and re-creating the database with the same name.

Issue #6602 [https://github.com/pgadmin-org/pgadmin4/issues/6602] - Fix an issue where the default server-group is being deleted if the load-server json file contains no servers.

Issue #6720 [https://github.com/pgadmin-org/pgadmin4/issues/6720] - Fix an issue of the incorrect format (no indent) of SQL stored functions/procedures.

Issue #6769 [https://github.com/pgadmin-org/pgadmin4/issues/6769] - Server config information in the about dialog should be only visible to admin users.

Issue #6784 [https://github.com/pgadmin-org/pgadmin4/issues/6784] - Fixed an issue where Schema Diff does not work when the user language is set to any language other than English in Preferences.

Issue #6817 [https://github.com/pgadmin-org/pgadmin4/issues/6817] - Fixed the query generated when creating subscription where copy_data parameter was missing.

Issue #6820 [https://github.com/pgadmin-org/pgadmin4/issues/6820] - Ensure backup/restore/maintenance works with invalid pgpass file parameter.

Issue #6835 [https://github.com/pgadmin-org/pgadmin4/issues/6835] - Fix an issue where OAUTH_ADDITIONAL_CLAIMS does not recognise AzureAD with > 150 groups.

Issue #6840 [https://github.com/pgadmin-org/pgadmin4/issues/6840] - Fixed circular import error occurring while deploying cloud PostgreSQL instance from pgAdmin.

Issue #6874 [https://github.com/pgadmin-org/pgadmin4/issues/6874] - Fix an issue where the browser window stuck on spinning with an Oauth user without email.

Issue #6875 [https://github.com/pgadmin-org/pgadmin4/issues/6875] - Fix an issue where import/export data is not working for shared servers.

Issue #6877 [https://github.com/pgadmin-org/pgadmin4/issues/6877] - Remove the max length of 255 from password exec command in server configuration dialog.

Issue #6884 [https://github.com/pgadmin-org/pgadmin4/issues/6884] - Remove gettext from empty strings in the title of the storage graph.

Issue #6902 [https://github.com/pgadmin-org/pgadmin4/issues/6902] - Fixed an issue where the change server password is not working in desktop mode.

Issue #6904 [https://github.com/pgadmin-org/pgadmin4/issues/6904] - Fix a crash issue occurring when debugging a function with arguments when using pgAdmin with external config database.

Issue #6920 [https://github.com/pgadmin-org/pgadmin4/issues/6920] - Fix an issue in ERD tool where SQL generated is missing columns for the table.

Issue #6934 [https://github.com/pgadmin-org/pgadmin4/issues/6934] - Clear the password field in the config database on clear saved server password.

Issue #6962 [https://github.com/pgadmin-org/pgadmin4/issues/6962] - Fixed an issue where the data type of the array type was not visible for the column in the Foreign Table dialog.

Version 7.8

Release date: 2023-10-19

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.7.

Supported Database Servers

PostgreSQL: 12, 13, 14, 15, and 16

EDB Advanced Server: 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 16.0

New features

Issue #640 [https://github.com/pgadmin-org/pgadmin4/issues/640] - Add support for foreign table’s new functionality for PG 11 and above.

Issue #6229 [https://github.com/pgadmin-org/pgadmin4/issues/6229] - Allow setting custom username for shared servers, with default as username of server being shared.

Issue #6373 [https://github.com/pgadmin-org/pgadmin4/issues/6373] - Add ‘GENERATED ALWAYS AS..’ option while creating column constraints for Foreign Table.

Issue #6797 [https://github.com/pgadmin-org/pgadmin4/issues/6797] - GUI representation of the system’s activity using the ‘system_stats’ extension.

Issue #6802 [https://github.com/pgadmin-org/pgadmin4/issues/6802] - Added ‘load_balance_hosts’ connection string parameter for PG 16 and above.

Housekeeping

Issue #6782 [https://github.com/pgadmin-org/pgadmin4/issues/6782] - Use PG16 as the default PostgreSQL version.

Bug fixes

Issue #4995 [https://github.com/pgadmin-org/pgadmin4/issues/4995] - Fixed an issue in ERD tool where the downloaded images have a few links cut.

Issue #5749 [https://github.com/pgadmin-org/pgadmin4/issues/5749] - Fixed an issue where user was not able to assign new/old columns as primary key once column with primary key is deleted.

Issue #6285 [https://github.com/pgadmin-org/pgadmin4/issues/6285] - Add support for setting prepare threshold in server connection.

Issue #6482 [https://github.com/pgadmin-org/pgadmin4/issues/6482] - Fixed an issue where the wrong message “Current database has been moved or renamed” is displayed when debugging any function.

Issue #6538 [https://github.com/pgadmin-org/pgadmin4/issues/6538] - Fixed an issue where Processes tab displays wrong server name in some scenario.

Issue #6579 [https://github.com/pgadmin-org/pgadmin4/issues/6579] - Fix an issue where global/native keyboard shortcuts are not working when any cell of data output grid has focus.

Issue #6666 [https://github.com/pgadmin-org/pgadmin4/issues/6666] - Fixed query history slowness issue by storing query only for those having certain threshold max length.

Issue #6674 [https://github.com/pgadmin-org/pgadmin4/issues/6674] - Fix an issue where foreign table column name becomes “none” if the user changes any column data type.

Issue #6718 [https://github.com/pgadmin-org/pgadmin4/issues/6718] - Pin the cryptography version to fix PyO3 modules initialisation error.

Issue #6790 [https://github.com/pgadmin-org/pgadmin4/issues/6790] - Ensure that the backup works properly for PG 16 on the latest docker image.

Issue #6799 [https://github.com/pgadmin-org/pgadmin4/issues/6799] - Fixed an issue where the user is unable to select objects on the backup dialog due to tree flickering.

Issue #6836 [https://github.com/pgadmin-org/pgadmin4/issues/6836] - Fixed an issue where non-super PostgreSQL users are not able to terminate their own connections from dashboard.

Issue #6851 [https://github.com/pgadmin-org/pgadmin4/issues/6851] - Fix an issue where scale in columns is not allowed to have value as 0 or below.

Issue #6858 [https://github.com/pgadmin-org/pgadmin4/issues/6858] - Fix an issue in graphical explain plan where query tool crashes when the plan has parallel workers details and sort node is clicked for details.

Issue #6865 [https://github.com/pgadmin-org/pgadmin4/issues/6865] - Fix an issue where user login is not working if username/email contains single quote in server mode.

Version 7.7

Release date: 2023-09-21

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.6.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.4

New features

Issue #642 [https://github.com/pgadmin-org/pgadmin4/issues/642] - Added support to select/deselect objects in the Backup dialog.

Issue #4805 [https://github.com/pgadmin-org/pgadmin4/issues/4805] - Added all the new options of the ‘WITH’ clause in the subscription dialog.

Issue #6378 [https://github.com/pgadmin-org/pgadmin4/issues/6378] - Added USING method while creating the table.

Issue #6379 [https://github.com/pgadmin-org/pgadmin4/issues/6379] - Added compression method option while creating a column.

Issue #6383 [https://github.com/pgadmin-org/pgadmin4/issues/6383] - Added Strategy, Locale Provider, ICU Locale, ICU Rules, and OID options while creating a database.

Issue #6400 [https://github.com/pgadmin-org/pgadmin4/issues/6400] - Added USING method while creating the materialized view.

Issue #6736 [https://github.com/pgadmin-org/pgadmin4/issues/6736] - Add support for additional ID token claim checks for OAuth 2 authentication.

Housekeeping

Issue #2411 [https://github.com/pgadmin-org/pgadmin4/issues/2411] - Added the ‘data type’ column in the properties tab of the Columns collection node.

Bug fixes

Issue #6274 [https://github.com/pgadmin-org/pgadmin4/issues/6274] - Fix an issue where user is not able to change the password when SMTP is not configured.

Issue #6704 [https://github.com/pgadmin-org/pgadmin4/issues/6704] - Ensure user is redirected to login page after failed login.

Issue #6712 [https://github.com/pgadmin-org/pgadmin4/issues/6712] - Ensure that Materialized view size fields in “Statistics” should be human-readable.

Issue #6730 [https://github.com/pgadmin-org/pgadmin4/issues/6730] - Fix an issue where changing the password shows success but the new password is not working.

Issue #6738 [https://github.com/pgadmin-org/pgadmin4/issues/6738] - Fix an issue where login form doesn’t appear if internal auth source is removed.

Issue #6764 [https://github.com/pgadmin-org/pgadmin4/issues/6764] - Fix a security related issue where an authenticated user can run remote command using validate binary path API (CVE-2023-5002).

Version 7.6

Release date: 2023-08-24

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.5.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.3

New features

Issue #2595 [https://github.com/pgadmin-org/pgadmin4/issues/2595] - Added Expression to CREATE INDEX.

Issue #3942 [https://github.com/pgadmin-org/pgadmin4/issues/3942] - Added cascade option while creating an extension.

Issue #5759 [https://github.com/pgadmin-org/pgadmin4/issues/5759] - Added ‘Ignore Grants’ option in the schema diff tool.

Issue #6004 [https://github.com/pgadmin-org/pgadmin4/issues/6004] - Added ‘Ignore Tablespace’ option in the schema diff tool.

Issue #6375 [https://github.com/pgadmin-org/pgadmin4/issues/6375] - Added support for ALTER INDEX column statistics.

Issue #6376 [https://github.com/pgadmin-org/pgadmin4/issues/6376] - Added unlogged option while creating a sequence.

Issue #6377 [https://github.com/pgadmin-org/pgadmin4/issues/6377] - Added all like options while creating a table.

Issue #6381 [https://github.com/pgadmin-org/pgadmin4/issues/6381] - Added support for SYSTEM, CONCURRENTLY and TABLESPACE options in REINDEX.

Issue #6382 [https://github.com/pgadmin-org/pgadmin4/issues/6382] - Added WAL option to EXPLAIN ANALYZE command.

Issue #6397 [https://github.com/pgadmin-org/pgadmin4/issues/6397] - Added new/missing options to the VACUUM command.

Issue #6415 [https://github.com/pgadmin-org/pgadmin4/issues/6415] - Added SKIP_LOCKED and BUFFER_USAGE_LIMIT option to Analyze command.

Issue #6448 [https://github.com/pgadmin-org/pgadmin4/issues/6448] - Add support for TRUNCATE trigger in foreign table.

Issue #6595 [https://github.com/pgadmin-org/pgadmin4/issues/6595] - Ensure that Schema Diff comparison results should be displayed in the sorted order.

Housekeeping

Issue #3702 [https://github.com/pgadmin-org/pgadmin4/issues/3702] - Generate software bill of materials as part of the package builds.

Issue #6588 [https://github.com/pgadmin-org/pgadmin4/issues/6588] - Added support for PostgreSQL and EPAS 16 to ensure it works without any errors.

Bug fixes

Issue #5454 [https://github.com/pgadmin-org/pgadmin4/issues/5454] - Fix incorrect redirection URL after authentication by removing fixed value set to SCRIPT_NAME environment variable in pgAdmin4.wsgi file.

Issue #6208 [https://github.com/pgadmin-org/pgadmin4/issues/6208] - Allow changing the POOL_SIZE and MAX_OVERFLOW config values of the pgAdmin config DB connection pool.

Issue #6252 [https://github.com/pgadmin-org/pgadmin4/issues/6252] - Fix an issue where query tool on shared server is throwing error if the pgAdmin config DB is external.

Issue #6420 [https://github.com/pgadmin-org/pgadmin4/issues/6420] - Fix the query tool issue where raise Notice from func/proc or code blocks are no longer displayed live.

Issue #6500 [https://github.com/pgadmin-org/pgadmin4/issues/6500] - Fix the issue where query tool window turns blank if the user tries to generate a graph on the result.

Issue #6624 [https://github.com/pgadmin-org/pgadmin4/issues/6624] - Fix an issue where changing MFA_SUPPORTED_METHODS breaks the MFA validation.

Issue #6630 [https://github.com/pgadmin-org/pgadmin4/issues/6630] - Fix an issue where pgAdmin 7.5 fails to render table SQL with extension loaded index method.

Issue #6639 [https://github.com/pgadmin-org/pgadmin4/issues/6639] - Fix an issue where cycle syntax was not added in SQL when creating new sequence from UI.

Issue #6651 [https://github.com/pgadmin-org/pgadmin4/issues/6651] - Fix an issue where the SET directive is excluded from the function header in the schema diff tool.

Issue #6660 [https://github.com/pgadmin-org/pgadmin4/issues/6660] - Fix a query tool error ‘pgAdminThread’ object has no attribute ‘native_id’.

Issue #6664 [https://github.com/pgadmin-org/pgadmin4/issues/6664] - Ensure keyboard shortcut for query execution is disabled when query execution is in progress.

Version 7.5

Release date: 2023-07-27

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.4.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.3

New features

Issue #6369 [https://github.com/pgadmin-org/pgadmin4/issues/6369] - Added support to detach partitions using concurrently and finalize.

Issue #6374 [https://github.com/pgadmin-org/pgadmin4/issues/6374] - Added all supported index storage parameters while creating an index.

Issue #6416 [https://github.com/pgadmin-org/pgadmin4/issues/6416] - Added new/missing parameters to pg_dumpall (Backup Server).

Issue #6417 [https://github.com/pgadmin-org/pgadmin4/issues/6417] - Added new/missing parameters to pg_dump (Backup Objects).

Issue #6562 [https://github.com/pgadmin-org/pgadmin4/issues/6562] - Added new/missing parameters to pg_restore.

Housekeeping

Issue #6295 [https://github.com/pgadmin-org/pgadmin4/issues/6295] - Remove Bootstrap and jQuery from authentication pages and rewrite them in ReactJS.

Issue #6323 [https://github.com/pgadmin-org/pgadmin4/issues/6323] - Enable cluster deployment with gp3 volume for AWS & BigAnimal cloud providers.

Issue #6423 [https://github.com/pgadmin-org/pgadmin4/issues/6423] - Clarify the LICENSE file to indicate that it is the PostgreSQL Licence.

Issue #6532 [https://github.com/pgadmin-org/pgadmin4/issues/6532] - Remove unsupported PostgreSQL versions from the container.

Bug fixes

Issue #6163 [https://github.com/pgadmin-org/pgadmin4/issues/6163] - Fix an issue where queries can’t complete execution.

Issue #6165 [https://github.com/pgadmin-org/pgadmin4/issues/6165] - Fixed an issue where Import Export not working when using pgpassfile.

Issue #6317 [https://github.com/pgadmin-org/pgadmin4/issues/6317] - Fix an issue where queries longer than 1 minute get stuck - Container 7.1

Issue #6356 [https://github.com/pgadmin-org/pgadmin4/issues/6356] - Fix an issue where queries get stuck with auto-completion enabled.

Issue #6364 [https://github.com/pgadmin-org/pgadmin4/issues/6364] - Fixed Query Tool/ PSQL tool tab title not getting updated on database rename.

Issue #6406 [https://github.com/pgadmin-org/pgadmin4/issues/6406] - Ensure user gets proper error if incorrect credentials are entered while authenticating AWS.

Issue #6489 [https://github.com/pgadmin-org/pgadmin4/issues/6489] - Fix an issue where the edit server fails in desktop mode if the server password is not stored.

Issue #6499 [https://github.com/pgadmin-org/pgadmin4/issues/6499] - Ensure that Backup, Restore, and Maintenance should work properly when pgpass file is used.

Issue #6501 [https://github.com/pgadmin-org/pgadmin4/issues/6501] - Fix the query tool auto-complete issue on the server reconnection.

Issue #6502 [https://github.com/pgadmin-org/pgadmin4/issues/6502] - Fix the query tool restore connection issue.

Issue #6509 [https://github.com/pgadmin-org/pgadmin4/issues/6509] - Fix the reconnecton issue if the PostgreSQL server is restarted from the backend.

Issue #6514 [https://github.com/pgadmin-org/pgadmin4/issues/6514] - Fix the connection and stability issues since v7, possibly related to background schema changes.

Issue #6515 [https://github.com/pgadmin-org/pgadmin4/issues/6515] - Fixed an issue where the query tool is unable to execute a query on Postgres 10 and below versions.

Issue #6524 [https://github.com/pgadmin-org/pgadmin4/issues/6524] - Fix the lost connection error in v7.4.

Issue #6531 [https://github.com/pgadmin-org/pgadmin4/issues/6531] - Fixed an issue where pgAdmin failed to setup role with hyphens in name.

Issue #6537 [https://github.com/pgadmin-org/pgadmin4/issues/6537] - Fixed an issue where filters are not working and query history shows empty queries.

Issue #6544 [https://github.com/pgadmin-org/pgadmin4/issues/6544] - Fix an issue where adding a sub-folder inside a folder is not working as expected in File Manager.

Issue #6556 [https://github.com/pgadmin-org/pgadmin4/issues/6556] - Fix an error ‘list’ object has no attribute ‘strip’ while attempting to populate auto-complete manually the first time.

Issue #6558 [https://github.com/pgadmin-org/pgadmin4/issues/6558] - Fixed an issue where ERD Tool can’t load the saved pgerd file from Shared Storage.

Issue #6582 [https://github.com/pgadmin-org/pgadmin4/issues/6582] - Fix an issue where inserting more than 10 rows does not work correctly in View Data; only parts end up in the table.

Version 7.4

Release date: 2023-06-29

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.3.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.3

New features

Issue #6367 [https://github.com/pgadmin-org/pgadmin4/issues/6367] - Added support to drop databases using the ‘WITH (FORCE)’ option.

Issue #6368 [https://github.com/pgadmin-org/pgadmin4/issues/6368] - Add “[ NULLS [ NOT ] DISTINCT ]” option while creating an Index.

Issue #6370 [https://github.com/pgadmin-org/pgadmin4/issues/6370] - Added ‘OR REPLACE’ clause while creating trigger.

Issue #6371 [https://github.com/pgadmin-org/pgadmin4/issues/6371] - Added security_invoker option while creating a view.

Housekeeping

Bug fixes

Issue #5306 [https://github.com/pgadmin-org/pgadmin4/issues/5306] - Fix an issue where object explorer tree crashes occasionally.

Issue #6065 [https://github.com/pgadmin-org/pgadmin4/issues/6065] - Ensure that query tool shortcuts are working properly.

Issue #6258 [https://github.com/pgadmin-org/pgadmin4/issues/6258] - Add Password exec command and Expiration time to server export JSON and also allow them to import.

Issue #6266 [https://github.com/pgadmin-org/pgadmin4/issues/6266] - When opening pgAdmin the layout should be auto reset if it is corrupted. Reset layout menu should work if layout is corrupted while using pgAdmin.

Issue #6291 [https://github.com/pgadmin-org/pgadmin4/issues/6291] - Fix an issue where loading more rows indicator will not disappear if connection is lost.

Issue #6340 [https://github.com/pgadmin-org/pgadmin4/issues/6340] - Fix an encoding error when connecting through Pgbouncer.

Issue #6352 [https://github.com/pgadmin-org/pgadmin4/issues/6352] - Fix an issue where explain plan details is showing HTML escaped characters.

Issue #6354 [https://github.com/pgadmin-org/pgadmin4/issues/6354] - Fixed an issue where queries with temporary tables in the same transaction is not working.

Issue #6363 [https://github.com/pgadmin-org/pgadmin4/issues/6363] - Fixed an issue where preview images for themes were not loading.

Issue #6420 [https://github.com/pgadmin-org/pgadmin4/issues/6420] - Fix raise notice from func/proc or code blocks are no longer displayed live.

Issue #6431 [https://github.com/pgadmin-org/pgadmin4/issues/6431] - Fix an issue where PSQL is not working if the database name have quotes or double quotes.

Issue #6435 [https://github.com/pgadmin-org/pgadmin4/issues/6435] - Fix an issue where all the menus are enabled when pgAdmin is opened and no object is selected in the object explorer.

Version 7.3

Release date: 2023-06-06

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.2.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.3

New features

Housekeeping

Bug fixes

Issue #6136 [https://github.com/pgadmin-org/pgadmin4/issues/6136] - Fix an issue where editing a database object de-selects it on the browser tree.

Issue #6341 [https://github.com/pgadmin-org/pgadmin4/issues/6341] - Ensure that SSH Tunnel should work properly after upgrading to 7.2 from 7.1

Issue #6342 [https://github.com/pgadmin-org/pgadmin4/issues/6342] - Fixed an issue where pgadmin is unable to take the defined role.

Issue #6345 [https://github.com/pgadmin-org/pgadmin4/issues/6345] - Fixed an issue where Foreign Key with 3 or more columns are shown in the wrong order in SQL and Properties.

Issue #6353 [https://github.com/pgadmin-org/pgadmin4/issues/6353] - Ensure that the master password dialog should not be visible if the parameter MASTER_PASSWORD_REQUIRED is set to False.

Version 7.2

Release date: 2023-06-01

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.1.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.2

New features

Issue #3831 [https://github.com/pgadmin-org/pgadmin4/issues/3831] - Add Option to only show active connections on Dashboard.

Issue #4769 [https://github.com/pgadmin-org/pgadmin4/issues/4769] - Allow pgAdmin to retrive master password from external script/program.

Issue #5048 [https://github.com/pgadmin-org/pgadmin4/issues/5048] - Add an option to hide/show empty object collection nodes.

Issue #5123 [https://github.com/pgadmin-org/pgadmin4/issues/5123] - Added support to use standard OS secret store to save server/ssh tunnel passwords instead of master password in pgAdmin desktop mode.

Issue #5868 [https://github.com/pgadmin-org/pgadmin4/issues/5868] - Implement new PostgreSQL 15 features in publication dialog and SQL.

Housekeeping

Bug fixes

Issue #5789 [https://github.com/pgadmin-org/pgadmin4/issues/5789] - Fixed an issue where Foreign Key columns are shown in the wrong order in SQL and Properties.

Issue #5817 [https://github.com/pgadmin-org/pgadmin4/issues/5817] - Ensure that a new row should be added on top in the User Management dialog.

Issue #5926 [https://github.com/pgadmin-org/pgadmin4/issues/5926] - Fixed an issue where REVOKE ALL DDL in table SQL was added only for one role.

Issue #6003 [https://github.com/pgadmin-org/pgadmin4/issues/6003] - Indicate the user if all the server’s children nodes are hidden from the preferences setting.

Issue #6026 [https://github.com/pgadmin-org/pgadmin4/issues/6026] - Tools menu should be toggled for “pause replay of wal” and “resume replay of wal”.

Issue #6043 [https://github.com/pgadmin-org/pgadmin4/issues/6043] - Make the ‘Connect to server’ dialog a modal dialog.

Issue #6080 [https://github.com/pgadmin-org/pgadmin4/issues/6080] - pgAdmin icon not showing on taskbar on Windows 10.

Issue #6127 [https://github.com/pgadmin-org/pgadmin4/issues/6127] - Fixed an issue where properties were not visible for FTS Parsers, FTS Templates, MViews, and Rules in Catalog objects.

Issue #6147 [https://github.com/pgadmin-org/pgadmin4/issues/6147] - Heartbeat is getting logged, though no server is connected in pgAdmin.

Issue #6204 [https://github.com/pgadmin-org/pgadmin4/issues/6204] - Ensure that name can’t be empty in edit mode for Primary Key and Index.

Issue #6221 [https://github.com/pgadmin-org/pgadmin4/issues/6221] - Fix circular reference error for the multirange data types in the query tool.

Issue #6247 [https://github.com/pgadmin-org/pgadmin4/issues/6247] - Fixed an issue where PSQL tool prompts for password if using password exec command.

Issue #6253 [https://github.com/pgadmin-org/pgadmin4/issues/6253] - Fix an issue in the register server when setting the role, an arbitrary SQL query can be fired.

Issue #6267 [https://github.com/pgadmin-org/pgadmin4/issues/6267] - Ensure the user is able to log in if the specified OAUTH2_USERNAME_CLAIM is present in the OAuth2 profile.

Issue #6278 [https://github.com/pgadmin-org/pgadmin4/issues/6278] - Use dependent instead of dependant in the message.

Issue #6279 [https://github.com/pgadmin-org/pgadmin4/issues/6279] - Fix incorrect number of foreign tables displayed. Show column comments in RE-SQL.

Issue #6280 [https://github.com/pgadmin-org/pgadmin4/issues/6280] - View SQL tab not quoting column comments.

Issue #6281 [https://github.com/pgadmin-org/pgadmin4/issues/6281] - VarChar Field Sizes are missing from Query’s Grid header.

Issue #6331 [https://github.com/pgadmin-org/pgadmin4/issues/6331] - Separate multiple Blocking PIDs with delimiter on Dashboard.

Version 7.1

Release date: 2023-05-04

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v7.0.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.2

New features

Issue #2078 [https://github.com/pgadmin-org/pgadmin4/issues/2078] - Show object breadcrumbs path along with its comment on object hover.

Issue #3275 [https://github.com/pgadmin-org/pgadmin4/issues/3275] - Allow on demand record count setting to be changed per user using preferences.

Issue #3316 [https://github.com/pgadmin-org/pgadmin4/issues/3316] - Added support to show statistics for materialized views.

Issue #3318 [https://github.com/pgadmin-org/pgadmin4/issues/3318] - Added support to create an unnamed index.

Housekeeping

Bug fixes

Issue #5044 [https://github.com/pgadmin-org/pgadmin4/issues/5044] - Fixed an issue where query tool hangs for some time when multiple columns are selected to open geometry viewer.

Issue #5777 [https://github.com/pgadmin-org/pgadmin4/issues/5777] - Fixed an issue where the browser tree state is not remembered when reopening pgAdmin.

Issue #5820 [https://github.com/pgadmin-org/pgadmin4/issues/5820] - Fixed an issue where collation was set to none if we remove it while creating partitioned table.

Issue #5922 [https://github.com/pgadmin-org/pgadmin4/issues/5922] - Ensure that when pasting a row in query tool grid, default value is used for autogenerated/serial columns.

Issue #6059 [https://github.com/pgadmin-org/pgadmin4/issues/6059] - Show proper message if the debugger is stopped by the user.

Issue #6075 [https://github.com/pgadmin-org/pgadmin4/issues/6075] - Ensure that the save button is enabled when registering a new server fails due to an API error.

Issue #6077 [https://github.com/pgadmin-org/pgadmin4/issues/6077] - The search object, query tool, and psql tool menu should not be displayed for pgAgent.

Issue #6120 [https://github.com/pgadmin-org/pgadmin4/issues/6120] - Fixed error occurring while logging out from pgAdmin keeping a query tool opened.

Issue #6128 [https://github.com/pgadmin-org/pgadmin4/issues/6128] - Fix a SQL error occurring on roles dependents SQL.

Issue #6130 [https://github.com/pgadmin-org/pgadmin4/issues/6130] - Ensure to quote the primary key value if needed while deleting rows from the table.

Issue #6137 [https://github.com/pgadmin-org/pgadmin4/issues/6137] - Fixed error occurring while dumping the servers from CLI.

Issue #6138 [https://github.com/pgadmin-org/pgadmin4/issues/6138] - Throw an appropriate error when a table for which View/Edit data is open, is deleted, and query is executed.

Issue #6151 [https://github.com/pgadmin-org/pgadmin4/issues/6151] - Ensure that internal users are able to login when auth sources are [ldap, internal].

Issue #6158 [https://github.com/pgadmin-org/pgadmin4/issues/6158] - Fixed an issue with the properties tab not getting updated if the user updates the selected node.

Issue #6159 [https://github.com/pgadmin-org/pgadmin4/issues/6159] - Ensure that the ERD tool should work with the external database after moving to psycopg3.

Issue #6180 [https://github.com/pgadmin-org/pgadmin4/issues/6180] - Fixed an issue where PSQL is not working if the PGUSER env variable is set and service file is used for server connection details.

Issue #6183 [https://github.com/pgadmin-org/pgadmin4/issues/6183] - Mac crash when you press Command-Shift-C.

Issue #6189 [https://github.com/pgadmin-org/pgadmin4/issues/6189] - Fix an issue in View SQL when column level privileges are set with multiple roles.

Issue #6191 [https://github.com/pgadmin-org/pgadmin4/issues/6191] - Fixed an issue where Reset Password is not working after upgrading to latest flask-security-too.

Issue #6234 [https://github.com/pgadmin-org/pgadmin4/issues/6234] - Usernames/roles with special character are not double quoted when assigning privileges.

Version 7.0

Release date: 2023-04-13

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.21.

Supported Database Servers

PostgreSQL: 11, 12, 13, 14 and 15

EDB Advanced Server: 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.2

New features

Issue #3298 [https://github.com/pgadmin-org/pgadmin4/issues/3298] - Auto expand row edit form when a new row is added for Primary Key, Foreign Key, Unique Constraint and Exclusion Constraint.

Issue #5014 [https://github.com/pgadmin-org/pgadmin4/issues/5014] - Added support for mounting shared storage in server mode.

Issue #5022 [https://github.com/pgadmin-org/pgadmin4/issues/5022] - Add a note on top of keyboard shortcuts preferences to show the Accesskey of the browser.

Issue #5750 [https://github.com/pgadmin-org/pgadmin4/issues/5750] - Added capability to deploy PostgreSQL servers on Google Cloud.

Issue #5805 [https://github.com/pgadmin-org/pgadmin4/issues/5805] - Added support of BigAnimal v3 API.

Issue #5854 [https://github.com/pgadmin-org/pgadmin4/issues/5854] - On pressing Ctrl+C on a tree object, copy the fully qualified name to clipboard.

Issue #5855 [https://github.com/pgadmin-org/pgadmin4/issues/5855] - Added option to create unique constraint with nulls not distinct.

Housekeeping

Issue #4734 [https://github.com/pgadmin-org/pgadmin4/issues/4734] - Rename the “Properties…” context menu option of the objects to “Edit Object…” and the “Browser” tree to “Object Explorer”.

Issue #5011 [https://github.com/pgadmin-org/pgadmin4/issues/5011] - Upgrade from psycopg2 to psycopg3.

Issue #5701 [https://github.com/pgadmin-org/pgadmin4/issues/5701] - Remove Bootstrap and jQuery usage.

Issue #5830 [https://github.com/pgadmin-org/pgadmin4/issues/5830] - Add .ts and .tsx files under linter and fix linter issues.

Issue #5901 [https://github.com/pgadmin-org/pgadmin4/issues/5901] - Update SQLAlchemy, Flask, Flask-SQLAlchemy, and other packages to current versions.

Bug fixes

Issue #4423 [https://github.com/pgadmin-org/pgadmin4/issues/4423] - Fixed an issue where list of tables is not displayed in a SQL_ASCII database.

Issue #4784 [https://github.com/pgadmin-org/pgadmin4/issues/4784] - Handle errors occurring during decoding UTF-8 encoded query result data which contains ascii characters.

Issue #4884 [https://github.com/pgadmin-org/pgadmin4/issues/4884] - Fixed an issue where it is not possible to import csv data to tables having columns with german umlauts in their name.

Issue #4891 [https://github.com/pgadmin-org/pgadmin4/issues/4891] - Fixed ‘rawunicodeescape’ codec can’t decode issue in a SQL_ASCII database.

Issue #5504 [https://github.com/pgadmin-org/pgadmin4/issues/5504] - Fixed an issue where incorrect view of text[] fields in query and table results when use other then UTF8 (win1251) codepage and symbols.

Issue #5735 [https://github.com/pgadmin-org/pgadmin4/issues/5735] - Show appropriate error message when master password is not set instead of ‘Crypt key missing’.

Issue #5775 [https://github.com/pgadmin-org/pgadmin4/issues/5775] - Display the ‘No menu available for this object’ message if the selected tree node does not have any options.

Issue #5824 [https://github.com/pgadmin-org/pgadmin4/issues/5824] - Ensure that the user’s storage directory is created when the users are created, as well as for those users whose directories have not yet been created.

Issue #5833 [https://github.com/pgadmin-org/pgadmin4/issues/5833] - Fixed an issue where user MFA entry was not getting delete after deleting a user.

Issue #5834 [https://github.com/pgadmin-org/pgadmin4/issues/5834] - Fixed issue where pgAgent jobs were not getting dropped from properties tab.

Issue #5874 [https://github.com/pgadmin-org/pgadmin4/issues/5874] - Make “using” and “with check” fields a textarea in the RLS policy.

Issue #5894 [https://github.com/pgadmin-org/pgadmin4/issues/5894] - Use fetch instead of axios to close connections in SQLEditor, ERD, Schema Diff and Debugger to ensure it completes.

Issue #5904 [https://github.com/pgadmin-org/pgadmin4/issues/5904] - Fixed an issue where the count query should not be triggered when the estimated count is less than zero.

Issue #5907 [https://github.com/pgadmin-org/pgadmin4/issues/5907] - Validate user inputs provided in configuration files before starting pgadmin server.

Issue #5916 [https://github.com/pgadmin-org/pgadmin4/issues/5916] - Fix an issue in search objects where objects were unable to locate occasionally.

Issue #5919 [https://github.com/pgadmin-org/pgadmin4/issues/5919] - While restoring the database connections due to lost server connection, ensure that the databases which were previously connected are only reconnected.

Issue #5921 [https://github.com/pgadmin-org/pgadmin4/issues/5921] - Ensure that when pasting rows the rows are added right below the selected rows for copying.

Issue #5929 [https://github.com/pgadmin-org/pgadmin4/issues/5929] - Dashboard graph Y-axis width should increase with label.

Issue #5934 [https://github.com/pgadmin-org/pgadmin4/issues/5934] - Ensure that default values are set only for insert statement if user does not provide any values, in case of updating existing values to blank it should be set to null.

Issue #5941 [https://github.com/pgadmin-org/pgadmin4/issues/5941] - Fixed an issue where migration on external database is not working.

Issue #5943 [https://github.com/pgadmin-org/pgadmin4/issues/5943] - Use http for SVG namespace URLs which were changed to https for SonarQube fixes.

Issue #5952 [https://github.com/pgadmin-org/pgadmin4/issues/5952] - Ensure that the schema diff tool should not allow comparison between Postgres Server and EDB Postgres Advanced Server.

Issue #5953 [https://github.com/pgadmin-org/pgadmin4/issues/5953] - Fixed error while executing continue in debugging session after some time of debug execution.

Issue #5955 [https://github.com/pgadmin-org/pgadmin4/issues/5955] - Fix an issue where query tool is stuck when running query after discarding changed data.

Issue #5958 [https://github.com/pgadmin-org/pgadmin4/issues/5958] - Fix an issue where new dashboard graphs are partially following theme colors.

Issue #5959 [https://github.com/pgadmin-org/pgadmin4/issues/5959] - Fix an issue where Backup, Restore, and Maintenance not working if connection timeout is set in the server dialog.

Issue #6018 [https://github.com/pgadmin-org/pgadmin4/issues/6018] - Change the foreground color of the code mirror text for Dark Theme.

Issue #6093 [https://github.com/pgadmin-org/pgadmin4/issues/6093] - Fix the dependents SQL of Roles which is throwing a type casting error on PostgreSQL 15.

Issue #6100 [https://github.com/pgadmin-org/pgadmin4/issues/6100] - Fixed the LDAP authentication issue for the simultaneous login attempts.(CVE-2023-1907)

Issue #6109 [https://github.com/pgadmin-org/pgadmin4/issues/6109] - Fixed asyncio random task error messages in Query tool.

Issue #6122 [https://github.com/pgadmin-org/pgadmin4/issues/6122] - Fixed CSV export from Query Tool results does not include all columns for multiple CTEs.

Version 6.21

Release date: 2023-03-09

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.20.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.1

New features

Issue #5832 [https://github.com/pgadmin-org/pgadmin4/issues/5832] - Allow changing cardinality notation in ERD to use Chen notation.

Issue #5842 [https://github.com/pgadmin-org/pgadmin4/issues/5842] - Add additional logging for successful logins and user creation.

Housekeeping

Bug fixes

Issue #5269 [https://github.com/pgadmin-org/pgadmin4/issues/5269] - Ensure that the schema diff tool should pick up the change in the column grants.

Issue #5685 [https://github.com/pgadmin-org/pgadmin4/issues/5685] - Ensure that Grant column permission to a view is visible in the SQL tab.

Issue #5747 [https://github.com/pgadmin-org/pgadmin4/issues/5747] - Ensure that content on the DDL comparison panel should get refreshed on selecting the object using the up and down arrow keys.

Issue #5756 [https://github.com/pgadmin-org/pgadmin4/issues/5756] - Fix for query tool prompting for unsaved changes even if no changes have been made.

Issue #5758 [https://github.com/pgadmin-org/pgadmin4/issues/5758] - Fixed an issue where lock layout menu was not in sync with preferences.

Issue #5760 [https://github.com/pgadmin-org/pgadmin4/issues/5760] - Fixed an issue where query was not pasted to editor after trojan source warning.

Issue #5764 [https://github.com/pgadmin-org/pgadmin4/issues/5764] - Fix an issue where the maintenance dialog for Materialized View gives an error.

Issue #5773 [https://github.com/pgadmin-org/pgadmin4/issues/5773] - Fixed an issue where Clear Saved Password should be disabled if the password is already cleared.

Issue #5790 [https://github.com/pgadmin-org/pgadmin4/issues/5790] - Fixed an issue where the user can’t create trigger AFTER UPDATE OF.

Issue #5803 [https://github.com/pgadmin-org/pgadmin4/issues/5803] - Fix an issue where query tool is stripping spaces in grid cell.

Issue #5810 [https://github.com/pgadmin-org/pgadmin4/issues/5810] - Fix an issue where sequence owner is remove on sequence edit.

Issue #5822 [https://github.com/pgadmin-org/pgadmin4/issues/5822] - Do not allow to save invalid JSON in query tool JSON editor.

Issue #5847 [https://github.com/pgadmin-org/pgadmin4/issues/5847] - Fixed an issue where pgAdmin failed to connect when the Postgres password included special characters.

Issue #5870 [https://github.com/pgadmin-org/pgadmin4/issues/5870] - Ensure that the database migration does not fail with a NoSuchTableError exception.

Issue #5872 [https://github.com/pgadmin-org/pgadmin4/issues/5872] - Handle MERGE operation in query tool explain introduced in PostgreSQL 15.

Issue #5889 [https://github.com/pgadmin-org/pgadmin4/issues/5889] - Fixed an issue where the database server is not connected using a service file.

Issue #5909 [https://github.com/pgadmin-org/pgadmin4/issues/5909] - Fixed an issue where the file name in the query tool tab was not changing if another file is opened.

Version 6.20

Release date: 2023-02-09

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.19.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

Bundled PostgreSQL Utilities

psql, pg_dump, pg_dumpall, pg_restore: 15.1

New features

Issue #4728 [https://github.com/pgadmin-org/pgadmin4/issues/4728] - Added support for setting PostgreSQL connection parameters.

Housekeeping

Issue #4320 [https://github.com/pgadmin-org/pgadmin4/issues/4320] - Added bundled PG utilities in the release note.

Issue #5525 [https://github.com/pgadmin-org/pgadmin4/issues/5525] - Upgrade Flask-Migrate to 4.x.

Issue #5723 [https://github.com/pgadmin-org/pgadmin4/issues/5723] - Improve performance by removing signal-based zoom-in, zoom-out, etc functionality from the runtime environment.

Issue #5794 [https://github.com/pgadmin-org/pgadmin4/issues/5794] - Use uplot for Dashboard graphs to reduce CPU usage.

Bug fixes

Issue #5532 [https://github.com/pgadmin-org/pgadmin4/issues/5532] - Fixed an issue where the client cert location was not stored on the shared servers.

Issue #5567 [https://github.com/pgadmin-org/pgadmin4/issues/5567] - Fix orphan database connections resulting in an inability to connect to databases.

Issue #5702 [https://github.com/pgadmin-org/pgadmin4/issues/5702] - Fix an issue where role is used as username for newly added servers when opening query tool.

Issue #5705 [https://github.com/pgadmin-org/pgadmin4/issues/5705] - Ensure that all parts of the application recommend and enforce the same length of passwords.

Issue #5732 [https://github.com/pgadmin-org/pgadmin4/issues/5732] - Fixed an issue where Kerberos authentication to the server is not imported/exported.

Issue #5733 [https://github.com/pgadmin-org/pgadmin4/issues/5733] - Ensure that the system columns should not visible in the import/export data.

Issue #5746 [https://github.com/pgadmin-org/pgadmin4/issues/5746] - Increase the length of the value column of the setting table.

Issue #5748 [https://github.com/pgadmin-org/pgadmin4/issues/5748] - Fixed console error while attaching the partition.

Issue #5751 [https://github.com/pgadmin-org/pgadmin4/issues/5751] - Fix failing import servers CLI due to vulnerability fix.

Issue #5761 [https://github.com/pgadmin-org/pgadmin4/issues/5761] - Fix an issue where drag and drop object names is not working.

Issue #5763 [https://github.com/pgadmin-org/pgadmin4/issues/5763] - Ensure that keyboard hotkey to open query tool and search object should work properly.

Issue #5781 [https://github.com/pgadmin-org/pgadmin4/issues/5781] - Fixed an issue where Query history is not getting loaded with external database.

Issue #5796 [https://github.com/pgadmin-org/pgadmin4/issues/5796] - Ensure nested menu items are shown in quick search result.

Version 6.19

Release date: 2023-01-17

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.18.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

New features

Issue #5569 [https://github.com/pgadmin-org/pgadmin4/issues/5569] - Added support of AWS provider for BigAnimal cloud deployment.

Housekeeping

Issue #5563 [https://github.com/pgadmin-org/pgadmin4/issues/5563] - Allow YouTube video demo links to be added to appropriate pgAdmin documentation.

Issue #5615 [https://github.com/pgadmin-org/pgadmin4/issues/5615] - Rewrite pgAdmin main menu bar to use React.

Bug fixes

Issue #5487 [https://github.com/pgadmin-org/pgadmin4/issues/5487] - Fixed an issue where incorrect password used with shared server.

Issue #5541 [https://github.com/pgadmin-org/pgadmin4/issues/5541] - Ensure the browser tree does not freeze while rendering 10k+ nodes/objects.

Issue #5542 [https://github.com/pgadmin-org/pgadmin4/issues/5542] - Fixed an issue updating the schema node de-select the node in the tree if only one schema is present in the collection node.

Issue #5559 [https://github.com/pgadmin-org/pgadmin4/issues/5559] - Fixed tree flickering issue on scroll.

Issue #5577 [https://github.com/pgadmin-org/pgadmin4/issues/5577] - Fixed an issue where the default value of string for columns should wrap in quotes in the create script.

Issue #5586 [https://github.com/pgadmin-org/pgadmin4/issues/5586] - Fix the webserver and internal authentication setup issue.

Issue #5613 [https://github.com/pgadmin-org/pgadmin4/issues/5613] - Ensure the appbundle has correct permissions so that pgAdmin can be accessed by users other than owner.

Issue #5622 [https://github.com/pgadmin-org/pgadmin4/issues/5622] - Fixed an issue where the ignore owner flag is not working for some cases in the Schema Diff.

Issue #5626 [https://github.com/pgadmin-org/pgadmin4/issues/5626] - Fixed an issue where actions performed on the tree node should update the context menu options.

Issue #5627 [https://github.com/pgadmin-org/pgadmin4/issues/5627] - Ensure that the submenus under the trigger’s context menu are enabled/disabled correctly.

Issue #5640 [https://github.com/pgadmin-org/pgadmin4/issues/5640] - Update boto3 & botocore to the latest version.

Issue #5641 [https://github.com/pgadmin-org/pgadmin4/issues/5641] - Fixed an issue where Geometry viewer does not show popup when columns are less than 3.

Issue #5647 [https://github.com/pgadmin-org/pgadmin4/issues/5647] - Fixed an issue where row count notification was disappearing automatically.

Issue #5661 [https://github.com/pgadmin-org/pgadmin4/issues/5661] - Fix select dropdown border issue.

Issue #5666 [https://github.com/pgadmin-org/pgadmin4/issues/5666] - Fixed a missing “jwks_uri” in metadata error that occurred when logging in with an oAuth2 provider like Azure or Google.

Issue #5675 [https://github.com/pgadmin-org/pgadmin4/issues/5675] - Fixed an issue where rename panel was losing focus when trying to add name if input box is empty.

Issue #5734 [https://github.com/pgadmin-org/pgadmin4/issues/5734] - Ensure that the authenticated users can’t access each other’s directories and files by providing relative paths.(CVE-2023-0241)

Version 6.18

Release date: 2022-12-19

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.17.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

New features

Issue #4088 [https://github.com/pgadmin-org/pgadmin4/issues/4088] - Enhancements to the ERD when selecting a relationship.

Issue #5503 [https://github.com/pgadmin-org/pgadmin4/issues/5503] - Added native menu support in desktop mode.

Housekeeping

Bug fixes

Issue #5453 [https://github.com/pgadmin-org/pgadmin4/issues/5453] - Fixed an issue where Transaction IDs were not found in session in the Query Tool.

Issue #5470 [https://github.com/pgadmin-org/pgadmin4/issues/5470] - Fixed an issue where tablespace was missing on partition tables in SQL.

Issue #5536 [https://github.com/pgadmin-org/pgadmin4/issues/5536] - Fixed an issue where properties tab was refreshing on tab change even if the selected node is same.

Issue #5551 [https://github.com/pgadmin-org/pgadmin4/issues/5551] - Fixed an issue with auto-complete not working as expected with double quotes.

Issue #5564 [https://github.com/pgadmin-org/pgadmin4/issues/5564] - Ensure that table statistics are sorted by size.

Issue #5598 [https://github.com/pgadmin-org/pgadmin4/issues/5598] - Fixed an issue while updating server node info removes the clear saved password menu.

Issue #5603 [https://github.com/pgadmin-org/pgadmin4/issues/5603] - Fixed an issue where master password was not set correctly with external config database.

Issue #5606 [https://github.com/pgadmin-org/pgadmin4/issues/5606] - Fixed an error in the collation create script for PG-15.

Issue #5629 [https://github.com/pgadmin-org/pgadmin4/issues/5629] - Fixed BigAnimal authentication aborted issue.

Issue #5637 [https://github.com/pgadmin-org/pgadmin4/issues/5637] - Ensure that the BigAnimal displays PG version 11-14 for Oracle compatible databases type.

Issue #5645 [https://github.com/pgadmin-org/pgadmin4/issues/5645] - Fixed a typo.

Version 6.17

Release date: 2022-12-02

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.16.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

New features

Housekeeping

Issue #5147 [https://github.com/pgadmin-org/pgadmin4/issues/5147] - Update the BigAnimal API version to V2.

Issue #5493 [https://github.com/pgadmin-org/pgadmin4/issues/5493] - Remove all traces of Backbone and Underscore.

Bug fixes

Issue #5488 [https://github.com/pgadmin-org/pgadmin4/issues/5488] - Fixed an issue where the wrong schema is displayed for a foreign key in the schema diff tool.

Issue #5495 [https://github.com/pgadmin-org/pgadmin4/issues/5495] - Ensure that the query history date format in Desktop mode matches the format of the locale of the pgadmin server.

Issue #5505 [https://github.com/pgadmin-org/pgadmin4/issues/5505] - Fixed an issue where the CSV file would not download if the CSV quote character length exceeded 1.

Issue #5513 [https://github.com/pgadmin-org/pgadmin4/issues/5513] - Ensure that DATA_DIR dependent folders/files are automatically created inside the specified DATA_DIR if they are not specified separately in the configuration file.

Issue #5539 [https://github.com/pgadmin-org/pgadmin4/issues/5539] - Improved error message to make it easier for users to understand.

Issue #5548 [https://github.com/pgadmin-org/pgadmin4/issues/5548] - Fixed an issue where editor position was wrong when editing data from result grid.

Issue #5575 [https://github.com/pgadmin-org/pgadmin4/issues/5575] - Ensure the query tool is launched successfully for the servers registered with the PostgreSQL service.

Issue #5593 [https://github.com/pgadmin-org/pgadmin4/issues/5593] - Ensure that only authorized and authenticated users can validate binary paths (CVE-2022-4223).

Version 6.16

Release date: 2022-11-18

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.15.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

New features

Issue #1832 [https://github.com/pgadmin-org/pgadmin4/issues/1832] - Added support for storing configurations of pgAdmin in an external database.

Issue #4756 [https://github.com/pgadmin-org/pgadmin4/issues/4756] - Added the ability to generate ERDs for tables.

Issue #5468 [https://github.com/pgadmin-org/pgadmin4/issues/5468] - Add the possibility to configure the Oauth2 claim which is used for the pgAdmin username.

Housekeeping

Bug fixes

Issue #2174 [https://github.com/pgadmin-org/pgadmin4/issues/2174] - Ensure that the browser tree should auto scroll to the selected node when expanding the server node.

Issue #4841 [https://github.com/pgadmin-org/pgadmin4/issues/4841] - Use SocketIO instead of REST for schema diff compare.

Issue #5066 [https://github.com/pgadmin-org/pgadmin4/issues/5066] - Ensure that users can use custom characters as CSV field separators/CSV quotes when downloading query results.

Issue #5058 [https://github.com/pgadmin-org/pgadmin4/issues/5058] - Ensure that the save button should be disabled by default on the Sort/Filter dialog in the query tool.

Issue #5098 [https://github.com/pgadmin-org/pgadmin4/issues/5098] - Fix an issue where the save button is enabled when the table properties dialog is opened.

Issue #5122 [https://github.com/pgadmin-org/pgadmin4/issues/5122] - Ensure that the spinner should be visible on the browser tree on node refresh.

Issue #5149 [https://github.com/pgadmin-org/pgadmin4/issues/5149] - Ensure the Generate ERD option is hidden if the connection to the database is not allowed.

Issue #5206 [https://github.com/pgadmin-org/pgadmin4/issues/5206] - Reposition the select dropdown when the browser is resized.

Issue #5281 [https://github.com/pgadmin-org/pgadmin4/issues/5281] - Ensure that autocomplete works properly with objects starting with double quotes.

Issue #5344 [https://github.com/pgadmin-org/pgadmin4/issues/5344] - Ensure that pgAdmin routes should have the SCRIPT_NAME prefix.

Issue #5424 [https://github.com/pgadmin-org/pgadmin4/issues/5424] - Ensure that the appropriate permissions are set on the key file before trying an SSL connection with the server in server mode.

Issue #5429 [https://github.com/pgadmin-org/pgadmin4/issues/5429] - Fixed an issue where parameters for roles were not visible.

Issue #5452 [https://github.com/pgadmin-org/pgadmin4/issues/5452] - The container deployment document should include the server.json file format.

Issue #5455 [https://github.com/pgadmin-org/pgadmin4/issues/5455] - Fixed an issue where the dependents tab wasn’t working for PG 15.

Issue #5458 [https://github.com/pgadmin-org/pgadmin4/issues/5458] - Ensure that the browser path column in the search object shows the complete path.

Issue #5463 [https://github.com/pgadmin-org/pgadmin4/issues/5463] - Fixed an issue where the result grid was not working properly while trying to edit data by hitting Enter key.

Issue #5465 [https://github.com/pgadmin-org/pgadmin4/issues/5465] - Fixed an issue where the screen was freezing while closing the wcDocker panel.

Issue #5473 [https://github.com/pgadmin-org/pgadmin4/issues/5473] - Fixed an issue where AutoComplete was not working correctly due to incorrect regex.

Issue #5475 [https://github.com/pgadmin-org/pgadmin4/issues/5475] - Fixed an issue where the ‘Confirm on close or refresh’ setting was ignored when closing the query/ERD tool opened in the new tab.

Issue #5507 [https://github.com/pgadmin-org/pgadmin4/issues/5507] - Fixed an issue where pgadmin does not respect reverse proxy any more.

Issue #5521 [https://github.com/pgadmin-org/pgadmin4/issues/5521] - Fixed SocketIO calls when pgAdmin 4 server is running from a sub directory.

Issue #5522 [https://github.com/pgadmin-org/pgadmin4/issues/5522] - Ensure that the load file paths are children of the storage directory.

Issue #5533 [https://github.com/pgadmin-org/pgadmin4/issues/5533] - Use the shared server username when opening query tool.

Issue #5535 [https://github.com/pgadmin-org/pgadmin4/issues/5535] - Fixed an issue where the ‘save_password’ column threw an error for the shared server when using an external database.

Issue #5537 [https://github.com/pgadmin-org/pgadmin4/issues/5537] - Ensure that the correct error message in ERD for permission denied should be shown.

Version 6.15

Release date: 2022-10-20

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.14.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13, 14 and 15

EDB Advanced Server: 10, 11, 12, 13, 14 and 15

New features

Issue #3491 [https://github.com/pgadmin-org/pgadmin4/issues/3491] - Added support for IAM token based authentication for AWS RDS or Azure DB.

Issue #4392 [https://github.com/pgadmin-org/pgadmin4/issues/4392] - Added support to specify the background fill color to the table nodes in the ERD tool.

Issue #4994 [https://github.com/pgadmin-org/pgadmin4/issues/4994] - Allow reordering table columns using drag and drop in ERD Tool.

Issue #4997 [https://github.com/pgadmin-org/pgadmin4/issues/4997] - Add option to generate SQL with DROP table DDL in ERD Tool.

Issue #5304 [https://github.com/pgadmin-org/pgadmin4/issues/5304] - Added high availability options to AWS deployment.

Issue #5390 [https://github.com/pgadmin-org/pgadmin4/issues/5390] - Expose the Gunicorn limit_request_line parameter in the container, with the default set to the maximum 8190.

Housekeeping

Issue #5065 [https://github.com/pgadmin-org/pgadmin4/issues/5065] - Use SocketIO instead of REST for fetching database tables data in ERD.

Issue #5293 [https://github.com/pgadmin-org/pgadmin4/issues/5293] - Ensure that the tooltips are consistent throughout the entire application.

Issue #5357 [https://github.com/pgadmin-org/pgadmin4/issues/5357] - Remove Python’s ‘Six’ package completely.

Bug fixes

Issue #5101 [https://github.com/pgadmin-org/pgadmin4/issues/5101] - Ensure consistent orderings for ACLS when comparing schemas in the schema diff.

Issue #5132 [https://github.com/pgadmin-org/pgadmin4/issues/5132] - Ensure that the result grid column should take width as pre preferences setting on first execution.

Issue #5133 [https://github.com/pgadmin-org/pgadmin4/issues/5133] - Fixed an exception occur while taking backup and SSL certificates/keys are not found in the specified path.

Issue #5145 [https://github.com/pgadmin-org/pgadmin4/issues/5145] - Fixed intermittent error shown while OAuth2 login.

Issue #5167 [https://github.com/pgadmin-org/pgadmin4/issues/5167] - Ensure that the path to the psqlrc file is correct when multiple users open the PSQL tool at the same time.

Issue #5188 [https://github.com/pgadmin-org/pgadmin4/issues/5188] - Ensure that the continue/start button should be disabled if the user stops the Debugger for the procedures.

Issue #5210 [https://github.com/pgadmin-org/pgadmin4/issues/5210] - Ensure that the query tool creates a new tab with the appropriate user when pressing Alt+Shift+Q.

Issue #5212 [https://github.com/pgadmin-org/pgadmin4/issues/5212] - Added the close button for all the notifications of the notistack.

Issue #5249 [https://github.com/pgadmin-org/pgadmin4/issues/5249] - Added the ability to display the selected text from the query tool in the find/replace box.

Issue #5261 [https://github.com/pgadmin-org/pgadmin4/issues/5261] - Ensure that the search filter should be cleared when a new row is added to the user management.

Issue #5262 [https://github.com/pgadmin-org/pgadmin4/issues/5262] - Ensure that the user management dialog should not allow the same email addresses with different letter casings when creating users.

Issue #5277 [https://github.com/pgadmin-org/pgadmin4/issues/5277] - Fixed XSS vulnerability issues.

Issue #5296 [https://github.com/pgadmin-org/pgadmin4/issues/5296] - Ensure that the scroll position should be preserved for the result set in the query tool on tab change.

Issue #5308 [https://github.com/pgadmin-org/pgadmin4/issues/5308] - Ensure that the default value for a column should be used if it is made empty.

Issue #5327 [https://github.com/pgadmin-org/pgadmin4/issues/5327] - Fixed an issue where user was unable to select privileges in Safari.

Issue #5332 [https://github.com/pgadmin-org/pgadmin4/issues/5332] - Fixed console warning shown while updating database node from browser tree.

Issue #5338 [https://github.com/pgadmin-org/pgadmin4/issues/5338] - Fixed an issue where the prompt is not visible when clicking on the ‘save results to file’ button on the large data.

Issue #5352 [https://github.com/pgadmin-org/pgadmin4/issues/5352] - Fixed error occurring while LDAP authentication for a user with multiple email attributes.

Issue #5364 [https://github.com/pgadmin-org/pgadmin4/issues/5364] - Fixed an issue where notifications disappeared quickly.

Issue #5367 [https://github.com/pgadmin-org/pgadmin4/issues/5367] - Ensure that the correct value should be returned if an exception occurs while decoding the password.

Issue #5368 [https://github.com/pgadmin-org/pgadmin4/issues/5368] - Fixed the issue while downloading the file from the file manager.

Issue #5386 [https://github.com/pgadmin-org/pgadmin4/issues/5386] - Ensure that the login form is hidden if the authentication source is OAuth2 or Kerberos.

Issue #5397 [https://github.com/pgadmin-org/pgadmin4/issues/5397] - Fixed an issue where the password recovery link was not working.

Issue #5402 [https://github.com/pgadmin-org/pgadmin4/issues/5402] - Ensure that scroll bar on browser tree should be visible on windows resize.

Issue #5405 [https://github.com/pgadmin-org/pgadmin4/issues/5405] - Fixed the cross-site scripting vulnerability.

Issue #5427 [https://github.com/pgadmin-org/pgadmin4/issues/5427] - Fixed an issue where filtered rows were not working.

Version 6.14

Release date: 2022-09-22

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.13.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13 and 14

EDB Advanced Server: 10, 11, 12, 13 and 14

New features

Housekeeping

Issue #4059 [https://github.com/pgadmin-org/pgadmin4/issues/4059] - Port schema diff to React. (RM #6133)

Issue #4060 [https://github.com/pgadmin-org/pgadmin4/issues/4060] - Remove Backgrid and Backform. (RM #6134)

Issue #5035 [https://github.com/pgadmin-org/pgadmin4/issues/5035] - Port the remaining components of the ERD Tool to React. (RM #7343)

Issue #5120 [https://github.com/pgadmin-org/pgadmin4/issues/5120] - Updated keyboard shortcut documentation. (RM #7446)

Issue #5260 [https://github.com/pgadmin-org/pgadmin4/issues/5260] - Remove Alertify from pgAdmin completely. (RM #7619)

Issue #5263 [https://github.com/pgadmin-org/pgadmin4/issues/5263] - Port search object dialog to React. (RM #7622)

Bug fixes

Issue #5144 [https://github.com/pgadmin-org/pgadmin4/issues/5144] - Ensure that if BigAnimal authentication is aborted, API calls should be stopped. (RM #7472)

Issue #5209 [https://github.com/pgadmin-org/pgadmin4/issues/5209] - Fixed an issue where pgAdmin failed to start due to bin path migration. (RM #7557)

Issue #5230 [https://github.com/pgadmin-org/pgadmin4/issues/5230] - Fixed an issue where backup does not work due to parameter ‘preexec_fn’ no longer being supported. (RM #7580)

Issue #5250 [https://github.com/pgadmin-org/pgadmin4/issues/5250] - Ensure that the browser tree should be refreshed after changing the ownership. (RM #7607)

Issue #5274 [https://github.com/pgadmin-org/pgadmin4/issues/5274] - Fixed the error message displayed when clicking the cloud server for which deployment is in progress. (RM #7636)

Issue #5275 [https://github.com/pgadmin-org/pgadmin4/issues/5275] - Fixed an issue where the wrong SQL displayed in difference if the user create an RLS policy on the table without a column. (RM #7637)

Issue #5282 [https://github.com/pgadmin-org/pgadmin4/issues/5282] - Ensure that the dump servers functionality works from setup.py. (RM #7644)

Issue #5284 [https://github.com/pgadmin-org/pgadmin4/issues/5284] - Ensure that the Import/Export server menu option is visible. (RM #7646)

Issue #5286 [https://github.com/pgadmin-org/pgadmin4/issues/5286] - Fixed API test case for change password in the server mode. (RM #7648)

Issue #5287 [https://github.com/pgadmin-org/pgadmin4/issues/5287] - Fixed an issue with the non-visibility of columns added prior to import/export data. (RM #7649)

Issue #5292 [https://github.com/pgadmin-org/pgadmin4/issues/5292] - Fixed an issue where textarea of the JSON Editor does not resize with dialog. (RM #7656)

Issue #5299 [https://github.com/pgadmin-org/pgadmin4/issues/5299] - Fixed ModuleNotFoundError when running setup.py to load/dump servers. (RM #7663)

Issue #5323 [https://github.com/pgadmin-org/pgadmin4/issues/5323] - Replace the language selection ‘Brazilian’ with ‘Portuguese (Brazilian). (RM #7693)

Issue #5325 [https://github.com/pgadmin-org/pgadmin4/issues/5325] - Fixed an issue where server names with special characters are not displayed correctly in the process tab. (RM #7695)

Issue #5333 [https://github.com/pgadmin-org/pgadmin4/issues/5333] - Fixed an issue where ERD throws an error if variable is added to the column. (RM #7709)

Issue #5342 [https://github.com/pgadmin-org/pgadmin4/issues/5342] - Fixed an error while saving changes to the ERD table.

Issue #5343 [https://github.com/pgadmin-org/pgadmin4/issues/5343] - Fixes a redirect vulnerability when the user opens the pgAdmin URL.

Version 6.13

Release date: 2022-08-25

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.12.

Supported Database Servers

PostgreSQL: 10, 11, 12, 13 and 14

EDB Advanced Server: 10, 11, 12, 13 and 14

New features

Issue #3709 [https://redmine.postgresql.org/issues/3709] - Added support to show all background processes in separate panel.

Issue #7387 [https://redmine.postgresql.org/issues/7387] - Added support to create triggers from existing trigger functions in EPAS.

Housekeeping

Issue #7344 [https://redmine.postgresql.org/issues/7344] - Port Role Reassign dialog to React.

Issue #7345 [https://redmine.postgresql.org/issues/7345] - Port User Management dialog to React.

Issue #7404 [https://redmine.postgresql.org/issues/7404] - Port process watcher to React.

Issue #7462 [https://redmine.postgresql.org/issues/7462] - Remove the SQL files for the unsupported versions of the database server.

Issue #7567 [https://redmine.postgresql.org/issues/7567] - Port About dialog to React.

Issue #7568 [https://redmine.postgresql.org/issues/7568] - Port change user password and 2FA dialog to React.

Issue #7590 [https://redmine.postgresql.org/issues/7590] - Port change ownership dialog to React.

Issue #7595 [https://redmine.postgresql.org/issues/7595] - Update the container base image to Alpine 3.16 (with Python 3.10.5).

Issue #7602 [https://redmine.postgresql.org/issues/7602] - Fixed improper parsing of HTTP requests in Pallets Werkzeug v2.1.0 and below (CVE-2022-29361).

Bug fixes

Issue #7452 [https://redmine.postgresql.org/issues/7452] - Ensure that an error is thrown if clipboard access is not provided and change the copy rows shortcut.

Issue #7468 [https://redmine.postgresql.org/issues/7468] - Fixed an issue where the History tab is getting blank and showing an error after some queries are executed.

Issue #7481 [https://redmine.postgresql.org/issues/7481] - Fixed an issue where OWNED BY was incorrectly set to NONE when adding user privileges on the sequence.

Issue #7497 [https://redmine.postgresql.org/issues/7497] - Fixed an issue with the error message being displayed at the right place for Azure deployments.

Issue #7521 [https://redmine.postgresql.org/issues/7521] - Fixed an issue where the Query Editor loses focus when saving a query (Alt+s).

Issue #7527 [https://redmine.postgresql.org/issues/7527] - Fixed API test cases for Postgres 14.4.

Issue #7540 [https://redmine.postgresql.org/issues/7540] - Ensure that rename panel should work on view/edit panels.

Issue #7563 [https://redmine.postgresql.org/issues/7563] - Fixed an issue where autocomplete is not working after clearing the query editor.

Issue #7573 [https://redmine.postgresql.org/issues/7573] - Ensure that autocomplete does not appear when navigating code using arrow keys.

Issue #7575 [https://redmine.postgresql.org/issues/7575] - Fixed an issue where Alt-Shift-Q didn’t work after creating a new query.

Issue #7579 [https://redmine.postgresql.org/issues/7579] - Fixed an issue where copy and pasting a row in the results grid doesn’t set the default for boolean.

Issue #7586 [https://redmine.postgresql.org/issues/7586] - Fixed an issue with rendering geometry when selecting a complete column.

Issue #7587 [https://redmine.postgresql.org/issues/7587] - Ensure that the children of information_schema and pg_catalog node should be displayed.

Issue #7591 [https://redmine.postgresql.org/issues/7591] - Fixed column “none” does not exist issue, while comparing schema objects.

Issue #7596 [https://redmine.postgresql.org/issues/7596] - Fixed an issue where schema diff did not pick up the change in RLS policy.

Issue #7608 [https://redmine.postgresql.org/issues/7608] - Fixed an issue where the cloud deployment wizard creates the cluster with the High Availability even if that option is not selected.

Issue #7611 [https://redmine.postgresql.org/issues/7611] - Ensure that schema diff maintains view ownership when view definitions are modified.

Issue #7614 [https://redmine.postgresql.org/issues/7614] - Fixed crypt key is missing issue when logout from the pgAdmin.

Issue #7616 [https://redmine.postgresql.org/issues/7616] - Ensure that the next button should be disabled if the password did not match for Azure deployment.

Issue #7617 [https://redmine.postgresql.org/issues/7617] - Fixed an issue where Azure cloud deployment failed.

Issue #7625 [https://redmine.postgresql.org/issues/7625] - Fixed Spanish translations typo.

Issue #7630 [https://redmine.postgresql.org/issues/7630] - Ensure that If the trigger function definition is changed, drop and recreate the trigger in the schema diff.

Issue #7632 [https://redmine.postgresql.org/issues/7632] - Fixed an issue where a user could not authenticate using Azure CLI on OSX.

Issue #7633 [https://redmine.postgresql.org/issues/7633] - Ensure that the autofocus is on the input control for the master password and server password dialogs.

Issue #7641 [https://redmine.postgresql.org/issues/7641] - Pin Flask-SocketIO <= v5.2.0. The latest version does not support Werkzeug in production environments.

Version 6.12

Release date: 2022-07-28

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.11.

New features

Issue #4488 [https://redmine.postgresql.org/issues/4488] - Added option to trigger autocomplete on key press in the query tool.

Issue #4607 [https://redmine.postgresql.org/issues/4607] - Allow users to delete files/folders from the storage manager.

Issue #7389 [https://redmine.postgresql.org/issues/7389] - Allow users to search within the file/storage manager.

Issue #7486 [https://redmine.postgresql.org/issues/7486] - Added support for visualizing the graphs using Stacked Line, Bar, and Stacked Bar charts in the query tool.

Issue #7487 [https://redmine.postgresql.org/issues/7487] - Added support for visualise the graph using a Pie chart in the query tool.

Housekeeping

Issue #7313 [https://redmine.postgresql.org/issues/7313] - Port the file/storage manager to React.

Issue #7341 [https://redmine.postgresql.org/issues/7341] - Port change password dialog to React.

Issue #7342 [https://redmine.postgresql.org/issues/7342] - Port Master Password dialog to React.

Issue #7492 [https://redmine.postgresql.org/issues/7492] - Removing dynamic module loading and replacing it with static loading.

Issue #7546 [https://redmine.postgresql.org/issues/7546] - Port named restore point dialog to React.

Bug fixes

Issue #7428 [https://redmine.postgresql.org/issues/7428] - Preserve the settings set by the user in the import/export data dialog.

Issue #7471 [https://redmine.postgresql.org/issues/7471] - Ensure that the splash screen can be moved.

Issue #7508 [https://redmine.postgresql.org/issues/7508] - Fixed an issue where comments on indexes are not displayed.

Issue #7512 [https://redmine.postgresql.org/issues/7512] - Ensure that notices should not disappear from the messages tab.

Issue #7517 [https://redmine.postgresql.org/issues/7517] - Enable the start debugging button once execution is completed.

Issue #7518 [https://redmine.postgresql.org/issues/7518] - Ensure that dashboard graph API is not called after the panel has been closed.

Issue #7519 [https://redmine.postgresql.org/issues/7519] - Ensure that geometry should be shown for all the selected cells.

Issue #7520 [https://redmine.postgresql.org/issues/7520] - Fixed the JSON editor issue of hiding the first record.

Issue #7522 [https://redmine.postgresql.org/issues/7522] - Added support for Azure PostgreSQL deployment in server mode.

Issue #7523 [https://redmine.postgresql.org/issues/7523] - Fixed typo error for Statistics on the table header.

Issue #7524 [https://redmine.postgresql.org/issues/7524] - Fixed an issue where new folders cannot be created in the save dialog.

Version 6.11

Release date: 2022-06-30

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.10.

New features

Issue #2647 [https://redmine.postgresql.org/issues/2647] - Added mouse over indication for breakpoint area in the Debugger.

Issue #2648 [https://redmine.postgresql.org/issues/2648] - Added search text option to the Debugger panel.

Issue #7178 [https://redmine.postgresql.org/issues/7178] - Added capability to deploy PostgreSQL servers on Microsoft Azure.

Issue #7332 [https://redmine.postgresql.org/issues/7332] - Added support for passing password using Docker Secret to Docker images.

Issue #7351 [https://redmine.postgresql.org/issues/7351] - Added the option ‘Show template databases?’ to display template databases regardless of the setting of ‘Show system objects?’.

Issue #7485 [https://redmine.postgresql.org/issues/7485] - Added support for visualise the graph using a Line chart in the query tool.

Housekeeping

Issue #6132 [https://redmine.postgresql.org/issues/6132] - Port Debugger to React.

Issue #7315 [https://redmine.postgresql.org/issues/7315] - Updates documentation for the Traefik v2 container deployment.

Issue #7411 [https://redmine.postgresql.org/issues/7411] - Update pgcli to latest release 3.4.1.

Issue #7469 [https://redmine.postgresql.org/issues/7469] - Upgrade Chartjs to the latest 3.8.0.

Bug fixes

Issue #7423 [https://redmine.postgresql.org/issues/7423] - Fixed an issue where there is no setting to turn off notifications in the Query Tool.

Issue #7440 [https://redmine.postgresql.org/issues/7440] - Fixed an issue where passwords entered in the ‘Connect To Server’ dialog were truncated.

Issue #7441 [https://redmine.postgresql.org/issues/7441] - Ensure that the Query Editor should be focused when switching between query tool tabs.

Issue #7443 [https://redmine.postgresql.org/issues/7443] - Fixed and issue where ‘Use spaces’ not working in the query tool.

Issue #7453 [https://redmine.postgresql.org/issues/7453] - Fixed an issue where the Database restriction is not working.

Issue #7460 [https://redmine.postgresql.org/issues/7460] - Fixed an issue where pgAdmin stuck while creating a new index.

Issue #7461 [https://redmine.postgresql.org/issues/7461] - Fixed an issue where the connection wasn’t being closed when the user switched to a new connection and closed the query tool.

Issue #7468 [https://redmine.postgresql.org/issues/7468] - Skip the history records if the JSON info can’t be parsed instead of showing ‘No history’.

Issue #7502 [https://redmine.postgresql.org/issues/7502] - Fixed an issue where an error message is displayed when creating the new database.

Issue #7506 [https://redmine.postgresql.org/issues/7506] - Fixed permission denied error when deploying PostgreSQL in Azure using Docker.

Version 6.10

Release date: 2022-06-02

This release contains a number of bug fixes and new features since the release of pgAdmin 4 v6.9.

New features

Issue #7364 [https://redmine.postgresql.org/issues/7364] - Added the ability to resize columns on dashboard tables.

Housekeeping

Issue #7283 [https://redmine.postgresql.org/issues/7283] - PG 15 compatibility issues fixed.

Issue #7337 [https://redmine.postgresql.org/issues/7337] - Port connect server password dialog to React.

Bug fixes

Issue #6962 [https://redmine.postgresql.org/issues/6962] - Fixed the browser tree overlapping nodes and expansion issue.

Issue #7002 [https://redmine.postgresql.org/issues/7002] - Added the ability to detect and warn users about bidirectional Unicode characters.

Issue #7347 [https://redmine.postgresql.org/issues/7347] - Ensure that when Authentication buttons are disabled their text is visible in the Dark and High contrast theme.

Issue #7368 [https://redmine.postgresql.org/issues/7368] - Ensure that unwanted APIs should not be getting called for BigAnimal.

Issue #7372 [https://redmine.postgresql.org/issues/7372] - Tell Docker to always pull the latest base images when building containers.

Issue #7373 [https://redmine.postgresql.org/issues/7373] - Fixed an issue with geometry window zoom mouse scroll not working.

Issue #7374 [https://redmine.postgresql.org/issues/7374] - Fixed an issue when switching between connections in the Query Tool dropdown, the background and foreground colors should be changed.

Issue #7376 [https://redmine.postgresql.org/issues/7376] - Fixed an issue where a popup for unsaved changes appears when clicking on the open file button for a blank query editor.

Issue #7380 [https://redmine.postgresql.org/issues/7380] - Added support for multi-cell selection in the query tool grid.

Issue #7383 [https://redmine.postgresql.org/issues/7383] - Fixed an issue where Preferences are not saved when the dialog is maximized.

Issue #7388 [https://redmine.postgresql.org/issues/7388] - Fixed an issue where an error message fills the entire window if the query is long.

Issue #7393 [https://redmine.postgresql.org/issues/7393] - Ensure that the editor position should not get changed once it is opened.

Issue #7394 [https://redmine.postgresql.org/issues/7394] - Fixed an issue where geometry is not visible when a single cell is selected.

Issue #7399 [https://redmine.postgresql.org/issues/7399] - Added missing toggle case keyboard shortcuts to the query tool.

Issue #7402 [https://redmine.postgresql.org/issues/7402] - Ensure that Dashboard graphs should be refreshed on changing the node from the browser tree.

Issue #7403 [https://redmine.postgresql.org/issues/7403] - Fixed an issue where comments on domain constraints were not visible when selecting a domain node.

Issue #7405 [https://redmine.postgresql.org/issues/7405] - Ensure that null values are accepted for the numeric columns in react-data-grid.

Issue #7408 [https://redmine.postgresql.org/issues/7408] - Fixed an issue when a table has a column with an array type with length or precision, the column type is not selected while editing the table.

Version 6.9

Release date: 2022-05-12

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.8.

New features

Issue #3253 [https://redmine.postgresql.org/issues/3253] - Added status bar to the Query Tool.

Issue #3989 [https://redmine.postgresql.org/issues/3989] - Ensure that row numbers should be visible in view when scrolling horizontally.

Issue #6830 [https://redmine.postgresql.org/issues/6830] - Relocate GIS Viewer Button to the Left Side of the Results Table.

Issue #7179 [https://redmine.postgresql.org/issues/7179] - Added capability to deploy PostgreSQL servers on EDB BigAnimal.

Issue #7282 [https://redmine.postgresql.org/issues/7282] - Added options ‘Ignore owner’ and ‘Ignore whitespace’ to the schema diff panel.

Issue #7325 [https://redmine.postgresql.org/issues/7325] - Added support for Azure AD OAUTH2 authentication.

Housekeeping

Issue #6131 [https://redmine.postgresql.org/issues/6131] - Port query tool to React.

Issue #6746 [https://redmine.postgresql.org/issues/6746] - Improve the Kerberos Documentation.

Issue #7255 [https://redmine.postgresql.org/issues/7255] - Ensure the database and schema restriction controls are not shown as a drop-down.

Issue #7340 [https://redmine.postgresql.org/issues/7340] - Port data filter dialog to React.

Bug fixes

Issue #6725 [https://redmine.postgresql.org/issues/6725] - Fixed an issue where the Query tool opens on minimum size if the user opens multiple query tool Window quickly.

Issue #6958 [https://redmine.postgresql.org/issues/6958] - Only set permissions on the storage directory upon creation.

Issue #7026 [https://redmine.postgresql.org/issues/7026] - Fixed an issue where the Browser panel is not completely viewable.

Issue #7168 [https://redmine.postgresql.org/issues/7168] - Improvement to the Geometry Viewer popup to change the size of the result tables when column names are quite long.

Issue #7187 [https://redmine.postgresql.org/issues/7187] - Fixed an issue where the downloaded ERD diagram was 0 bytes.

Issue #7188 [https://redmine.postgresql.org/issues/7188] - Fixed an issue where the connection bar is not visible.

Issue #7231 [https://redmine.postgresql.org/issues/7231] - Don’t strip binaries when packaging them in the server RPM as this might break cpython modules.

Issue #7252 [https://redmine.postgresql.org/issues/7252] - Ensure that Columns should always be visible in the import/export dialog.

Issue #7260 [https://redmine.postgresql.org/issues/7260] - Fixed an issue where an Empty message popup after running a query.

Issue #7262 [https://redmine.postgresql.org/issues/7262] - Ensure that Autocomplete should work after changing the connection.

Issue #7294 [https://redmine.postgresql.org/issues/7294] - Fixed an issue where the copy and paste row does not work if the first column contains no data.

Issue #7296 [https://redmine.postgresql.org/issues/7296] - Ensure that after deleting multiple objects from the properties panel, the browser tree should be refreshed.

Issue #7299 [https://redmine.postgresql.org/issues/7299] - Fixed sorting issue in the statistics panel.

Issue #7305 [https://redmine.postgresql.org/issues/7305] - Fixed an issue where the Dashboard Server Activity was showing old queries as active.

Issue #7307 [https://redmine.postgresql.org/issues/7307] - Fixed an issue where the table showed duplicate columns when creating multiple sequences on the same column.

Issue #7308 [https://redmine.postgresql.org/issues/7308] - Ensure that sorting should be preserved on refresh for Server Activity.

Issue #7322 [https://redmine.postgresql.org/issues/7322] - Fixed an issue while creating a new database throwing an error that failed to retrieve data.

Issue #7333 [https://redmine.postgresql.org/issues/7333] - Fixed an issue where the drag and drop table in ERD throws an error.

Issue #7339 [https://redmine.postgresql.org/issues/7339] - Ensure that the Dashboard column sort order should be remembered when the refresh button is clicked.

Version 6.8

Release date: 2022-04-07

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.7.

New features

Issue #7215 [https://redmine.postgresql.org/issues/7215] - Added transaction start time to Server activity sessions view.

Issue #7249 [https://redmine.postgresql.org/issues/7249] - Added support for unique keys in ERD.

Issue #7257 [https://redmine.postgresql.org/issues/7257] - Support running the container under OpenShift with alternate UIDs.

Housekeeping

Issue #7132 [https://redmine.postgresql.org/issues/7132] - Port Properties panel for collection node, Dashboard, and SQL panel in React.

Issue #7149 [https://redmine.postgresql.org/issues/7149] - Port preferences dialog to React.

Bug fixes

Issue #4256 [https://redmine.postgresql.org/issues/4256] - Fixed an issue where SQL for revoke statements are not shown for databases.

Issue #5836 [https://redmine.postgresql.org/issues/5836] - Adds a new LDAP authentication configuration parameter that indicates the case sensitivity of the LDAP schema/server.

Issue #6960 [https://redmine.postgresql.org/issues/6960] - Ensure that the master password dialog is popped up if the crypt key is missing.

Issue #7059 [https://redmine.postgresql.org/issues/7059] - Fixed an issue where the error is shown on logout when the authentication source is oauth2.

Issue #7176 [https://redmine.postgresql.org/issues/7176] - Fixed an issue where the browser tree state was not preserved correctly.

Issue #7197 [https://redmine.postgresql.org/issues/7197] - Fixed an issue where foreign key relationships do not update when the primary key is modified.

Issue #7216 [https://redmine.postgresql.org/issues/7216] - Ensure that the values of certain fields are prettified in the statistics tab for collection nodes.

Issue #7221 [https://redmine.postgresql.org/issues/7221] - Ensure objects depending on extensions are not displayed in Schema Diff.

Issue #7238 [https://redmine.postgresql.org/issues/7238] - Fixed an issue where foreign key is not removed even if the referred table is removed in ERD.

Issue #7239 [https://redmine.postgresql.org/issues/7239] - Fixed an issue where the newly added table is not visible under the Tables node on refresh.

Issue #7261 [https://redmine.postgresql.org/issues/7261] - Correct typo in the documentation.

Issue #7263 [https://redmine.postgresql.org/issues/7263] - Fixed schema diff issue where function’s difference DDL was showing incorrectly when arguments had default values with commas.

Issue #7264 [https://redmine.postgresql.org/issues/7264] - Ensure that the correct user should be selected in the new connection dialog.

Issue #7265 [https://redmine.postgresql.org/issues/7265] - Fixed schema diff issue in which the option ‘null’ doesn’t appear in the DDL statement for the foreign table.

Issue #7267 [https://redmine.postgresql.org/issues/7267] - Fixed an issue where unexpected error messages are displayed when users change the language via preferences.

Issue #7269 [https://redmine.postgresql.org/issues/7269] - Ensure that pgAdmin4 should work with latest jinja2 version.

Issue #7275 [https://redmine.postgresql.org/issues/7275] - Fixed ‘Cannot read properties of undefined’ error while creating the table via the ERD tool.

Version 6.7

Release date: 2022-03-14

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.6.

Note

Security Release

Please note that this release includes a security update to fix an issue where a user could upload files to directories outside of their storage directory, when using pgAdmin running in server mode.

Users running pgAdmin in server mode, including the standard container based distribution, should upgrade to this release as soon as possible.

This issue does not affect users running in desktop mode.

Bug fixes

Issue #7220 [https://redmine.postgresql.org/issues/7220] - Fixed a schema diff issue where difference SQL isn’t generated when foreign key values for a table differ.

Issue #7228 [https://redmine.postgresql.org/issues/7228] - Fixed a schema diff issue where string separator ‘_$PGADMIN$_’ is visible for identical user mappings.

Issue #7230 [https://redmine.postgresql.org/issues/7230] - Fixed an issue where pgAdmin 4 took ~75 seconds to display the ‘Starting pgAdmin’ text on the splash screen.

Issue #7233 [https://redmine.postgresql.org/issues/7233] - Ensure that upload paths are children of the storage directory (CVE-2022-0959).

Version 6.6

Release date: 2022-03-10

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.5.

New features

Issue #7177 [https://redmine.postgresql.org/issues/7177] - Added capability to deploy PostgreSQL servers on Amazon RDS.

Housekeeping

Issue #7180 [https://redmine.postgresql.org/issues/7180] - Rename the menu ‘Disconnect Database’ to ‘Disconnect from database’.

Bug fixes

Issue #6956 [https://redmine.postgresql.org/issues/6956] - Fixed a schema diff issue in which user mappings were not compared correctly.

Issue #6991 [https://redmine.postgresql.org/issues/6991] - Fixed an issue where pgadmin cannot connect to LDAP when STARTTLS is required before bind.

Issue #6999 [https://redmine.postgresql.org/issues/6999] - Fixed an issue where a warning is flashed every time for an email address when authentication sources are internal and ldap.

Issue #7105 [https://redmine.postgresql.org/issues/7105] - Fixed an issue where the parent partition table was not displayed during autocomplete.

Issue #7124 [https://redmine.postgresql.org/issues/7124] - Fixed the schema diff issue where tables have different column positions and a column has a default value.

Issue #7152 [https://redmine.postgresql.org/issues/7152] - Added comments column for the functions collection node.

Issue #7172 [https://redmine.postgresql.org/issues/7172] - Allow users to scroll and enter input when there is a validation error.

Issue #7173 [https://redmine.postgresql.org/issues/7173] - Fixed an issue where the User Management dialog is not opening.

Issue #7181 [https://redmine.postgresql.org/issues/7181] - Ensure that the user should be able to add new server with unix socket connection.

Issue #7186 [https://redmine.postgresql.org/issues/7186] - Fixes an issue where the connect server/database menu was not updated correctly.

Issue #7202 [https://redmine.postgresql.org/issues/7202] - Ensure that Flask-Security-Too is using the latest version.

Version 6.5

Release date: 2022-02-11

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.4.

New features

Issue #7139 [https://redmine.postgresql.org/issues/7139] - Added support to open SQL help, Dialog help, and online help in an external web browser.

Housekeeping

Issue #7016 [https://redmine.postgresql.org/issues/7016] - Port Dependent, dependencies, statistics panel to React.

Issue #7017 [https://redmine.postgresql.org/issues/7017] - Port Import/Export dialog to React.

Issue #7163 [https://redmine.postgresql.org/issues/7163] - Rename the menu ‘Disconnect Server’ to ‘Disconnect from server’.

Bug fixes

Issue #6916 [https://redmine.postgresql.org/issues/6916] - Added flag in runtime to disable GPU hardware acceleration.

Issue #7035 [https://redmine.postgresql.org/issues/7035] - Fixed an issue where connections keep open to (closed) connections on the initial connection to the database server.

Issue #7085 [https://redmine.postgresql.org/issues/7085] - Ensure that Partitioned tables should be visible correctly when creating multiple partition levels.

Issue #7086 [https://redmine.postgresql.org/issues/7086] - Correct documentation for ‘Add named restore point’.

Issue #7100 [https://redmine.postgresql.org/issues/7100] - Fixed an issue where the Browser tree gets disappears when scrolling sequences.

Issue #7109 [https://redmine.postgresql.org/issues/7109] - Make the size blank for all the directories in the file select dialog.

Issue #7110 [https://redmine.postgresql.org/issues/7110] - Ensure that cursor should be focused on the first options of the Utility dialogs.

Issue #7118 [https://redmine.postgresql.org/issues/7118] - Ensure that JSON files should be downloaded properly from the storage manager.

Issue #7123 [https://redmine.postgresql.org/issues/7123] - Fixed an issue where restore generates incorrect options for the schema.

Issue #7126 [https://redmine.postgresql.org/issues/7126] - Fixed an issue where the F2 Function key removes browser panel contents.

Issue #7127 [https://redmine.postgresql.org/issues/7127] - Added validation for Hostname in the server dialog.

Issue #7135 [https://redmine.postgresql.org/issues/7135] - Enforce the minimum Windows version that the installer will run on.

Issue #7136 [https://redmine.postgresql.org/issues/7136] - Fixed an issue where the query tool is displaying an incorrect label.

Issue #7142 [https://redmine.postgresql.org/issues/7142] - Fixed an issue where a warning message was shown after database creation/modification.

Issue #7145 [https://redmine.postgresql.org/issues/7145] - Ensure that owner should be ignored while comparing extensions.

Issue #7146 [https://redmine.postgresql.org/issues/7146] - Fixed event trigger comparing issue in Schema Diff tool.

Issue #7150 [https://redmine.postgresql.org/issues/7150] - Fixed an issue when uploading a CSV throwing an error in the Desktop mode.

Issue #7151 [https://redmine.postgresql.org/issues/7151] - Fixed value error in the restore dialog.

Issue #7154 [https://redmine.postgresql.org/issues/7154] - Ensure that the layout should not be reset if a query tool is opened and pgAdmin is restarted.

Version 6.4

Release date: 2022-01-13

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.3.

New features

Issue #4803 [https://redmine.postgresql.org/issues/4803] - Added support to import/export server groups and servers from GUI.

Housekeeping

Issue #7018 [https://redmine.postgresql.org/issues/7018] - Port Restore dialog to React.

Issue #7019 [https://redmine.postgresql.org/issues/7019] - Port Maintenance dialog to React.

Bug fixes

Issue #6745 [https://redmine.postgresql.org/issues/6745] - Fixed an issue where Tablespace is created though an error is shown on the dialog.

Issue #7003 [https://redmine.postgresql.org/issues/7003] - Fixed an issue where Explain Analyze shows negative exclusive time.

Issue #7034 [https://redmine.postgresql.org/issues/7034] - Fixed an issue where Columns with default value not showing when adding a new row.

Issue #7075 [https://redmine.postgresql.org/issues/7075] - Ensure that help should be visible properly for Procedures.

Issue #7077 [https://redmine.postgresql.org/issues/7077] - Fixed an issue where the Owner is not displayed in the reverse engineering SQL for Procedures.

Issue #7078 [https://redmine.postgresql.org/issues/7078] - Fixed an issue where an operation error message pop up showing the database object’s name incorrectly.

Issue #7081 [https://redmine.postgresql.org/issues/7081] - Fixed an issue in SQL generation for PostgreSQL-14 functions.

Issue #7093 [https://redmine.postgresql.org/issues/7093] - Fixed an issue where SubPlans may overlap other nodes & make them inaccessible in Graphical EXPLAIN View.

Issue #7096 [https://redmine.postgresql.org/issues/7096] - Ensure that Truncate and Reset statistics should work.

Issue #7102 [https://redmine.postgresql.org/issues/7102] - Fixed a schema diff issue where generated script adds unwanted line endings for Functions/Procedures/Trigger Functions.

Version 6.3

Release date: 2021-12-16

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.2.

New features

Issue #6543 [https://redmine.postgresql.org/issues/6543] - Added support for Two-factor authentication for improving security.

Issue #6872 [https://redmine.postgresql.org/issues/6872] - Include GSSAPI support in the PostgreSQL libraries and utilities on macOS.

Issue #7039 [https://redmine.postgresql.org/issues/7039] - Added support to disable the auto-discovery of the database servers.

Housekeeping

Issue #6088 [https://redmine.postgresql.org/issues/6088] - Replace Flask-BabelEx with Flask-Babel.

Issue #6984 [https://redmine.postgresql.org/issues/6984] - Port Backup Global, Backup Server, and Backup object dialog in React.

Issue #7004 [https://redmine.postgresql.org/issues/7004] - Replaced alertifyjs notifiers with React-based notistack.

Issue #7010 [https://redmine.postgresql.org/issues/7010] - Upgrade Flask to version 2.

Issue #7053 [https://redmine.postgresql.org/issues/7053] - Replace Alertify alert and confirm with React-based model dialog.

Bug fixes

Issue #6840 [https://redmine.postgresql.org/issues/6840] - Fixed an issue where tooltip data are not displaying on downloaded graphical explain plan.

Issue #6877 [https://redmine.postgresql.org/issues/6877] - Fixed schema diff owner related issue.

Issue #6906 [https://redmine.postgresql.org/issues/6906] - Fixed an issue where referenced table drop-down should be disabled in foreign key -> columns after one row is added.

Issue #6955 [https://redmine.postgresql.org/issues/6955] - Ensure that sort order should be maintained when renaming a server group.

Issue #6957 [https://redmine.postgresql.org/issues/6957] - Fixed schema diff related some issues.

Issue #6963 [https://redmine.postgresql.org/issues/6963] - Ensure that the user should be allowed to set the schema of an extension while creating it.

Issue #6978 [https://redmine.postgresql.org/issues/6978] - Increase the width of the scrollbars.

Issue #6986 [https://redmine.postgresql.org/issues/6986] - Fixed an issue where the user can’t debug function with timestamp parameter.

Issue #6989 [https://redmine.postgresql.org/issues/6989] - Fixed an issue where the Change Password menu option is missing for internal authentication source when more than one authentication source is defined.

Issue #7005 [https://redmine.postgresql.org/issues/7005] - Fixed an issue where On-demand rows throw an error when any row cell is edited and saved it then scroll to get more rows.

Issue #7006 [https://redmine.postgresql.org/issues/7006] - Ensure that Python 3.10 and the latest eventlet dependency should not break the application.

Issue #7013 [https://redmine.postgresql.org/issues/7013] - Fix an RPM build issue that could lead to a conflict with python3 at installation.

Issue #7015 [https://redmine.postgresql.org/issues/7015] - Fixed an issue where the error is thrown while creating a new server using Add New Server from the dashboard while tree item is not selected.

Issue #7020 [https://redmine.postgresql.org/issues/7020] - Ensure that statue message should not hide the last line of messages when running a long query.

Issue #7024 [https://redmine.postgresql.org/issues/7024] - Fixed an issue where reverse engineering SQL is wrong for Aggregate.

Issue #7029 [https://redmine.postgresql.org/issues/7029] - Correct the SQL definition for function/procedure with the Atomic keyword in PG14.

Issue #7031 [https://redmine.postgresql.org/issues/7031] - Fixed an issue where SQLite database definition is wrong because the USER_ID FK references the table user_old which is not available.

Issue #7040 [https://redmine.postgresql.org/issues/7040] - Add “section” to the Debian package control files.

Issue #7044 [https://redmine.postgresql.org/issues/7044] - Update the dropzone version to 5.9.3 and Flask-SQLAlchemy to 2.5.*.

Issue #7046 [https://redmine.postgresql.org/issues/7046] - Fixed some accessibility issues.

Issue #7048 [https://redmine.postgresql.org/issues/7048] - Fixed unhashable type issue while opening the about dialog.

Issue #7064 [https://redmine.postgresql.org/issues/7064] - Ensure that the Owner should not be disabled while creating the procedure.

Issue #7071 [https://redmine.postgresql.org/issues/7071] - Fixed an issue where confirmation pop-up is hidden behind Reassign/Drop Owned Dialog.

Version 6.2

Release date: 2021-11-18

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.1.

New features

Issue #3834 [https://redmine.postgresql.org/issues/3834] - Added support of Aggregate and Operator node in view-only mode.

Issue #6953 [https://redmine.postgresql.org/issues/6953] - Ensure that users should be able to modify the REMOTE_USER environment variable as per their environment by introducing the new config parameter WEBSERVER_REMOTE_USER.

Housekeeping

Bug fixes

Issue #5427 [https://redmine.postgresql.org/issues/5427] - Fixed pgAdmin freezing issue by providing the error message for the operation that can’t perform due to lock on the particular table.

Issue #6780 [https://redmine.postgresql.org/issues/6780] - Ensure that columns should be merged if the newly added column is present in the parent table.

Issue #6809 [https://redmine.postgresql.org/issues/6809] - Fixed an issue where pgAdmin is not opening properly.

Issue #6832 [https://redmine.postgresql.org/issues/6832] - Ensure that internal authentication when combined with other authentication providers, the order of internal source should not matter while picking up the provider.

Issue #6845 [https://redmine.postgresql.org/issues/6845] - Ensure that inherit table icon should be visible properly in the tree view.

Issue #6859 [https://redmine.postgresql.org/issues/6859] - Fixed an issue where properties panel is not updated when any object is added from the browser tree.

Issue #6896 [https://redmine.postgresql.org/issues/6896] - Ensure that the user should be able to navigate browser tree objects using arrow keys from keyboard.

Issue #6905 [https://redmine.postgresql.org/issues/6905] - Fixed an issue where database nodes are not getting loaded behind a reverse proxy with SSL.

Issue #6925 [https://redmine.postgresql.org/issues/6925] - Fixed SQL syntax error if select “Custom auto-vacuum” option and not set Autovacuum option to Yes or No.

Issue #6939 [https://redmine.postgresql.org/issues/6939] - Fixed an issue where older server group name displayed in the confirmation pop-up when the user removes server group.

Issue #6944 [https://redmine.postgresql.org/issues/6944] - Fixed an issue where JSON editor preview colours have inappropriate contrast in dark mode.

Issue #6945 [https://redmine.postgresql.org/issues/6945] - Fixed JSON Editor scrolling issue in code mode.

Issue #6940 [https://redmine.postgresql.org/issues/6940] - Fixed an issue where user details are not shown when the non-admin user tries to connect to the shared server.

Issue #6949 [https://redmine.postgresql.org/issues/6949] - Ensure that dialog should be opened when clicking on Reassign/Drop owned menu.

Issue #6954 [https://redmine.postgresql.org/issues/6954] - Ensure that changing themes should work on Windows when system high contrast mode is enabled.

Issue #6972 [https://redmine.postgresql.org/issues/6972] - Ensure that the Binary path for PG14 should be visible in the preferences.

Issue #6974 [https://redmine.postgresql.org/issues/6974] - Added operators and aggregates in search objects.

Issue #6976 [https://redmine.postgresql.org/issues/6976] - Fixed an issue where textarea should be allowed to resize and have more than 255 chars.

Issue #6981 [https://redmine.postgresql.org/issues/6981] - Fixed an issue where SQL for index shows the same column multiple times.

Issue #6988 [https://redmine.postgresql.org/issues/6988] - Reset the layout if pgAdmin4 detects the layout is in an inconsistent state.

Version 6.1

Release date: 2021-10-21

This release contains a number of bug fixes and new features since the release of pgAdmin4 6.0.

New features

Issue #4596 [https://redmine.postgresql.org/issues/4596] - Added support for indent guides in the browser tree.

Issue #6081 [https://redmine.postgresql.org/issues/6081] - Added support for advanced table fields like the foreign key, primary key in the ERD tool.

Issue #6241 [https://redmine.postgresql.org/issues/6241] - Added support to allow tables to be dragged to ERD Tool.

Issue #6529 [https://redmine.postgresql.org/issues/6529] - Added index creation when generating SQL in the ERD tool.

Issue #6657 [https://redmine.postgresql.org/issues/6657] - Added support for authentication via the webserver (REMOTE_USER).

Issue #6794 [https://redmine.postgresql.org/issues/6794] - Added support to enable/disable rules.

Housekeeping

Bug fixes

Issue #6719 [https://redmine.postgresql.org/issues/6719] - Fixed OAuth2 integration redirect issue.

Issue #6754 [https://redmine.postgresql.org/issues/6754] - Ensure that query highlighting color in the query tool should be less intensive.

Issue #6776 [https://redmine.postgresql.org/issues/6776] - Changed the label ‘Inherits Tables?’ to ‘Is inherited?’ as it misleading in the properties panel.

Issue #6790 [https://redmine.postgresql.org/issues/6790] - Fixed an issue where the user is unable to create an index with concurrently keyword.

Issue #6797 [https://redmine.postgresql.org/issues/6797] - Remove an extra blank line at the start of the SQL for function, procedure, and trigger function.

Issue #6802 [https://redmine.postgresql.org/issues/6802] - Fixed the issue of editing triggers for advanced servers.

Issue #6828 [https://redmine.postgresql.org/issues/6828] - Fixed an issue where the tree is not scrolling to the object selected from the search result.

Issue #6858 [https://redmine.postgresql.org/issues/6858] - Fixed object delete issue from the properties tab for the collection nodes.

Issue #6876 [https://redmine.postgresql.org/issues/6876] - Ensure that the Dashboard should get updated after connecting to the server.

Issue #6881 [https://redmine.postgresql.org/issues/6881] - Fixed an issue where the browser tree doesn’t show all contents on changing resolution.

Issue #6882 [https://redmine.postgresql.org/issues/6882] - Ensure that columns should be displayed in the order of creation instead of alphabetical order in the browser tree.

Issue #6890 [https://redmine.postgresql.org/issues/6890] - Fixed background colour issue in the browser tree.

Issue #6891 [https://redmine.postgresql.org/issues/6891] - Added support for composite foreign keys in the ERD tool.

Issue #6900 [https://redmine.postgresql.org/issues/6900] - Fixed an issue where exclusion constraint cannot be created from table dialog if the access method name is changed once.

Issue #6905 [https://redmine.postgresql.org/issues/6905] - Fixed an issue where the users are unable to load the databases behind an HTTP reverse proxy.

Issue #6908 [https://redmine.postgresql.org/issues/6908] - Fixed an issue where each click to refresh the collection node, the number of objects decreasing by tens or more.

Issue #6912 [https://redmine.postgresql.org/issues/6912] - Fixed browser tree sort order regression issue.

Issue #6915 [https://redmine.postgresql.org/issues/6915] - Fixed an issue where the blank string is stored instead of NULL in the server table of SQLite database.

Issue #6928 [https://redmine.postgresql.org/issues/6928] - Ensure that the master password should be prompt when MASTER_PASSWORD_REQUIRED is set to True and AUTHENTICATION_SOURCES is webserver.

Issue #6929 [https://redmine.postgresql.org/issues/6929] - Ensure that only the table node should be allowed to drop on the ERD tool.

Issue #6930 [https://redmine.postgresql.org/issues/6930] - Fixed an issue where the existing server group is disappeared on rename it.

Issue #6935 [https://redmine.postgresql.org/issues/6935] - Fixed an issue where the wrong SQL is generated when deleting and renaming table columns together.

Version 6.0

Release date: 2021-10-07

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.7.

New features

Issue #4211 [https://redmine.postgresql.org/issues/4211] - Added support for OWNED BY Clause for sequences.

Housekeeping

Issue #5741 [https://redmine.postgresql.org/issues/5741] - Revisit all the CREATE and DROP DDL’s to add appropriate ‘IF EXISTS’, ‘CASCADE’ and ‘CREATE OR REPLACE’.

Issue #6129 [https://redmine.postgresql.org/issues/6129] - Port browser tree to React.

Issue #6588 [https://redmine.postgresql.org/issues/6588] - Port object nodes and properties dialogs to React.

Issue #6687 [https://redmine.postgresql.org/issues/6687] - Port Grant Wizard to react.

Issue #6692 [https://redmine.postgresql.org/issues/6692] - Remove GPDB support completely.

Bug fixes

Issue #2097 [https://redmine.postgresql.org/issues/2097] - Fixed an issue where grant wizard is unresponsive if the database size is huge.

Issue #2546 [https://redmine.postgresql.org/issues/2546] - Added support to create the Partitioned table using COLLATE and opclass.

Issue #3827 [https://redmine.postgresql.org/issues/3827] - Ensure that in the Query History tab, query details should be scrollable.

Issue #6712 [https://redmine.postgresql.org/issues/6712] - Fixed an issue where collapse and expand arrows mismatch in case of nested IF.

Issue #6713 [https://redmine.postgresql.org/issues/6713] - Fixed an issue where the last message is not visible in the Debugger.

Issue #6723 [https://redmine.postgresql.org/issues/6723] - Updated query error row selection color as per dark theme style guide.

Issue #6724 [https://redmine.postgresql.org/issues/6724] - Fixed an issue where the drop cascade button enables for Databases.

Issue #6736 [https://redmine.postgresql.org/issues/6736] - Fixed an issue where Refresh view options are not working for materialized view.

Issue #6755 [https://redmine.postgresql.org/issues/6755] - Fixed keyerror issue in schema diff for ‘attnum’ and ‘edit_types’ parameter.

Issue #6759 [https://redmine.postgresql.org/issues/6759] - Ensure that RLS names should not be editable in the collection node of properties tab.

Issue #6798 [https://redmine.postgresql.org/issues/6798] - Fixed an issue where Execute button of the query tool gets disabled once we change anything in the data grid.

Issue #6834 [https://redmine.postgresql.org/issues/6834] - Ensure that SQL help should work for EPAS servers.

Version 5.7

Release date: 2021-09-09

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.6.

New features

Issue #2538 [https://redmine.postgresql.org/issues/2538] - Added support for the truncate table with restart identity.

Issue #4264 [https://redmine.postgresql.org/issues/4264] - Make code folding case insensitive in the code mirror.

Issue #4629 [https://redmine.postgresql.org/issues/4629] - Added database and server information on the Maintenance process watcher dialog.

Issue #6495 [https://redmine.postgresql.org/issues/6495] - Allow the referenced table to be the same as the local table in one to many relationship for ERD Tool.

Issue #6625 [https://redmine.postgresql.org/issues/6625] - Make closing tabs to be smarter by focusing on the appropriate tab when the user closed a tab.

Issue #6691 [https://redmine.postgresql.org/issues/6691] - Set PSQLRC and PSQL_HISTORY env vars to apt. user storage path in the server mode.

Housekeeping

Bug fixes

Issue #4567 [https://redmine.postgresql.org/issues/4567] - Fixed an issue where privileges were revoked using SQL query on objects like tables that do not correctly show in SQL tab.

Issue #4815 [https://redmine.postgresql.org/issues/4815] - Fixed an issue where the user can not paste the updated table header in safari 12 and 13 browsers.

Issue #5849 [https://redmine.postgresql.org/issues/5849] - Ensure that trigger function SQL should have ‘create or replace function’ instead of ‘create function’ only.

Issue #6419 [https://redmine.postgresql.org/issues/6419] - Fixed blank screen issue on windows and also made changes to use NWjs manifest for remembering window size.

Issue #6531 [https://redmine.postgresql.org/issues/6531] - Fixed the export image issue where relation lines are over the nodes.

Issue #6544 [https://redmine.postgresql.org/issues/6544] - Fixed width limitation issue in PSQL tool window.

Issue #6564 [https://redmine.postgresql.org/issues/6564] - Fixed an issue where columns with sequences get altered unnecessarily with a schema diff tool.

Issue #6570 [https://redmine.postgresql.org/issues/6570] - Ensure that the lock panel should not be blocked for larger records.

Issue #6572 [https://redmine.postgresql.org/issues/6572] - Partially fixes the data output panel display issue.

Issue #6620 [https://redmine.postgresql.org/issues/6620] - Fixed an issue where whitespace in function bodies was not applied while generating the script using Schema Diff.

Issue #6627 [https://redmine.postgresql.org/issues/6627] - Introduced OAUTH2_SCOPE variable for the Oauth2 scope configuration.

Issue #6641 [https://redmine.postgresql.org/issues/6641] - Enables pgAdmin to retrieve user permissions in case of nested roles which helps to terminate the session for AWS RDS.

Issue #6663 [https://redmine.postgresql.org/issues/6663] - Fixed no attribute ‘_asdict’ error when connecting the database server.

Issue #6668 [https://redmine.postgresql.org/issues/6668] - Fixed errors related to HTML tags shown in the error message for JSON editor.

Issue #6671 [https://redmine.postgresql.org/issues/6671] - Fixed UnboundLocalError where local variable ‘user_id’ referenced before assignment.

Issue #6682 [https://redmine.postgresql.org/issues/6682] - Renamed ‘Auto rollback?’ to ‘Auto rollback on error?’.

Issue #6684 [https://redmine.postgresql.org/issues/6684] - Fixed the JSON editor issue of hiding the first record.

Issue #6685 [https://redmine.postgresql.org/issues/6685] - Ensure that deleting a database should not automatically connect to the next database.

Issue #6704 [https://redmine.postgresql.org/issues/6704] - Ensure that pgAdmin should not fail at login due to a special character in the hostname.

Issue #6710 [https://redmine.postgresql.org/issues/6710] - Fixed an issue where multiple query tool tabs getting closed for the single close event.

Version 5.6

Release date: 2021-08-12

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.5.

New features

Issue #4904 [https://redmine.postgresql.org/issues/4904] - Added support to copy SQL from main window to query tool.

Issue #5198 [https://redmine.postgresql.org/issues/5198] - Added support for formatted JSON viewer/editor when interacting with data in a JSON column.

Housekeeping

Issue #6622 [https://redmine.postgresql.org/issues/6622] - Rename the “Resize by data?” to “Columns sized by” and disabled the ‘Maximum column width’ button if ‘Columns sized by’ is set to ‘Column data’.

Bug fixes

Issue #6337 [https://redmine.postgresql.org/issues/6337] - Ensure that the login account should be locked after N number of attempts. N is configurable using the ‘MAX_LOGIN_ATTEMPTS’ parameter.

Issue #6369 [https://redmine.postgresql.org/issues/6369] - Fixed CSRF errors for stale sessions by increasing the session expiration time for desktop mode.

Issue #6448 [https://redmine.postgresql.org/issues/6448] - Fixed an issue in the search object when searching in ‘all types’ or ‘subscription’ if the user doesn’t have access to the subscription.

Issue #6574 [https://redmine.postgresql.org/issues/6574] - Fixed an issue where paste is not working through Right-Click option on PSQL.

Issue #6580 [https://redmine.postgresql.org/issues/6580] - Fixed TypeError ‘NoneType’ object is not sub scriptable.

Issue #6586 [https://redmine.postgresql.org/issues/6586] - Fixed incorrect tablespace options in the drop-down for move objects dialog.

Issue #6618 [https://redmine.postgresql.org/issues/6618] - Fixed an issue where the titles in query tabs are different.

Issue #6619 [https://redmine.postgresql.org/issues/6619] - Fixed incorrect binary path issue when the user deletes the binary path from the preferences.

Issue #6643 [https://redmine.postgresql.org/issues/6643] - Ensure that all the required options should be loaded when the Range data type is selected while creating a custom data type.

Issue #6650 [https://redmine.postgresql.org/issues/6650] - Fixed dashboard server activity issue when active_since parameter is None.

Issue #6664 [https://redmine.postgresql.org/issues/6664] - Fixed an issue where even if the user is locked, he can reset the password and can login into pgAdmin.

Version 5.5

Release date: 2021-07-15

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.4.

New features

Issue #1975 [https://redmine.postgresql.org/issues/1975] - Highlighted long running queries on the dashboards.

Issue #3893 [https://redmine.postgresql.org/issues/3893] - Added support for Reassign/Drop Owned for login roles.

Issue #3920 [https://redmine.postgresql.org/issues/3920] - Do not block the query editor window when running a query.

Issue #5940 [https://redmine.postgresql.org/issues/5940] - Added support for OAuth 2 authentication.

Issue #6559 [https://redmine.postgresql.org/issues/6559] - Added option to provide maximum width of the column when ‘Resize by data?’ option in the preferences is set to True.

Housekeeping

Bug fixes

Issue #4189 [https://redmine.postgresql.org/issues/4189] - Ensure that the Data Output panel can be snapped back after it is detached.

Issue #6388 [https://redmine.postgresql.org/issues/6388] - Fixed replace keyboard shortcut issue in the query tool on the normal keyboard layout.

Issue #6398 [https://redmine.postgresql.org/issues/6398] - Fixed an issue where detaching the query editor panel gives a blank white panel.

Issue #6427 [https://redmine.postgresql.org/issues/6427] - Remove leading whitespace and replace it with ‘[…] ‘ in the Query Tool data grid so cells don’t look empty.

Issue #6448 [https://redmine.postgresql.org/issues/6448] - Fixed an issue in the search object when searching in ‘all types’ or ‘subscription’ if the user doesn’t have access to the subscription.

Issue #6489 [https://redmine.postgresql.org/issues/6489] - Fixed an issue where Execute/Refresh button should not be disabled when we run the empty query.

Issue #6505 [https://redmine.postgresql.org/issues/6505] - Fixed an issue where the New Connection Drop Down has lost default maintenance database, auto-select, and tab-through functionality.

Issue #6536 [https://redmine.postgresql.org/issues/6536] - Fixed directory selection issue with the folder dialog.

Issue #6541 [https://redmine.postgresql.org/issues/6541] - Ensure that setting ‘Open in new browser tab’ should be visible, it should not be based on the value of ‘ENABLE_PSQL’.

Issue #6547 [https://redmine.postgresql.org/issues/6547] - Fixed copy/paste issues for PSQL tool terminal.

Issue #6550 [https://redmine.postgresql.org/issues/6550] - Disable email deliverability check that was introduced in flask-security-too by default to maintain backwards compatibility.

Issue #6555 [https://redmine.postgresql.org/issues/6555] - Fixed Czech translation string for ‘Login’ keyword.

Issue #6557 [https://redmine.postgresql.org/issues/6557] - Fixed an issue where incorrect column name listed in the properties of Index.

Version 5.4

Release date: 2021-06-17

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.3.

New features

Issue #1561 [https://redmine.postgresql.org/issues/1561] - Added browse button to select the binary path in the Preferences.

Issue #1591 [https://redmine.postgresql.org/issues/1591] - Added Grant Wizard option under Package node.

Issue #2341 [https://redmine.postgresql.org/issues/2341] - Added support to launch PSQL for the connected database server.

Issue #4064 [https://redmine.postgresql.org/issues/4064] - Added window maximize/restore functionality for properties dialog.

Issue #5370 [https://redmine.postgresql.org/issues/5370] - Added support to set the binary path for the different database server versions.

Issue #6231 [https://redmine.postgresql.org/issues/6231] - Added OS, Browser, Configuration details in the About dialog.

Issue #6395 [https://redmine.postgresql.org/issues/6395] - Added support for rotating the pgAdmin log file on the basis of size and age.

Issue #6524 [https://redmine.postgresql.org/issues/6524] - Support non-admin installation on Windows.

Housekeeping

Issue #4622 [https://redmine.postgresql.org/issues/4622] - Added RESQL/MSQL test cases for Table and its child nodes.

Issue #6225 [https://redmine.postgresql.org/issues/6225] - Updated Flask-Security-Too to the latest v4.

Issue #6460 [https://redmine.postgresql.org/issues/6460] - Added a mechanism to detect a corrupt/broken config database file.

Bug fixes

Issue #4203 [https://redmine.postgresql.org/issues/4203] - Fixed the issue of renaming the database by another user.

Issue #6404 [https://redmine.postgresql.org/issues/6404] - Ensure that the Query Tool connection string should not be changed as per the ‘Query Tool tab title’.

Issue #6466 [https://redmine.postgresql.org/issues/6466] - Ensure that the user should be able to add members in Login/Role group while creating it.

Issue #6469 [https://redmine.postgresql.org/issues/6469] - Ensure that the calendar control should be disabled in the properties panel for Role.

Issue #6473 [https://redmine.postgresql.org/issues/6473] - Disable browser password saving in the runtime.

Issue #6478 [https://redmine.postgresql.org/issues/6478] - Fixed duplicate SQL issue for tables with more than one partition.

Issue #6482 [https://redmine.postgresql.org/issues/6482] - Fixed an issue where the Foreground Color property of server dialog does not work.

Issue #6513 [https://redmine.postgresql.org/issues/6513] - Fixed an issue where pgAdmin does not open after password reset in server mode.

Issue #6520 [https://redmine.postgresql.org/issues/6520] - Fixed an issue where a decimal number is appended for character varying fields while downloading the data in CSV format.

Version 5.3

Release date: 2021-05-20

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.2.

New features

Issue #5954 [https://redmine.postgresql.org/issues/5954] - Added support to set auto width of columns by content size in the data output window.

Issue #6158 [https://redmine.postgresql.org/issues/6158] - Added support to connect PostgreSQL servers via Kerberos authentication.

Issue #6397 [https://redmine.postgresql.org/issues/6397] - Added “IF NOT EXISTS” clause while creating tables and partition tables which is convenient while using the ERD tool.

Housekeeping

Bug fixes

Issue #4436 [https://redmine.postgresql.org/issues/4436] - Fixed an issue where drag and drop object is not correct in codemirror for properties dialog.

Issue #5477 [https://redmine.postgresql.org/issues/5477] - Added support for cache bust webpack chunk files.

Issue #5555 [https://redmine.postgresql.org/issues/5555] - Fixed an issue where data is displayed in the wrong order when executing the query repeatedly.

Issue #5776 [https://redmine.postgresql.org/issues/5776] - Ensure that while connecting to the server using SSPI login, it should not prompt for the password.

Issue #6329 [https://redmine.postgresql.org/issues/6329] - Fixed an issue where the wrong SQL is showing for the child partition tables.

Issue #6341 [https://redmine.postgresql.org/issues/6341] - Fixed an issue where CSV download quotes the numeric columns.

Issue #6355 [https://redmine.postgresql.org/issues/6355] - Ensure that pgAdmin should not allow opening external files that are dragged into it.

Issue #6377 [https://redmine.postgresql.org/issues/6377] - Fixed an issue where schema diff does not create DROP DEFAULT statement for columns.

Issue #6385 [https://redmine.postgresql.org/issues/6385] - Ensure that Backup and Restore should work on shared servers.

Issue #6392 [https://redmine.postgresql.org/issues/6392] - Fixed an issue where the filter ‘Include/Exclude By Selection’ not working for null values.

Issue #6399 [https://redmine.postgresql.org/issues/6399] - Ensure that the user should not be able to add duplicate panels.

Issue #6407 [https://redmine.postgresql.org/issues/6407] - Added support for the creation of Nested Table and Varying Array Type for Advanced Server.

Issue #6408 [https://redmine.postgresql.org/issues/6408] - Fixed ModuleNotFoundError when running setup.py from outside of the root.

Issue #6409 [https://redmine.postgresql.org/issues/6409] - Fixed an issue where the current debug line is not visible in the ‘Dark’ theme.

Issue #6413 [https://redmine.postgresql.org/issues/6413] - Fixed an issue where duplicate columns are visible in the browser tree, which is owned by two sequences.

Issue #6414 [https://redmine.postgresql.org/issues/6414] - Fixed an issue where the Help message not displaying correctly on Login/Group role.

Issue #6416 [https://redmine.postgresql.org/issues/6416] - Added comment column in the properties panel for View and Materialized View collection node.

Issue #6417 [https://redmine.postgresql.org/issues/6417] - Fixed an issue where query editor is not being closed if the user clicks on the ‘Don’t Save’ button.

Issue #6420 [https://redmine.postgresql.org/issues/6420] - Ensure that pgAdmin4 shut down completely on the Quit command.

Issue #6443 [https://redmine.postgresql.org/issues/6443] - Fixed an issue where file dialog showing incorrect files for the selected file types.

Issue #6444 [https://redmine.postgresql.org/issues/6444] - Fixed an issue where the user is not warned if Kerberos ticket expiration is less than 30 min while initiating a global backup.

Issue #6445 [https://redmine.postgresql.org/issues/6445] - Ensure that proper identification should be there when the server is connected using Kerberos or without Kerberos.

Version 5.2

Release date: 2021-04-22

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.1.

New features

Housekeeping

Issue #5319 [https://redmine.postgresql.org/issues/5319] - Improve code coverage and API test cases for Server module.

Bug fixes

Issue #4001 [https://redmine.postgresql.org/issues/4001] - Updated docs and screenshots to cover the Notifications tab on the Query Tool.

Issue #5519 [https://redmine.postgresql.org/issues/5519] - Ensure that the query tool tab should be closed after server disconnection when auto-commit/auto-rollback is set to false.

Issue #5908 [https://redmine.postgresql.org/issues/5908] - Fixed an issue where shortcut keys are not working with manage macro.

Issue #6076 [https://redmine.postgresql.org/issues/6076] - Fixed an issue where correct error not thrown while importing servers and JSON file has incorrect/insufficient keys.

Issue #6082 [https://redmine.postgresql.org/issues/6082] - Ensure that the user should not be to change the connection when a long query is running.

Issue #6107 [https://redmine.postgresql.org/issues/6107] - Fixed flickering issue of the input box on check constraints.

Issue #6161 [https://redmine.postgresql.org/issues/6161] - Fixed an issue where the cursor shifts its focus to the wrong window for all the query tool related model dialogs.

Issue #6220 [https://redmine.postgresql.org/issues/6220] - Corrected the syntax for ‘CREATE TRIGGER’, use ‘EXECUTE FUNCTION’ instead of ‘EXECUTE PROCEDURE’ from v11 onwards.

Issue #6274 [https://redmine.postgresql.org/issues/6274] - Ensure that the strings in the LDAP auth module are translatable.

Issue #6293 [https://redmine.postgresql.org/issues/6293] - Fixed an issue where the procedure creation is failed when providing the Volatility option.

Issue #6306 [https://redmine.postgresql.org/issues/6306] - Fixed an issue while selecting the row which was deleted just before the selection operation.

Issue #6325 [https://redmine.postgresql.org/issues/6325] - Ensure that the file format for the storage manager should be ‘All files’ and for other dialogs, it should remember the last selected format.

Issue #6327 [https://redmine.postgresql.org/issues/6327] - Ensure that while comparing domains check function dependencies should be considered in schema diff.

Issue #6333 [https://redmine.postgresql.org/issues/6333] - Fixed sizing issue of help dialog for Query Tool and ERD Tool when open in the new browser tab.

Issue #6334 [https://redmine.postgresql.org/issues/6334] - Fixed SQL panel black screen issue when detaching it in runtime.

Issue #6338 [https://redmine.postgresql.org/issues/6338] - Added missing dependency ‘xdg-utils’ for the desktop packages in RPM and Debian.

Issue #6344 [https://redmine.postgresql.org/issues/6344] - Fixed cannot unpack non-iterable response object error when selecting any partition.

Issue #6356 [https://redmine.postgresql.org/issues/6356] - Mark the Apache HTTPD config file as such in the web DEB and RPM packages.

Issue #6367 [https://redmine.postgresql.org/issues/6367] - Fixed an issue where the Save button is enabled by default when open the table’s properties dialog on PG 9.5.

Issue #6375 [https://redmine.postgresql.org/issues/6375] - Fixed an issue where users are unable to see data of the partitions using the View/Edit data option.

Issue #6376 [https://redmine.postgresql.org/issues/6376] - Fixed an issue where a connection warning should be displayed on the user clicks on explain or explain analyze and the database server is disconnected from the browser tree.

Issue #6379 [https://redmine.postgresql.org/issues/6379] - Fixed an issue where foreign data wrapper properties are not visible if the host option contains two host addresses.

Version 5.1

Release date: 2021-03-25

This release contains a number of bug fixes and new features since the release of pgAdmin4 5.0.

New features

Issue #5404 [https://redmine.postgresql.org/issues/5404] - Show the login roles that are members of a group role be shown when examining a group role.

Issue #6212 [https://redmine.postgresql.org/issues/6212] - Make the container distribution a multi-arch build with x86_64 and Arm64 support.

Issue #6268 [https://redmine.postgresql.org/issues/6268] - Make ‘kerberos’ an optional feature in the Python wheel, to avoid the need to install MIT Kerberos on the system by default.

Issue #6270 [https://redmine.postgresql.org/issues/6270] - Added ‘–replace’ option in Import server to replace the list of servers with the newly imported one.

Issue #6271 [https://redmine.postgresql.org/issues/6271] - Added zoom scaling options with keyboard shortcuts in runtime.

Housekeeping

Issue #3976 [https://redmine.postgresql.org/issues/3976] - Use schema qualification while accessing the catalog objects.

Issue #6176 [https://redmine.postgresql.org/issues/6176] - Make the ‘Save Data Changes’ icon to be more intuitive.

Bug fixes

Issue #4014 [https://redmine.postgresql.org/issues/4014] - Fixed alignment issue under preferences for the German language.

Issue #4020 [https://redmine.postgresql.org/issues/4020] - Fixed color issue on the statistics tab for collection node in the safari browser.

Issue #4438 [https://redmine.postgresql.org/issues/4438] - Fixed an issue where adding/updating records fails if the table name contains percent sign.

Issue #4784 [https://redmine.postgresql.org/issues/4784] - Ensure that autovacuum and analyze scale factors should be editable with more than two decimals.

Issue #4847 [https://redmine.postgresql.org/issues/4847] - Fixed an issue where % displayed twice in explain analyze for query and table.

Issue #4849 [https://redmine.postgresql.org/issues/4849] - Rename text ‘table’ with ‘relation’ in the statistic tab for explain analyze.

Issue #4959 [https://redmine.postgresql.org/issues/4959] - Fixed an issue where the properties tab for collection nodes is unresponsive after switching the tabs.

Issue #5073 [https://redmine.postgresql.org/issues/5073] - Fixed an issue where the Save button is enabled for functions/procedures by default when open the properties dialog.

Issue #5119 [https://redmine.postgresql.org/issues/5119] - Fixed an issue where hanging symlinks in a directory cause select file dialog to break.

Issue #5467 [https://redmine.postgresql.org/issues/5467] - Allow underscores in the Windows installation path.

Issue #5628 [https://redmine.postgresql.org/issues/5628] - Remove the “launch now” option in the Windows installer, as UAC could cause it to run as an elevated user.

Issue #5810 [https://redmine.postgresql.org/issues/5810] - Ensure that cell content being auto selected when editing the cell data.

Issue #5869 [https://redmine.postgresql.org/issues/5869] - Ensure that SQL formatter should not add extra tabs and format the SQL correctly.

Issue #6018 [https://redmine.postgresql.org/issues/6018] - Fixed encoding issue when database encoding set to SQL_ASCII and name of the column is in ASCII character.

Issue #6159 [https://redmine.postgresql.org/issues/6159] - Ensure that the user should be able to kill the session from Dashboard if the user has a ‘pg_signal_backend’ role.

Issue #6206 [https://redmine.postgresql.org/issues/6206] - Ensure that the view/edit data panel should not be opened for unsupported nodes using the keyboard shortcut.

Issue #6227 [https://redmine.postgresql.org/issues/6227] - Ensure PGADMIN_DEFAULT_EMAIL looks sane when initialising a container deployment.

Issue #6228 [https://redmine.postgresql.org/issues/6228] - Improve the web setup script for Linux to make the platform detection more robust and overrideable.

Issue #6233 [https://redmine.postgresql.org/issues/6233] - Ensure that SQL formatter should not use tab size if ‘Use spaces?’ set to false.

Issue #6253 [https://redmine.postgresql.org/issues/6253] - Fixed an issue where the user is unable to create a subscription if the host/IP address for connection is 127.0.0.1.

Issue #6259 [https://redmine.postgresql.org/issues/6259] - Ensure that proper error message should be shown on the properties and statistics tab in case of insufficient privileges for a subscription.

Issue #6260 [https://redmine.postgresql.org/issues/6260] - Fixed an issue where the ‘Create Slot’ option is disabled in case of the same IP/host provided but the port is different.

Issue #6269 [https://redmine.postgresql.org/issues/6269] - Ensure the Python interpreter used by the runtime ignores user site-packages.

Issue #6272 [https://redmine.postgresql.org/issues/6272] - Fixed an issue where the user is not able to change the connection in Query Tool when any SQL file is opened.

Issue #6279 [https://redmine.postgresql.org/issues/6279] - Ensure that the venv activation scripts have the correct path in them on Linux.

Issue #6281 [https://redmine.postgresql.org/issues/6281] - Fixed an issue where schema diff showing wrong SQL when comparing triggers with different when clause.

Issue #6286 [https://redmine.postgresql.org/issues/6286] - Ensure that the template database should be visible while creating the database.

Issue #6292 [https://redmine.postgresql.org/issues/6292] - Fixed string index out of range error where the dependent tab is in focus and selecting any publication or table.

Issue #6294 [https://redmine.postgresql.org/issues/6294] - Fixed an issue where the dependent tab throwing an error when selecting any login/group role.

Issue #6307 [https://redmine.postgresql.org/issues/6307] - Fixed an issue where the incorrect values visible in the dependents tab for publication.

Issue #6312 [https://redmine.postgresql.org/issues/6312] - Fixed an issue where copy/paste rows in view data paste the wrong value for boolean type.

Issue #6316 [https://redmine.postgresql.org/issues/6316] - Ensure that the primary key should be visible properly in the table dialog.

Issue #6317 [https://redmine.postgresql.org/issues/6317] - Ensure that toggle buttons are accessible by most screen readers.

Issue #6322 [https://redmine.postgresql.org/issues/6322] - Fixed an issue where the top menu disappears when entering into the full screen for minimum screen resolution.

Issue #6323 [https://redmine.postgresql.org/issues/6323] - Ensure that the grantor name should be visible properly for the security tab in the table dialog.

Version 5.0

Release date: 2021-02-25

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.30.

New features

Issue #5091 [https://redmine.postgresql.org/issues/5091] - Make Statistics, Dependencies, Dependants tabs closable and the user can add them back using the ‘Add panel’ option.

Issue #5912 [https://redmine.postgresql.org/issues/5912] - Added support for Logical Replication.

Issue #5967 [https://redmine.postgresql.org/issues/5967] - Implemented runtime using NWjs to open pgAdmin4 in a standalone window instead of the system tray and web browser.

Issue #6148 [https://redmine.postgresql.org/issues/6148] - Added Quick Search functionality for menu items and help articles.

Issue #6153 [https://redmine.postgresql.org/issues/6153] - Added publication and subscription support in Schema Diff.

Issue #6170 [https://redmine.postgresql.org/issues/6170] - Ensure logs are not stored in the container, and only sent to the console.

Housekeeping

Issue #5017 [https://redmine.postgresql.org/issues/5017] - Use cheroot as the default production server for pgAdmin4.

Issue #6145 [https://redmine.postgresql.org/issues/6145] - Documentation of Logical Replication.

Issue #6195 [https://redmine.postgresql.org/issues/6195] - Documentation of runtime with NWjs.

Issue #6196 [https://redmine.postgresql.org/issues/6196] - Documentation of Quick Search support.

Issue #6207 [https://redmine.postgresql.org/issues/6207] - Updated the JS dependencies to the latest.

Bug fixes

Issue #5809 [https://redmine.postgresql.org/issues/5809] - Fixed an issue where the focus is not properly set on the filter text editor after closing the error dialog.

Issue #5871 [https://redmine.postgresql.org/issues/5871] - Ensure that username should be visible in the ‘Connect to Server’ popup when service and user name both specified.

Issue #6045 [https://redmine.postgresql.org/issues/6045] - Fixed autocomplete issue where it is not showing any suggestions if the schema name contains escape characters.

Issue #6087 [https://redmine.postgresql.org/issues/6087] - Fixed an issue where the dependencies tab showing multiple owners for the objects having shared dependencies.

Issue #6117 [https://redmine.postgresql.org/issues/6117] - Fixed an issue where the user is unable to update column-level privileges from the security tab.

Issue #6143 [https://redmine.postgresql.org/issues/6143] - Fixed an issue where shared server entries not getting deleted from SQLite database if the user gets deleted.

Issue #6157 [https://redmine.postgresql.org/issues/6157] - Fixed an issue where strike-through is not visible for rows selected for deletion after scrolling.

Issue #6163 [https://redmine.postgresql.org/issues/6163] - Fixed an issue where Zoom to fit button only works if the diagram is larger than the canvas.

Issue #6164 [https://redmine.postgresql.org/issues/6164] - Ensure that the diagram should not vanish entirely if zooming out too far in ERD.

Issue #6177 [https://redmine.postgresql.org/issues/6177] - Fixed an issue while downloading ERD images in Safari and Firefox.

Issue #6178 [https://redmine.postgresql.org/issues/6178] - Fixed an issue where the user unable to change the background color for a server.

Issue #6179 [https://redmine.postgresql.org/issues/6179] - Fixed an issue where Generate SQL displayed twice in the ERD tool.

Issue #6180 [https://redmine.postgresql.org/issues/6180] - Updated missing documentation for the ‘Download Image’ option in ERD.

Issue #6187 [https://redmine.postgresql.org/issues/6187] - Limit the upgrade check to run once per day.

Issue #6193 [https://redmine.postgresql.org/issues/6193] - Ensure that ERD throws a warning before closing unsaved changes if open in a new tab.

Issue #6197 [https://redmine.postgresql.org/issues/6197] - Fixed an issue where the ERD image is not properly downloaded.

Issue #6201 [https://redmine.postgresql.org/issues/6201] - Added SSL support for creating a subscription.

Issue #6208 [https://redmine.postgresql.org/issues/6208] - Fixed an issue where utility(Backup, Maintenance, …) jobs are failing when the log level is set to DEBUG.

Issue #6230 [https://redmine.postgresql.org/issues/6230] - Fixed an issue where the user is not able to create the subscription.

Issue #6250 [https://redmine.postgresql.org/issues/6250] - Ensure DEB/RPM packages depend on the same version of each other.

Version 4.30

Release date: 2021-01-28

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.29.

New features

Issue #1802 [https://redmine.postgresql.org/issues/1802] - Added ERD Diagram support with basic table fields, primary key, foreign key, and DDL SQL generation.

Issue #5457 [https://redmine.postgresql.org/issues/5457] - Added support for Kerberos authentication, using SPNEGO to forward the Kerberos tickets through a browser.

Issue #6147 [https://redmine.postgresql.org/issues/6147] - Documentation of Kerberos support.

Issue #6152 [https://redmine.postgresql.org/issues/6152] - Documentation of ERD Diagram support.

Issue #6160 [https://redmine.postgresql.org/issues/6160] - Add a container option (PGADMIN_DISABLE_POSTFIX) to disable the Postfix server.

Housekeeping

Issue #5338 [https://redmine.postgresql.org/issues/5338] - Improve code coverage and API test cases for pgAgent.

Issue #6052 [https://redmine.postgresql.org/issues/6052] - Added connected pgAdmin user and connection name in the log file.

Issue #6079 [https://redmine.postgresql.org/issues/6079] - Updated mimetype from ‘text/javascript’ to ‘application/javascript’ as ‘text/javascript’ is obsolete.

Issue #6162 [https://redmine.postgresql.org/issues/6162] - Include PostgreSQL 13 utilities in the container.

Bug fixes

Issue #5282 [https://redmine.postgresql.org/issues/5282] - Added ‘Count Rows’ option to the partition sub tables.

Issue #5488 [https://redmine.postgresql.org/issues/5488] - Improve the explain plan details by showing popup instead of tooltip on clicking of the specified node.

Issue #5571 [https://redmine.postgresql.org/issues/5571] - Added support for expression in exclusion constraints.

Issue #5829 [https://redmine.postgresql.org/issues/5829] - Fixed incorrect log information for AUTHENTICATION_SOURCES.

Issue #5875 [https://redmine.postgresql.org/issues/5875] - Ensure that the ‘template1’ database should not be visible after pg_upgrade.

Issue #5905 [https://redmine.postgresql.org/issues/5905] - Fixed an issue where the Save button is enabled by default in Macro.

Issue #5906 [https://redmine.postgresql.org/issues/5906] - Remove extra line after Manage Macros menu while clearing all macros.

Issue #5907 [https://redmine.postgresql.org/issues/5907] - Ensure that ‘Clear All Rows’ should not work if there is no existing macro available and the user does not specify any value.

Issue #5929 [https://redmine.postgresql.org/issues/5929] - Fixed an issue where the server is disconnected error message displayed if the user creates Macro with invalid SQL.

Issue #5965 [https://redmine.postgresql.org/issues/5965] - Ensure that the macro query result should be download properly.

Issue #5973 [https://redmine.postgresql.org/issues/5973] - Added appropriate help message and a placeholder for letting users know about the account password expiry for Login/Group Role.

Issue #5997 [https://redmine.postgresql.org/issues/5997] - Updated Flask-BabelEx to the latest.

Issue #6046 [https://redmine.postgresql.org/issues/6046] - Fixed an issue where the state of the Save File icon does not match the dirty editor indicator.

Issue #6047 [https://redmine.postgresql.org/issues/6047] - Fixed an issue where the dirty indicator stays active even if all changes were undone.

Issue #6058 [https://redmine.postgresql.org/issues/6058] - Ensure that the rename panel should be disabled when the SQL file opened in the query tool.

Issue #6061 [https://redmine.postgresql.org/issues/6061] - Fixed extra parentheses issue around joins for Views.

Issue #6065 [https://redmine.postgresql.org/issues/6065] - Fixed accessibility issues in schema diff module.

Issue #6069 [https://redmine.postgresql.org/issues/6069] - Fixed an issue on refreshing files in Query Tool.

Issue #6075 [https://redmine.postgresql.org/issues/6075] - Fixed an issue where Non-admin user is unable to view shared server created using service.

Issue #6077 [https://redmine.postgresql.org/issues/6077] - Fixed accessibility issues in various dialogs.

Issue #6084 [https://redmine.postgresql.org/issues/6084] - Fixed TypeError exception in schema diff when selected any identical object.

Issue #6096 [https://redmine.postgresql.org/issues/6096] - Updated deployment documentation, refer correctly to uWSGI where Gunicorn had been referenced.

Issue #6098 [https://redmine.postgresql.org/issues/6098] - Fixed an issue of deleting records when the user tries to delete multiple records.

Issue #6120 [https://redmine.postgresql.org/issues/6120] - Ensure that the user should be able to specify an older date for the account expiration of the role/user.

Issue #6121 [https://redmine.postgresql.org/issues/6121] - Fixed an issue where the database list in the new connection window is not visible.

Issue #6122 [https://redmine.postgresql.org/issues/6122] - Added informative message when there is no difference found for schema diff.

Issue #6128 [https://redmine.postgresql.org/issues/6128] - Fixed an issue where sequences are not created.

Issue #6140 [https://redmine.postgresql.org/issues/6140] - Ensure that verbose logs should be visible for Utility(Backup, Maintenance) jobs.

Issue #6144 [https://redmine.postgresql.org/issues/6144] - Ensure that the current value of the sequence should be ignored while comparing using schema diff.

Version 4.29

Release date: 2020-12-10

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.28.

New features

Housekeeping

Issue #5328 [https://redmine.postgresql.org/issues/5328] - Improve code coverage and API test cases for Foreign Tables.

Issue #5337 [https://redmine.postgresql.org/issues/5337] - Improve code coverage and API test cases for Views and Materialized Views.

Issue #5343 [https://redmine.postgresql.org/issues/5343] - Improve code coverage and API test cases for Debugger.

Issue #6062 [https://redmine.postgresql.org/issues/6062] - Ensure that code coverage should cover class and function declarations.

Bug fixes

Issue #5886 [https://redmine.postgresql.org/issues/5886] - Fixed false error is shown while adding a new foreign key from the table dialog when a foreign key already exists with Auto FK Index set to true.

Issue #5943 [https://redmine.postgresql.org/issues/5943] - Ensure that folder rename should work properly in Storage Manager.

Issue #5974 [https://redmine.postgresql.org/issues/5974] - Fixed an issue where the debugger’s custom tab title not applied when opened in the new browser tab.

Issue #5978 [https://redmine.postgresql.org/issues/5978] - Fixed an issue where dynamic tab title has not applied the first time for debugger panel.

Issue #5982 [https://redmine.postgresql.org/issues/5982] - Fixed documentation issue where JSON is not valid.

Issue #5983 [https://redmine.postgresql.org/issues/5983] - Added the appropriate server icon based on the server type in the new connection dialog.

Issue #5985 [https://redmine.postgresql.org/issues/5985] - Fixed an issue where the process watcher dialog throws an error for the database server which is already removed.

Issue #5991 [https://redmine.postgresql.org/issues/5991] - Ensure that dirty indicator (*) should not be visible when renaming the tabs.

Issue #5992 [https://redmine.postgresql.org/issues/5992] - Fixed an issue where escape character is shown when the server/database name has some special characters.

Issue #5998 [https://redmine.postgresql.org/issues/5998] - Fixed an issue where schema diff doesn’t show the result of compare if source schema has tables with RLS.

Issue #6003 [https://redmine.postgresql.org/issues/6003] - Fixed an issue where an illegal argument is showing for trigger SQL when a trigger is created for View.

Issue #6022 [https://redmine.postgresql.org/issues/6022] - Fixed an issue where shared servers import is failing.

Issue #6072 [https://redmine.postgresql.org/issues/6072] - Fixed DLL load failed while importing bcrypt.

Version 4.28

Release date: 2020-11-12

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.27.

New features

Issue #3318 [https://redmine.postgresql.org/issues/3318] - Added support to download utility files at the client-side.

Issue #4230 [https://redmine.postgresql.org/issues/4230] - Added support to rename query tool and debugger tabs title.

Issue #4231 [https://redmine.postgresql.org/issues/4231] - Added support for dynamic tab size.

Issue #4232 [https://redmine.postgresql.org/issues/4232] - Added tab title placeholder for Query Tool, View/Edit Data, and Debugger.

Issue #5891 [https://redmine.postgresql.org/issues/5891] - Added support to compare schemas and databases in schema diff.

Housekeeping

Issue #5938 [https://redmine.postgresql.org/issues/5938] - Documentation of Storage Manager.

Bug fixes

Issue #4639 [https://redmine.postgresql.org/issues/4639] - Ensure that some fields should be disabled for the trigger in edit mode.

Issue #5736 [https://redmine.postgresql.org/issues/5736] - Fixed an issue where the validation error message is shown twice.

Issue #5760 [https://redmine.postgresql.org/issues/5760] - Ensure that non-superuser should be able to debug the function.

Issue #5842 [https://redmine.postgresql.org/issues/5842] - Ensure that query history should be listed by date/time in descending order.

Issue #5858 [https://redmine.postgresql.org/issues/5858] - Ensure that search object functionality works with case insensitive string.

Issue #5895 [https://redmine.postgresql.org/issues/5895] - Fixed an issue where the suffix for Toast table size is not visible in the Statistics tab.

Issue #5911 [https://redmine.postgresql.org/issues/5911] - Ensure that macros should be run on the older version of Safari and Chrome.

Issue #5914 [https://redmine.postgresql.org/issues/5914] - Fixed an issue where a mismatch in the value of ‘Estimated row’ for functions.

Issue #5919 [https://redmine.postgresql.org/issues/5919] - Added security related enhancements.

Issue #5923 [https://redmine.postgresql.org/issues/5923] - Fixed an issue where non-closeable tabs are getting closed.

Issue #5950 [https://redmine.postgresql.org/issues/5950] - Fixed an issue where a long file name is not visible on the process watcher dialog.

Issue #5953 [https://redmine.postgresql.org/issues/5953] - Fixed an issue where connection to the server is on wait state if a different user is provided.

Issue #5959 [https://redmine.postgresql.org/issues/5959] - Ensure that Grant Wizard should include foreign tables.

Version 4.27

Release date: 2020-10-15

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.26.

New features

Issue #1402 [https://redmine.postgresql.org/issues/1402] - Added Macro support.

Issue #2519 [https://redmine.postgresql.org/issues/2519] - Added support to view trigger function under the respective trigger node.

Issue #3794 [https://redmine.postgresql.org/issues/3794] - Allow user to change the database connection from an open query tool tab.

Issue #5200 [https://redmine.postgresql.org/issues/5200] - Added support to ignore the owner while comparing objects in the Schema Diff tool.

Issue #5857 [https://redmine.postgresql.org/issues/5857] - Added documentation for Macro support.

Housekeeping

Issue #5330 [https://redmine.postgresql.org/issues/5330] - Improve code coverage and API test cases for Functions.

Issue #5395 [https://redmine.postgresql.org/issues/5395] - Added RESQL/MSQL test cases for Functions.

Issue #5497 [https://redmine.postgresql.org/issues/5497] - Merged the latest code of ‘pgcli’ used for the autocomplete feature.

Bug fixes

Issue #4806 [https://redmine.postgresql.org/issues/4806] - Added useful message when the explain plan is not used and empty.

Issue #4855 [https://redmine.postgresql.org/issues/4855] - Fixed an issue where file extension is stripped on renaming a file.

Issue #5131 [https://redmine.postgresql.org/issues/5131] - Ensure that ‘ctrl + a’ shortcut does not move the cursor in SQL editor.

Issue #5417 [https://redmine.postgresql.org/issues/5417] - Fixed and improve API test cases for the schema diff tool.

Issue #5739 [https://redmine.postgresql.org/issues/5739] - Ensure that the import/export feature should work with SSH Tunnel.

Issue #5802 [https://redmine.postgresql.org/issues/5802] - Remove maximum length on the password field in the server dialog.

Issue #5807 [https://redmine.postgresql.org/issues/5807] - Fixed an issue where a column is renamed and then removed, then the drop SQL query takes the wrong column name.

Issue #5826 [https://redmine.postgresql.org/issues/5826] - Fixed an issue where schema diff is showing identical table as different due to default vacuum settings.

Issue #5830 [https://redmine.postgresql.org/issues/5830] - Fixed reverse engineering SQL where parenthesis is not properly arranged for View/MView definition.

Issue #5835 [https://redmine.postgresql.org/issues/5835] - Fixed ‘can’t execute an empty query’ message if the user change the option of Auto FK Index.

Issue #5839 [https://redmine.postgresql.org/issues/5839] - Ensure that multiple extensions can be dropped from the properties tab.

Issue #5841 [https://redmine.postgresql.org/issues/5841] - Fixed an issue where the server is not able to connect using the service.

Issue #5843 [https://redmine.postgresql.org/issues/5843] - Fixed an issue where the ‘PARALLEL UNSAFE’ option is missing from reverse engineering SQL of function/procedure.

Issue #5845 [https://redmine.postgresql.org/issues/5845] - Fixed an issue where the query tool is not fetching more than 1000 rows for the table does not have any primary key.

Issue #5853 [https://redmine.postgresql.org/issues/5853] - Fixed an issue where ‘Rows X’ column values were not visible properly for Explain Analyze in Dark theme.

Issue #5855 [https://redmine.postgresql.org/issues/5855] - Ensure that the user should be able to change the start value of the existing sequence.

Issue #5861 [https://redmine.postgresql.org/issues/5861] - Ensure that the ‘Remove Server’ option should be visible in the context menu.

Issue #5867 [https://redmine.postgresql.org/issues/5867] - Fixed an issue where some properties are not being updated correctly for the shared server.

Issue #5882 [https://redmine.postgresql.org/issues/5882] - Fixed invalid literal issue when fetching dependencies for Materialized View.

Issue #5885 [https://redmine.postgresql.org/issues/5885] - Fixed an issue where the user is unable to change the macro name.

Version 4.26

Release date: 2020-09-17

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.25.

New features

Issue #2042 [https://redmine.postgresql.org/issues/2042] - Added SQL Formatter support in Query Tool.

Issue #4059 [https://redmine.postgresql.org/issues/4059] - Added a new button to the query tool toolbar to open a new query tool window.

Issue #4979 [https://redmine.postgresql.org/issues/4979] - Added shared server support for admin users.

Issue #5772 [https://redmine.postgresql.org/issues/5772] - Warn the user when connecting to a server that is older than pgAdmin supports.

Housekeeping

Issue #5332 [https://redmine.postgresql.org/issues/5332] - Improve code coverage and API test cases for Columns and Constraints (Index, Foreign Key, Check, Exclusion).

Issue #5344 [https://redmine.postgresql.org/issues/5344] - Improve code coverage and API test cases for Grant Wizard.

Issue #5774 [https://redmine.postgresql.org/issues/5774] - Improve code coverage and API test cases for Tables.

Issue #5792 [https://redmine.postgresql.org/issues/5792] - Added documentation for shared server support.

Bug fixes

Issue #4216 [https://redmine.postgresql.org/issues/4216] - Ensure that schema names starting with ‘pg’ should be visible in browser tree when standard_conforming_strings is set to off.

Issue #5426 [https://redmine.postgresql.org/issues/5426] - Adjusted the height of jobstep code block to use maximum space.

Issue #5652 [https://redmine.postgresql.org/issues/5652] - Modified the ‘Commit’ and ‘Rollback’ query tool button icons.

Issue #5722 [https://redmine.postgresql.org/issues/5722] - Ensure that the user should be able to drop the database even if it is connected.

Issue #5732 [https://redmine.postgresql.org/issues/5732] - Fixed some accessibility issues.

Issue #5734 [https://redmine.postgresql.org/issues/5734] - Update the description of GIN and GiST indexes in the documentation.

Issue #5746 [https://redmine.postgresql.org/issues/5746] - Fixed an issue where –load-server does not allow loading connections that use pg_services.

Issue #5748 [https://redmine.postgresql.org/issues/5748] - Fixed incorrect reverse engineering SQL for Foreign key when creating a table.

Issue #5751 [https://redmine.postgresql.org/issues/5751] - Enable the ‘Configure’ and ‘View log’ menu option when the server taking longer than usual time to start.

Issue #5754 [https://redmine.postgresql.org/issues/5754] - Fixed an issue where schema diff is not working when providing the options to Foreign Data Wrapper, Foreign Server, and User Mapping.

Issue #5764 [https://redmine.postgresql.org/issues/5764] - Fixed SQL for Row Level Security which is incorrectly generated.

Issue #5765 [https://redmine.postgresql.org/issues/5765] - Fixed an issue in the query tool when columns are having the same name as javascript object internal functions.

Issue #5766 [https://redmine.postgresql.org/issues/5766] - Fixed string indices must be integers issue for PostgreSQL < 9.3.

Issue #5773 [https://redmine.postgresql.org/issues/5773] - Fixed an issue where the application ignores the fixed port configuration value.

Issue #5775 [https://redmine.postgresql.org/issues/5775] - Ensure that ‘setup-web.sh’ should work in Debian 10.

Issue #5779 [https://redmine.postgresql.org/issues/5779] - Remove illegal argument from trigger function in trigger DDL statement.

Issue #5794 [https://redmine.postgresql.org/issues/5794] - Fixed excessive CPU usage by stopping the indefinite growth of the graph dataset.

Issue #5815 [https://redmine.postgresql.org/issues/5815] - Fixed an issue where clicking on the ‘Generate script’ button shows a forever spinner due to pop up blocker.

Issue #5816 [https://redmine.postgresql.org/issues/5816] - Ensure that the ‘CREATE SCHEMA’ statement should be present in the generated script if the schema is not present in the target database.

Issue #5820 [https://redmine.postgresql.org/issues/5820] - Fixed an issue while refreshing Resource Group.

Issue #5833 [https://redmine.postgresql.org/issues/5833] - Fixed an issue where custom sequences are not visible when show system objects are set to false.

Issue #5834 [https://redmine.postgresql.org/issues/5834] - Ensure that the ‘Remove Server Group’ option is available in the context menu.

Version 4.25

Release date: 2020-08-20

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.24.

New features

Issue #3904 [https://redmine.postgresql.org/issues/3904] - Replace charting library Flotr2 with ChartJS using React.

Issue #5126 [https://redmine.postgresql.org/issues/5126] - Modified schema diff tool to compare two databases instead of two schemas.

Issue #5610 [https://redmine.postgresql.org/issues/5610] - Add a –yes command line option to setup-web.sh to allow non-interactive use.

Housekeeping

Issue #5324 [https://redmine.postgresql.org/issues/5324] - Improve code coverage and API test cases for Foreign Servers and User Mappings.

Issue #5327 [https://redmine.postgresql.org/issues/5327] - Improve code coverage and API test cases for Schemas.

Issue #5336 [https://redmine.postgresql.org/issues/5336] - Improve code coverage and API test cases for Types.

Issue #5700 [https://redmine.postgresql.org/issues/5700] - Remove old Python 2 compatibility code.

Issue #5731 [https://redmine.postgresql.org/issues/5731] - Upgrade font awesome from v4 to v5.

Bug fixes

Issue #3767 [https://redmine.postgresql.org/issues/3767] - Ensure that the original file format should be retained when saving the same file in SQL editor.

Issue #3791 [https://redmine.postgresql.org/issues/3791] - Added missing comments in reverse engineering SQL for each column of a View.

Issue #4123 [https://redmine.postgresql.org/issues/4123] - Fixed an issue where debugger doesn’t work if the search path is set other than ‘public’.

Issue #4361 [https://redmine.postgresql.org/issues/4361] - Fixed ssh tunnel hang issue when the user tries to disconnect the server.

Issue #4387 [https://redmine.postgresql.org/issues/4387] - Fixed an issue where the user is not able to insert the data if the table and columns name contains special characters.

Issue #4810 [https://redmine.postgresql.org/issues/4810] - Fixed an issue where the user is not able to save the new row if the table is empty.

Issue #5429 [https://redmine.postgresql.org/issues/5429] - Ensure that the Dictionaries drop-down shows all the dictionaries in the FTS configuration dialog.

Issue #5490 [https://redmine.postgresql.org/issues/5490] - Make the runtime configuration dialog non-modal.

Issue #5526 [https://redmine.postgresql.org/issues/5526] - Fixed an issue where copying and pasting a cell with multiple line data will result in multiple rows.

Issue #5567 [https://redmine.postgresql.org/issues/5567] - Fixed an issue where conversion of bytea to the binary string results in an error.

Issue #5604 [https://redmine.postgresql.org/issues/5604] - Fixed an issue where the entire logs is in red text when the user runs backup and restore.

Issue #5632 [https://redmine.postgresql.org/issues/5632] - Ensure that the user will be able to modify the start value of the Identity column.

Issue #5646 [https://redmine.postgresql.org/issues/5646] - Ensure that RLS Policy node should be searchable using search object.

Issue #5664 [https://redmine.postgresql.org/issues/5664] - Fixed an issue where ‘ALTER VIEW’ statement is missing when the user sets the default value of a column for View.

Issue #5670 [https://redmine.postgresql.org/issues/5670] - Fixed an issue where the error message does not have a close button on utility dialogs.

Issue #5689 [https://redmine.postgresql.org/issues/5689] - Added the ‘ORDER BY’ clause for the privileges type to fix schema diff issue.

Issue #5708 [https://redmine.postgresql.org/issues/5708] - Correct TLS certificate filename in the container deployment docs.

Issue #5710 [https://redmine.postgresql.org/issues/5710] - Fixed an issue when comparing the table with a trigger throwing error in schema diff.

Issue #5713 [https://redmine.postgresql.org/issues/5713] - Corrected DROP SQL syntax for catalog.

Issue #5716 [https://redmine.postgresql.org/issues/5716] - Fixed an issue where ajax call continues to fire even after disconnecting the database server.

Issue #5724 [https://redmine.postgresql.org/issues/5724] - Clarify some of the differences when running in server mode in the docs.

Issue #5730 [https://redmine.postgresql.org/issues/5730] - Resolve schema diff dependencies by selecting the appropriate node automatically and maintain the order in the generated script.

Version 4.24

Release date: 2020-07-23

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.23.

New features

Issue #5235 [https://redmine.postgresql.org/issues/5235] - Support configuration files that are external to the application installation.

Issue #5484 [https://redmine.postgresql.org/issues/5484] - Added support for LDAP authentication with different DN by setting the dedicated user for the LDAP connection.

Issue #5583 [https://redmine.postgresql.org/issues/5583] - Added support for schema level restriction.

Issue #5601 [https://redmine.postgresql.org/issues/5601] - Added RLS Policy support in Schema Diff.

Issue #5622 [https://redmine.postgresql.org/issues/5622] - Added support for permissive/restricted policy type while creating RLS Policy.

Issue #5650 [https://redmine.postgresql.org/issues/5650] - Added support for LDAP anonymous binding.

Issue #5653 [https://redmine.postgresql.org/issues/5653] - Added High Contrast theme support.

Housekeeping

Issue #5323 [https://redmine.postgresql.org/issues/5323] - Improve code coverage and API test cases for Foreign Data Wrapper.

Issue #5326 [https://redmine.postgresql.org/issues/5326] - Improve code coverage and API test cases for Domain and Domain Constraints.

Issue #5329 [https://redmine.postgresql.org/issues/5329] - Improve code coverage and API test cases for FTS Configuration, FTS Parser, FTS Dictionaries, and FTS Template.

Bug fixes

Issue #3814 [https://redmine.postgresql.org/issues/3814] - Fixed issue of error message not getting displayed when filename is empty for backup, restore, and import/export.

Issue #3851 [https://redmine.postgresql.org/issues/3851] - Add proper indentation to the code while generating functions, procedures, and trigger functions.

Issue #4235 [https://redmine.postgresql.org/issues/4235] - Fixed tab indent issue on a selection of lines is deleting the content when ‘use spaces == true’ in the preferences.

Issue #5137 [https://redmine.postgresql.org/issues/5137] - Fixed save button enable issue when focusing in and out of numeric input field.

Issue #5287 [https://redmine.postgresql.org/issues/5287] - Fixed dark theme-related CSS and modify the color codes.

Issue #5414 [https://redmine.postgresql.org/issues/5414] - Use QStandardPaths::AppLocalDataLocation in the runtime to determine where to store runtime logs.

Issue #5463 [https://redmine.postgresql.org/issues/5463] - Fixed an issue where CSV download quotes numeric columns.

Issue #5470 [https://redmine.postgresql.org/issues/5470] - Fixed backgrid row hover issue where on hover background color is set for edit and delete cell only.

Issue #5530 [https://redmine.postgresql.org/issues/5530] - Ensure that the referenced table should be displayed on foreign key constraints.

Issue #5554 [https://redmine.postgresql.org/issues/5554] - Replace the runtime themes with ones that don’t have sizing issues.

Issue #5569 [https://redmine.postgresql.org/issues/5569] - Fixed reverse engineered SQL for partitions when storage parameters are specified.

Issue #5577 [https://redmine.postgresql.org/issues/5577] - Include LICENSE and DEPENDENCIES [inventory] files in official packages.

Issue #5621 [https://redmine.postgresql.org/issues/5621] - Remove extra brackets from reverse engineering SQL of RLS Policy.

Issue #5629 [https://redmine.postgresql.org/issues/5629] - Fixed an issue where the user is able to edit properties when some of the collection nodes are selected.

Issue #5630 [https://redmine.postgresql.org/issues/5630] - Fixed an issue where installation of pgadmin4 not working on 32-bit Windows.

Issue #5631 [https://redmine.postgresql.org/issues/5631] - Fixed ‘cant execute empty query’ issue when remove the value of ‘USING’ or ‘WITH CHECK’ option of RLS Policy.

Issue #5633 [https://redmine.postgresql.org/issues/5633] - Ensure that create RLS Policy menu should not be visible for catalog objects.

Issue #5647 [https://redmine.postgresql.org/issues/5647] - Fixed an issue where difference DDL is showing the wrong SQL when changing the policy owner.

Issue #5662 [https://redmine.postgresql.org/issues/5662] - Fixed accessibility issue where few dialogs are not rendering properly when we zoomed in browser window 200% and screen resolution is low.

Issue #5666 [https://redmine.postgresql.org/issues/5666] - Added missing dependencies/dependent and corrected some wrongly identified.

Issue #5673 [https://redmine.postgresql.org/issues/5673] - Fixed an issue where fetching the schema throws an error if the database is not connected in Schema Diff.

Issue #5675 [https://redmine.postgresql.org/issues/5675] - Fixed CSRF errors when pgAdmin opened in an iframe on safari browser.

Issue #5677 [https://redmine.postgresql.org/issues/5677] - Fixed text color issue in explain analyze for the Dark theme.

Issue #5686 [https://redmine.postgresql.org/issues/5686] - Fixed issue where the user was not able to update policy if the policy is created with space.

Version 4.23

Release date: 2020-06-25

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.22.

New features

Issue #5468 [https://redmine.postgresql.org/issues/5468] - Added option to ignore the whitespaces while comparing objects in schema diff.

Issue #5500 [https://redmine.postgresql.org/issues/5500] - Added server group name while selecting servers in schema diff.

Issue #5516 [https://redmine.postgresql.org/issues/5516] - Added support of Row Security Policies.

Issue #5576 [https://redmine.postgresql.org/issues/5576] - Improve error messaging if the storage and log directories cannot be created.

Housekeeping

Issue #5325 [https://redmine.postgresql.org/issues/5325] - Improve code coverage and API test cases for Collations.

Issue #5574 [https://redmine.postgresql.org/issues/5574] - Cleanup Windows build scripts and ensure Windows x64 builds will work.

Issue #5581 [https://redmine.postgresql.org/issues/5581] - Documentation of Row Level Security Policies.

Bug fixes

Issue #3591 [https://redmine.postgresql.org/issues/3591] - Ensure that the query tool should display the proper error message while terminating the active session.

Issue #3669 [https://redmine.postgresql.org/issues/3669] - Ensure that proper error should be displayed for the deleted node.

Issue #3787 [https://redmine.postgresql.org/issues/3787] - Disabled the Stop process button after clicking it and added a message ‘Terminating the process…’ to notify the user.

Issue #4226 [https://redmine.postgresql.org/issues/4226] - Fixed an issue where select all checkbox only selects the first 50 tables.

Issue #5416 [https://redmine.postgresql.org/issues/5416] - Ensure that the query tool panel gets closed when clicking on the ‘Don’t Save’ button.

Issue #5465 [https://redmine.postgresql.org/issues/5465] - Fixed an issue where the Edge browser version is showing wrong and warning message gets displayed.

Issue #5492 [https://redmine.postgresql.org/issues/5492] - Fixed an issue where the search object is unable to locate inherited tables and constraint filters are not working.

Issue #5507 [https://redmine.postgresql.org/issues/5507] - Fixed connection and version number detection issue when the database server is upgraded.

Issue #5521 [https://redmine.postgresql.org/issues/5521] - Fixed an issue when dumping servers from a desktop pgAdmin app by providing an option ‘–sqlite-path’.

Issue #5539 [https://redmine.postgresql.org/issues/5539] - Fixed typo in exception keyword.

Issue #5584 [https://redmine.postgresql.org/issues/5584] - Fixed an issue where two identical tables showing different by schema diff tool.

Issue #5592 [https://redmine.postgresql.org/issues/5592] - Ensure that pgadmin should be able to connect to the server which has password more than 1000 characters.

Version 4.22

Release date: 2020-05-28

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.21.

New features

Issue #5452 [https://redmine.postgresql.org/issues/5452] - Added connected pgAdmin user and connection name in the log file.

Issue #5489 [https://redmine.postgresql.org/issues/5489] - Show the startup log as well as the server log in the runtime’s log viewer.

Housekeeping

Issue #5255 [https://redmine.postgresql.org/issues/5255] - Implement Selenium Grid to run multiple tests across different browsers, operating systems, and machines in parallel.

Issue #5333 [https://redmine.postgresql.org/issues/5333] - Improve code coverage and API test cases for Indexes.

Issue #5334 [https://redmine.postgresql.org/issues/5334] - Improve code coverage and API test cases for the Rules module.

Issue #5335 [https://redmine.postgresql.org/issues/5335] - Improve code coverage and API test cases for Triggers and Compound Triggers.

Issue #5443 [https://redmine.postgresql.org/issues/5443] - Remove support for Python 2.

Issue #5444 [https://redmine.postgresql.org/issues/5444] - Cleanup Python detection in the runtime project file.

Issue #5455 [https://redmine.postgresql.org/issues/5455] - Refactor pgAdmin4.py so it can be imported and is a lot more readable.

Issue #5493 [https://redmine.postgresql.org/issues/5493] - Search object UI improvements.

Issue #5525 [https://redmine.postgresql.org/issues/5525] - Cleanup and refactor the macOS build scripts.

Issue #5552 [https://redmine.postgresql.org/issues/5552] - Update dependencies in the Docker container.

Issue #5553 [https://redmine.postgresql.org/issues/5553] - Remove PG 9.4 utilities from the Docker container as it’s now out of support.

Bug fixes

Issue #3694 [https://redmine.postgresql.org/issues/3694] - Gracefully informed the user that the database is already connected when they click on “Connect Database…”.

Issue #4033 [https://redmine.postgresql.org/issues/4033] - Fixed an issue where clicking on the cross button of the alert box on the login page is not working.

Issue #4099 [https://redmine.postgresql.org/issues/4099] - Fixed the SQL help issue for EDB Postgres Advanced Server.

Issue #4223 [https://redmine.postgresql.org/issues/4223] - Ensure that maintenance job should be worked properly for indexes under a materialized view.

Issue #4279 [https://redmine.postgresql.org/issues/4279] - Ensure that file browse “home” button should point to $HOME rather than /.

Issue #4840 [https://redmine.postgresql.org/issues/4840] - Ensure that ‘With OID’ option should be disabled while taking backup of database server version 12 and above.

Issue #5001 [https://redmine.postgresql.org/issues/5001] - Fixed invalid literal issue when removing the connection limit for the existing role.

Issue #5052 [https://redmine.postgresql.org/issues/5052] - Fixed internal server error when clicking on Triggers -> ‘Enable All’ for partitions.

Issue #5398 [https://redmine.postgresql.org/issues/5398] - Fixed generated SQL issue for auto vacuum options.

Issue #5422 [https://redmine.postgresql.org/issues/5422] - Ensure that the dependencies tab shows correct information for Synonyms.

Issue #5434 [https://redmine.postgresql.org/issues/5434] - Fixed an issue where the newly added table is not alphabetically added to the tree.

Issue #5440 [https://redmine.postgresql.org/issues/5440] - Fixed list sorting issue in the schema diff tool.

Issue #5449 [https://redmine.postgresql.org/issues/5449] - Fixed an issue while comparing the two identical schemas using the schema diff tool.

Issue #5450 [https://redmine.postgresql.org/issues/5450] - Fixed an issue when renaming the column not added in the proper order.

Issue #5466 [https://redmine.postgresql.org/issues/5466] - Correct ipv4 “all interfaces” address in the container docs, per Frank Limpert.

Issue #5469 [https://redmine.postgresql.org/issues/5469] - Fixed an issue where select2 hover is inconsistent for the SSL field in create server dialog.

Issue #5473 [https://redmine.postgresql.org/issues/5473] - Fixed post-login redirect location when running in server mode under a non-default root.

Issue #5480 [https://redmine.postgresql.org/issues/5480] - Fixed an issue where the background job creation fails if there is only a version-specific python binary available in PATH.

Issue #5481 [https://redmine.postgresql.org/issues/5481] - Fixed data truncation issue when updating the data of type character with length.

Issue #5487 [https://redmine.postgresql.org/issues/5487] - Fixed an issue where if LDAP_SEARCH_BASE_DN is not set then, the value for LDAP_BASE_DN will be considered.

Issue #5496 [https://redmine.postgresql.org/issues/5496] - Fixed an issue where clicking on Select All button, not selecting all the options in pgAgent job scheduler.

Issue #5503 [https://redmine.postgresql.org/issues/5503] - Clarify and correct the docs on enabling the pl/debugger plugin on the server.

Issue #5510 [https://redmine.postgresql.org/issues/5510] - Fixed Unicode decode error ‘utf-8’ codec can’t decode byte.

Version 4.21

Release date: 2020-04-30

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.20.

New features

Issue #2172 [https://redmine.postgresql.org/issues/2172] - Added search object functionality.

Issue #2186 [https://redmine.postgresql.org/issues/2186] - Added LDAP authentication support.

Issue #4636 [https://redmine.postgresql.org/issues/4636] - Added job step and job schedule disable icons to identify it quickly within the browser tree.

Issue #5181 [https://redmine.postgresql.org/issues/5181] - Added support for parameter toast_tuple_target and parallel_workers of the table.

Issue #5263 [https://redmine.postgresql.org/issues/5263] - Added support of Foreign Tables to the Schema Diff.

Issue #5264 [https://redmine.postgresql.org/issues/5264] - Added support of Packages, Sequences and Synonyms to the Schema Diff.

Issue #5348 [https://redmine.postgresql.org/issues/5348] - Documentation of LDAP authentication support.

Issue #5353 [https://redmine.postgresql.org/issues/5353] - Added an option to prevent a browser tab being opened at startup.

Issue #5399 [https://redmine.postgresql.org/issues/5399] - Warn the user if an unsupported, deprecated or unknown browser is detected.

Housekeeping

Issue #4620 [https://redmine.postgresql.org/issues/4620] - Add Reverse Engineered and Modified SQL tests for procedures.

Issue #4623 [https://redmine.postgresql.org/issues/4623] - Add Reverse Engineered and Modified SQL tests for pgAgent jobs.

Bug fixes

Issue #1257 [https://redmine.postgresql.org/issues/1257] - Ensure all object types have a “System XXX?” property.

Issue #2813 [https://redmine.postgresql.org/issues/2813] - Ensure that the password prompt should not be visible if the database server is in trust authentication mode.

Issue #3495 [https://redmine.postgresql.org/issues/3495] - Fixed an issue where the query tool unable to load the file which contains the BOM marker.

Issue #3523 [https://redmine.postgresql.org/issues/3523] - Fixed an issue where right-clicking a browser object does not apply to the object on which right-click was fired.

Issue #3645 [https://redmine.postgresql.org/issues/3645] - Ensure that the start and end date should be deleted when clear the selection for pgAgent Job.

Issue #3900 [https://redmine.postgresql.org/issues/3900] - Added multiple drop/delete functionality for the table constraints.

Issue #3947 [https://redmine.postgresql.org/issues/3947] - Fixed copy-paste row issues in View/Edit Data.

Issue #3972 [https://redmine.postgresql.org/issues/3972] - Modified keyboard shortcuts in Query Tool for OSX native support.

Issue #3988 [https://redmine.postgresql.org/issues/3988] - Fixed cursor disappeared issue in the query editor for some of the characters when zoomed out.

Issue #4180 [https://redmine.postgresql.org/issues/4180] - Fixed mouse click issue where it does not select an object in Browser unless the pointer is over the object.

Issue #4206 [https://redmine.postgresql.org/issues/4206] - Ensure that the grant wizard should be closed on pressing the ESC key.

Issue #4292 [https://redmine.postgresql.org/issues/4292] - Added dark mode support for the configuration dialog on Windows/macOS runtime.

Issue #4440 [https://redmine.postgresql.org/issues/4440] - Ensure the DROP statements in reverse engineered SQL are properly quoted for all objects.

Issue #4445 [https://redmine.postgresql.org/issues/4445] - Ensure all object names in the title line of the reverse-engineered SQL are not quoted.

Issue #4504 [https://redmine.postgresql.org/issues/4504] - Fixed an issue where like options should be disabled if the relation is not selected while creating a table.

Issue #4512 [https://redmine.postgresql.org/issues/4512] - Fixed calendar opening issue on the exception tab inside the schedules tab of pgAgent.

Issue #4545 [https://redmine.postgresql.org/issues/4545] - Fixed an issue wherein grant wizard the last object is not selectable.

Issue #4573 [https://redmine.postgresql.org/issues/4573] - Ensure that if the delimiter is set other than comma then download the file as ‘.txt’ file.

Issue #4684 [https://redmine.postgresql.org/issues/4684] - Fixed encoding issue while saving data in encoded charset other than ‘utf-8’.

Issue #4709 [https://redmine.postgresql.org/issues/4709] - Added schema-qualified dictionary names in FTS configuration to avoid confusion of duplicate names.

Issue #4856 [https://redmine.postgresql.org/issues/4856] - Enable the save button by default when a query tool is opened with CREATE or other scripts.

Issue #4858 [https://redmine.postgresql.org/issues/4858] - Fixed python exception error when user tries to download the CSV and there is a connection issue.

Issue #4864 [https://redmine.postgresql.org/issues/4864] - Make the configuration window in runtime to auto-resize.

Issue #4873 [https://redmine.postgresql.org/issues/4873] - Fixed an issue when changing the comments of the procedure with arguments gives error in case of overloading.

Issue #4946 [https://redmine.postgresql.org/issues/4946] - Fixed an issue when the user creates a temporary table with ‘on commit drop as’ clause.

Issue #4957 [https://redmine.postgresql.org/issues/4957] - Ensure that Constraint Trigger, Deferrable, Deferred option should be disabled when the user selects EDB-SPL function for the trigger.

Issue #4969 [https://redmine.postgresql.org/issues/4969] - Fixed an issue where changing the values of columns with JSONB or JSON types to NULL.

Issue #5007 [https://redmine.postgresql.org/issues/5007] - Ensure index dropdown should have existing indexes while creating unique constraints.

Issue #5043 [https://redmine.postgresql.org/issues/5043] - Fixed an issue where columns names should be visible in the order of their creation in the browser tree.

Issue #5053 [https://redmine.postgresql.org/issues/5053] - Fixed an issue where changing the columns in the existing view throws an error.

Issue #5157 [https://redmine.postgresql.org/issues/5157] - Ensure that default sort order should be using the primary key in View/Edit data.

Issue #5180 [https://redmine.postgresql.org/issues/5180] - Fixed an issue where the autovacuum_enabled parameter is added automatically in the RE-SQL when the table has been created using the WITH clause.

Issue #5210 [https://redmine.postgresql.org/issues/5210] - Ensure that text larger than underlying field size should not be truncated automatically.

Issue #5213 [https://redmine.postgresql.org/issues/5213] - Fixed an issue when the user performs refresh on a large size materialized view.

Issue #5227 [https://redmine.postgresql.org/issues/5227] - Fixed an issue where user cannot be added if many users are already exists.

Issue #5268 [https://redmine.postgresql.org/issues/5268] - Fixed generated SQL when any token in FTS Configuration or any option in FTS Dictionary is changed.

Issue #5270 [https://redmine.postgresql.org/issues/5270] - Ensure that OID should be shown in properties for Synonyms.

Issue #5275 [https://redmine.postgresql.org/issues/5275] - Fixed tab key navigation issue for parameters in table dialog.

Issue #5302 [https://redmine.postgresql.org/issues/5302] - Fixed an issue where difference SQL is not seen in the schema diff tool for Types.

Issue #5314 [https://redmine.postgresql.org/issues/5314] - Ensure that switch cell is in sync with switch control for accessibility.

Issue #5315 [https://redmine.postgresql.org/issues/5315] - Fixed an issue where schema diff showing changes in the identical domain constraints.

Issue #5350 [https://redmine.postgresql.org/issues/5350] - Fixed an issue where schema diff marks an identical table as different.

Issue #5351 [https://redmine.postgresql.org/issues/5351] - Fixed compilation warnings while building pgAdmin.

Issue #5352 [https://redmine.postgresql.org/issues/5352] - Fixed the rightmost and bottom tooltip crop issues in the explain query plan.

Issue #5356 [https://redmine.postgresql.org/issues/5356] - Fixed modified SQL issue while adding an exception in pgAgent job schedule.

Issue #5361 [https://redmine.postgresql.org/issues/5361] - Fixes an issue where pgAdmin4 GUI does not display properly in IE 11.

Issue #5362 [https://redmine.postgresql.org/issues/5362] - Fixed an issue where the identical packages and sequences visible as different in the schema diff tool.

Issue #5366 [https://redmine.postgresql.org/issues/5366] - Added alert message to Reset Layout if any of the panels from Query Tool failed to load.

Issue #5371 [https://redmine.postgresql.org/issues/5371] - Fixed tab key navigation for some dialogs.

Issue #5375 [https://redmine.postgresql.org/issues/5375] - Fixed an issue where the Mode cell of argument grid does not appear completely in the Functions dialog.

Issue #5383 [https://redmine.postgresql.org/issues/5383] - Fixed syntax error while refreshing the existing synonyms.

Issue #5387 [https://redmine.postgresql.org/issues/5387] - Fixed an issue where the mode is not shown in the properties dialog of functions/procedures if all the arguments are “IN” arguments.

Issue #5396 [https://redmine.postgresql.org/issues/5396] - Fixed an issue where the search object module unable to locate the object in the browser tree.

Issue #5400 [https://redmine.postgresql.org/issues/5400] - Fixed internal server error when the database server is logged in with non-super user.

Issue #5401 [https://redmine.postgresql.org/issues/5401] - Fixed search object issue when the object name contains special characters.

Issue #5402 [https://redmine.postgresql.org/issues/5402] - Fixed an issue where the checkbox is not visible on Configuration dialog in runtime for the dark theme.

Issue #5409 [https://redmine.postgresql.org/issues/5409] - Fixed validation issue in Synonyms node.

Issue #5410 [https://redmine.postgresql.org/issues/5410] - Fixed an issue while removing the package body showing wrong modified SQL.

Issue #5415 [https://redmine.postgresql.org/issues/5415] - Ensure that the query tool context menu should work on the collection nodes.

Issue #5419 [https://redmine.postgresql.org/issues/5419] - Ensure that the user should not be able to change the authentication source.

Issue #5420 [https://redmine.postgresql.org/issues/5420] - Ensure error should be handled properly when LDAP user is created with the same name.

Issue #5430 [https://redmine.postgresql.org/issues/5430] - Added title to the login page.

Issue #5432 [https://redmine.postgresql.org/issues/5432] - Fixed an issue where an internal user is not created if the authentication source is set to internal and ldap.

Issue #5439 [https://redmine.postgresql.org/issues/5439] - Fixed an issue where the user is not able to create a server if login with an LDAP account.

Issue #5441 [https://redmine.postgresql.org/issues/5441] - Fixed an issue where the search object not able to locate pg_toast_* tables in the pg_toast schema.

Issue #5447 [https://redmine.postgresql.org/issues/5447] - Fixed failed to fetch utility error when click on refresh(any option) materialized view.

Version 4.20

Release date: 2020-04-02

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.19.

New features

Issue #5261 [https://redmine.postgresql.org/issues/5261] - Added support of Collation, FTS Configuration, FTS Dictionary, FTS Parser and FTS Template to the Schema Diff.

Issue #5262 [https://redmine.postgresql.org/issues/5262] - Added support of Domain, Domain Constraints and Types to the Schema Diff.

Housekeeping

Issue #5271 [https://redmine.postgresql.org/issues/5271] - Enhance the color of switch control for both light and dark theme.

Issue #5284 [https://redmine.postgresql.org/issues/5284] - Added and fixed gettext usage for better translation coverage.

Bug fixes

Issue #4237 [https://redmine.postgresql.org/issues/4237] - Fix an issue where the user can not change the value of DateTime picker control using keyboard.

Issue #4608 [https://redmine.postgresql.org/issues/4608] - Fixed some accessibility issues in the dialogs.

Issue #4942 [https://redmine.postgresql.org/issues/4942] - Fixed chrome driver download utility issue for Ubuntu.

Issue #5128 [https://redmine.postgresql.org/issues/5128] - Change some colors and opacity to comply with WCAG color contrast standards.

Issue #5143 [https://redmine.postgresql.org/issues/5143] - Fix an accessibility issue to maximize the panel for all alertify dialog.

Issue #5221 [https://redmine.postgresql.org/issues/5221] - Improve logic to get the DDL statements as a part of the comparison.

Issue #5241 [https://redmine.postgresql.org/issues/5241] - Fixed tab key navigation issue for Grant Wizard.

Issue #5279 [https://redmine.postgresql.org/issues/5279] - Fixed Unicode character issue causing error on Python2 environment.

Issue #5292 [https://redmine.postgresql.org/issues/5292] - Fixed focus color issue for Alertify dialog buttons.

Version 4.19

Release date: 2020-03-05

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.18.

New features

Issue #5154 [https://redmine.postgresql.org/issues/5154] - Added accessibility support in AlertifyJS.

Issue #5170 [https://redmine.postgresql.org/issues/5170] - Added Czech language support.

Issue #5179 [https://redmine.postgresql.org/issues/5179] - Added Python 3.8 support.

Housekeeping

Issue #5088 [https://redmine.postgresql.org/issues/5088] - Improve code coverage and API test cases for the Event Trigger module.

Issue #5133 [https://redmine.postgresql.org/issues/5133] - Improvements in the UI for both default and dark themes.

Issue #5176 [https://redmine.postgresql.org/issues/5176] - Enhance logging by tracking stdout and stderr of subprocess when log level set to DEBUG.

Issue #5185 [https://redmine.postgresql.org/issues/5185] - Added option to override the class name of a label tag for select2 control.

Bug fixes

Issue #4955 [https://redmine.postgresql.org/issues/4955] - Changed the color of selected and hovered item for Select2 dropdown.

Issue #4996 [https://redmine.postgresql.org/issues/4996] - Improve the style of the highlighted code after query execution for Dark mode.

Issue #5058 [https://redmine.postgresql.org/issues/5058] - Ensure that AlertifyJS should not be visible as a title for alert dialog.

Issue #5077 [https://redmine.postgresql.org/issues/5077] - Changed background pattern for geometry viewer to use #fff for all themes.

Issue #5101 [https://redmine.postgresql.org/issues/5101] - Fix an issue where debugger not showing all arguments anymore after hitting SQL error while debugging.

Issue #5107 [https://redmine.postgresql.org/issues/5107] - Set proper focus on tab navigation for file manager dialog.

Issue #5115 [https://redmine.postgresql.org/issues/5115] - Fix an issue where command and statements were parsed incorrectly for Rules.

Issue #5142 [https://redmine.postgresql.org/issues/5142] - Ensure that all the transactions should be canceled before closing the connections when a server is disconnected using pgAdmin.

Issue #5184 [https://redmine.postgresql.org/issues/5184] - Fixed Firefox monospaced issue by updating the font to the latest version.

Issue #5214 [https://redmine.postgresql.org/issues/5214] - Update Flask-SQLAlchemy and SQLAlchemy package which is not working on Windows with Python 3.8.

Issue #5215 [https://redmine.postgresql.org/issues/5215] - Fix syntax error when changing the event type for the existing rule.

Version 4.18

Release date: 2020-02-06

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.17.

New features

Issue #2554 [https://redmine.postgresql.org/issues/2554] - Added support for a multi-level partitioned table.

Issue #3452 [https://redmine.postgresql.org/issues/3452] - Added a Schema Diff tool to compare two schemas and generate a diff script.

Issue #4762 [https://redmine.postgresql.org/issues/4762] - Allow screen-reader to read label & description of non-textable elements.

Issue #4763 [https://redmine.postgresql.org/issues/4763] - Allow screen-reader to identify the alert errors.

Issue #4770 [https://redmine.postgresql.org/issues/4770] - Added labels and titles after parsing and validating all the pgAdmin4 web pages for accessibility.

Issue #4993 [https://redmine.postgresql.org/issues/4993] - Set input controls as read-only instead of disabled will allow tab navigation in the properties tab and also allow screen readers to read it.

Housekeeping

Issue #5049 [https://redmine.postgresql.org/issues/5049] - Improve code coverage and API test cases for the CAST module.

Issue #5050 [https://redmine.postgresql.org/issues/5050] - Improve code coverage and API test cases for the LANGUAGE module.

Issue #5071 [https://redmine.postgresql.org/issues/5071] - Improve the test framework to run for multiple classes defined in a single file.

Issue #5072 [https://redmine.postgresql.org/issues/5072] - Updated wcDocker package which includes aria-label accessibility improvements.

Issue #5096 [https://redmine.postgresql.org/issues/5096] - Replace node-sass with sass for SCSS compilation.

Bug fixes

Issue #3812 [https://redmine.postgresql.org/issues/3812] - Ensure that path file name should not disappear when changing ext from the dropdown in file explorer dialog.

Issue #4410 [https://redmine.postgresql.org/issues/4410] - Fixed an issue while editing char[] or character varying[] column from View/Edit data throwing an error.

Issue #4511 [https://redmine.postgresql.org/issues/4511] - Fixed an issue where Grant wizard unable to handle multiple objects when the query string parameter exceeds its limit.

Issue #4601 [https://redmine.postgresql.org/issues/4601] - Added tab navigation on close buttons for all the panels and create/properties dialog.

Issue #4827 [https://redmine.postgresql.org/issues/4827] - Fix column resizable issue in the file explorer dialog.

Issue #5000 [https://redmine.postgresql.org/issues/5000] - Logout the pgAdmin session when no user activity of mouse move, click or keypress.

Issue #5025 [https://redmine.postgresql.org/issues/5025] - Fix an issue where setting STORAGE_DIR to empty should show all the volumes on Windows in server mode.

Issue #5065 [https://redmine.postgresql.org/issues/5065] - Updated the incorrect icon used for the cast node on refresh.

Issue #5066 [https://redmine.postgresql.org/issues/5066] - Fix an issue where refreshing a package results in the change in the object completely.

Issue #5074 [https://redmine.postgresql.org/issues/5074] - Fix an issue where select, insert and update scripts on tables throwing an error.

Issue #5076 [https://redmine.postgresql.org/issues/5076] - Ensure Postfix starts in the container, now it runs as non-root by default.

Issue #5116 [https://redmine.postgresql.org/issues/5116] - Fixed an issue where Save Password control disappears after clicking on it while creating a server.

Version 4.17

Release date: 2020-01-09

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.16.

New features

Issue #4764 [https://redmine.postgresql.org/issues/4764] - Allow screen-reader to read relationship attributes in nested elements.

Issue #5060 [https://redmine.postgresql.org/issues/5060] - Ensure all binaries are securely signed and linked with the hardened runtime in the macOS bundle

Housekeeping

Issue #4988 [https://redmine.postgresql.org/issues/4988] - Refactored SQL of Table’s and it’s child nodes.

Issue #5023 [https://redmine.postgresql.org/issues/5023] - Refactored SQL of Views and Materialized Views.

Issue #5024 [https://redmine.postgresql.org/issues/5024] - Refactored SQL of Functions and Procedures.

Issue #5038 [https://redmine.postgresql.org/issues/5038] - Added support for on-demand loading of items in Select2.

Issue #5048 [https://redmine.postgresql.org/issues/5048] - Added code coverage tool for pgAdmin.

Bug fixes

Issue #4198 [https://redmine.postgresql.org/issues/4198] - Fix syntax highlighting in code mirror for backslash and escape constant.

Issue #4506 [https://redmine.postgresql.org/issues/4506] - Fix an issue where clicking on an empty textbox like fill factor or comments, considers it as change and enabled the save button.

Issue #4633 [https://redmine.postgresql.org/issues/4633] - Added support to view multilevel partitioned tables.

Issue #4842 [https://redmine.postgresql.org/issues/4842] - Ensure that constraints, indexes, rules, triggers, and compound triggers should be created on partitions.

Issue #4943 [https://redmine.postgresql.org/issues/4943] - Added more information to the ‘Database connected/disconnected’ message.

Issue #4950 [https://redmine.postgresql.org/issues/4950] - Ensure that the user should be able to select/modify tablespace for the partitioned table on v12 and above.

Issue #4999 [https://redmine.postgresql.org/issues/4999] - Rename some internal environment variables that could conflict with Kubernetes.

Issue #5004 [https://redmine.postgresql.org/issues/5004] - Fix vulnerability issues reported by ‘yarn audit’. Replace the deprecated uglifyjs-webpack-plugin with a terser-webpack-plugin.

Issue #5008 [https://redmine.postgresql.org/issues/5008] - Ensure that the error message should not be displayed if Tablespace is not selected while creating the index.

Issue #5009 [https://redmine.postgresql.org/issues/5009] - Fix an issue where operator, access method and operator class is not visible for exclusion constraints.

Issue #5013 [https://redmine.postgresql.org/issues/5013] - Add a note to the documentation about the use of non-privileged ports on filesystems that don’t support extended attributes when running the container.

Issue #5047 [https://redmine.postgresql.org/issues/5047] - Added tab navigation for tabs under explain panel in query tool.

Issue #5068 [https://redmine.postgresql.org/issues/5068] - Fix an issue where the table is not created with autovacuum_enabled and toast.autovacuum_enabled for PG/EPAS 12.

Version 4.16

Release date: 2019-12-12

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.15.

Warning

Warning: This release includes a change to the container distribution to run pgAdmin as a non-root user. Those users of the container who are running with mapped storage directories may need to change the ownership on the host machine, for example:

sudo chown -R 5050:5050 <host_directory>

New features

Issue #4396 [https://redmine.postgresql.org/issues/4396] - Warn the user on changing the definition of Materialized View about the loss of data and its dependent objects.

Issue #4435 [https://redmine.postgresql.org/issues/4435] - Allow drag and drop functionality for all the nodes under the database node, excluding collection nodes.

Issue #4711 [https://redmine.postgresql.org/issues/4711] - Use a ‘play’ icon for the Execute Query button in the Query Tool for greater consistency with other applications.

Issue #4772 [https://redmine.postgresql.org/issues/4772] - Added aria-label to provide an invisible label where a visible label cannot be used.

Issue #4773 [https://redmine.postgresql.org/issues/4773] - Added role=”status” attribute to all the status messages for accessibility.

Issue #4939 [https://redmine.postgresql.org/issues/4939] - Run pgAdmin in the container as a non-root user (pgadmin, UID: 5050)

Issue #4944 [https://redmine.postgresql.org/issues/4944] - Allow Gunicorn logs in the container to be directed to a file specified through GUNICORN_ACCESS_LOGFILE.

Issue #4990 [https://redmine.postgresql.org/issues/4990] - Changed the open query tool and data filter icons.

Housekeeping

Issue #4696 [https://redmine.postgresql.org/issues/4696] - Add Reverse Engineered and Modified SQL tests for Materialized Views.

Issue #4807 [https://redmine.postgresql.org/issues/4807] - Refactored code of table and it’s child nodes.

Issue #4938 [https://redmine.postgresql.org/issues/4938] - Refactored code of columns node.

Bug fixes

Issue #3538 [https://redmine.postgresql.org/issues/3538] - Fix issue where the Reset button does not get enabled till all the mandatory fields are provided in the dialog.

Issue #4220 [https://redmine.postgresql.org/issues/4220] - Fix scrolling issue in ‘Users’ dialog.

Issue #4516 [https://redmine.postgresql.org/issues/4516] - Remove the sorting of table headers with no labels.

Issue #4659 [https://redmine.postgresql.org/issues/4659] - Updated documentation for default privileges to clarify more on the grantor.

Issue #4674 [https://redmine.postgresql.org/issues/4674] - Fix query tool launch error if user name contains HTML characters. It’s a regression.

Issue #4724 [https://redmine.postgresql.org/issues/4724] - Fix network disconnect issue while establishing the connection via SSH Tunnel and it impossible to expand the Servers node.

Issue #4761 [https://redmine.postgresql.org/issues/4761] - Fix an issue where the wrong type is displayed when changing the datatype from timestamp with time zone to timestamp without time zone.

Issue #4792 [https://redmine.postgresql.org/issues/4792] - Ensure that the superuser should be able to create database, as the superuser overrides all the access restrictions.

Issue #4818 [https://redmine.postgresql.org/issues/4818] - Fix server connection drops out issue in query tool.

Issue #4836 [https://redmine.postgresql.org/issues/4836] - Updated the json file name from ‘servers.json’ to ‘pgadmin4/servers.json’ in the container deployment section of the documentation.

Issue #4878 [https://redmine.postgresql.org/issues/4878] - Ensure that the superuser should be able to create role, as the superuser overrides all the access restrictions.

Issue #4893 [https://redmine.postgresql.org/issues/4893] - Fix reverse engineering SQL issue for partitions when specifying digits as comments.

Issue #4923 [https://redmine.postgresql.org/issues/4923] - Enhance the logic to change the label from ‘Delete/Drop’ to ‘Remove’ for the server and server group node.

Issue #4925 [https://redmine.postgresql.org/issues/4925] - Shown some text on process watcher till the initial logs are loaded.

Issue #4926 [https://redmine.postgresql.org/issues/4926] - Fix VPN network disconnect issue where pgAdmin4 hangs on expanding the Servers node.

Issue #4930 [https://redmine.postgresql.org/issues/4930] - Fix main window tab navigation accessibility issue.

Issue #4933 [https://redmine.postgresql.org/issues/4933] - Ensure that the Servers collection node should expand independently of server connections.

Issue #4934 [https://redmine.postgresql.org/issues/4934] - Fix the help button link on the User Management dialog.

Issue #4935 [https://redmine.postgresql.org/issues/4935] - Fix accessibility issues.

Issue #4947 [https://redmine.postgresql.org/issues/4947] - Fix XSS issue in explain and explain analyze for table and type which contain HTML.

Issue #4952 [https://redmine.postgresql.org/issues/4952] - Fix an issue of retrieving properties for Compound Triggers. It’s a regression of #4006.

Issue #4953 [https://redmine.postgresql.org/issues/4953] - Fix an issue where pgAdmin4 unable to retrieve table node if the trigger is already disabled and the user clicks on Enable All.

Issue #4958 [https://redmine.postgresql.org/issues/4958] - Fix reverse engineering SQL issue for triggers when passed a single argument to trigger function.

Issue #4964 [https://redmine.postgresql.org/issues/4964] - Fix an issue where length and precision are not removed from table/column dialog.

Issue #4965 [https://redmine.postgresql.org/issues/4965] - Fix an issue where the Interval data type is not displayed in the properties dialog of table/column.

Issue #4966 [https://redmine.postgresql.org/issues/4966] - Fix ‘Could not find the object on the server.’ error while refreshing the check constraint.

Issue #4975 [https://redmine.postgresql.org/issues/4975] - Fix issue where the user can not switch the UI language. It’s a regression of #4348.

Issue #4976 [https://redmine.postgresql.org/issues/4976] - Fix reverse engineering SQL issue where when clause is not visible for PG/EPAS 12.

Issue #4978 [https://redmine.postgresql.org/issues/4978] - Fix pgAdmin4 failed to start issue after upgrading to version 4.15.

Issue #4982 [https://redmine.postgresql.org/issues/4982] - Added statistics and storage information in reverse engineering SQL of table/column.

Issue #4985 [https://redmine.postgresql.org/issues/4985] - Fix an issue where the inherited table name with quotes did not escape correctly.

Issue #4991 [https://redmine.postgresql.org/issues/4991] - Fix an issue where context menu is open along with submenu and the focus is not on context menu or submenu.

Version 4.15

Release date: 2019-11-14

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.14.

New features

Issue #1974 [https://redmine.postgresql.org/issues/1974] - Added encrypted password in reverse engineered SQL for roles.

Issue #3741 [https://redmine.postgresql.org/issues/3741] - Added Dark(Beta) UI Theme option.

Issue #4006 [https://redmine.postgresql.org/issues/4006] - Support Enable Always and Enable Replica on triggers.

Issue #4351 [https://redmine.postgresql.org/issues/4351] - Add an option to request confirmation before cancelling/resetting changes on a Properties dialog.

Issue #4348 [https://redmine.postgresql.org/issues/4348] - Added support for custom theme creation and selection.

Housekeeping

Bug fixes

Issue #3130 [https://redmine.postgresql.org/issues/3130] - Ensure create new object dialog should be opened when alt+shift+n key is pressed on the collection node.

Issue #3279 [https://redmine.postgresql.org/issues/3279] - Fixed issue where Drop and Disconnect connection menu points are too close to each other.

Issue #3789 [https://redmine.postgresql.org/issues/3789] - Ensure context menus never get hidden below the menu bar.

Issue #3859 [https://redmine.postgresql.org/issues/3859] - Rename the context menu from ‘Drop Server’ to ‘Remove Server’.

Issue #3913 [https://redmine.postgresql.org/issues/3913] - Ensure the correct “running at” agent is shown when a pgAgent job is executing.

Issue #3915 [https://redmine.postgresql.org/issues/3915] - Fix an issue in the Query Tool where shortcut keys could be ignored following a query error.

Issue #3999 [https://redmine.postgresql.org/issues/3999] - Fix the toggle case shortcut key combination.

Issue #4173 [https://redmine.postgresql.org/issues/4173] - Fix an issue where a black arrow-kind image is displaying at the background of browser tree images.

Issue #4191 [https://redmine.postgresql.org/issues/4191] - Ensure comments are shown in reverse engineered SQL for table partitions.

Issue #4242 [https://redmine.postgresql.org/issues/4242] - Handle NULL values appropriately when sorting backgrid tables.

Issue #4341 [https://redmine.postgresql.org/issues/4341] - Give appropriate error messages when the user tries to use an blank master password.

Issue #4451 [https://redmine.postgresql.org/issues/4451] - Remove arbitrary (and incorrect) requirement that composite types must have at least two members.

Issue #4459 [https://redmine.postgresql.org/issues/4459] - Don’t quote bigints when copying them from the Query Tool results grid.

Issue #4482 [https://redmine.postgresql.org/issues/4482] - Ensure compression level is passed to pg_dump when backing up in directory format.

Issue #4483 [https://redmine.postgresql.org/issues/4483] - Ensure the number of jobs can be specified when backing up in directory format.

Issue #4564 [https://redmine.postgresql.org/issues/4564] - Ensure Javascript errors during Query Tool execution are reported as such and not as Ajax errors.

Issue #4610 [https://redmine.postgresql.org/issues/4610] - Suppress Enter key presses in Alertify dialogues when the come from Select2 controls to allow item selection with Enter.

Issue #4647 [https://redmine.postgresql.org/issues/4647] - Ensure that units are respected when sorting by file size in the File dialog.

Issue #4730 [https://redmine.postgresql.org/issues/4730] - Ensure all messages are retained in the Query Tool from long running queries.

Issue #4734 [https://redmine.postgresql.org/issues/4734] - Updated documentation for the delete row button that only strikeout the row instead of deleting it.

Issue #4779 [https://redmine.postgresql.org/issues/4779] - Updated documentation for the query tool toolbar buttons.

Issue #4835 [https://redmine.postgresql.org/issues/4835] - Fixed an issue where psql of v12 throwing “symbol not found” error while running Maintenance and Import/Export.

Issue #4845 [https://redmine.postgresql.org/issues/4845] - Fixed potential error in the properties dialog for the Code tab.

Issue #4850 [https://redmine.postgresql.org/issues/4850] - Fixed an issue where Datetimepicker control opens when clicking on the label.

Issue #4895 [https://redmine.postgresql.org/issues/4895] - Fixed potential issue in reset function for nested objects.

Issue #4896 [https://redmine.postgresql.org/issues/4896] - Fixed an issue where escape key not working to close the open/save file dialog.

Issue #4906 [https://redmine.postgresql.org/issues/4906] - Fixed an issue where keyboard shortcut for context menu is not working when using Firefox on CentOS7.

Issue #4924 [https://redmine.postgresql.org/issues/4924] - Fixed docker container exit issue occurs due to change in Gunicorn’s latest version.

Version 4.14

Release date: 2019-10-17

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.13.

New features

Issue #3009 [https://redmine.postgresql.org/issues/3009] - Added Copy with headers functionality when copy data from Query Tool/View Data.

Issue #4778 [https://redmine.postgresql.org/issues/4778] - Implemented the Query Plan Analyser.

Issue #4823 [https://redmine.postgresql.org/issues/4823] - Include PostgreSQL 12 binaries in the container.

Housekeeping

Issue #4472 [https://redmine.postgresql.org/issues/4472] - Add Reverse Engineered and Modified SQL tests for Synonyms.

Issue #4628 [https://redmine.postgresql.org/issues/4628] - Add Reverse Engineered and Modified SQL tests for Unique Constraints.

Issue #4701 [https://redmine.postgresql.org/issues/4701] - Optimize Webpack to improve overall performance.

Bug fixes

Issue #3386 [https://redmine.postgresql.org/issues/3386] - Ensure backup a partition table should not backup the whole database.

Issue #4199 [https://redmine.postgresql.org/issues/4199] - Ensure that ‘ENTER’ key in the data filter should not run the query.

Issue #4590 [https://redmine.postgresql.org/issues/4590] - Fix issue where backup fails for schema name that needs quoting.

Issue #4728 [https://redmine.postgresql.org/issues/4728] - Highlighted the color of closing or opening parenthesis when user select them in CodeMirror.

Issue #4751 [https://redmine.postgresql.org/issues/4751] - Fix issue where export job fails when deselecting all the columns.

Issue #4753 [https://redmine.postgresql.org/issues/4753] - Fix an error where ‘false’ string is displayed when we add a new parameter in the Parameters tab, also clear the old value when the user changes the parameter name.

Issue #4755 [https://redmine.postgresql.org/issues/4755] - Ensure that pgAdmin should work behind reverse proxy if the inbuilt server is used as it is.

Issue #4756 [https://redmine.postgresql.org/issues/4756] - Fix issue where pgAdmin does not load completely if loaded in an iframe.

Issue #4760 [https://redmine.postgresql.org/issues/4760] - Ensure the search path should not be quoted for Database.

Issue #4768 [https://redmine.postgresql.org/issues/4768] - Ensure pgAdmin should work behind reverse proxy on a non standard port.

Issue #4769 [https://redmine.postgresql.org/issues/4769] - Fix query tool open issue on Internet Explorer.

Issue #4777 [https://redmine.postgresql.org/issues/4777] - Fix issue where query history is not visible in the query history tab.

Issue #4780 [https://redmine.postgresql.org/issues/4780] - Ensure the search path should not be quoted for Function, Procedure and Trigger Function.

Issue #4791 [https://redmine.postgresql.org/issues/4791] - Fix issue where VALID foreign keys show as NOT VALID in the SQL tab for tables.

Issue #4817 [https://redmine.postgresql.org/issues/4817] - Ensure the MAC OSX app should be notarized for Catalina.

Version 4.13

Release date: 2019-09-19

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.12.

New features

Issue #2828 [https://redmine.postgresql.org/issues/2828] - Added Gather Merge, Named Tuple Store Scan and Table Function Scan icon for explain module.

Issue #4553 [https://redmine.postgresql.org/issues/4553] - Don’t wait for the database connection before rendering the Query Tool UI, for improved UX.

Issue #4651 [https://redmine.postgresql.org/issues/4651] - Allow configuration options to be set from the environment in the container distribution.

Issue #4667 [https://redmine.postgresql.org/issues/4667] - Ensure editable and read-only columns in Query Tool should be identified by icons and tooltips in the column header.

Issue #4691 [https://redmine.postgresql.org/issues/4691] - Add an Italian translation.

Issue #4752 [https://redmine.postgresql.org/issues/4752] - Refactor Dockerfile to avoid needing to run supporting scripts (i.e. ‘docker build .’ will work) and minimise layers.

Housekeeping

Issue #4575 [https://redmine.postgresql.org/issues/4575] - Add Reverse Engineered SQL tests for Schemas.

Issue #4576 [https://redmine.postgresql.org/issues/4576] - Add Reverse Engineered SQL tests for Views.

Issue #4600 [https://redmine.postgresql.org/issues/4600] - Add Reverse Engineered SQL tests for Rules.

Issue #4616 [https://redmine.postgresql.org/issues/4616] - Add Reverse Engineered and Modified SQL tests for Foreign Keys.

Issue #4617 [https://redmine.postgresql.org/issues/4617] - Add Reverse Engineered and Modified SQL tests for Foreign Servers.

Issue #4618 [https://redmine.postgresql.org/issues/4618] - Add Reverse Engineered and Modified SQL tests for Foreign Tables.

Issue #4619 [https://redmine.postgresql.org/issues/4619] - Add Reverse Engineered and Modified SQL tests for FTS Templates.

Issue #4621 [https://redmine.postgresql.org/issues/4621] - Add Reverse Engineered and Modified SQL tests for Indexes.

Issue #4624 [https://redmine.postgresql.org/issues/4624] - Add Reverse Engineered and Modified SQL tests for Primary Keys.

Issue #4627 [https://redmine.postgresql.org/issues/4627] - Add Reverse Engineered and Modified SQL tests for User Mappings.

Issue #4690 [https://redmine.postgresql.org/issues/4690] - Add Modified SQL tests for Resource Group.

Bug fixes

Issue #2706 [https://redmine.postgresql.org/issues/2706] - Added ProjectSet icon for explain module.

Issue #3778 [https://redmine.postgresql.org/issues/3778] - Ensure Boolean columns should be editable using keyboard keys.

Issue #3936 [https://redmine.postgresql.org/issues/3936] - Further code refactoring to stabilise the Feature Tests.

Issue #4381 [https://redmine.postgresql.org/issues/4381] - Fix an issue where oid column should not be pasted when copy/paste row is used on query output containing the oid column.

Issue #4408 [https://redmine.postgresql.org/issues/4408] - Fix display of validation error message in SlickGrid cells.

Issue #4412 [https://redmine.postgresql.org/issues/4412] - Fix issue where Validated switch option is inverted for the Foreign Key.

Issue #4419 [https://redmine.postgresql.org/issues/4419] - Fix a debugger error when using Python 2.7.

Issue #4461 [https://redmine.postgresql.org/issues/4461] - Fix error while importing data to a table using Import/Export dialog and providing “Not null columns” option.

Issue #4486 [https://redmine.postgresql.org/issues/4486] - Ensure View should be created with special characters.

Issue #4487 [https://redmine.postgresql.org/issues/4487] - Ensure Boolean columns should be editable in View/Edit data and Query Tool.

Issue #4577 [https://redmine.postgresql.org/issues/4577] - Fix an error that could be seen when click on any system column of a table.

Issue #4584 [https://redmine.postgresql.org/issues/4584] - Unescape HTML entities in database names in the Query Tool title bar.

Issue #4631 [https://redmine.postgresql.org/issues/4631] - Add editor options for plain text mode and to disable block folding to workaround rendering speed issues in CodeMirror with very large scripts.

Issue #4642 [https://redmine.postgresql.org/issues/4642] - Ensure port and username should not be mandatory when a service is provided.

Issue #4643 [https://redmine.postgresql.org/issues/4643] - Fix Truncate option deselect issue for compound triggers.

Issue #4644 [https://redmine.postgresql.org/issues/4644] - Fix length and precision enable/disable issue when changing the data type for Domain node.

Issue #4650 [https://redmine.postgresql.org/issues/4650] - Fix SQL tab issue for Views. It’s a regression of compound triggers.

Issue #4657 [https://redmine.postgresql.org/issues/4657] - Fix PGADMIN_SERVER_JSON_FILE environment variable support in the container.

Issue #4663 [https://redmine.postgresql.org/issues/4663] - Fix exception in query history for python 2.7.

Issue #4674 [https://redmine.postgresql.org/issues/4674] - Fix query tool launch error if user name contain html characters.

Issue #4681 [https://redmine.postgresql.org/issues/4681] - Increase cache control max age for static files to improve performance over longer run.

Issue #4698 [https://redmine.postgresql.org/issues/4698] - Fix SQL issue of length and precision when changing the data type of Column.

Issue #4702 [https://redmine.postgresql.org/issues/4702] - Fix modified SQL for Index when reset the value of Fill factor and Clustered?.

Issue #4703 [https://redmine.postgresql.org/issues/4703] - Fix reversed engineered SQL for btree Index when provided sort order and NULLs.

Issue #4726 [https://redmine.postgresql.org/issues/4726] - Ensure sequence with negative value should be created.

Issue #4727 [https://redmine.postgresql.org/issues/4727] - Fix issue where EXEC script doesn’t write the complete script for Procedures.

Issue #4736 [https://redmine.postgresql.org/issues/4736] - Fix query tool and view data issue with the Italian language.

Issue #4742 [https://redmine.postgresql.org/issues/4742] - Ensure Primary Key should be created with Index.

Issue #4750 [https://redmine.postgresql.org/issues/4750] - Fix query history exception for Python 3.6.

Version 4.12

Release date: 2019-08-22

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.11.

New features

Issue #4144 [https://redmine.postgresql.org/issues/4144] - Add support of Compound Triggers for EPAS 12+.

Issue #4333 [https://redmine.postgresql.org/issues/4333] - Add support for planner support functions in PostgreSQL 12+ functions.

Issue #4334 [https://redmine.postgresql.org/issues/4334] - Add support for generated columns in Postgres 12+.

Issue #4540 [https://redmine.postgresql.org/issues/4540] - Use the full tab space for CodeMirror instances on dialogues where appropriate.

Issue #4549 [https://redmine.postgresql.org/issues/4549] - Allow a banner to be displayed on the login and other related pages showing custom text.

Issue #4566 [https://redmine.postgresql.org/issues/4566] - Allow enhanced cookie protection to be disabled for compatibility with dynamically addressed hosting environments.

Issue #4570 [https://redmine.postgresql.org/issues/4570] - Add an optimisation to the internal code responsible for searching for treeview nodes.

Issue #4574 [https://redmine.postgresql.org/issues/4574] - Display the row count in the popup message when counting table rows, not just in the properties list.

Issue #4612 [https://redmine.postgresql.org/issues/4612] - Add support in query history to show internal queries generated by pgAdmin during save data operations.

Housekeeping

Issue #4546 [https://redmine.postgresql.org/issues/4546] - Add Reverse Engineered SQL tests for Columns.

Issue #4554 [https://redmine.postgresql.org/issues/4554] - Add Reverse Engineered SQL tests for Trigger Functions.

Issue #4555 [https://redmine.postgresql.org/issues/4555] - Add Reverse Engineered SQL tests for Exclusion Constraint.

Issue #4560 [https://redmine.postgresql.org/issues/4560] - Add a –modules option to the RE-SQL test suite to allow testing of specific object types.

Bug fixes

Issue #3605 [https://redmine.postgresql.org/issues/3605] - Fix issue where Deleting N number of rows makes first N number of rows disable.

Issue #4179 [https://redmine.postgresql.org/issues/4179] - Fix generation of reverse engineered SQL for tables with Greenplum 5.x.

Issue #4229 [https://redmine.postgresql.org/issues/4229] - Update wcDocker to allow the browser’s context menu to be used except in tab strips and panel headers.

Issue #4401 [https://redmine.postgresql.org/issues/4401] - Ensure type names are properly encoded in the results grid.

Issue #4414 [https://redmine.postgresql.org/issues/4414] - Fix generation of reverse engineered SQL for partition table, partitions were shown as a child of indexes.

Issue #4489 [https://redmine.postgresql.org/issues/4489] - Update wcDocker to prevent window state loading creating blank dialogues.

Issue #4490 [https://redmine.postgresql.org/issues/4490] - Fix accessibility issue for checkbox in IE11.

Issue #4492 [https://redmine.postgresql.org/issues/4492] - Ensure the Query Tool doesn’t throw an error when viewing the contents of a table with no columns.

Issue #4496 [https://redmine.postgresql.org/issues/4496] - Ensure columns can be created when they are IDENTITY fields with the CYCLE option enabled.

Issue #4497 [https://redmine.postgresql.org/issues/4497] - Ensure purely numeric comments can be saved on new columns.

Issue #4508 [https://redmine.postgresql.org/issues/4508] - Fix accessibility issue for Datetime cell in backgrid.

Issue #4520 [https://redmine.postgresql.org/issues/4520] - Ensure the query tool will work with older versions of psycopg2 than we officially support, albeit without updatable resultsets.

Issue #4525 [https://redmine.postgresql.org/issues/4525] - Ensure command tags are shown in the messages tab of the Query Tool.

Issue #4536 [https://redmine.postgresql.org/issues/4536] - Fix load on demand in View/Edit data mode.

Issue #4552 [https://redmine.postgresql.org/issues/4552] - Fix some errors thrown on the JS console when dragging text in the Query Tool.

Issue #4559 [https://redmine.postgresql.org/issues/4559] - Ensure triggers should be updated properly for EPAS server.

Issue #4565 [https://redmine.postgresql.org/issues/4565] - Fix the reverse engineered SQL for trigger functions with the WINDOW option selected.

Issue #4578 [https://redmine.postgresql.org/issues/4578] - Ensure enable trigger menu should be visible when trigger is disabled.

Issue #4581 [https://redmine.postgresql.org/issues/4581] - Ensure the comment on a Primary Key constraint can be edited under the Table node.

Issue #4582 [https://redmine.postgresql.org/issues/4582] - Fix console error when changing kind(SQL/BATCH) for pgAgent job step.

Issue #4585 [https://redmine.postgresql.org/issues/4585] - Fix double click issue to expand the contents of a cell if the resultset was not editable.

Issue #4586 [https://redmine.postgresql.org/issues/4586] - Fix generation of reverse engineered SQL for Rules.

Issue #4635 [https://redmine.postgresql.org/issues/4635] - Ensure compound triggers for event should be updated properly.

Issue #4638 [https://redmine.postgresql.org/issues/4638] - Ensure compound triggers should be displayed under Views.

Issue #4641 [https://redmine.postgresql.org/issues/4641] - Ensure Truncate option should be available for Compound Triggers.

Version 4.11

Release date: 2019-07-25

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.10.

New features

Issue #1760 [https://redmine.postgresql.org/issues/1760] - Add support for editing of resultsets in the Query Tool, if the data can be identified as updatable.

Issue #4318 [https://redmine.postgresql.org/issues/4318] - Set the mouse cursor appropriately based on the layout lock state.

Issue #4335 [https://redmine.postgresql.org/issues/4335] - Add EXPLAIN options for SETTINGS and SUMMARY.

Housekeeping

Issue #4415 [https://redmine.postgresql.org/issues/4415] - Add Reverse Engineered SQL tests for Roles and Resource Groups.

Issue #4441 [https://redmine.postgresql.org/issues/4441] - Add Reverse Engineered SQL tests for FDWs.

Issue #4452 [https://redmine.postgresql.org/issues/4452] - Add Reverse Engineered SQL tests for Languages.

Issue #4453 [https://redmine.postgresql.org/issues/4453] - Add Reverse Engineered SQL tests for Extensions.

Issue #4454 [https://redmine.postgresql.org/issues/4454] - Add Reverse Engineered SQL tests for FTS Configurations.

Issue #4456 [https://redmine.postgresql.org/issues/4456] - Add Reverse Engineered SQL tests for Packages.

Issue #4460 [https://redmine.postgresql.org/issues/4460] - Add Reverse Engineered SQL tests for FTS Dictionaries.

Issue #4463 [https://redmine.postgresql.org/issues/4463] - Add Reverse Engineered SQL tests for Domains.

Issue #4464 [https://redmine.postgresql.org/issues/4464] - Add Reverse Engineered SQL tests for Collations.

Issue #4468 [https://redmine.postgresql.org/issues/4468] - Add Reverse Engineered SQL tests for Types.

Issue #4469 [https://redmine.postgresql.org/issues/4469] - Add Reverse Engineered SQL tests for Sequences.

Issue #4471 [https://redmine.postgresql.org/issues/4471] - Add Reverse Engineered SQL tests for FTS Parsers.

Issue #4475 [https://redmine.postgresql.org/issues/4475] - Add Reverse Engineered SQL tests for Constraints.

Bug fixes

Issue #3919 [https://redmine.postgresql.org/issues/3919] - Allow keyboard navigation of all controls on subnode grids.

Issue #3996 [https://redmine.postgresql.org/issues/3996] - Fix dropping of pgAgent schedules through the Job properties.

Issue #4224 [https://redmine.postgresql.org/issues/4224] - Prevent flickering of large tooltips on the Graphical EXPLAIN canvas.

Issue #4389 [https://redmine.postgresql.org/issues/4389] - Fix an error that could be seen when editing column privileges.

Issue #4393 [https://redmine.postgresql.org/issues/4393] - Ensure parameter values are quoted when needed when editing roles.

Issue #4395 [https://redmine.postgresql.org/issues/4395] - EXPLAIN options should be Query Tool instance-specific.

Issue #4427 [https://redmine.postgresql.org/issues/4427] - Fix an error while retrieving json data from the table.

Issue #4428 [https://redmine.postgresql.org/issues/4428] - Fix ‘malformed array literal’ error when updating a pgAgent job.

Issue #4429 [https://redmine.postgresql.org/issues/4429] - Ensure drag/drop from the treeview works as expected on Firefox.

Issue #4437 [https://redmine.postgresql.org/issues/4437] - Fix table icon issue when updating any existing field.

Issue #4442 [https://redmine.postgresql.org/issues/4442] - Ensure browser should not be started by Selenium when feature tests are excluded from a test run.

Issue #4446 [https://redmine.postgresql.org/issues/4446] - Use ROLE consistently when generating RE-SQL for roles, not USER.

Issue #4448 [https://redmine.postgresql.org/issues/4448] - Fix an error seen when updating a connection string in a pgAgent job step.

Issue #4450 [https://redmine.postgresql.org/issues/4450] - Fix reverse engineered sql for Foreign Data Wrapper created on EPAS server in redwood mode.

Issue #4462 [https://redmine.postgresql.org/issues/4462] - Fix some minor UI issues on IE11.

Issue #4470 [https://redmine.postgresql.org/issues/4470] - Fix sequence reverse engineered SQL generation with quoted names on PG/EPAS 10+.

Issue #4484 [https://redmine.postgresql.org/issues/4484] - Fix an issue where Explain and Explain Analyze are not working, it’s regression of #1760.

Issue #4485 [https://redmine.postgresql.org/issues/4485] - Fix an issue where Filter toolbar button is not working in view/edit data, it’s regression of keyboard navigation.

Version 4.10

Release date: 2019-07-04

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.9.

New features

Issue #4139 [https://redmine.postgresql.org/issues/4139] - Allow some objects to be dragged/dropped into the Query Tool to insert their signature into the query text.

Issue #4400 [https://redmine.postgresql.org/issues/4400] - Allow the path to /pgadmin4/servers.json to be overridden in the container distribution.

Bug fixes

Issue #4403 [https://redmine.postgresql.org/issues/4403] - Ensure the browser close confirmation is only shown when closing a Query Tool which is running in a separate browser tab.

Issue #4404 [https://redmine.postgresql.org/issues/4404] - Prevent an error that may occur when editing data with an integer primary key.

Issue #4407 [https://redmine.postgresql.org/issues/4407] - Fix a quoting issue that caused a blank UI to be displayed when running in French.

Issue #4421 [https://redmine.postgresql.org/issues/4421] - Ensure the version comparision should be correct for windows installer.

Version 4.9

Release date: 2019-06-27

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.8.

New features

Issue #3174 [https://redmine.postgresql.org/issues/3174] - Visually distinguish simple tables from tables that are inherited and from which other tables are inherited.

Housekeeping

Issue #4202 [https://redmine.postgresql.org/issues/4202] - Add a framework for testing reversed engineered SQL and CRUD API endpoints.

Bug fixes

Issue #3994 [https://redmine.postgresql.org/issues/3994] - Fix issue where the dependencies tab for inherited tables/foreign keys shows partial text.

Issue #4036 [https://redmine.postgresql.org/issues/4036] - Allow editing of data where a primary key column includes a % sign in the value.

Issue #4171 [https://redmine.postgresql.org/issues/4171] - Fix issue where reverse engineered SQL was failing for foreign tables, if it had “=” in the options.

Issue #4195 [https://redmine.postgresql.org/issues/4195] - Fix keyboard navigation in “inner” tabsets such as the Query Tool and Debugger.

Issue #4228 [https://redmine.postgresql.org/issues/4228] - Ensure the correct label is used in panel headers when viewing filtered rows.

Issue #4253 [https://redmine.postgresql.org/issues/4253] - Fix issue where new column should be created with Default value.

Issue #4283 [https://redmine.postgresql.org/issues/4283] - Initial support for PostgreSQL 12.

Issue #4288 [https://redmine.postgresql.org/issues/4288] - Initial support for PostgreSQL 12.

Issue #4290 [https://redmine.postgresql.org/issues/4290] - Initial support for PostgreSQL 12.

Issue #4255 [https://redmine.postgresql.org/issues/4255] - Prevent the geometry viewer grabbing key presses when not in focus under Firefox, IE and Edge.

Issue #4306 [https://redmine.postgresql.org/issues/4306] - Prevent the “Please login to access this page” message displaying multiple times.

Issue #4310 [https://redmine.postgresql.org/issues/4310] - Ensure that the Return key can be used to submit the Master Password dialogue.

Issue #4317 [https://redmine.postgresql.org/issues/4317] - Ensure that browser auto-fill doesn’t cause Help pages to be opened unexpectedly.

Issue #4320 [https://redmine.postgresql.org/issues/4320] - Fix issue where SSH tunnel connection using password is failing, it’s regression of Master Password.

Issue #4329 [https://redmine.postgresql.org/issues/4329] - Fix an initialisation error when two functions with parameters are debugged in parallel.

Issue #4343 [https://redmine.postgresql.org/issues/4343] - Fix issue where property dialog of column should open properly for EPAS v12.

Issue #4345 [https://redmine.postgresql.org/issues/4345] - Capitalize the word ‘export’ used in Import/Export module.

Issue #4349 [https://redmine.postgresql.org/issues/4349] - Ensure strings are properly encoded in the Query History.

Issue #4350 [https://redmine.postgresql.org/issues/4350] - Ensure we include the CSRF token when uploading files.

Issue #4357 [https://redmine.postgresql.org/issues/4357] - Fix connection restoration issue when pgAdmin server is restarted and the page is refreshed.

Issue #4360 [https://redmine.postgresql.org/issues/4360] - Ensure the debugger control buttons are only enabled once initialisation is complete.

Issue #4362 [https://redmine.postgresql.org/issues/4362] - Remove additional “SETOF” included when generating CREATE scripts for trigger functions.

Issue #4365 [https://redmine.postgresql.org/issues/4365] - Fix help links for backup globals and backup server.

Issue #4367 [https://redmine.postgresql.org/issues/4367] - Fix an XSS issue seen in View/Edit data mode if a column name includes HTML.

Issue #4378 [https://redmine.postgresql.org/issues/4378] - Ensure Python escaping matched JS escaping and fix a minor XSS issue in the Query Tool that required superuser access to trigger.

Issue #4380 [https://redmine.postgresql.org/issues/4380] - Ensure that both columns and partitions can be edited at the same time in the table dialog.

Issue #4386 [https://redmine.postgresql.org/issues/4386] - Fix an XSS issue when username contains XSS vulnerable text.

Version 4.8

Release date: 2019-06-03

This release contains a number of bug fixes and new features since the release of pgAdmin4 4.7.

New features

Issue #2653 [https://redmine.postgresql.org/issues/2653] - Allow the UI layout to be fully locked or to prevent docking changes.

Bug fixes

Issue #4169 [https://redmine.postgresql.org/issues/4169] - Omit the geometry viewer in the Query Tool from layout saving.

Issue #4307 [https://redmine.postgresql.org/issues/4307] - Improve the performance of explain plan by embedding the images only when downloading it.

Issue #4308 [https://redmine.postgresql.org/issues/4308] - Fix the issue of accessing the SQL for Views and Materialized Views. Regression of pluralisation of folder names.

Version 4.7

Release date: 2019-05-30

This release contains a number of bug fixes since the release of pgAdmin4 4.6.

Bug fixes

Issue #3377 [https://redmine.postgresql.org/issues/3377] - In server mode, update all the saved server credentials when user password is changed.

Issue #3885 [https://redmine.postgresql.org/issues/3885] - Fix the responsive layout of the main menu bar.

Issue #4162 [https://redmine.postgresql.org/issues/4162] - Fix syntax error when adding more than one column to the existing table.

Issue #4164 [https://redmine.postgresql.org/issues/4164] - Fix file browser path issue which occurs when client is on Windows and server is on Mac/Linux.

Issue #4184 [https://redmine.postgresql.org/issues/4184] - Added Master Password to increase the security of saved passwords.

Issue #4194 [https://redmine.postgresql.org/issues/4194] - Fix accessibility issue for menu navigation.

Issue #4208 [https://redmine.postgresql.org/issues/4208] - Update the UI logo.

Issue #4217 [https://redmine.postgresql.org/issues/4217] - Fixed CSRF security vulnerability issue, per Alvin Lindstam

Issue #4218 [https://redmine.postgresql.org/issues/4218] - Properly assign dropdownParent in Select2 controls.

Issue #4219 [https://redmine.postgresql.org/issues/4219] - Ensure popper.js is installed when needed.

Issue #4227 [https://redmine.postgresql.org/issues/4227] - Fixed Tab key navigation for Maintenance dialog.

Issue #4244 [https://redmine.postgresql.org/issues/4244] - Fix Tab key issue for Toggle switch controls and button on the dialog footer in Safari browser.

Issue #4245 [https://redmine.postgresql.org/issues/4245] - Ensure that element should get highlighted when they get focus on using Tab key.

Issue #4246 [https://redmine.postgresql.org/issues/4246] - Fixed console error when subnode control is used in panels.

Issue #4261 [https://redmine.postgresql.org/issues/4261] - Stop using application/x-javascript as a mime type and use the RFC-compliant application/javascript instead.

Issue #4262 [https://redmine.postgresql.org/issues/4262] - Fixed error on displaying table properties of a table partitioned by list having a default partition.

Issue #4263 [https://redmine.postgresql.org/issues/4263] - Fix handling of JSON in the Query Tool with NULL elements.

Issue #4269 [https://redmine.postgresql.org/issues/4269] - Fix navigation of switch cells in grids.

Issue #4275 [https://redmine.postgresql.org/issues/4275] - Clarify wording for the NO INHERIT option on constraints, per Michel Feinstein.

Issue #4276 [https://redmine.postgresql.org/issues/4276] - Relax the permission check on the directory containing the config database, as it may fail in some environments such as OpenShift.

Issue #4278 [https://redmine.postgresql.org/issues/4278] - Prevent Backgrid Password cells from losing focus if the browser opens an autocomplete list.

Issue #4284 [https://redmine.postgresql.org/issues/4284] - Fix syntax error when creating a table with a serial column.

Version 4.6

Release date: 2019-05-02

This release contains a number of new features and fixes reported since the release of pgAdmin4 4.5

Features

Issue #4165 [https://redmine.postgresql.org/issues/4165] - Depend on psycopg2-binary in the Python wheel, rather than psycopg2.

Bug fixes

Issue #2392 [https://redmine.postgresql.org/issues/2392] - Ensure that on clicking Delete button should not delete rows immediately from the database server, it should be deleted when Save button will be clicked.

Issue #3327 [https://redmine.postgresql.org/issues/3327] - Ensure that newly added row in backgrid should be visible.

Issue #3582 [https://redmine.postgresql.org/issues/3582] - Ensure that JSON strings as comments should be added properly for all the objects.

Issue #3605 [https://redmine.postgresql.org/issues/3605] - Fix an issue where Deleting N number of rows makes first N number of rows disable.

Issue #3938 [https://redmine.postgresql.org/issues/3938] - Added support for Default Partition.

Issue #4087 [https://redmine.postgresql.org/issues/4087] - Fix an issue where ‘GRANT UPDATE’ sql should be displayed for default sequence privileges.

Issue #4101 [https://redmine.postgresql.org/issues/4101] - Ensure that confirmation dialog should be popped up before reload of query tool or debugger if it is opened in a new browser tab.

Issue #4104 [https://redmine.postgresql.org/issues/4104] - Ensure that record should be add/edited for root partition table with primary keys.

Issue #4121 [https://redmine.postgresql.org/issues/4121] - Fixed alignment issue of columns in definition section of Index node.

Issue #4134 [https://redmine.postgresql.org/issues/4134] - Fixed ‘Location cannot be empty’ error when open Tablespace properties.

Issue #4138 [https://redmine.postgresql.org/issues/4138] - Fix an issue where the dropdown becomes misaligned/displaced.

Issue #4154 [https://redmine.postgresql.org/issues/4154] - Ensure the treeview shows all sequences except those used to implement IDENTITY columns (which can be edited as part of the column). Show all if Show System Objects is enabled.

Issue #4160 [https://redmine.postgresql.org/issues/4160] - Fixed ‘Increment value cannot be empty’ error for existing tables.

Issue #4161 [https://redmine.postgresql.org/issues/4161] - Ensure that parameters of procedures for EPAS server 10 and below should be set/reset properly.

Issue #4163 [https://redmine.postgresql.org/issues/4163] - Prevent duplicate columns being included in reverse engineered SQL for tables.

Issue #4182 [https://redmine.postgresql.org/issues/4182] - Ensure sanity of the permissions on the storage and session directories and the config database.

Version 4.5

Release date: 2019-04-10

This release contains a number of new features and fixes reported since the release of pgAdmin4 4.4.

Bug fixes

Issue #2214 [https://redmine.postgresql.org/issues/2214] - Fixed ‘Change Password’ issue for SCRAM authentication.

Issue #3656 [https://redmine.postgresql.org/issues/3656] - Ensure that two consecutive SELECT statements should work properly.

Issue #4131 [https://redmine.postgresql.org/issues/4131] - Relabel the Save button on the datagrid text editor to avoid confusion with the actual Save button that updates the database.

Issue #4142 [https://redmine.postgresql.org/issues/4142] - Added recommended ESLinter checks.

Issue #4143 [https://redmine.postgresql.org/issues/4143] - Ensure that pgAdmin4 should work properly with psycopg2 v2.8

Version 4.4

Release date: 2019-04-04

This release contains a number of new features and fixes reported since the release of pgAdmin4 4.3.

Warning

This release includes a bug fix (Issue #3887 [https://redmine.postgresql.org/issues/3887]) which will rename the per-user storage directories for existing users when running in server mode. Previously, saved SQL queries were stored under the STORAGE_DIR in a sub-directory named after the username part of the user’s email address. From this version onwards, the full email address is used, with the @ replaced with an underscore. For example, in v.4.3 with STORAGE_DIR set to /var/lib/pgadmin4 user files may be stored in:

/var/lib/pgadmin4/storage/username/

With the fix, that directory will be renamed (or created for new users) as:

/var/lib/pgadmin4/storage/username_example.com/

Features

Issue #2001 [https://redmine.postgresql.org/issues/2001] - Add support for reverse proxied setups with Gunicorn, and document Gunicorn, uWSGI & NGINX configurations.

Issue #4017 [https://redmine.postgresql.org/issues/4017] - Make the Query Tool history persistent across sessions.

Issue #4018 [https://redmine.postgresql.org/issues/4018] - Remove the large and unnecessary dependency on React and 87 other related libraries.

Issue #4030 [https://redmine.postgresql.org/issues/4030] - Add support for IDENTITY columns.

Issue #4075 [https://redmine.postgresql.org/issues/4075] - Add an ePub doc build target.

Bug fixes

Issue #1269 [https://redmine.postgresql.org/issues/1269] - Fix naming inconsistency for the column and FTS parser modules.

Issue #2627 [https://redmine.postgresql.org/issues/2627] - Include inherited column comments and defaults in reverse engineered table SQL.

Issue #3104 [https://redmine.postgresql.org/issues/3104] - Improve a couple of German translations.

Issue #3887 [https://redmine.postgresql.org/issues/3887] - Use the user’s full email address (not just the username part) as the basis for the storage directory name.

Issue #3968 [https://redmine.postgresql.org/issues/3968] - Update wcDocker to fix the issue where the Scratch Pad grows in size if the results panel is resized.

Issue #3995 [https://redmine.postgresql.org/issues/3995] - Avoid ‘bogus varno’ message from Postgres when viewing the SQL for a table with triggers.

Issue #4019 [https://redmine.postgresql.org/issues/4019] - Update all Python and JavaScript dependencies.

Issue #4037 [https://redmine.postgresql.org/issues/4037] - Include comment SQL for inherited columns in reverse engineered table SQL.

Issue #4050 [https://redmine.postgresql.org/issues/4050] - Make the WHEN field a CodeMirror control on the Event Trigger dialogue.

Issue #4052 [https://redmine.postgresql.org/issues/4052] - Fix the online help button on the resource group dialogue.

Issue #4053 [https://redmine.postgresql.org/issues/4053] - Enable the online help button on the index dialogue.

Issue #4054 [https://redmine.postgresql.org/issues/4054] - Handle resultsets with zero columns correctly in the Query Tool.

Issue #4058 [https://redmine.postgresql.org/issues/4058] - Include inherited columns in SELECT scripts.

Issue #4060 [https://redmine.postgresql.org/issues/4060] - Fix the latexpdf doc build.

Issue #4062 [https://redmine.postgresql.org/issues/4062] - Fix handling of numeric arrays in View/Edit Data.

Issue #4063 [https://redmine.postgresql.org/issues/4063] - Enlarge the grab handles for resizing dialogs etc.

Issue #4069 [https://redmine.postgresql.org/issues/4069] - Append the file suffix to filenames when needed in the File Create dialogue.

Issue #4071 [https://redmine.postgresql.org/issues/4071] - Ensure that Firefox prompts for a filename/location when downloading query results as a CSV file.

Issue #4073 [https://redmine.postgresql.org/issues/4073] - Change the CodeMirror active line background colour to $color-danger-lighter so it doesn’t conflict with the selection colour.

Issue #4081 [https://redmine.postgresql.org/issues/4081] - Fix the RE-SQL syntax for roles with a VALID UNTIL clause.

Issue #4082 [https://redmine.postgresql.org/issues/4082] - Prevent an empty error message being shown when “downloading” a CREATE script using the CSV download.

Issue #4084 [https://redmine.postgresql.org/issues/4084] - Overhaul the layout saving code so it includes the Query Tool and Debugger, and stores the layout when change events are detected rather than (unreliably) on exit.

Issue #4085 [https://redmine.postgresql.org/issues/4085] - Display errors during CSV download from the Query Tool in the UI rather than putting them in the CSV file.

Issue #4090 [https://redmine.postgresql.org/issues/4090] - Improve the German translation for Backup Server.

Issue #4096 [https://redmine.postgresql.org/issues/4096] - Ensure the toolbar buttons are properly reset following a CSV download in the Query Tool.

Issue #4099 [https://redmine.postgresql.org/issues/4099] - Fix SQL help for EPAS 10+, and refactor the URL generation code into a testable function.

Issue #4100 [https://redmine.postgresql.org/issues/4100] - Ensure sequences can be created with increment, start, minimum and maximum options set.

Issue #4105 [https://redmine.postgresql.org/issues/4105] - Fix an issue where JSON data would not be rendered in the Query Tool.

Issue #4109 [https://redmine.postgresql.org/issues/4109] - Ensure View/Materialized View node should be visible after updating any property.

Issue #4110 [https://redmine.postgresql.org/issues/4110] - Fix custom autovacuum configuration for Materialized Views.

Version 4.3

Release date: 2019-03-07

This release contains a number of new features and fixes reported since the release of pgAdmin4 4.2

Features

Issue #1825 [https://redmine.postgresql.org/issues/1825] - Install a script to start pgAdmin (pgadmin4) from the command line when installed from the Python wheel.

Issue #2233 [https://redmine.postgresql.org/issues/2233] - Add a “scratch pad” to the Query Tool to hold text snippets whilst editing.

Issue #2418 [https://redmine.postgresql.org/issues/2418] - Add Commit and Rollback buttons to the Query Tool.

Issue #3439 [https://redmine.postgresql.org/issues/3439] - Allow X-FRAME-OPTIONS to be set for security. Default to SAMEORIGIN.

Issue #3559 [https://redmine.postgresql.org/issues/3559] - Automatically expand child nodes as well as the selected node on the treeview if there is only one.

Issue #3886 [https://redmine.postgresql.org/issues/3886] - Include multiple versions of the PG utilties in containers.

Issue #3991 [https://redmine.postgresql.org/issues/3991] - Update Alpine Linux version in the docker container.

Issue #4034 [https://redmine.postgresql.org/issues/4034] - Support double-click on Query Tool result grid column resize handles to auto-size to the content.

Bug fixes

Bug #3096 [https://redmine.postgresql.org/issues/3096] - Ensure size stats are prettified on the statistics tab when the UI language is not English.

Bug #3352 [https://redmine.postgresql.org/issues/3352] - Handle display of roles with expiration set to infinity correctly.

Bug #3418 [https://redmine.postgresql.org/issues/3418] - Allow editing of values in columns with the oid datatype which are not an actual row OID.

Bug #3544 [https://redmine.postgresql.org/issues/3544] - Make the Query Tool tab titles more concise and useful.

Bug #3587 [https://redmine.postgresql.org/issues/3587] - Fix support for bigint’s in JSONB data.

Bug #3583 [https://redmine.postgresql.org/issues/3583] - Update CodeMirror to 5.43.0 to resolve issues with auto-indent.

Bug #3600 [https://redmine.postgresql.org/issues/3600] - Ensure JSON data isn’t modified in-flight by psycopg2 when using View/Edit data.

Bug #3673 [https://redmine.postgresql.org/issues/3673] - Modify the Download as CSV option to use the same connection as the Query Tool its running in so temporary tables etc. can be used.

Bug #3873 [https://redmine.postgresql.org/issues/3873] - Fix context sub-menu alignment on Safari.

Bug #3890 [https://redmine.postgresql.org/issues/3890] - Update documentation screenshots as per new design.

Bug #3906 [https://redmine.postgresql.org/issues/3906] - Fix alignment of Close and Maximize button of Grant Wizard.

Bug #3911 [https://redmine.postgresql.org/issues/3911] - Add full support and testsfor all PG server side encodings.

Bug #3912 [https://redmine.postgresql.org/issues/3912] - Fix editing of table data with a JSON primary key.

Bug #3933 [https://redmine.postgresql.org/issues/3933] - Ignore exceptions in the logger.

Bug #3942 [https://redmine.postgresql.org/issues/3942] - Close connections gracefully when the user logs out of pgAdmin.

Bug #3946 [https://redmine.postgresql.org/issues/3946] - Fix alignment of checkbox to drop multiple schedules of pgAgent job.

Bug #3958 [https://redmine.postgresql.org/issues/3958] - Don’t exclude SELECT statements from transaction management in the Query Tool in case they call data-modifying functions.

Bug #3959 [https://redmine.postgresql.org/issues/3959] - Optimise display of Dependencies and Dependents, and use on-demand loading of rows in batches of 100.

Bug #3963 [https://redmine.postgresql.org/issues/3963] - Fix alignment of import/export toggle switch.

Bug #3970 [https://redmine.postgresql.org/issues/3970] - Prevent an error when closing the Sort/Filter dialogue with an empty filter string.

Bug #3974 [https://redmine.postgresql.org/issues/3974] - Fix alignment of Connection type toggle switch of pgagent.

Bug #3981 [https://redmine.postgresql.org/issues/3981] - Fix the query to set bytea_output so that read-only standbys don’t consider it a write query.

Bug #3982 [https://redmine.postgresql.org/issues/3982] - Add full support and testsfor all PG server side encodings.

Bug #3985 [https://redmine.postgresql.org/issues/3985] - Don’t embed docs and external sites in iframes, to allow the external sites to set X-FRAME-OPTIONS = DENY for security.

Bug #3992 [https://redmine.postgresql.org/issues/3992] - Add full support and testsfor all PG server side encodings.

Bug #3998 [https://redmine.postgresql.org/issues/3998] - Custom-encode forward slashes in URL parameters as Apache HTTPD doesn’t allow them in some cases.

Bug #4000 [https://redmine.postgresql.org/issues/4000] - Update CodeMirror to 5.43.0 to resolve issues with tab indent with use spaces enabled.

Bug #4013 [https://redmine.postgresql.org/issues/4013] - Ensure long queries don’t cause errors when downloading CSV in the Query Tool.

Bug #4021 [https://redmine.postgresql.org/issues/4021] - Disable the editor and execute functions whilst queries are executing.

Bug #4022 [https://redmine.postgresql.org/issues/4022] - Fix an issue where importing servers fails if a group already exists for a different user.

Version 4.2

Release date: 2019-02-07

This release contains a number of fixes reported since the release of pgAdmin4 4.1

Bug fixes

Issue #3051 [https://redmine.postgresql.org/issues/3051] - Replace Bootstrap switch with Bootstrap4 toggle to improve the performance.

Issue #3272 [https://redmine.postgresql.org/issues/3272] - Replace the PyCrypto module with the cryptography module.

Issue #3453 [https://redmine.postgresql.org/issues/3453] - Fixed SQL for foreign table options.

Issue #3475 [https://redmine.postgresql.org/issues/3475] - Fixed execution time to show Hours part for long running queries in Query Tool.

Issue #3608 [https://redmine.postgresql.org/issues/3608] - Messages tab of Query Tool should be clear on subsequent execution of table/view using View/Edit Data.

Issue #3609 [https://redmine.postgresql.org/issues/3609] - Clear drop-down menu should be disabled for View/Edit Data.

Issue #3664 [https://redmine.postgresql.org/issues/3664] - Fixed Statistics panel hang issue for 1000+ tables.

Issue #3693 [https://redmine.postgresql.org/issues/3693] - Proper error should be thrown when server group is created with existing name.

Issue #3695 [https://redmine.postgresql.org/issues/3695] - Ensure long string should be wrap in alertify dialogs.

Issue #3697 [https://redmine.postgresql.org/issues/3697] - Ensure that output of the query should be displayed even if Data Output window is detached from the Query Tool.

Issue #3740 [https://redmine.postgresql.org/issues/3740] - Inline edbspl trigger functions should not be visible in Grant Wizard.

Issue #3774 [https://redmine.postgresql.org/issues/3774] - Proper SQL should be generated when create function with return type as custom type argument.

Issue #3800 [https://redmine.postgresql.org/issues/3800] - Ensure that database restriction of server dialog should work with special characters.

Issue #3811 [https://redmine.postgresql.org/issues/3811] - Ensure that Backup/Restore button should work on single click.

Issue #3837 [https://redmine.postgresql.org/issues/3837] - Fixed SQL for when clause while creating Trigger.

Issue #3838 [https://redmine.postgresql.org/issues/3838] - Proper SQL should be generated when creating/changing column with custom type argument.

Issue #3840 [https://redmine.postgresql.org/issues/3840] - Ensure that file format combo box value should be retained when hidden files checkbox is toggled.

Issue #3846 [https://redmine.postgresql.org/issues/3846] - Proper SQL should be generated when create procedure with custom type arguments.

Issue #3849 [https://redmine.postgresql.org/issues/3849] - Ensure that browser should warn before close or refresh.

Issue #3850 [https://redmine.postgresql.org/issues/3850] - Fixed EXEC script for procedures.

Issue #3853 [https://redmine.postgresql.org/issues/3853] - Proper SQL should be generated when create domain of type interval with precision.

Issue #3858 [https://redmine.postgresql.org/issues/3858] - Drop-down should be closed when click on any other toolbar button.

Issue #3862 [https://redmine.postgresql.org/issues/3862] - Fixed keyboard navigation for dialog tabs.

Issue #3865 [https://redmine.postgresql.org/issues/3865] - Increase frames splitter mouse hover area to make it easier to resize.

Issue #3871 [https://redmine.postgresql.org/issues/3871] - Fixed alignment of tree arrow icons for Internet Explorer.

Issue #3872 [https://redmine.postgresql.org/issues/3872] - Ensure object names in external process dialogues are properly escaped.

Issue #3891 [https://redmine.postgresql.org/issues/3891] - Correct order of Save and Cancel button for json/jsonb editing.

Issue #3897 [https://redmine.postgresql.org/issues/3897] - Data should be updated properly for FTS Configurations, FTS Dictionaries, FTS Parsers and FTS Templates.

Issue #3899 [https://redmine.postgresql.org/issues/3899] - Fixed unable to drop multiple Rules and Foreign Tables from properties tab.

Issue #3903 [https://redmine.postgresql.org/issues/3903] - Fixed Query Tool Initialization Error.

Issue #3908 [https://redmine.postgresql.org/issues/3908] - Fixed keyboard navigation for Select2 and Privilege cell in Backgrid.

Issue #3916 [https://redmine.postgresql.org/issues/3916] - Correct schema should be displayed in Materialized View dialog.

Issue #3927 [https://redmine.postgresql.org/issues/3927] - Fixed debugger issue for procedure inside package for EPAS servers.

Issue #3929 [https://redmine.postgresql.org/issues/3929] - Fix alignment of help messages in properties panels.

Issue #3932 [https://redmine.postgresql.org/issues/3932] - Fix alignment of submenu for Internet Explorer.

Issue #3935 [https://redmine.postgresql.org/issues/3935] - Ensure that grant wizard should list down functions for EPAS server running with no-redwood-compat mode.

Issue #3941 [https://redmine.postgresql.org/issues/3941] - Dashboard graph optimization.

Issue #3954 [https://redmine.postgresql.org/issues/3954] - Remove Python 2.6 code that’s now obsolete.

Issue #3955 [https://redmine.postgresql.org/issues/3955] - Expose the bind address in the Docker container via PGADMIN_BIND_ADDRESS.

Issue #3961 [https://redmine.postgresql.org/issues/3961] - Exclude HTTPExceptions from the all_exception_handler as they should be returned as-is.

Version 4.1

Release date: 2019-01-15

This release contains a number of fixes reported since the release of pgAdmin4 4.0

Bug fixes

Issue #3505 [https://redmine.postgresql.org/issues/3505] - Fix SQL generated for tables with inherited columns.

Issue #3575 [https://redmine.postgresql.org/issues/3575] - Ensure the context menu works after a server is renamed.

Issue #3836 [https://redmine.postgresql.org/issues/3836] - Fix ordering of VACUUM options which changed in PG11.

Issue #3842 [https://redmine.postgresql.org/issues/3842] - Don’t show system catalogs in the schemas property list unless show system objects is enabled.

Issue #3861 [https://redmine.postgresql.org/issues/3861] - Fix help for the backup/restore dialogues.

Issue #3866 [https://redmine.postgresql.org/issues/3866] - Ensure that last row of table data should be visible and user will be able to add new row.

Issue #3877 [https://redmine.postgresql.org/issues/3877] - Make the browser more robust in the face of multibyte characters in SQL_ASCII databases.

Version 4.0

Release date: 2019-01-10

This release contains a number of features and fixes reported since the release of pgAdmin4 3.6

Features

Issue #3589 [https://redmine.postgresql.org/issues/3589] - Allow query plans to be downloaded as an SVG file.

Issue #3692 [https://redmine.postgresql.org/issues/3692] - New UI design.

Issue #3801 [https://redmine.postgresql.org/issues/3801] - Allow servers to be pre-loaded into container deployments.

Bug fixes

Issue #3083 [https://redmine.postgresql.org/issues/3083] - Increase the size of the resize handle of the edit grid text pop-out.

Issue #3354 [https://redmine.postgresql.org/issues/3354] - Fix handling of array types as inputs to the debugger.

Issue #3433 [https://redmine.postgresql.org/issues/3433] - Fix an issue that could cause the Query Tool to fail to render.

Issue #3549 [https://redmine.postgresql.org/issues/3549] - Display event trigger functions correctly on EPAS.

Issue #3559 [https://redmine.postgresql.org/issues/3559] - Further improvements to treeview restoration.

Issue #3599 [https://redmine.postgresql.org/issues/3599] - Run Postfix in the container build so passwords can be reset etc.

Issue #3619 [https://redmine.postgresql.org/issues/3619] - Add titles to the code areas of the Query Tool and Debugger to ensure that panels can be re-docked within them.

Issue #3679 [https://redmine.postgresql.org/issues/3679] - Fix a webpack issue that could cause the Query Tool to fail to render.

Issue #3702 [https://redmine.postgresql.org/issues/3702] - Ensure we display the relation name (and not the OID) in the locks table wherever possible.

Issue #3711 [https://redmine.postgresql.org/issues/3711] - Fix an encoding issue in the Query Tool.

Issue #3726 [https://redmine.postgresql.org/issues/3726] - Include the WHERE clause on EXCLUDE constraints in RE-SQL.

Issue #3753 [https://redmine.postgresql.org/issues/3753] - Fix an issue when user define Cast from smallint->text is created.

Issue #3757 [https://redmine.postgresql.org/issues/3757] - Hide Radio buttons that should not be shown on the maintenance dialogue.

Issue #3780 [https://redmine.postgresql.org/issues/3780] - Ensure that null values handled properly in CSV download.

Issue #3796 [https://redmine.postgresql.org/issues/3796] - Tweak the wording on the Grant Wizard.

Issue #3797 [https://redmine.postgresql.org/issues/3797] - Prevent attempts to bulk-drop schema objects.

Issue #3798 [https://redmine.postgresql.org/issues/3798] - Ensure the browser toolbar buttons work in languages other than English.

Issue #3805 [https://redmine.postgresql.org/issues/3805] - Allow horizontal sizing of the edit grid text pop-out.

Issue #3809 [https://redmine.postgresql.org/issues/3809] - Ensure auto complete should works when first identifier in the FROM clause needs quoting.

Issue #3810 [https://redmine.postgresql.org/issues/3810] - Ensure auto complete should works for columns from a schema-qualified table.

Issue #3821 [https://redmine.postgresql.org/issues/3821] - Ensure identifiers are properly displayed in the plan viewer.

Issue #3830 [https://redmine.postgresql.org/issues/3830] - Make the setup process more robust against aborted executions.

Issue #3856 [https://redmine.postgresql.org/issues/3856] - Fixed an issue while creating export job.

Version 3.6

Release date: 2018-11-29

This release contains a number of features and fixes reported since the release of pgAdmin4 3.5

Features

Issue #1513 [https://redmine.postgresql.org/issues/1513] - Add support for dropping multiple objects at once from the collection Properties panel.

Issue #3772 [https://redmine.postgresql.org/issues/3772] - Add the ability to import and export server definitions from a config database.

Bug fixes

Issue #3016 [https://redmine.postgresql.org/issues/3016] - Ensure previous notices are not removed from the Messages tab in the Query Tool if an error occurs during query execution.

Issue #3029 [https://redmine.postgresql.org/issues/3029] - Allow the selection order to be preserved in the Select2 control to fix column ordering in data Import/Export.

Issue #3629 [https://redmine.postgresql.org/issues/3629] - Allow use of 0 (integer) and empty strings as parameters in the debugger.

Issue #3723 [https://redmine.postgresql.org/issues/3723] - Properly report errors when debugging cannot be started.

Issue #3734 [https://redmine.postgresql.org/issues/3734] - Prevent the debugger controls being pressed again before previous processing is complete.

Issue #3736 [https://redmine.postgresql.org/issues/3736] - Fix toggle breakpoints buttons in the debugger.

Issue #3742 [https://redmine.postgresql.org/issues/3742] - Fix changes to the NOT NULL and default value options in the Table Dialogue.

Issue #3746 [https://redmine.postgresql.org/issues/3746] - Fix dropping of multiple functions/procedures at once.

Version 3.5

Release date: 2018-11-01

This release contains a number of features and fixes reported since the release of pgAdmin4 3.4

Features

Issue #1253 [https://redmine.postgresql.org/issues/1253] - Save the treeview state periodically, and restore it automatically when reconnecting.

Issue #3562 [https://redmine.postgresql.org/issues/3562] - Migrate from Bootstrap 3 to Bootstrap 4.

Bug fixes

Issue #3232 [https://redmine.postgresql.org/issues/3232] - Ensure that Utilities(Backup/Restore/Maintenence/Import-Export) should not be started if binary path is wrong and also added ‘Stop Process’ button to cancel the process.

Issue #3638 [https://redmine.postgresql.org/issues/3638] - Fix syntax error when creating new pgAgent schedules with a start date/time and exception.

Issue #3674 [https://redmine.postgresql.org/issues/3674] - Cleanup session files periodically.

Issue #3660 [https://redmine.postgresql.org/issues/3660] - Rename the ‘SQL Editor’ section of the Preferences to ‘Query Tool’ as it applies to the whole tool, not just the editor.

Issue #3676 [https://redmine.postgresql.org/issues/3676] - Fix CREATE Script functionality for EDB-Wrapped functions.

Issue #3700 [https://redmine.postgresql.org/issues/3700] - Fix connection garbage collector.

Issue #3703 [https://redmine.postgresql.org/issues/3703] - Purge connections from the cache on logout.

Issue #3722 [https://redmine.postgresql.org/issues/3722] - Ensure that utility existence check should work for schema and other child objects while taking Backup/Restore.

Issue #3730 [https://redmine.postgresql.org/issues/3730] - Fixed fatal error while launching the pgAdmin4 3.5. Update the version of the Flask to 0.12.4 for release.

Version 3.4

Release date: 2018-10-04

This release contains a number of features and fixes reported since the release of pgAdmin4 3.3

Features

Issue #2927 [https://redmine.postgresql.org/issues/2927] - Move all CSS into SCSS files for consistency and ease of colour maintenance etc.

Issue #3514 [https://redmine.postgresql.org/issues/3514] - Add optional data point markers and mouse-over tooltips to display values on graphs.

Issue #3564 [https://redmine.postgresql.org/issues/3564] - Add shortcuts for View Data and the Query tool to the Browser header bar.

Bug fixes

Issue #3464 [https://redmine.postgresql.org/issues/3464] - Ensure the runtime can startup properly if there are wide characters in the logfile path on Windows.

Issue #3551 [https://redmine.postgresql.org/issues/3551] - Fix handling of backslashes in the edit grid.

Issue #3576 [https://redmine.postgresql.org/issues/3576] - Ensure queries are no longer executed when dashboards are closed.

Issue #3596 [https://redmine.postgresql.org/issues/3596] - Fix support for the CLOB datatype in EPAS.

Issue #3607 [https://redmine.postgresql.org/issues/3607] - Fix logic around validation and highlighting of Sort/Filter in the Query Tool.

Issue #3630 [https://redmine.postgresql.org/issues/3630] - Ensure auto-complete works for objects in schemas other than public and pg_catalog.

Issue #3657 [https://redmine.postgresql.org/issues/3657] - Ensure changes to Query Tool settings from the Preferences dialogue are applied before executing queries.

Issue #3658 [https://redmine.postgresql.org/issues/3658] - Swap the Schema and Schemas icons and Catalog and Catalogs icons that had been used the wrong way around.

Version 3.3

Release date: 2018-09-06

This release contains a number of features and fixes reported since the release of pgAdmin4 3.2

Features

Issue #1407 [https://redmine.postgresql.org/issues/1407] - Add a geometry viewer that can render PostGIS data on a blank canvas or various map sources.

Issue #3503 [https://redmine.postgresql.org/issues/3503] - Added new backup/restore options for PostgreSQL 11. Added dump options for ‘pg_dumpall’.

Issue #3553 [https://redmine.postgresql.org/issues/3553] - Add a Spanish translation.

Bug fixes

Issue #3136 [https://redmine.postgresql.org/issues/3136] - Stabilise feature tests for continuous running on CI systems.

Issue #3191 [https://redmine.postgresql.org/issues/3191] - Fixed debugger execution issues.

Issue #3313 [https://redmine.postgresql.org/issues/3313] - Ensure ‘select all’ and ‘unselect all’ working properly for pgAgent schedule.

Issue #3325 [https://redmine.postgresql.org/issues/3325] - Fix sort/filter dialog issue where it incorrectly requires ASC/DESC.

Issue #3347 [https://redmine.postgresql.org/issues/3347] - Ensure backup should work with ‘–data-only’ and ‘–schema-only’ for any format.

Issue #3407 [https://redmine.postgresql.org/issues/3407] - Fix keyboard shortcuts layout in the preferences panel.

Issue #3420 [https://redmine.postgresql.org/issues/3420] - Merge pgcli code with version 1.10.3, which is used for auto complete feature.

Issue #3461 [https://redmine.postgresql.org/issues/3461] - Ensure that refreshing a node also updates the Property list.

Issue #3525 [https://redmine.postgresql.org/issues/3525] - Ensure that refresh button on dashboard should refresh the table.

Issue #3528 [https://redmine.postgresql.org/issues/3528] - Handle connection errors properly in the Query Tool.

Issue #3547 [https://redmine.postgresql.org/issues/3547] - Make session implementation thread safe

Issue #3548 [https://redmine.postgresql.org/issues/3548] - Ensure external table node should be visible only for GPDB.

Issue #3554 [https://redmine.postgresql.org/issues/3554] - Fix auto scrolling issue in debugger on step in and step out.

Issue #3558 [https://redmine.postgresql.org/issues/3558] - Fix sort/filter dialog editing issue.

Issue #3561 [https://redmine.postgresql.org/issues/3561] - Ensure sort/filter dialog should display proper message after losing database connection.

Issue #3578 [https://redmine.postgresql.org/issues/3578] - Ensure sql for Role should be visible in SQL panel for GPDB.

Issue #3579 [https://redmine.postgresql.org/issues/3579] - When building the Windows installer, copy system Python packages before installing dependencies to ensure we don’t end up with older versions than intended.

Issue #3604 [https://redmine.postgresql.org/issues/3604] - Correct the documentation of View/Edit data.

Version 3.2

Release date: 2018-08-09

This release contains a number of features and fixes reported since the release of pgAdmin4 3.1

Features

Issue #2136 [https://redmine.postgresql.org/issues/2136] - Added version number for URL’s to ensure that files are only cached on a per-version basis.

Issue #2214 [https://redmine.postgresql.org/issues/2214] - Add support for SCRAM password changes (requires psycopg2 >= 2.8).

Issue #3074 [https://redmine.postgresql.org/issues/3074] - Add support for reset saved password.

Issue #3397 [https://redmine.postgresql.org/issues/3397] - Add support for Trigger and JIT stats in the graphical query plan viewer.

Issue #3412 [https://redmine.postgresql.org/issues/3412] - Add support for primary key, foreign key, unique key, indexes and triggers on partitioned tables for PG/EPAS 11.

Issue #3506 [https://redmine.postgresql.org/issues/3506] - Allow the user to specify a fixed port number in the runtime to aid cookie whitelisting etc.

Issue #3510 [https://redmine.postgresql.org/issues/3510] - Add a menu option to the runtime to copy the appserver URL to the clipboard.

Bug fixes

Issue #3185 [https://redmine.postgresql.org/issues/3185] - Fix the upgrade check on macOS.

Issue #3191 [https://redmine.postgresql.org/issues/3191] - Fix a number of debugger execution issues.

Issue #3294 [https://redmine.postgresql.org/issues/3294] - Infrastructure (and changes to the Query Tool, Dashboards and Debugger) for realtime preference handling.

Issue #3309 [https://redmine.postgresql.org/issues/3309] - Fix Directory format support for backups.

Issue #3316 [https://redmine.postgresql.org/issues/3316] - Support running on systems without a system tray.

Issue #3319 [https://redmine.postgresql.org/issues/3319] - Cleanup and fix handling of Query Tool Cancel button status.

Issue #3363 [https://redmine.postgresql.org/issues/3363] - Fix restoring of restore options for sections.

Issue #3371 [https://redmine.postgresql.org/issues/3371] - Don’t create a session when the /misc/ping test endpoint is called.

Issue #3446 [https://redmine.postgresql.org/issues/3446] - Various procedure/function related fixes for EPAS/PG 11.

Issue #3448 [https://redmine.postgresql.org/issues/3448] - Exclude system columns in Import/Export.

Issue #3457 [https://redmine.postgresql.org/issues/3457] - Fix debugging of procedures in EPAS packages.

Issue #3458 [https://redmine.postgresql.org/issues/3458] - pgAdmin4 should work with python 3.7.

Issue #3468 [https://redmine.postgresql.org/issues/3468] - Support SSH tunneling with keys that don’t have a passphrase.

Issue #3471 [https://redmine.postgresql.org/issues/3471] - Ensure the SSH tunnel port number is honoured.

Issue #3511 [https://redmine.postgresql.org/issues/3511] - Add support to save and clear SSH Tunnel password.

Issue #3526 [https://redmine.postgresql.org/issues/3526] - COST statement should not be automatically duplicated after creating trigger function.

Issue #3527 [https://redmine.postgresql.org/issues/3527] - View Data->Filtered Rows dialog should be displayed.

Version 3.1

Release date: 2018-06-28

This release contains a number of features and fixes reported since the release of pgAdmin4 3.0

Features

Issue #1447 [https://redmine.postgresql.org/issues/1447] - Add support for SSH tunneled connections

Issue #2686 [https://redmine.postgresql.org/issues/2686] - Add an option to auto-complete keywords in upper case

Issue #3204 [https://redmine.postgresql.org/issues/3204] - Add support for LISTEN/NOTIFY in the Query Tool

Issue #3273 [https://redmine.postgresql.org/issues/3273] - Allow sorting in the file dialogue

Issue #3362 [https://redmine.postgresql.org/issues/3362] - Function and procedure support for PG11

Issue #3388 [https://redmine.postgresql.org/issues/3388] - Allow the connection timeout to be configured on a per-server basis

Bug fixes

Issue #1220 [https://redmine.postgresql.org/issues/1220] - Backup and Restore should not be started if database name contains “=” symbol

Issue #1221 [https://redmine.postgresql.org/issues/1221] - Maintenance should not be started if database name contains “=” symbol

Issue #3179 [https://redmine.postgresql.org/issues/3179] - Fix an error generating SQL for trigger functions

Issue #3238 [https://redmine.postgresql.org/issues/3238] - Standardise the error handling for parsing of JSON response messages from the server

Issue #3250 [https://redmine.postgresql.org/issues/3250] - Fix handling of SQL_ASCII data in the Query Tool

Issue #3257 [https://redmine.postgresql.org/issues/3257] - Catch errors when trying to EXPLAIN an invalid query

Issue #3277 [https://redmine.postgresql.org/issues/3277] - Ensure server cleanup on exit only happens if the server actually started up

Issue #3284 [https://redmine.postgresql.org/issues/3284] - F5 key should work to refresh Browser tree

Issue #3289 [https://redmine.postgresql.org/issues/3289] - Fix handling of SQL_ASCII data in the Query Tool

Issue #3290 [https://redmine.postgresql.org/issues/3290] - Close button added to the alertify message box, which pops up in case of backend error

Issue #3295 [https://redmine.postgresql.org/issues/3295] - Ensure the debugger gets focus when loaded so shortcut keys work as expected

Issue #3298 [https://redmine.postgresql.org/issues/3298] - Fixed Query Tool keyboard issue where arrow keys were not behaving as expected for execute options dropdown

Issue #3303 [https://redmine.postgresql.org/issues/3303] - Fix a Japanese translation error that could prevent the server starting up

Issue #3306 [https://redmine.postgresql.org/issues/3306] - Fixed display SQL of table with index for Greenplum database

Issue #3307 [https://redmine.postgresql.org/issues/3307] - Allow connections to servers with port numbers < 1024 which may be seen in container environments

Issue #3308 [https://redmine.postgresql.org/issues/3308] - Fixed issue where icon for Partitioned tables was the same as Non Partitioned tables for Greenplum database

Issue #3310 [https://redmine.postgresql.org/issues/3310] - Fixed layout of the alertify error message in the Query Tool

Issue #3324 [https://redmine.postgresql.org/issues/3324] - Fix the template loader to work reliably under Windows (fixing external tables under Greenplum)

Issue #3333 [https://redmine.postgresql.org/issues/3333] - Ensure the runtime core application is setup before trying to access any settings

Issue #3342 [https://redmine.postgresql.org/issues/3342] - Set SESSION_COOKIE_SAMESITE=’Lax’ per Flask recommendation to prevents sending cookies with CSRF-prone requests from external sites, such as submitting a form

Issue #3353 [https://redmine.postgresql.org/issues/3353] - Handle errors properly if they occur when renaming a database

Issue #3356 [https://redmine.postgresql.org/issues/3356] - Include the schema name on RE-SQL for packages

Issue #3374 [https://redmine.postgresql.org/issues/3374] - Fix autocomplete

Issue #3392 [https://redmine.postgresql.org/issues/3392] - Fix IPv6 support in the container build

Issue #3409 [https://redmine.postgresql.org/issues/3409] - Avoid an exception on GreenPlum when retrieving RE-SQL on a table

Issue #3411 [https://redmine.postgresql.org/issues/3411] - Fix a French translation error that could prevent the server starting up

Issue #3431 [https://redmine.postgresql.org/issues/3431] - Fix the RE-SQL generation for GreenPlum external tables

Version 3.0

Release date: 2018-03-22

This release contains a number of features and fixes reported since the release of pgAdmin4 2.1

Features

Issue #1894 [https://redmine.postgresql.org/issues/1894] - Allow sorting when viewing/editing data

Issue #1978 [https://redmine.postgresql.org/issues/1978] - Add the ability to enable/disable UI animations

Issue #2895 [https://redmine.postgresql.org/issues/2895] - Add keyboard navigation options for the main browser windows

Issue #2896 [https://redmine.postgresql.org/issues/2896] - Add keyboard navigation in Query tool module via Tab/Shift-Tab key

Issue #2897 [https://redmine.postgresql.org/issues/2897] - Support keyboard navigation in the debugger

Issue #2898 [https://redmine.postgresql.org/issues/2898] - Support tab navigation in dialogs

Issue #2899 [https://redmine.postgresql.org/issues/2899] - Add configurable shortcut keys for various common options in the main window

Issue #2901 [https://redmine.postgresql.org/issues/2901] - Configurable shortcuts in the Debugger

Issue #2904 [https://redmine.postgresql.org/issues/2904] - Ensure clickable images/buttons have appropriate tooltips for screen readers

Issue #2950 [https://redmine.postgresql.org/issues/2950] - Add a marker (/pga4dash/) to the dashboard queries to allow them to be more easily filtered from server logs

Issue #2951 [https://redmine.postgresql.org/issues/2951] - Allow dashboard tables and charts to be enabled/disabled

Issue #3004 [https://redmine.postgresql.org/issues/3004] - Support server and database statistics on Greenplum

Issue #3036 [https://redmine.postgresql.org/issues/3036] - Display partitions in Greenplum

Issue #3044 [https://redmine.postgresql.org/issues/3044] - Display functions in Greenplum

Issue #3086 [https://redmine.postgresql.org/issues/3086] - Rewrite the runtime as a tray-based server which can launch a web browser

Issue #3097 [https://redmine.postgresql.org/issues/3097] - Support EXPLAIN on Greenplum

Issue #3098 [https://redmine.postgresql.org/issues/3098] - Unvendorize REACT so no longer required in our source tree

Issue #3107 [https://redmine.postgresql.org/issues/3107] - Hide tablespace node on GPDB

Issue #3140 [https://redmine.postgresql.org/issues/3140] - Add support for connecting using pg_service.conf files

Issue #3168 [https://redmine.postgresql.org/issues/3168] - Support for external tables in GPDB

Issue #3182 [https://redmine.postgresql.org/issues/3182] - Update Jasmine to v3

Issue #3184 [https://redmine.postgresql.org/issues/3184] - Add a French translation

Issue #3195 [https://redmine.postgresql.org/issues/3195] - Pass the service name to external processes

Issue #3246 [https://redmine.postgresql.org/issues/3246] - Update container build to use Alpine Linux and Gunicorn instead of CentOS/Apache

In addition, various changes were made for PEP8 compliance

Bug fixes

Issue #1173 [https://redmine.postgresql.org/issues/1173] - Add a comment to the existing node

Issue #1925 [https://redmine.postgresql.org/issues/1925] - Fix issue resizing column widths not resizable in Query Tool after first query

Issue #2104 [https://redmine.postgresql.org/issues/2104] - Runtime update display file version and copyright year under installers properties

Issue #2249 [https://redmine.postgresql.org/issues/2249] - Application no longer hangs after reload in runtime

Issue #2251 [https://redmine.postgresql.org/issues/2251] - Runtime fixed OSX html scroll direction ignored in MacOS setup

Issue #2309 [https://redmine.postgresql.org/issues/2309] - Allow text selection/copying from disabled CodeMirror instances

Issue #2480 [https://redmine.postgresql.org/issues/2480] - Runtime update fix to Context Menus on Mac that do not work

Issue #2578 [https://redmine.postgresql.org/issues/2578] - Runtime update fix to HTML access keys that don’t work

Issue #2581 [https://redmine.postgresql.org/issues/2581] - Fix keyboard shortcut for text selection

Issue #2677 [https://redmine.postgresql.org/issues/2677] - Update Elephant icon for pgAdmin4 on Windows

Issue #2776 [https://redmine.postgresql.org/issues/2776] - Fix unreadable font via Remote Desktop

Issue #2777 [https://redmine.postgresql.org/issues/2777] - Fix spacing issue on server tree

Issue #2783 [https://redmine.postgresql.org/issues/2783] - Runtime update fixed blank screen on Windows Desktop

Issue #2906 [https://redmine.postgresql.org/issues/2906] - Correct display issues on HiDPI screens

Issue #2961 [https://redmine.postgresql.org/issues/2961] - Issues when creating a pgAgent Schedule

Issue #2963 [https://redmine.postgresql.org/issues/2963] - Fix unicode handling in the external process tools and show the complete command in the process viewer

Issue #2980 [https://redmine.postgresql.org/issues/2980] - Copy text from the Query tool into the clipboard adds invisible characters

Issue #2981 [https://redmine.postgresql.org/issues/2981] - Support keyboard navigation in the debugger

Issue #2983 [https://redmine.postgresql.org/issues/2983] - Fix intermittent specified_version_number ValueError issue on restart

Issue #2985 [https://redmine.postgresql.org/issues/2985] - Fix drag and drop issues

Issue #2998 [https://redmine.postgresql.org/issues/2998] - Don’t listen on port 443 if TLS is not enabled when launching the container

Issue #3001 [https://redmine.postgresql.org/issues/3001] - Runtime update fix scrolling with mouse wheel on mac pgAdmin 4.2.1

Issue #3002 [https://redmine.postgresql.org/issues/3002] - Fix block indent/outdent with configurable width

Issue #3003 [https://redmine.postgresql.org/issues/3003] - Runtime update fix copy to clipboard

Issue #3005 [https://redmine.postgresql.org/issues/3005] - Runtime update fix unable to select tabs in pgAdmin 4.2.1

Issue #3013 [https://redmine.postgresql.org/issues/3013] - Fix a minor UI issue on dashboard while displaying subnode control in Backgrid

Issue #3014 [https://redmine.postgresql.org/issues/3014] - Fix validation of sequence parameters

Issue #3015 [https://redmine.postgresql.org/issues/3015] - Support Properties on Greenplum databases

Issue #3016 [https://redmine.postgresql.org/issues/3016] - Ensure debug messages are available in “messages” window when error occurs

Issue #3021 [https://redmine.postgresql.org/issues/3021] - Update scan and index scan EXPLAIN icons for greater clarity

Issue #3027 [https://redmine.postgresql.org/issues/3027] - Ensure we capture notices raised by queries

Issue #3031 [https://redmine.postgresql.org/issues/3031] - Runtime issue causing double and single quotes not to work

Issue #3039 [https://redmine.postgresql.org/issues/3039] - Runtime issue causing wrong row counts on count column

Issue #3042 [https://redmine.postgresql.org/issues/3042] - Runtime issue causing empty dialog box when refreshing

Issue #3043 [https://redmine.postgresql.org/issues/3043] - Runtime issue causing word sizing in macOS High Sierra

Issue #3045 [https://redmine.postgresql.org/issues/3045] - Runtime issue causing copy cells issues copying cells for key binding

Issue #3046 [https://redmine.postgresql.org/issues/3046] - Fix connection status indicator on IE/FF

Issue #3050 [https://redmine.postgresql.org/issues/3050] - Correct display of RE-SQL for partitioned tables in Greenplum

Issue #3052 [https://redmine.postgresql.org/issues/3052] - Don’t include sizes on primitive data types that shouldn’t have them when modifying columns

Issue #3054 [https://redmine.postgresql.org/issues/3054] - Ensure the user can use keyboard shortcuts after using button controls such as Cancel, Open and Save

Issue #3057 [https://redmine.postgresql.org/issues/3057] - Update the regression tests to fix issues with Python 3.5 and PG 9.2

Issue #3058 [https://redmine.postgresql.org/issues/3058] - Fix on-click handling of treeview nodes that wasn’t refreshing SQL/Dependencies/Dependents in some circumstances

Issue #3059 [https://redmine.postgresql.org/issues/3059] - Fix table statistics for Greenplum

Issue #3060 [https://redmine.postgresql.org/issues/3060] - Fix quoting of function names in RE-SQL

Issue #3066 [https://redmine.postgresql.org/issues/3066] - Ensure column names on indexes on views are properly quoted in RE-SQL

Issue #3067 [https://redmine.postgresql.org/issues/3067] - Prevent the filter dialog CodeMirror from overflowing onto the button bar of the dialog

Issue #3072 [https://redmine.postgresql.org/issues/3072] - Add a (configurable) limit to the number of pgAgent job history rows displayed on the statistics tab

Issue #3073 [https://redmine.postgresql.org/issues/3073] - Ensure the pgAgent job start/end time grid fields synchronise with the subnode control and validate correctly

Issue #3075 [https://redmine.postgresql.org/issues/3075] - Runtime issue causing Select, Update, and Insert script generation for a table fails to load

Issue #3077 [https://redmine.postgresql.org/issues/3077] - Remove dependency on standards_conforming_strings being enabled

Issue #3079 [https://redmine.postgresql.org/issues/3079] - Fix handling of tie/datetime array types when adding columns to a table

Issue #3080 [https://redmine.postgresql.org/issues/3080] - Fix alignment issues in keyboard shortcut options

Issue #3081 [https://redmine.postgresql.org/issues/3081] - Add missing reverse-engineered SQL header and drop statement for sequences

Issue #3090 [https://redmine.postgresql.org/issues/3090] - Ensure message severity is decoded when necessary by the driver

Issue #3094 [https://redmine.postgresql.org/issues/3094] - Ensure all messages are retrieved from the server in the Query Tool

Issue #3099 [https://redmine.postgresql.org/issues/3099] - Fix creation of tables and columns in GPDB

Issue #3105 [https://redmine.postgresql.org/issues/3105] - Ensure we can properly update rows with upper-case primary key columns

Issue #3135 [https://redmine.postgresql.org/issues/3135] - Insert rows correctly when a table has OIDs and a Primary Key in uppercase

Issue #3122 [https://redmine.postgresql.org/issues/3122] - Ensure SSL options are pushed down to external tools like pg_dump

Issue #3129 [https://redmine.postgresql.org/issues/3129] - Handle opening of non-UTF8 compatible files

Issue #3137 [https://redmine.postgresql.org/issues/3137] - Allow copying of SQL from the dashboard tables

Issue #3138 [https://redmine.postgresql.org/issues/3138] - Fix tablespace tests for Python 3.x

Issue #3150 [https://redmine.postgresql.org/issues/3150] - Fix function reserve SQL for GPDB

Issue #3157 [https://redmine.postgresql.org/issues/3157] - Fix unicode handling in the external process tools and show the complete command in the process viewer

Issue #3171 [https://redmine.postgresql.org/issues/3171] - Runtime issue causing inability to scroll in File Selector with trackpad on OSX

Issue #3176 [https://redmine.postgresql.org/issues/3176] - Disable function statistics on Greenplum

Issue #3180 [https://redmine.postgresql.org/issues/3180] - Ensure Indexes are displayed on PG 10 tables

Issue #3190 [https://redmine.postgresql.org/issues/3190] - Skip tests where appropriate on GPDB

Issue #3196 [https://redmine.postgresql.org/issues/3196] - Ensure the file manager properly escapes file & directory names

Issue #3197 [https://redmine.postgresql.org/issues/3197] - Appropriately set the cookie path

Issue #3200 [https://redmine.postgresql.org/issues/3200] - Ensure the host parameter is correctly pickup up from the service file

Issue #3219 [https://redmine.postgresql.org/issues/3219] - Update required ChromeDriver version for current versions of Chrome

Issue #3226 [https://redmine.postgresql.org/issues/3226] - Move the field error indicators in front of the affected fields so they don’t obscure spinners or drop downs etc.

Issue #3244 [https://redmine.postgresql.org/issues/3244] - Show more granular timing info in the Query Tool history panel

Issue #3248 [https://redmine.postgresql.org/issues/3248] - Ensure Alertify dialogues are modal to prevent them being closed by mis-click

Version 2.1

Release date: 2018-01-11

This release contains a number of features and fixes reported since the release of pgAdmin4 2.0

Features

Issue #1383 [https://redmine.postgresql.org/issues/1383] - Allow connections to be coloured in the treeview and Query Tool

Issue #1489 [https://redmine.postgresql.org/issues/1489] - Improve user interface for selection query in Data Filter window

Issue #2368 [https://redmine.postgresql.org/issues/2368] - Improve data entry in Query Tool

Issue #2781 [https://redmine.postgresql.org/issues/2781] - Allow configuration of CSV and clipboard formatting of query results

Issue #2802 [https://redmine.postgresql.org/issues/2802] - Allow connections to be coloured in the treeview and Query Tool.

Issue #2810 [https://redmine.postgresql.org/issues/2810] - Allow files to be opened by double clicking on them within Query Tool

Issue #2845 [https://redmine.postgresql.org/issues/2845] - Make the “Save Changes” prompts in the Query Tool optional

Issue #2849 [https://redmine.postgresql.org/issues/2849] - Add support for editing data in tables with OIDs but no primary keys and updates the editor to retrieve all row values on save, thus immediately showing default values and allowing subsequent editing without a refresh

Bug fixes

Issue #1365 [https://redmine.postgresql.org/issues/1365] - Prevent the Windows installer accepting paths containing invalid characters

Issue #1366 [https://redmine.postgresql.org/issues/1366] - Fix /NOICONS switch in the windows installer

Issue #1436 [https://redmine.postgresql.org/issues/1436] - Fix issue with debugger which is failing for sub - procedure on PPAS 9.6

Issue #1749 [https://redmine.postgresql.org/issues/1749] - Fixes in pgAgent module including; 1) allowing start date earlier than end date when scheduling job, 2) Datetime picker not displaying in grid and 3) validation error not displaying propertly for Datetime control

Issue #2094 [https://redmine.postgresql.org/issues/2094] - Display relevant error messages when access is denied creating a schema

Issue #2098 [https://redmine.postgresql.org/issues/2098] - Cleanup some inconsistent error dialog titles

Issue #2258 [https://redmine.postgresql.org/issues/2258] - Fix handling of DATERANGE[] type

Issue #2278 [https://redmine.postgresql.org/issues/2278] - Display long names appropriately in dialogue headers

Issue #2443 [https://redmine.postgresql.org/issues/2443] - Confirm with the user before exiting the runtime

Issue #2524 [https://redmine.postgresql.org/issues/2524] - Fix debugging of self-referencing functions

Issue #2566 [https://redmine.postgresql.org/issues/2566] - Fix the Pause/Resume Replay of WAL files for PostgreSQL 10

Issue #2624 [https://redmine.postgresql.org/issues/2624] - Ensure the switch animation is consistent on the table dialogue and avoid displaying an error incorrectly

Issue #2651 [https://redmine.postgresql.org/issues/2651] - Ensure estimated rows are included correctly in CREATE script for functions

Issue #2679 [https://redmine.postgresql.org/issues/2679] - Getting started links does not open second time if User open any URL and Click on Close button with cross bar

Issue #2705 [https://redmine.postgresql.org/issues/2705] - User can add expirty date on Windows

Issue #2715 [https://redmine.postgresql.org/issues/2715] - Ensure we can download large files and keep the user informed about progress

Issue #2720 [https://redmine.postgresql.org/issues/2720] - Ensure password changes are successful if authenticating using a pgpass file

Issue #2726 [https://redmine.postgresql.org/issues/2726] - Ensure the auto-complete selection list can display longer names

Issue #2738 [https://redmine.postgresql.org/issues/2738] - Ensure line numbers form CodeMirror don’t appear on top of menus

Issue #2748 [https://redmine.postgresql.org/issues/2748] - Format JSON/JSONB nicely when displaying it in the grid editor pop-up

Issue #2760 [https://redmine.postgresql.org/issues/2760] - When selecting an SSL cert or key, update only the expected path in the UI, not all of them

Issue #2765 [https://redmine.postgresql.org/issues/2765] - Do not decrypt the password when the password is ‘None’. This should avoid the common but harmless exception “ValueError: IV must be 16 bytes long while decrypting the password.”

Issue #2768 [https://redmine.postgresql.org/issues/2768] - Only allow specification of a pgpass file if libpq >= 10

Issue #2769 [https://redmine.postgresql.org/issues/2769] - Correct keyboard shortcut. Don’t un-comment code with alt+. in the Query Tool. It’s only supposed to respond to ctrl/cmd+

Issue #2772 [https://redmine.postgresql.org/issues/2772] - Remove external links from Panel’s context menu

Issue #2778 [https://redmine.postgresql.org/issues/2778] - Ensure the datatype cache is updated when a domain is added

Issue #2779 [https://redmine.postgresql.org/issues/2779] - Ensure column collation isn’t lost when changing field size

Issue #2780 [https://redmine.postgresql.org/issues/2780] - Ensure auto-indent honours the spaces/tabs config setting

Issue #2782 [https://redmine.postgresql.org/issues/2782] - Re-hash the way that we handle rendering of special types such as arrays

Issue #2787 [https://redmine.postgresql.org/issues/2787] - Quote the owner name when creating types

Issue #2806 [https://redmine.postgresql.org/issues/2806] - Attempt to decode database errors based on lc_messages

Issue #2811 [https://redmine.postgresql.org/issues/2811] - Display process output as it happens

Issue #2820 [https://redmine.postgresql.org/issues/2820] - Logs available when executing backup and restore

Issue #2821 [https://redmine.postgresql.org/issues/2821] - Attempt to decode database errors based on lc_messages

Issue #2822 [https://redmine.postgresql.org/issues/2822] - Re-hash the way that we handle rendering of special types such as arrays.

Issue #2824 [https://redmine.postgresql.org/issues/2824] - Fix a number of graphical explain rendering issues

Issue #2836 [https://redmine.postgresql.org/issues/2636] - Fix counted rows display in table properties

Issue #2842 [https://redmine.postgresql.org/issues/2842] - Fix a number of graphical explain rendering issues

Issue #2846 [https://redmine.postgresql.org/issues/2846] - Add an option to manually count rows in tables to render the properties

Issue #2854 [https://redmine.postgresql.org/issues/2854] - Fix utility output capture encoding

Issue #2859 [https://redmine.postgresql.org/issues/2859] - Allow form validation messages to be close in case the eclipse anything on the form

Issue #2866 [https://redmine.postgresql.org/issues/2866] - Ensure we don’t show the full path on the server when using virtual filesystem roots in server mode for SSL certs

Issue #2875 [https://redmine.postgresql.org/issues/2875] - Ensure the scroll location is retains in the Query Tool data grid if the user changes tab and then returns

Issue #2877 [https://redmine.postgresql.org/issues/2877] - Remove the artificial limit of 4000 characters from text areas

Issue #2880 [https://redmine.postgresql.org/issues/2880] - Honour whitespace properly in the data grid

Issue #2881 [https://redmine.postgresql.org/issues/2881] - Fix support for time without timezone

Issue #2886 [https://redmine.postgresql.org/issues/2886] - Resolve issue where Insert failed when tried with default primary key value

Issue #2891 [https://redmine.postgresql.org/issues/2891] - Allow changing of the users password without leaving the app

Issue #2892 [https://redmine.postgresql.org/issues/2892] - Refuse password changes (and tell the user) if the notification email cannot be sent

Issue #2908 [https://redmine.postgresql.org/issues/2908] - Fix bundle creation on Windows which was failing due to rn line endings in code mirror

Issue #2918 [https://redmine.postgresql.org/issues/2918] - Add missing init.py to backports.csv when building the MSVC windows build

Issue #2920 [https://redmine.postgresql.org/issues/2920] - Push HTTPD logs to container stdout/stderr as appropriate

Issue #2921 [https://redmine.postgresql.org/issues/2921] - Fixes in pgAgent module including; 1) allowing start date earlier than end date when scheduling job, 2) Datetime picker not displaying in grid and 3) validation error not displaying propertly for Datetime control

Issue #2922 [https://redmine.postgresql.org/issues/2922] - Don’t login the user with every request in desktop mode. Just do it once

Issue #2923 [https://redmine.postgresql.org/issues/2923] - Prevent the user pressing the select button in the file manager when it is supposed to be disabled

Issue #2924 [https://redmine.postgresql.org/issues/2924] - Cleanup the layout of the filter data dialogue

Issue #2928 [https://redmine.postgresql.org/issues/2928] - Prevent multiple connections to new slow-to-respond servers being initiated in error

Issue #2934 [https://redmine.postgresql.org/issues/2934] - Fix a reference before assignment error in the file dialogue

Issue #2937 [https://redmine.postgresql.org/issues/2937] - Prevent attempts to select directories as files in the file dialogue

Issue #2945 [https://redmine.postgresql.org/issues/2945] - Ensure invalid options can’t be selected on triggers on views

Issue #2949 [https://redmine.postgresql.org/issues/2949] - Display complete SQL for FTS dictionaries

Issue #2952 [https://redmine.postgresql.org/issues/2952] - Don’t try to render security URLs in desktop mode

Issue #2954 [https://redmine.postgresql.org/issues/2954] - Allow selection of validation error text

Issue #2974 [https://redmine.postgresql.org/issues/2974] - Clear the messages tab when running EXPLAIN/EXPLAIN ANALYZE

Issue #2993 [https://redmine.postgresql.org/issues/2993] - Fix view data for views/mat views

Version 2.0

Release date: 2017-10-05

This release contains a number of features and fixes reported since the release of pgAdmin4 1.6

Features

Issue #1918 [https://redmine.postgresql.org/issues/1918] - Add a field to the Server Dialogue allowing users to specify a subset of databases they’d like to see in the treeview

Issue #2135 [https://redmine.postgresql.org/issues/2135] - Significantly speed up loading of the application

Issue #2556 [https://redmine.postgresql.org/issues/2556] - Allow for slow vs. fast connection failures

Issue #2579 [https://redmine.postgresql.org/issues/2579] - Default the file browser view to list, and make it configurable

Issue #2597 [https://redmine.postgresql.org/issues/2597] - Allow queries to be cancelled from the dashboard and display additional info in the subnode control

Issue #2649 [https://redmine.postgresql.org/issues/2649] - Support use of SSL certificates for authentication

Issue #2650 [https://redmine.postgresql.org/issues/2650] - Support use of pgpass files

Issue #2662 [https://redmine.postgresql.org/issues/2662] - Ship with pre-configured paths that can work in both Server and Desktop modes out of the box

Issue #2689 [https://redmine.postgresql.org/issues/2689] - Update icons with new designs and remove from menus to de-clutter the UI

Bug fixes

Issue #1165 [https://redmine.postgresql.org/issues/1165] - Prevent continual polling for graph data on the dashboard if the server is disconnected

Issue #1697 [https://redmine.postgresql.org/issues/1697] - Update CodeMirror version

Issue #2043 [https://redmine.postgresql.org/issues/2043] - Properly handle trigger functions with parameters

Issue #2074 [https://redmine.postgresql.org/issues/2074] - Make $ quoting consistent

Issue #2080 [https://redmine.postgresql.org/issues/2080] - Fix issue where Browser hangs/crashes when loading data (using sql editor) from table which contains large blob data

Issue #2153 [https://redmine.postgresql.org/issues/2153] - Fix handline of large file uploads and properly show any errors that may occur

Issue #2168 [https://redmine.postgresql.org/issues/2168] - Update CodeMirror version

Issue #2170 [https://redmine.postgresql.org/issues/2170] - Support SSL in the regression tests

Issue #2324 [https://redmine.postgresql.org/issues/2324] - Fix PostGIS Datatypes in SQL tab, Create / Update dialogues for Table, Column, Foreign Table and Type node

Issue #2447 [https://redmine.postgresql.org/issues/2447] - Update CodeMirror version

Issue #2452 [https://redmine.postgresql.org/issues/2452] - Install pgadmin4-v1 1.5 on Centos7

Issue #2501 [https://redmine.postgresql.org/issues/2501] - Fix collation tests on Windows, replace use of default ‘POSIX’ collation with ‘C’ collation for testing

Issue #2541 [https://redmine.postgresql.org/issues/2541] - Fix issues using special keys on MacOS

Issue #2544 [https://redmine.postgresql.org/issues/2544] - Correct malformed query generated when using custom type

Issue #2551 [https://redmine.postgresql.org/issues/2551] - Show tablespace on partitions

Issue #2555 [https://redmine.postgresql.org/issues/2555] - Fix issue in Query Tool where messages were not displaying from functions/procedures properly

Issue #2557 [https://redmine.postgresql.org/issues/2557] - Tidy up tab styling

Issue #2558 [https://redmine.postgresql.org/issues/2558] - Prevent the tab bar being hidden when detached tabs are being closed

Issue #2559 [https://redmine.postgresql.org/issues/2559] - Stop tool buttons from changing their styling unexpectedly

Issue #2560 [https://redmine.postgresql.org/issues/2560] - Fix View ‘CREATE Script’ Problem

Issue #2562 [https://redmine.postgresql.org/issues/2562] - Update CodeMirror version

Issue #2563 [https://redmine.postgresql.org/issues/2563] - Fix paths under non-standard virtual directories

Issue #2566 [https://redmine.postgresql.org/issues/2566] - Fix Pause/Resume Replay of WAL files for PostgreSQL 10

Issue #2567 [https://redmine.postgresql.org/issues/2567] - Use the proper database connection to fetch the default priviledges in the properties tab of the database

Issue #2582 [https://redmine.postgresql.org/issues/2582] - Unset compression ratio if it is an empty string in Backup module

Issue #2586 [https://redmine.postgresql.org/issues/2586] - Cleanup feature tests

Issue #2590 [https://redmine.postgresql.org/issues/2590] - Allow navigation of query history using the arrow keys

Issue #2592 [https://redmine.postgresql.org/issues/2592] - Stop Flask from initialising service twice in Debug mode

Issue #2593 [https://redmine.postgresql.org/issues/2593] - Ensure babel-polyfill is loaded in older qWebKits

Issue #2594 [https://redmine.postgresql.org/issues/2594] - Fix disconnection of new databases

Issue #2596 [https://redmine.postgresql.org/issues/2596] - Define the proper NODE_ENV environment during running the webpack

Issue #2606 [https://redmine.postgresql.org/issues/2606] - Ensure role names are escaped in the membership control

Issue #2616 [https://redmine.postgresql.org/issues/2616] - Domain create dialog do not open and Font size issue in Security label control

Issue #2617 [https://redmine.postgresql.org/issues/2617] - Add missing pgagent file in webpack.config.js

Issue #2619 [https://redmine.postgresql.org/issues/2619] - Fix quoting of index column names on tables

Issue #2620 [https://redmine.postgresql.org/issues/2620] - Set database name to blank(‘’) when job type is set to batch, while creating pgAgent job

Issue #2631 [https://redmine.postgresql.org/issues/2631] - Change mapping of cell from ‘numeric’ to ‘integer’ for integer control as numeric cell has been removed from the code

Issue #2633 [https://redmine.postgresql.org/issues/2633] - Fix pgAgent job step issues

Issue #2634 [https://redmine.postgresql.org/issues/2634] - Add New Server through Quick links

Issue #2637 [https://redmine.postgresql.org/issues/2637] - Fix Copy so it still works after query results have been copied

Issue #2641 [https://redmine.postgresql.org/issues/2641] - User management issues - styling and inability to edit users properly

Issue #2644 [https://redmine.postgresql.org/issues/2644] - Fix alertify notification messages where checkmark box disconnected from frame

Issue #2646 [https://redmine.postgresql.org/issues/2646] - Fix the path reference of load-node.gif which was referencing to vendor directory

Issue #2654 [https://redmine.postgresql.org/issues/2654] - Update datetime picker

Issue #2655 [https://redmine.postgresql.org/issues/2655] - Fix connection string validation for pgAgent jobs

Issue #2656 [https://redmine.postgresql.org/issues/2656] - Change Datetimepicker to expand from bottom in pgAgent so calendar does not get hidden

Issue #2657 [https://redmine.postgresql.org/issues/2657] - Fix syntax error while saving changes for start/end time, weekdays, monthdays, month, hours, minutes while updating the pgAgent Job

Issue #2659 [https://redmine.postgresql.org/issues/2659] - Fix issue where unable to add/update variables for columns of a table

Issue #2660 [https://redmine.postgresql.org/issues/2660] - Not able to select rows in History Tab

Issue #2668 [https://redmine.postgresql.org/issues/2668] - Fix RE-SQL for triggers with a single arg

Issue #2670 [https://redmine.postgresql.org/issues/2670] - Improve datamodel validations for default Validator if user (developer) does not implement validate function in datamodel

Issue #2671 [https://redmine.postgresql.org/issues/2671] - Fix array data type formating for bigint, real, float, double precision

Issue #2681 [https://redmine.postgresql.org/issues/2681] - Reset Query Tool options before running tests

Issue #2684 [https://redmine.postgresql.org/issues/2684] - Fix layout of password prompt dialogue

Issue #2691 [https://redmine.postgresql.org/issues/2691] - View data option is missing from pgAdmin4 2.0 version

Issue #2692 [https://redmine.postgresql.org/issues/2692] - Base type is missing for Domain on pgAdmin4

Issue #2693 [https://redmine.postgresql.org/issues/2693] - User list is not available on User mapping pgAdmin4

Issue #2698 [https://redmine.postgresql.org/issues/2698] - User can not create function due to missing return type

Issue #2699 [https://redmine.postgresql.org/issues/2699] - Filtered Rows issue on pgAdmin4

Issue #2700 [https://redmine.postgresql.org/issues/2700] - Cancel button is visible after query executed succesfully

Issue #2707 [https://redmine.postgresql.org/issues/2707] - Disable trigger button does not work on pgAdmin4

Issue #2708 [https://redmine.postgresql.org/issues/2708] - Tablespace name should displayed instead of %s(new_tablespace)s with Move Objects to another tablespace

Issue #2709 [https://redmine.postgresql.org/issues/2709] - Display user relations in schema prefixed by ‘pg’

Issue #2713 [https://redmine.postgresql.org/issues/2713] - Fix an exception seen sometimes when the server is restarted

Issue #2742 [https://redmine.postgresql.org/issues/2742] - Ensure using an alternate role to connect to a database doesn’t cause an error when checking recovery state.

Version 1.6

Release date: 2017-07-13

This release contains a number of features and fixes reported since the release of pgAdmin4 1.5

Features

Issue #1344 [https://redmine.postgresql.org/issues/1344] - Allow the Query Tool, Debugger and web browser tabs to be moved to different monitors as desired

Issue #1533 [https://redmine.postgresql.org/issues/1533] - Set focus on the first enabled field when a dialogue is opened

Issue #1535 [https://redmine.postgresql.org/issues/1535] - Teach dialogues about Escape to cancel, Enter to Save/OK, and F1 for help

Issue #1971 [https://redmine.postgresql.org/issues/1971] - Retain column sizing in the Query Tool results grid when the same query is re-run multiple times in a row

Issue #1972 [https://redmine.postgresql.org/issues/1972] - Prompt the user to save dirty queries rather than discard them for a more natural workflow

Issue #2137 [https://redmine.postgresql.org/issues/2137] - On-demand loading for the Query Tool results

Issue #2191 [https://redmine.postgresql.org/issues/2191] - Add support for the hostaddr connection parameter. This helps us play nicely with Kerberos/SSPI and friends

Issue #2282 [https://redmine.postgresql.org/issues/2282] - Overhaul the query history tab to allow browsing of the history and full query text

Issue #2379 [https://redmine.postgresql.org/issues/2379] - Support inserting multiple new rows into a table without clicking Save for each row

Issue #2485 [https://redmine.postgresql.org/issues/2485] - Add a shortcut to reset the zoom level in the runtime

Issue #2506 [https://redmine.postgresql.org/issues/2506] - Allow the user to close the dashboard panel

Issue #2513 [https://redmine.postgresql.org/issues/2513] - Add preferences to enable brace matching and brace closing in the SQL editors

Bug fixes

Issue #1126 [https://redmine.postgresql.org/issues/1126] - Various FTS dictionary cleanups

Issue #1229 [https://redmine.postgresql.org/issues/1229] - Fix default values and SQL formatting for event triggers

Issue #1466 [https://redmine.postgresql.org/issues/1466] - Prevent attempts to debug procedures with variadic arguments

Issue #1525 [https://redmine.postgresql.org/issues/1525] - Make $ quoting consistent

Issue #1575 [https://redmine.postgresql.org/issues/1575] - Properly display security labels on EPAS 9.2+

Issue #1795 [https://redmine.postgresql.org/issues/1795] - Fix validation for external and range types

Issue #1813 [https://redmine.postgresql.org/issues/1813] - List packages in PPAS 9.2-9.4 when creating synonyms

Issue #1831 [https://redmine.postgresql.org/issues/1831] - Fix server stats display for EPAS 9.2, where inet needs casting to text for concatenation

Issue #1851 [https://redmine.postgresql.org/issues/1851] - Reverse engineer SQL for table-returning functions correctly

Issue #1860 [https://redmine.postgresql.org/issues/1860] - Ensure default values are honoured when adding/editing columns

Issue #1888 [https://redmine.postgresql.org/issues/1888] - Fix various issues with pgAgent job steps and schedules

Issue #1889 [https://redmine.postgresql.org/issues/1889] - Fix various issues with pgAgent job steps and schedules

Issue #1890 [https://redmine.postgresql.org/issues/1890] - Fix various issues with pgAgent job steps and schedules

Issue #1920 [https://redmine.postgresql.org/issues/1920] - Ensure saved passwords are effective immediately, not just following a restart when first saved

Issue #1928 [https://redmine.postgresql.org/issues/1928] - Fix the handling of double precision[] type

Issue #1934 [https://redmine.postgresql.org/issues/1934] - Fix import/export to work as expected with TSV data

Issue #1999 [https://redmine.postgresql.org/issues/1999] - Handle warning correctly when saving query results to an unmounted USB drive

Issue #2013 [https://redmine.postgresql.org/issues/2013] - Increase the default size of the Grant Wizard to enable it to properly display privileges at the default size on smaller displays

Issue #2014 [https://redmine.postgresql.org/issues/2014] - To fix unexpected behaviour displayed if user stops debugging on package/procedure fire_emp

Issue #2043 [https://redmine.postgresql.org/issues/2043] - Properly handle trigger functions with parameters

Issue #2078 [https://redmine.postgresql.org/issues/2078] - Refresh the SQL editor view on resize to ensure the contents are re-rendered for the new viewport

Issue #2086 [https://redmine.postgresql.org/issues/2086] - Allow editing of the WITH ADMIN option of role membership

Issue #2113 [https://redmine.postgresql.org/issues/2113] - Correct the validation logic when modifying indexes/exclusion constraints

Issue #2116 [https://redmine.postgresql.org/issues/2116] - Enable dialogue help buttons on Language and Foreign Table dialogues

Issue #2142 [https://redmine.postgresql.org/issues/2142] - Fix canceling of Grant Wizard on Windows

Issue #2155 [https://redmine.postgresql.org/issues/2155] - Fix removal of sizes from column definitions

Issue #2162 [https://redmine.postgresql.org/issues/2162] - Allow non-superusers to debug their own functions and prevent them from setting global breakpoints

Issue #2242 [https://redmine.postgresql.org/issues/2242] - Fix an issue in NodeAjaxControl caching with cache-node field and add cache-node field in Trigger & Event trigger node so that whenever the user creates new Trigger Function we get new data from server in NodeAjaxControl

Issue #2280 [https://redmine.postgresql.org/issues/2280] - Handle procedure flags (IMMUTABLE STRICT SECURITY DEFINER PARALLEL RESTRICTED) properly in RE-SQL on EPAS

Issue #2324 [https://redmine.postgresql.org/issues/2324] - Fix the PostGIS Datatypes in SQL tab, Create / Update dialogues for Table, Column, Foreign Table and Type node

Issue #2344 [https://redmine.postgresql.org/issues/2344] - Fix issue with ctrl-c / ctrl-v not working in Query Tool

Issue #2348 [https://redmine.postgresql.org/issues/2348] - Fix issue when resizing columns in Query Too/View Data where all row/colums will select/deselect

Issue #2355 [https://redmine.postgresql.org/issues/2355] - Properly refresh the parent node when renaming children

Issue #2357 [https://redmine.postgresql.org/issues/2355] - Cache statistics more reliably

Issue #2381 [https://redmine.postgresql.org/issues/2381] - Fix the RE-SQL for for views to properly qualify trigger function names

Issue #2386 [https://redmine.postgresql.org/issues/2386] - Display and allow toggling of trigger enable/disable status from the trigger dialogue

Issue #2398 [https://redmine.postgresql.org/issues/2398] - Bypass the proxy server for local addresses on Windows

Issue #2400 [https://redmine.postgresql.org/issues/2400] - Cleanup handling of default/null values when data editing

Issue #2414 [https://redmine.postgresql.org/issues/2414] - Improve error handling in cases where the user tries to rename or create a server group that would duplicate an existing group

Issue #2417 [https://redmine.postgresql.org/issues/2417] - Order columns in multi-column pkeys correctly

Issue #2422 [https://redmine.postgresql.org/issues/2422] - Fix RE-SQL for rules which got the table name wrong in the header and DROP statement

Issue #2425 [https://redmine.postgresql.org/issues/2425] - Handle composite primary keys correctly when deleting rows in the Edit Grid

Issue #2426 [https://redmine.postgresql.org/issues/2426] - Allow creation of ENUM types with no members

Issue #2427 [https://redmine.postgresql.org/issues/2427] - Add numerous missing checks to ensure objects really exist when we think they do

Issue #2435 [https://redmine.postgresql.org/issues/2435] - Pass the database ID to the Query Tool when using the Script options

Issue #2436 [https://redmine.postgresql.org/issues/2436] - Ensure the last placeholder is included when generating UPDATE scripts for tables

Issue #2448 [https://redmine.postgresql.org/issues/2448] - Ensure that boolean checkboxes cycle values in the correct order

Issue #2450 [https://redmine.postgresql.org/issues/2450] - Fix error on the stats tab with PG10. Also, rename the 10.0_plus template directory to 10_plus to match the new versioning

Issue #2461 [https://redmine.postgresql.org/issues/2461] - Allow users to remove default values from columns properly

Issue #2468 [https://redmine.postgresql.org/issues/2468] - Fix issue where function create script won’t compile

Issue #2470 [https://redmine.postgresql.org/issues/2470] - Fix an intermittent error seen during result polling

Issue #2476 [https://redmine.postgresql.org/issues/2476] - Improvements to the Query Results grid including improvements to the UI and allow copy/paste from sets of rows, columns or arbitrary blocks of cells

Issue #2477 [https://redmine.postgresql.org/issues/2477] - Ensure text editors render in an appropriate place on the results grid

Issue #2479 [https://redmine.postgresql.org/issues/2479] - No need for the menu icon to link to the homepage, as pgAdmin is a SPA

Issue #2482 [https://redmine.postgresql.org/issues/2482] - Use a more sensible name for Query Tool tabs

Issue #2486 [https://redmine.postgresql.org/issues/2486] - Ensure the feature tests use the correct test settings database

Issue #2487 [https://redmine.postgresql.org/issues/2487] - Maintain a client-side cache of preference values, populated using an async call

Issue #2489 [https://redmine.postgresql.org/issues/2489] - Fix clipboard handling with large datasets

Issue #2492 [https://redmine.postgresql.org/issues/2492] - Ensure the initial password is properly hashed during setup in web mode

Issue #2498 [https://redmine.postgresql.org/issues/2498] - Properly handle bytea[], and ‘infinity’::real/real[]

Issue #2502 [https://redmine.postgresql.org/issues/2502] - Properly handle bytea[], and ‘infinity’::real/real[]

Issue #2503 [https://redmine.postgresql.org/issues/2503] - Handle missing/dropped synonyms gracefully

Issue #2504 [https://redmine.postgresql.org/issues/2504] - Update MatView and pgAgent modules to work with recent integer/numeric changes

Issue #2507 [https://redmine.postgresql.org/issues/2507] - Ensure revoked public privileges are displayed in the RE-SQL for functions

Issue #2518 [https://redmine.postgresql.org/issues/2518] - Fix encoding issue when saving servers

Issue #2522 [https://redmine.postgresql.org/issues/2522] - Improve speed of Select All in the results grid

Issue #2527 [https://redmine.postgresql.org/issues/2527] - Fix deletion of table rows with the column definition having NOT NULL TRUE and HAS NO DEFAULT VALUE

Issue #2528 [https://redmine.postgresql.org/issues/2528] - Allow breakpoints to be set on triggers on views

Issue #2529 [https://redmine.postgresql.org/issues/2529] - Resolve a number of issues with domains and domain constraints

Issue #2532 [https://redmine.postgresql.org/issues/2532] - Refresh nodes correctly when there is a single child that is updated

Issue #2534 [https://redmine.postgresql.org/issues/2534] - Fix handling of CREATE TABLE OF <type>

Issue #2535 [https://redmine.postgresql.org/issues/2535] - Fix clear history functionality

Issue #2540 [https://redmine.postgresql.org/issues/2540] - Ensure the save password option is enabled when creating a server

Version 1.5

Release date: 2017-05-19

This release contains a number of features and fixes reported since the release of pgAdmin4 1.4.

Features

Issue #2216 [https://redmine.postgresql.org/issues/2216] - Allow column or row selection in the Query Tool

Bug fixes

Issue #2225 [https://redmine.postgresql.org/issues/2225] - Hide menu options for creating objects, if the object type is set to hidden. Includes Jasmine tests

Issue #2253 [https://redmine.postgresql.org/issues/2253] - Fix various issues in CSV file download feature

Issue #2257 [https://redmine.postgresql.org/issues/2257] - Improve handling of nulls and default values in the data editor

Issue #2271 [https://redmine.postgresql.org/issues/2271] - Don’t change the trigger icon back to “enabled” when the trigger is updated when it’s disabled

Issue #2284 [https://redmine.postgresql.org/issues/2284] - Allow creation of tables with pure numeric names

Issue #2292 [https://redmine.postgresql.org/issues/2292] - Only reconnect to databases that were previously connected

Issue #2314 [https://redmine.postgresql.org/issues/2314] - Fix various issues in CSV file download feature

Issue #2315 [https://redmine.postgresql.org/issues/2315] - Fix sorting of sizes on the statistics views by sorting raw values and prettifying on the client side. Includes Jasmine tests for the prettyfying function

Issue #2318 [https://redmine.postgresql.org/issues/2318] - Order foreign table columns correctly

Issue #2331 [https://redmine.postgresql.org/issues/2331] - Fix binary search algorithm so new treeview nodes are added in the correct position

Issue #2336 [https://redmine.postgresql.org/issues/2336] - Update inode info when refreshing treeview nodes.

Issue #2339 [https://redmine.postgresql.org/issues/2339] - Ensure the treeview can be scrolled horizontally

Issue #2350 [https://redmine.postgresql.org/issues/2350] - Fix handling of default parameters ordering in functions

Issue #2354 [https://redmine.postgresql.org/issues/2354] - Fix the Backup module where it was not working if user changes its preference language other than English

Issue #2356 [https://redmine.postgresql.org/issues/2356] - Ensure errors thrown when deleting rows in the Query Tool in edit mode are shown properly

Issue #2360 [https://redmine.postgresql.org/issues/2360] - Fix various issues in CSV file download feature

Issue #2369 [https://redmine.postgresql.org/issues/2369] - Support loading files with Unicode BOMs

Issue #2377 [https://redmine.postgresql.org/issues/2377] - Update psycopg2 version for PostgreSQL 10 compatibility

Issue #2379 [https://redmine.postgresql.org/issues/2379] - Make various improvements to the NULL/DEFAULT handling in the data editor

Issue #2405 [https://redmine.postgresql.org/issues/2405] - Ensure object names are properly escaped for external process management

Issue #2410 [https://redmine.postgresql.org/issues/2410] - Fix PostgreSQL 10.0 compatibility issues

Version 1.4

Release date: 2017-04-13

This release contains a number of features and fixes reported since the release of pgAdmin4 1.3.

Features

Issue #2232 [https://redmine.postgresql.org/issues/2232] - Add the ability to gray-out/disable the “Save Password” option when creating a connection to a server

Issue #2261 [https://redmine.postgresql.org/issues/2261] - Display table DDL for Greenplum in SQL tab

Issue #2320 [https://redmine.postgresql.org/issues/2163] - Added German translation

Bug fixes

Issue #2077 [https://redmine.postgresql.org/issues/2077] - Add missing “Run Now” option for pgAdmin jobs

Issue #2105 [https://redmine.postgresql.org/issues/2105] - Fix validation on the table dialogue so the Save button isn’t enabled if the name is removed and autovac custom settings are enabled

Issue #2145 [https://redmine.postgresql.org/issues/2145] - Resolve the issue for restoring the table from the backup

Issue #2187 [https://redmine.postgresql.org/issues/2187] - Ensure the web/ directory is cleared before upgrading Windows installations

Issue #2190 [https://redmine.postgresql.org/issues/2190] - Allow users to select UI language at login or from Preferences rather than unpredictable behaviour from browsers

Issue #2226 [https://redmine.postgresql.org/issues/2226] - Show tooltips for disabled buttons to help user learning

Issue #2241 [https://redmine.postgresql.org/issues/2241] - Fix numeric control validation in nested schemas

Issue #2243 [https://redmine.postgresql.org/issues/2243] - Fix dropping of databases with Unicode names

Issue #2244 [https://redmine.postgresql.org/issues/2244] - Prevent an error being displayed if the user views data on a table with no columns

Issue #2246 [https://redmine.postgresql.org/issues/2246] - Add missing braces to reverse engineered SQL header block for Functions

Issue #2258 [https://redmine.postgresql.org/issues/2258] - Fix handling of DATERANGE[] type

Issue #2264 [https://redmine.postgresql.org/issues/2264] - Resolve error message ExtDeprecationWarning displayed on new pgAdmin4 setup for Python 3.4 on ubuntu 14.04 Linux 64

Issue #2265 [https://redmine.postgresql.org/issues/2265] - Resolved import/Export issue for a table

Issue #2274 [https://redmine.postgresql.org/issues/2274] - Properly handle truncated table names

Issue #2277 [https://redmine.postgresql.org/issues/2277] - Resolved various file-system encoding/decoding related cases

Issue #2281 [https://redmine.postgresql.org/issues/2281] - Ensure menus are updated after disconnecting a server

Issue #2283 [https://redmine.postgresql.org/issues/2283] - Check if cell is in multiselect mode before setting default selection of multiple values

Issue #2287 [https://redmine.postgresql.org/issues/2287] - Properly handle EXPLAIN queries entered directly by the user in the Query Tool

Issue #2291 [https://redmine.postgresql.org/issues/2291] - Fix error highlighting in the Query Tool

Issue #2299 [https://redmine.postgresql.org/issues/2299] - Fix usage of QString

Issue #2303 [https://redmine.postgresql.org/issues/2303] - Fix ascending/descending sort order in backgrid while clicking on the headers

Issue #2304 [https://redmine.postgresql.org/issues/2304] - Resolve the issue for restoring the table from the backup

Issue #2305 [https://redmine.postgresql.org/issues/2305] - Resolve the issue where Generic function qtLiteral was not adapting values properly when they contain non ascii characters

Issue #2310 [https://redmine.postgresql.org/issues/2310] - Fix Dialog Help where Query Tool/Debugger opens in new browser tab

Issue #2319 [https://redmine.postgresql.org/issues/2319] - Resolve issue where Click on pgAdmin4 logo leads to unauthorized error

Issue #2321 [https://redmine.postgresql.org/issues/2321] - Improved functionality of browser tree when adding new nodes if parent collection node has not loaded

Issue #2330 [https://redmine.postgresql.org/issues/2330] - Ensure the Query Tool displays but does not render HTML returned by the server in the results grid

Version 1.3

Release date: 2017-03-10

This release contains a number of features and fixes reported since the release of pgAdmin4 1.2.

Features

Issue #2036 [https://redmine.postgresql.org/issues/2036] - Query tool efficiency - SlickGrid result set format efficiency

Issue #2038 [https://redmine.postgresql.org/issues/2038] - Query tool efficiency - Incremental back off when polling

Issue #2163 [https://redmine.postgresql.org/issues/2163] - Make syntax highlighting more visible

Issue #2210 [https://redmine.postgresql.org/issues/2210] - Build a universal Python wheel instead of per-python-version ones

Issue #2215 [https://redmine.postgresql.org/issues/2215] - Improve visibility of syntax highlighting colours

Bug fixes

Issue #1796 [https://redmine.postgresql.org/issues/1796] - Add missing “Run Now” option for pgAdmin jobs

Issue #1797 [https://redmine.postgresql.org/issues/1797] - Resolve encoding issues with DATA_DIR

Issue #1914 [https://redmine.postgresql.org/issues/1914] - Resolved error utf8’ codec can’t decode byte

Issue #1983 [https://redmine.postgresql.org/issues/1983] - Fix bug in Sql query contains Arabic Charaters

Issue #2089 [https://redmine.postgresql.org/issues/2089] - Add PARALLEL SAFE|UNSAFE|RESTRICTED support

Issue #2115 [https://redmine.postgresql.org/issues/2115] - Fix exclusion constraint reverse engineered SQL

Issue #2119 [https://redmine.postgresql.org/issues/2119] - Fix display of long integers and decimals

Issue #2126 [https://redmine.postgresql.org/issues/2126] - Correct node labels in Preferences for EDB functions and procedures

Issue #2151 [https://redmine.postgresql.org/issues/2151] - Display un-sized varlen column types correctly in the Query Tool

Issue #2154 [https://redmine.postgresql.org/issues/2154] - Fix display of long integers and decimals

Issue #2159 [https://redmine.postgresql.org/issues/2159] - Resolve issue where Query editor is not working with Python2.6

Issue #2160 [https://redmine.postgresql.org/issues/2160] - Various encoding fixes to allow ‘ascii’ codec to decode byte 0xc3 in position 66: ordinal not in range(128)

Issue #2166 [https://redmine.postgresql.org/issues/2166] - Resolved import/Export issue for a table

Issue #2173 [https://redmine.postgresql.org/issues/2173] - Resolved issues where Sequences API test cases are not working in PG9.2 and PPAS9.2

Issue #2174 [https://redmine.postgresql.org/issues/2174] - Resolved various file-system encoding/decoding related cases

Issue #2185 [https://redmine.postgresql.org/issues/2185] - Removed sorting columns on the treeview

Issue #2192 [https://redmine.postgresql.org/issues/2192] - Fix startup complete tests to ensure we properly poll the server for completed startup

Issue #2198 [https://redmine.postgresql.org/issues/2198] - Fix function arguments when generating create SQL

Issue #2200 [https://redmine.postgresql.org/issues/2200] - Properly handle event trigger functions in different schemas

Issue #2201 [https://redmine.postgresql.org/issues/2201] - Fix renaming of check constraints when the table name is changed at the same time

Issue #2202 [https://redmine.postgresql.org/issues/2202] - Fix issue where Dependents query fails due to non ascii characters

Issue #2204 [https://redmine.postgresql.org/issues/2204] - Fixed issue where pgadmin 4 jobs not showing any activity

Issue #2205 [https://redmine.postgresql.org/issues/2205] - Fix display of boolean nulls in the Query Tool

Issue #2208 [https://redmine.postgresql.org/issues/2208] - Ensure primary key column names are quoted in View Data mode of the Query Tool

Issue #2212 [https://redmine.postgresql.org/issues/2212] - Ensure servers are deleted when their parent group is deleted

Issue #2213 [https://redmine.postgresql.org/issues/2213] - Enable right click on browser tree

Issue #2218 [https://redmine.postgresql.org/issues/2218] - Show the correct indeterminate state when editing new boolean values

Issue #2228 [https://redmine.postgresql.org/issues/2228] - Authenticate the runtime to the server

Issue #2230 [https://redmine.postgresql.org/issues/2230] - Prevent the Slonik logo obscuring the login dialogue on small displays in server mode

Version 1.2

Release date: 2017-02-10

This release contains a number of features and fixes reported since the release of pgAdmin4 1.1.

Features

Issue #1375 [https://redmine.postgresql.org/issues/1375] - Migrate the runtime to QtWebEngine from QtWebKit

Issue #1765 [https://redmine.postgresql.org/issues/1765] - Find and replace functionality with regexp and group replacement

Issue #1789 [https://redmine.postgresql.org/issues/1789] - Column width of data output panel should fit to data (as pgAdmin III)

Issue #1790 [https://redmine.postgresql.org/issues/1790] - [Web] Support setting a field’s value to “null”

Issue #1848 [https://redmine.postgresql.org/issues/1848] - macOS appbundle is missing postgresql binaries for import etc.

Issue #1910 [https://redmine.postgresql.org/issues/1910] - Remember last used directory in the file manager

Issue #1911 [https://redmine.postgresql.org/issues/1911] - Direct path navigation in the file manager

Issue #1922 [https://redmine.postgresql.org/issues/1922] - Improve handling of corrupt configuration databases

Issue #1963 [https://redmine.postgresql.org/issues/1963] - Add a Chinese (Simplified) translation

Issue #1964 [https://redmine.postgresql.org/issues/1964] - Create a docs tarball along with the source tarball

Issue #2025 [https://redmine.postgresql.org/issues/2025] - Allow the SQL Editors to word-wrap

Issue #2124 [https://redmine.postgresql.org/issues/2124] - Create a template loader to simplify SQL template location, and remove duplicate templates

Bug fixes

Issue #1227 [https://redmine.postgresql.org/issues/1227] - Display improved error message for Debugger listener starting error and reset between executions

Issue #1267 [https://redmine.postgresql.org/issues/1267] - Fix issue where MINIFY_HTML doesn’t work with the docs

Issue #1364 [https://redmine.postgresql.org/issues/1364] - Ensure dialogue control buttons are consistent

Issue #1394 [https://redmine.postgresql.org/issues/1394] - Fix Table dialogue column specification issues

Issue #1432 [https://redmine.postgresql.org/issues/1432] - Enhanced OSX File Browser

Issue #1585 [https://redmine.postgresql.org/issues/1585] - Cannot save scripts to the network

Issue #1599 [https://redmine.postgresql.org/issues/1599] - Ensure the grant wizard works with objects with special characters in the name

Issue #1603 [https://redmine.postgresql.org/issues/1603] - Fix quoting of objects names for external utilities.

Issue #1679 [https://redmine.postgresql.org/issues/1679] - Re-engineer the background process executor to avoid using sqlite as some builds of components it relies on do not support working in forked children

Issue #1680 [https://redmine.postgresql.org/issues/1680] - Render column headers at the correct width in the Query Tool under Firefox

Issue #1729 [https://redmine.postgresql.org/issues/1729] - Improve display of role options

Issue #1730 [https://redmine.postgresql.org/issues/1730] - Improve the display of role membership on both the properties panel and role dialogue

Issue #1745 [https://redmine.postgresql.org/issues/1745] - Ensure breakpoints are cleared properly when working with Debugger

Issue #1747 [https://redmine.postgresql.org/issues/1747] - Add newly created triggers to the treeview

Issue #1780 [https://redmine.postgresql.org/issues/1780] - Properly size the SQL Editor gutter as the width of the line numbers increases

Issue #1792 [https://redmine.postgresql.org/issues/1792] - List files and folders alphabetically

Issue #1800 [https://redmine.postgresql.org/issues/1800] - Handle the template property on databases appropriately

Issue #1801 [https://redmine.postgresql.org/issues/1801] - Handle databases with datallowconn == false

Issue #1807 [https://redmine.postgresql.org/issues/1807] - Properly detect when files have changed in the Query Tool and set flag accordingly

Issue #1830 [https://redmine.postgresql.org/issues/1830] - Fix a SQL error when reverse-engineering ROLE SQL on EPAS servers

Issue #1832 [https://redmine.postgresql.org/issues/1832] - Prevent attempts to access what may be an empty list in Dependancies tab

Issue #1840 [https://redmine.postgresql.org/issues/1840] - Enable/disable NULLs and ASC/DESC options for index columns and exclusion constraints appropriately

Issue #1842 [https://redmine.postgresql.org/issues/1842] - Show index columns in the correct order in RE-SQL

Issue #1855 [https://redmine.postgresql.org/issues/1855] - Ensure dialogue panels show their errors themselves, and not in the properties panel when creating Trigger Function

Issue #1865 [https://redmine.postgresql.org/issues/1865] - Properly schema qualify domains when reverse engineering SQL

Issue #1874 [https://redmine.postgresql.org/issues/1874] - Add file resources to the windows runtime

Issue #1893 [https://redmine.postgresql.org/issues/1893] - Fix refreshing of Unique constraints

Issue #1896 [https://redmine.postgresql.org/issues/1896] - Use the correct OID for retrieving properties of freshly created exclusion constraints

Issue #1899 [https://redmine.postgresql.org/issues/1899] - Properly quote role names when specifying function ownership

Issue #1909 [https://redmine.postgresql.org/issues/1909] - Handle startup errors more gracefully in the runtime

Issue #1912 [https://redmine.postgresql.org/issues/1912] - Properly format arguments passed by triggers to functions

Issue #1919 [https://redmine.postgresql.org/issues/1919] - Ensure all changes to rows are stored in the data editor

Issue #1924 [https://redmine.postgresql.org/issues/1924] - Ensure the check_option is only set when editing views when appropriate

Issue #1936 [https://redmine.postgresql.org/issues/1936] - Don’t strip rn from “Download as CSV” batches of rows, as it leads to malformed data

Issue #1937 [https://redmine.postgresql.org/issues/1937] - Generate mSQL for new schemas correctly

Issue #1938 [https://redmine.postgresql.org/issues/1938] - Fix sorting of numerics in the statistics grids

Issue #1939 [https://redmine.postgresql.org/issues/1939] - Updated dynamic default for the window size (90% x 90%)

Issue #1949 [https://redmine.postgresql.org/issues/1949] - Ensure trigger function names are schema qualified in trigger RE-SQL

Issue #1951 [https://redmine.postgresql.org/issues/1951] - Fix issue where nnable to browse table columns when oid values exceeed max int

Issue #1953 [https://redmine.postgresql.org/issues/1953] - Add display messages and notices received in the Query Tool

Issue #1961 [https://redmine.postgresql.org/issues/1961] - Fix upgrade check on Python 3

Issue #1962 [https://redmine.postgresql.org/issues/1962] - Ensure treeview collection nodes are translated in the UI

Issue #1967 [https://redmine.postgresql.org/issues/1967] - Store layout changes on each adjustment

Issue #1976 [https://redmine.postgresql.org/issues/1976] - Prevent users selecting elements of the UI that shouldn’t be selectable

Issue #1979 [https://redmine.postgresql.org/issues/1979] - Deal with Function arguments correctly in the properties dialogue

Issue #1986 [https://redmine.postgresql.org/issues/1986] - Fix various encoding issues with multibyte paths and filenames resulting in empty file save

Issue #1992 [https://redmine.postgresql.org/issues/1992] - Quote identifiers correctly in auto-complete

Issue #1994 [https://redmine.postgresql.org/issues/1994] - Update to show modifications in edit grid

Issue #2000 [https://redmine.postgresql.org/issues/2000] - Allow setting of effective_io_concurrency on tablespaces in 9.6+

Issue #2005 [https://redmine.postgresql.org/issues/2005] - Fix various mis-spellings of VACUUM

Issue #2006 [https://redmine.postgresql.org/issues/2006] - Fix error when modifying table name or set schema on tables with postgis geometry column

Issue #2007 [https://redmine.postgresql.org/issues/2007] - Correctly sort rows by the pkey when viewing first/last 100

Issue #2009 [https://redmine.postgresql.org/issues/2009] - Reset the column list properly if the access method is changed on an index to ensure error handling works correctly

Issue #2012 [https://redmine.postgresql.org/issues/2012] - Prevent attempts to create server groups with no name

Issue #2015 [https://redmine.postgresql.org/issues/2015] - Enable trigger option when user tries to change Row trigger value through properties section

Issue #2024 [https://redmine.postgresql.org/issues/2024] - Properly handle setting comments and other options on databases with allowconn = False

Issue #2026 [https://redmine.postgresql.org/issues/2026] - Improve detection of the pldbgapi extension and functions before allowing debugging

Issue #2027 [https://redmine.postgresql.org/issues/2027] - Fix inconsistent table styling

Issue #2028 [https://redmine.postgresql.org/issues/2028] - Fix display of double scrollbars on the grant wizard

Issue #2032 [https://redmine.postgresql.org/issues/2032] - Fix time formatting on dashboards

Issue #2033 [https://redmine.postgresql.org/issues/2033] - Show icons for unique and exclusion constraints in the dependency/dependents panels

Issue #2045 [https://redmine.postgresql.org/issues/2045] - Update copyright year on doc page

Issue #2046 [https://redmine.postgresql.org/issues/2046] - Fix error when setting up regression on Windows for pgadmin4

Issue #2047 [https://redmine.postgresql.org/issues/2047] - Ensure dialogues cannot be moved under the navbar

Issue #2061 [https://redmine.postgresql.org/issues/2061] - Enable/disable NULLs and ASC/DESC options for index columns and exclusion constraints appropriately

Issue #2065 [https://redmine.postgresql.org/issues/2065] - Improve display of columns of exclusion contraints and foreign keys in the properties lists

Issue #2069 [https://redmine.postgresql.org/issues/2069] - Correct tablespace displayed in table properties

Issue #2076 [https://redmine.postgresql.org/issues/2076] - Handle sized time/timestamp columns correctly

Issue #2109 [https://redmine.postgresql.org/issues/2109] - Update copyright year

Issue #2110 [https://redmine.postgresql.org/issues/2110] - Handle saved directories that no longer exist gracefully

Issue #2112 [https://redmine.postgresql.org/issues/2026] - Enable comments on Initial database through right Click

Issue #2133 [https://redmine.postgresql.org/issues/2133] - Fix display of graphical query plans for UPDATE/DELETE queries

Issue #2138 [https://redmine.postgresql.org/issues/2138] - Fix display of zeros in read-only grid editors

Issue #2139 [https://redmine.postgresql.org/issues/2139] - Fixed issue causing Message (Connection to the server has been lost.) displayed with Materialized view and view under sql tab

Issue #2152 [https://redmine.postgresql.org/issues/2152] - Fix handling of “char” columns

Issue #2156 [https://redmine.postgresql.org/issues/2156] - Added compatibility fixes for newer versions of Jinja2 (e.g. 2.9.5+)

Version 1.1

Release date: 2016-10-27

This release contains a number of features and fixes reported since the release of pgAdmin4 1.0;

Features

Issue #1328 [https://redmine.postgresql.org/issues/1328] - Add Python 3.5 Support

Issue #1859 [https://redmine.postgresql.org/issues/1859] - Include wait information on the activity tab of the dashboards

Bug fixes

Issue #1155 [https://redmine.postgresql.org/issues/1155] - Display the start value when the user creates sequence

Issue #1531 [https://redmine.postgresql.org/issues/1531] - Fix to update privileges for Views and Materials Views where “string indices must be integers error” displayed

Issue #1574 [https://redmine.postgresql.org/issues/1574] - Display SQL in SQL pane for security label in PG and EPAS server

Issue #1576 [https://redmine.postgresql.org/issues/1576] - Make security label option available in procedure properties

Issue #1577 [https://redmine.postgresql.org/issues/1577] - Make debug option available for package function and procedure

Issue #1596 [https://redmine.postgresql.org/issues/1596] - Correct spelling error from evnt_turncate to evnt_truncate

Issue #1599 [https://redmine.postgresql.org/issues/1599] - Ensure the grant wizard works with objects with special characters in the name

Issue #1622 [https://redmine.postgresql.org/issues/1622] - Fix issue using special characters when creating synonym

Issue #1728 [https://redmine.postgresql.org/issues/1728] - Properties refreshing after objects are edited

Issue #1739 [https://redmine.postgresql.org/issues/1739] - Prevent the user from trying to…..

Issue #1785 [https://redmine.postgresql.org/issues/1785] - Correctly identify server type upon first connection

Issue #1786 [https://redmine.postgresql.org/issues/1786] - Ensure errorModel unset property is set correctly when adding a new server

Issue #1808 [https://redmine.postgresql.org/issues/1808] - Set seconds to valid value in pgAgent job schedule

Issue #1817 [https://redmine.postgresql.org/issues/1817] - Display message “server does not support ssl” if server with ca-cert or ca-full added

Issue #1821 [https://redmine.postgresql.org/issues/1821] - Optionally sign both the Mac app bundle and the disk image

Issue #1822 [https://redmine.postgresql.org/issues/1822] - Handle non-ascii responses from the server when connecting

Issue #1823 [https://redmine.postgresql.org/issues/1823] - Attempt to sign the Windows installer, failing with a warning if there’s no cert available

Issue #1824 [https://redmine.postgresql.org/issues/1824] - Add documenation for pgAgent

Issue #1835 [https://redmine.postgresql.org/issues/1835] - Allow users to choose SELECT permissions for tables and sequences in the grant wizard

Issue #1837 [https://redmine.postgresql.org/issues/1837] - Fix refreshing of FTS dictionaries which was causing error “Connection to the server has been lost”

Issue #1838 [https://redmine.postgresql.org/issues/1838] - Don’t append new objects with the wrong parent in tree browser if the correct one isn’t loaded

Issue #1843 [https://redmine.postgresql.org/issues/1843] - Function definition matches value returned from pg_get_functiondef()

Issue #1845 [https://redmine.postgresql.org/issues/1845] - Allow refreshing synonym node. Does not display message “Unimplemented method (node) for this url (/browser/synonym/nodes/1/7/14301/2200/test)”

Issue #1847 [https://redmine.postgresql.org/issues/1847] - Identify the collation correctly when reverse engineering table SQL. ERROR: schema “default” does not exist no longer displayed

Issue #1849 [https://redmine.postgresql.org/issues/1849] - Remove security keys from config.py/config_local.py

Issue #1857 [https://redmine.postgresql.org/issues/1857] - Fix error while renaming FTS dictionary and FTS template nodes

Issue #1858 [https://redmine.postgresql.org/issues/1858] - Ensure the File Manager honours the file type while traversing the directories.

Issue #1861 [https://redmine.postgresql.org/issues/1861] - Properly generate exclusion constraint SQL.

Issue #1863 [https://redmine.postgresql.org/issues/1863] - Correctly quote type names in reverse engineered SQL for tables

Issue #1864 [https://redmine.postgresql.org/issues/1864] - Fix layout of DateTimePicker control help message.

Issue #1867 [https://redmine.postgresql.org/issues/1867] - Allow package bodies to be dropped.

Issue #1868 [https://redmine.postgresql.org/issues/1868] - Resolved issue where Integer type of preferences are not updated

Issue #1872 [https://redmine.postgresql.org/issues/1872] - Fix the file manager when used under Python 3.

Issue #1877 [https://redmine.postgresql.org/issues/1877] - Ensure preferences values are stored properly.

Issue #1878 [https://redmine.postgresql.org/issues/1878] - Ensure steps and schedules can be created in empty jobs. ProgrammingError: can’t adapt type ‘Undefined’ was displayed

Issue #1880 [https://redmine.postgresql.org/issues/1880] - Add new indexes to the correct parent on the treeview.

Version 1.0

Release date: 2016-09-29

The first major release of pgAdmin 4. With a more modern look and feel, this release includes the following features;

Multiplatform

Designed for multiple PostgreSQL versions and derivatives

Extensive documentation

Multiple deployment models

Tools

Routine maintenance

Create, view and edit all common PostgreSQL objects

Multibyte support

Licence

pgAdmin is released under the PostgreSQL Licence [https://www.postgresql.org/about/licence], which is a liberal Open Source licence similar to BSD or MIT, and approved by the Open Source Initiative. The copyright for the project source code, website and documentation is attributed to the pgAdmin Development Team [https://www.pgadmin.org/development/team/]

pgAdmin 4

Copyright (C) 2013 - 2024, The pgAdmin Development Team

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

IN NO EVENT SHALL THE PGADMIN DEVELOPMENT TEAM BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE PGADMIN DEVELOPMENT TEAM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE PGADMIN DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN “AS IS” BASIS, AND THE PGADMIN DEVELOPMENT TEAM HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Index

A | B | C | D | E | F | G | I | K | L | M | P | Q | R | S | T | U | V

A

Add Named Restore Point Dialog

Amazon RDS Cloud Deployment

Azure Database Cloud Deployment

B

Backup and Restore

Backup Dialog

Backup Globals Dialog

Backup Server Dialog

C

Cast Dialog

Change Ownership Dialog

Change Password Dialog

Change User Password Dialog

Check Dialog

Clear Saved Passwords

Code Overview

Code Review Notes

Coding Standards

Collation Dialog

Column Dialog

Compound Trigger Dialog

Connect to Server

Connecting To A Server

Connection Error

Container Deployment

Creating a pgAgent Job

Creating or Modifying a Table

D

Database Dialog

DBMS Job

DBMS Program

DBMS Schedule

Debugger

Deployment

Desktop Deployment

Developer Tools

Domain Constraints Dialog

Domain Dialog

E

EDB BigAnimal Cloud Deployment

Enabling Kerberos Authentication

Enabling LDAP Authentication

Enabling OAUTH2 Authentication

Enabling two-factor authentication (2FA)

Enabling Webserver Authentication

ERD Tool

Event Trigger Dialog

Exclusion Constraint Dialog

Extension Dialog

External database for pgAdmin user settings

F

Foreign Data Wrapper Dialog

Foreign key Dialog

Foreign Server Dialog

Foreign Table Dialog

FTS Configuration Dialog

FTS Dictionary Dialog

FTS Parser Dialog

FTS Template Dialog

Function Dialog

G

Getting Started

Google Cloud SQL Deployment

Grant Wizard

I

Import/Export Data Dialog

Import/Export Servers

Index Dialog

Installing pgAgent

K

Keyboard Shortcuts

L

Language Dialog

Licence

Lock/Restore Account

Login Page

Login/Group Role Dialog

M

Maintenance Dialog

Management Basics

Managing Cluster Objects

Managing Database Objects

Master Password

Materialized View Dialog

Menu Bar

P

Package Dialog

pgAdmin Project Contributions

pgAgent

PGD Replication Group Node Dialog

PGD Replication Server Node Dialog

PostgreSQL Cloud Deployment

Preferences Dialog

Primary key Dialog

Procedure Dialog

Processes

PSQL Tool

Publication Dialog

Q

Query Tool

Query Tool Toolbar

R

Replica Node Dialog

Resource Group Dialog

Restore Dialog

RLS Policy Dialog

Role Reassign/Drop Own Dialog

Rule Dialog

S

Schema Dialog

Schema Diff

Search objects

Sequence Dialog

Server Deployment

Server Dialog

Server Group Dialog

Storage Manager

Submitting Pull Requests

Subscription Dialog

Synonym Dialog

T

Tabbed Browser

Table Dialog

Tablespace Dialog

The config.py File

Toolbar

Translations

Tree Control

Trigger Dialog

Trigger Function Dialog

Type Dialog

U

Unique Constraint Dialog

User Interface

User Management Dialog

User Mapping Dialog

Using EDB Job Scheduler

Using pgAgent

V

View Dialog

View/Edit Data

View/Edit Data Filter