ADB service actions

Anton Vasilev

This article describes the actions available for the ADB service in the ADCM web interface.

Create database

Creates the default database. The default name is adb.

This database is required to install most of the ADB extensions. If you installed the cluster using the Install cluster action, the database is created automatically, and the manual action is not required. If you install services one by one, the database is not created automatically, and you should manually run the Create database action.

After the action completes successfully, you can check that the database exists:

  1. On the ADB master host, log in as the gpadmin user:

    $ sudo su - gpadmin

  2. List all databases:

    $ psql -l

    The output should contain the adb database:

                                   List of databases
   Name    |  Owner  | Encoding |  Collate   |   Ctype    |  Access privileges
-----------+---------+----------+------------+------------+---------------------
 adb       | gpadmin | UTF8     | en_US.utf8 | en_US.utf8 | =Tc/gpadmin        +
           |         |          |            |            | gpadmin=CTc/gpadmin
 postgres  | gpadmin | UTF8     | en_US.utf8 | en_US.utf8 |
 template0 | gpadmin | UTF8     | en_US.utf8 | en_US.utf8 | =c/gpadmin         +
           |         |          |            |            | gpadmin=CTc/gpadmin
 template1 | gpadmin | UTF8     | en_US.utf8 | en_US.utf8 | =c/gpadmin         +
           |         |          |            |            | gpadmin=CTc/gpadmin
(5 rows)

Create role

Adds a new role to the database cluster.

The Create role window
The Create role window

On the Configuration tab of the window that opens, configure the following parameters.

Parameter Description Default value

Role name

A unique name for the new role

 — 

Role password

The password of the role. Can’t be left empty

 — 

Allow this role to login

Determines whether a role is allowed to log in. When set to true, the role can be thought of as a user

true

Make role superuser

Determines whether a role is a superuser

false

Allow role to create databases

Determines whether the role can create new databases

false

Allow role to create users/roles

Determines whether the role can create new roles

false

Allow role create external tables

Determines whether the role can create external tables

false

Resource Group

The name of one of the existing resource groups to which a new role should be assigned. The value cannot be empty since each user should belong to a resource group

default_group

Enable auto core dump

Installs the Auto Core Dump service (systemd-coredump) on the master, standby master, and every segment host. The action uses the following values of the service configuration options:

  • Storage=external — core dumps will be stored in /var/lib/systemd/coredump/.

  • MaxUse=1024M — remove old core dumps when their size exceeds 1 GB.

To check that the service was successfully installed and started, run the following command on the master, standby master, or any segment host:

$ systemctl status systemd-coredump.socket

The service should have the active (listening) status:

systemd-coredump.socket - Process Core Dump Socket
     Loaded: loaded (/lib/systemd/system/systemd-coredump.socket; static)
     Active: active (listening) since Thu 2025-09-04 10:24:43 UTC; 21min ago
       Docs: man:systemd-coredump(8)
     Listen: /run/systemd/coredump (SequentialPacket)
   Accepted: 0; Connected: 0;
     CGroup: /system.slice/systemd-coredump.socket

Disable auto core dump

Removes the Auto Core Dump service (systemd-coredump) and its configuration files.

Enable mirroring

Enables synchronous replication for primary data segments by adding mirrors to the cluster.

On the Configuration tab of the window that opens, in the Type of mirroring list, select the mirroring type: spread or group.

Spread mirroring is used by default. If you select spread mirroring, the action verifies that the number of segment hosts in your cluster is greater than the number of segments configured per host and that the number of segments per host can be divided by the number of the data directories on the host without remainder. If these conditions are not met, the action will fail.

The Enable mirroring window
The Enable mirroring window

Install diskquota

Installs the Diskquota ADB extension. This extension allows users to limit the disk space used by schemas and roles.

The action creates the diskquota database and the diskquota schema and registers diskquota as a database extension.

You can check the diskquota extension by running:

SELECT * FROM pg_extension WHERE extname = 'diskquota';

The output should be similar to:

  extname  | extowner | extnamespace | extrelocatable | extversion |   extconfig   | extcondition
-----------+----------+--------------+----------------+------------+---------------+--------------
 diskquota |       10 |         2200 | t              | 2.3        | {48320,48328} | {"",""}
(1 row)

After diskquota is installed, the Uninstall diskquota and Reinstall diskquota actions become available.

Install MADlib

Installs the MADlib library.

The action creates the madlib schema that stores MADlib functions.

Check the installed version by running:

SELECT madlib.version();

The output should be similar to:

          version
---------------------------------------------------------------------------------------------------------
 MADlib version: 1.21.0, git revision: 6.27.1_arenadata64-66-gbf5684f4, cmake configuration time: Tue Aug
 19 23:01:09 UTC 2025, build type: RelWithDebInfo, build system: Linux-4.15.0-175-generic, C compiler: gc
c 11, C++ compiler: g++ 11
(1 row)

After MADlib is installed, the Uninstall MADlib and Reinstall MADlib actions become available.

Install PostGIS

Installs the PostGIS extension.

To check the version of installed PostGIS, run the following command in your database:

SELECT PostGIS_Lib_Version();

The output should be similar to the following:

 postgis_lib_version
---------------------
 2.5.4
(1 row)

After PostGIS is installed, the Uninstall PostGIS and Reinstall PostGIS actions become available.

Install Plpython3

Installs the plpython3u extension to enable the use of the PL/Python procedural language.

You can check the plpython3u extension in PostgreSQL by running:

SELECT * FROM pg_extension WHERE extname = 'plpython3u';

The output should be similar to:

  extname   | extowner | extnamespace | extrelocatable | extversion | extconfig | extcondition
------------+----------+--------------+----------------+------------+-----------+--------------
 plpython3u |       10 |           11 | f              | 1.0        |           |
(1 row)

After Plpython3 is installed, the Uninstall Plpython3 and Reinstall Plpython3 actions become available.

Reconfigure & Restart

Updates the service configuration according to the configuration settings.

The action restarts the cluster (using gpstop -arM fast) if any of the following configuration parameters are changed:

  • ADB GPperfmon Extension

  • Interconnect properties → Interconnect type

  • Any option under SSL

Otherwise, the action reloads the configuration (using gpstop -au).

On the Configuration tab of the window that opens, the Migrate db_files_history table now flag indicates whether to migrate the arenadata_toolkit.db_files_history table during the upgrade process. If this flag is set, the table will be recreated with loading partitions/compression options and all data into the new table.

Reinstall ADB

Reinstalls the ADB service.

On the Configuration tab of the window that opens, configure the following parameters:

  • Reboot cluster servers after installation — a flag that indicates whether to reboot ADB hosts automatically after the Reinstall ADB action is completed. The default value is true. If set to false, you need to restart hosts manually.

  • Reboot timeout, sec — a timeout that is used to wait for the reboot of ADB hosts (in seconds). The default value is 1800. The value must be at least 600.

The Reinstall ADB window
The Reinstall ADB window

Start

Starts the ADB service.

Stop

Stop the ADB service. After you select the action, a dialog box opens in which you can set the ADB shutdown mode:

  • fast — the ADB service will be stopped after all transactions are interrupted and rolled back, and all active connections are closed. This is the default mode.

  • smart — the ADB service will be stopped only if there are no active client connections. Otherwise, the action fails with a warning.

  • immediate — the ADB service will be stopped after all transactions are aborted and PostgreSQL processes are killed. This mode does not allow a database server to complete transaction processing and clean up any temporary or in-process work files. It is not recommended to use the immediate mode since it can damage databases in some cases.

Run SQL

Runs any custom SQL command on behalf of the gpadmin user.

The command is executed in the adb database unless another database is specified as the default database for client connections.

In the window that opens, in the SQL query field, enter your command.

The Run SQL window
The Run SQL window

To view the action result, on the Jobs page click the action name and open the Ansible [check] tab — the result will be in the SQL query line.

Manage tablespace

Creates a tablespace or modifies existing tablespaces.

Parameter Description Default value

Name

A unique name for the new tablespace. The name cannot start with the pg_ prefix.

Alternatively, you can specify the name of an existing tablespace to modify its parameters

pg_default

Path

The path to the directory that will be used for the tablespace. The parameter is required if you create a new tablespace. The directory must exist on the master host and on every segment host; the action does not create it

 — 

Storage device

If you want to store the tablespace on a separate storage device, specify the name of a block device on the master host (in the /dev catalog). The action will create an XFS file system on that device, format and mount it to the directory specified in Path

 — 

Use for temporary and transaction files

Use the tablespace to store temporary objects. The action adds the tablespace to the temp_tablespaces configuration parameter.

To check tablespaces currently used to store temporary objects, you can run the following command:

$ gpconfig -s temp_tablespaces

The output should be similar to:

Values on all segments are consistent
GUC          : temp_tablespaces
Master  value: fast_storage
Segment value: fast_storage

false
The Manage tablespace window
The Manage tablespace window
Found a mistake? Seleсt text and press Ctrl+Enter to report it