Forrest logo
back to the pg_restore tool

pg_restore:tldr:1bd61

pg_restore: List database objects included in the archive.
$ pg_restore --list ${archive_file-dump}
try on your machine

The command "pg_restore --list ${archive_file-dump}" is used to display the contents of a PostgreSQL backup file without actually performing the restore operation. Let's break down the command:

  • "pg_restore" is a PostgreSQL utility used to restore a database backup. It can also be used to analyze and display the metadata of a backup file before restoring it.
  • "--list" is an option for pg_restore that instructs it to list the contents of the backup file, instead of executing the restore.
  • "${archive_file-dump}" is a placeholder for the actual path and filename of the PostgreSQL backup file. You need to provide the correct path to the backup file in place of this placeholder.

Overall, this command is useful when you want to inspect the contents of a PostgreSQL backup file before actually performing the restore operation.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the pg_restore tool