PolarDB:PolarDB-Tools

Tool name

Description

Usage

Differences from native tools

psql

A client tool for connecting to PostgreSQL.

The usage is the same as that of the native psql tool. For more information, see the psql documentation on the official PostgreSQL website.

• It is optimized for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle compatibility syntax. Using the community version may cause unexpected errors.

• You can use the community version of the psql tool to execute simple SQL statements when you manage a PolarDB cluster. Note that the community version of the psql tool does not support creating stored procedures. If you use it to create a stored procedure, the SQL string may be truncated unexpectedly.

• When you use the psql client, you can download the latest version of PolarDB-Tools. Newer versions are backward-compatible.

pg_dump

A logical backup tool for PostgreSQL used to back up a single database in a cluster.

The usage is the same as that of the native pg_dump tool. For more information, see the pg_dump documentation on the official PostgreSQL website.

• PolarDB supports data backups and log backups in the console. For more information, see Configure a backup policy.

• It is optimized for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle compatibility syntax. If you use the community version, some objects may not be dumped.

• When you use the pg_dump client, you can download the latest version of PolarDB-Tools. Newer versions are backward-compatible.

pg_restore

A PostgreSQL tool used to restore backup files created by pg_dump and pg_dumpall.

The usage is the same as that of the native pg_restore tool. For more information, see the pg_restore documentation on the official PostgreSQL website.

• PolarDB supports two restore methods: point-in-time restore and restoring from a backup set (snapshot). These methods restore historical data to a new cluster. For more information, see Restoration operations.

• It is optimized for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle compatibility syntax. If you use the community version, some objects may not be restored.

• When you use the pg_restore client, you can download the latest version of PolarDB-Tools. Newer versions are backward-compatible.

ecpg

An embedded SQL C preprocessor.

The usage is the same as that of the native ecpg tool. For more information, see the ecpg documentation on the official PostgreSQL website.

• It is optimized for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle compatibility syntax. If you use the community version, some objects may not be transformed.

• When you use the ecpg client, you can download the latest version of PolarDB-Tools. Newer versions are backward-compatible.