pg_is_in_backup()

A function determining whether an exclusive backup is in progress
This entry relates to a PostgreSQL feature which is deprecated and may be desupported in future releases.

pg_is_in_backup() is a system function determining whether an on-line exclusive backup is in progress.

pg_is_in_backup() was added in PostgreSQL 9.3 and removed in PostgreSQL 15.

Usage

pg_is_in_backup () → boolean

pg_is_in_backup() returns true if an online exclusive backup was started with pg_start_backup(), otherwise false.

Change history

Examples

See pg_start_backup() for a usage example.

Categories

Backup, Deprecated, System function

See also

pg_backup_start_time(), pg_start_backup(), pg_stop_backup()