Specifies various behavioral properties of the TPSQLRestore.

Syntax:

TRestoreOption = (roDataOnly, roClean, roCreate, roExitOnError,
              roIgnoreVersion, roList, roNoOwner,
              roSchemaOnly, roVerbose, roNoPrivileges,
              roDisableTriggers, roUseSetSessionAuthorization,
              roSingleTransaction, roNoDataForFailedTables,
              roNoTablespaces);

TRestoreOptions = set of TRestoreOption;
property Options: TRestoreOptions;

Description:

Set Options to include the desired properties for the restore. Options is a set drawn from the following values:

roDataOnly

Restore only the data, not the schema (data definitions).

roClean

Clean (drop) database objects before recreating them.

roCreate

Create the database before restoring into it. (When this option is used, the database named with DBName property is used only to issue the initial CREATE DATABASE command. All data is restored into the database name that appears in the archive.)

roExitOnError

Exit if an error is encountered while sending SQL commands to the database. The default is to continue and to display a count of errors at the end of the restoration.

roIgnoreVersion

A deprecated option that is now ignored.

roList

List the contents of the archive to file with name specified by OutputFileName. The output file of this operation must be used with the ListFile property to restrict and reorder the items that are restored.

roNoOwner

Do not output commands to set ownership of objects to match the original database. By default, TPSQLRestore issues SET SESSION AUTHORIZATION statements to set ownership of created schema elements. These statements will fail unless the initial connection to the database is made by a superuser (or the same user that owns all of the objects in the script). With roNoOwner, any user name can be used for the initial connection, and this user will own all the created objects.

roSchemaOnly

Restore only the schema (data definitions), not the data. Sequence values will be reset.

roVerbose

Specifies verbose mode.

roNoPrivileges

Prevent restoration of access privileges (GRANT/REVOKE commands).

roDisableTriggers

This option is only relevant when performing a data-only restore. It instructs TPSQLRestore to execute commands to temporarily disable triggers on the target tables while the data is reloaded. Use this if you have referential integrity checks or other triggers on the tables that you do not want to invoke during data reload. Presently, the commands emitted for roDisableTriggers must be done as superuser. So, you should also specify a superuser name with SuperUserName property, or preferably run TPSQLRestore as a PostgreSQL superuser.

roUseSetSessionAuthorization

Output SQL standard SET SESSION AUTHORIZATION commands instead of OWNER TO commands. This makes the dump more standards compatible, but depending on the history of the objects in the dump, may not restore properly.

roSingleTransaction

This option instructs TPSQLRestore to run entire session in a single transaction.

roNoDataForFailedTables

Suppress loading data if table creation failed, because the table already exists. By default, table data objects are restored even if the associated table could not be successfully created (e. g. because it already exists). With this option, such table data is silently ignored. This is useful for dumping and restoring databases with tables which contain auxiliary data for PostgreSQL extensions (e. g. PostGIS).

roNoTablespaces

Do not output commands to select tablespaces. With this option, all objects will be created in whichever tablespace is the default during restore.