PolarDB:PolarDB-Tools

Tool name

Description

Usage

Differences from native tools

psql

A client connection tool for PostgreSQL.

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

• This tool is adapted for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle-compatible syntax. Using the community version might cause unexpected errors.

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

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

pg_dump

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

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

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

• This tool is adapted for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle-compatible syntax. If you use the community version, some objects might fail to be dumped.

• When you use the pg_dump client, 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 the native pg_restore tool. For more information, see the pg_restore documentation on the official PostgreSQL website.

• PolarDB supports two data restoration methods: point-in-time restore and restoration from a backup set (snapshot). You can use these methods to restore historical data to a new cluster. For more information, see Data restoration operations.

• This tool is adapted for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle-compatible syntax. If you use the community version, some objects might fail to be restored.

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

ecpg

An embedded SQL C preprocessor.

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

• This tool is adapted for PolarDB for PostgreSQL (Compatible with Oracle) and supports Oracle-compatible syntax. If you use the community version, some objects might fail to be transformed.

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