Backup and Restore Options

Advantage Concepts

The following options can be passed in the options parameter to the Backup and Restore Canned Procedures. These options are similar to, but should not be confused with the adsbackup utility command line parameters.

If you do not want to pass any options you can pass an empty string (‘’) or NULL.

If you want to pass multiple options separate each option with a semi-colon (;).

Example: ‘include=table1;PrepareDiff’

Include

Use this option to specify a list of tables to include in the backup or restore. Only the tables in this list will be processed. The option should include the keyword "include" followed by an equal sign and then a comma-delimited list of table names.

 Example: ‘include=table1, table2’

If backing up or restoring a data dictionary, use the table object names. If backing up or restoring free tables, use the base filename and the file extension. For example:

 Example: ‘include=table1.adt, table2.adt’

Exclude

Use this option to specify a list of tables to exclude from the backup or restore. Tables in this list will not be processed. The option should include the keyword "exclude" followed by an equal sign and then a comma-delimited list of table names.

 Example: ‘exclude=table1, table2’

If backing up or restoring a data dictionary, use the table object names. If backing up or restoring free tables, use the base filename and the file extension. For example:

 Example: ‘exclude=table1.adt, table2.adt’

DontOverwrite

Specify the "DontOverwrite" keyword if you do not want the backup or restore operation to overwrite existing tables. Instead a warning will be logged to the result set.

 Example: ‘DontOverwrite’

MetaOnly

Specify the "MetaOnly" keyword if you only want to backup or restore the data dictionary file.

 Example: ‘MetaOnly’

PrepareDiff

Specify the "PrepareDiff" keyword if you want to initialize a differential backup.

 Example: ‘PrepareDiff’

Diff

Specify the "Diff" keyword if you want to perform a differential backup on a database that you have previously initialized using the "PrepareDiff" keyword.

 Example: ‘Diff’

TableTypeMap

Use this option to specify what table type should be used for a specific table extension. Only necessary for free table backup/restore operations. This option can be used to backup and/or restore a directory of free tables that consists of both ADT and DBF tables. The option should include a three byte extension, followed by an equal sign, followed by the Advantage table type constant. Each mapping is separated by a comma. For example:

TABLETYPEMAP=adt=ADS_ADT,dbf=ADS_CDX’

could be used to specify files with the extension "adt" should be opened using the ADS_ADT table type, and files with the extension "dbf" should be opened with the ADS_CDX table type. This mapping allows the caller to specify the table type at a more granular level (as opposed to a single table type global setting).