The Restore Process setting in the Restore Request determines
whether archived data is restored using an Insert Process or a Load
Process. Archived data is restored by matching the Archive File to
the appropriate Insert or Load Request (from a list of requests referenced
in the Restore Request) on the basis of the setting for Insert (or
Load) Request Selection Mode. If desired, you can provide overrides
for one or more settings in the Insert or Load Request selected at
run time, using the following keywords.
General
- DELARES
- Override for Delete Subset Extract setting in the
Restore Request used for processing.
- Y
- Delete Subset Extract Files at the successful conclusion
of the Restore Process.
- N
- Retain Subset Extract Files.
- CONONERR
- Override for Continue Processing if Errors setting
in the Restore Request used for processing.
- Y
- Continue the processing any unprocessed Archive
File if an error occurs.
- N
- Stop the process on an error.
- GLOCONN
- Override for multiple table criteria connector.
- AND
- Data must match criteria for all tables.
- OR
- Data must match criteria for any table.
- GLOSELCRIT
- Override for all global selection criteria specifications
for a table in a Restore Process. Criteria must conform to requirements
described in SQL Grammar for Search and Restore, with global criteria overrides
for each table and column in a separate statement.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- columnname
- Name of column to which criteria applies.
- operator
- Logical operator.
- value
- Value or list of values appropriate for the operator,
expressed as literals or substitution variables (:variablename)
- GLOCOLCONN
- Override for connector for all global selection
criteria applied to a table.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- AND
- Restore data that meets criteria for all columns
in the table.
- OR
- Restore data that meets criteria for any columns
in the table.
- GLOSQLTEXT
- Override for global SQL WHERE clause specifications
for a table in a Restore Process. The WHERE clause must conform to
requirements described in SQL Grammar for Search and Restore, with overrides for each table
in a separate statement.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- sqlwhereclause
- The SQL WHERE clause.
- AUTOGENSUBXF
- Override for Automatically Generate Subset Extract
Files setting in the Restore Request used for processing.
- Y
- Generate a name in the form PSTnnn.xf for
each Subset Extract File as needed.
- N
- Use the name provided in the Restore Request used
for processing or with the override keyword SUBXFFILE.
Archive File
- [AFn]
- Override for Archive Files referenced in the Restore
Request. You must use the AFFILE, AFID,
or GUID keywords to identify the Archive File to
be processed.
- n
- Sequential identifier, beginning with 1, for Archive
File and any accompanying Insert or Load overrides that follow.
- SERVER
- The Server, if any, for the Archive File designated
by the accompanying AFFILE override. If used, the SERVER override
must be on the first line following the [AFn] keyword.
If not, an error condition results.
- servername
- Name of the Server on which the Archive File resides.
- (local)
- The Archive File resides on the local Server. (Default)
- AFFILE
- The Archive File to be restored. The AFFILE override
must be on the first line following the [AFn] or,
if applicable, the SERVER keyword. If not, an error
condition results.
- arcfilename.af
- The name of the Archive File. Provide the full path
if the file is not in the default Archive File Directory.
- AFID
- The identifier for the Archive File to be restored.
The AFID override must be on the first line following
the [AFn] keyword. If not, an
error condition results.
- n
- An integer that identifies the Archive File.
- GUID
- The Globally Unique Identifier (GUID) for an Archive
File to be restored. The GUID override must be on
the first line following the [AFn] keyword.
If not, an error condition results.
- string
- A 38-character string that identifies the Archive
File.
Note: At the time an Archive File is created, you can
use a built-in variable with an Archive Action to obtain and record
the Archive File identifier or the GUID. The recorded identifier is
then available to an external application that builds a command line
parameter file for restoring data. Refer to the Common Elements
Manual for additional
information about using built-in variables with Archive Actions.
- STARTTAB
- Override for the Start Table specification in the
Access Definition used to create the Archive File.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part Start Table name. If tablename is
not fully qualified, the default qualifier is used.
- ROWLIM
- Maximum number of rows in the Archive File to process.
- n
- 0 (to use the maximum limit) or a number from 1
to 99,999,999. Processing is terminated when this limit is reached
- REF
- Override for reference table designation in Archive
File.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part name of any table other
than the Start Table. If tablename is
not fully qualified, the default qualifier applies.
- Y
- Process table as a Reference Table.
- N
- Do not process the table as a Reference Table.
- GLOSELSQL
- Application of global criteria, defined in the Restore
Request or with the GLOSELCRIT or GLOSQLTEXT keywords,
to Archive File.
- Y
- Apply global selection criteria to Archive File.
- N
- Do not apply global selection criteria to Archive
File.
- LOCSELCRIT
- Local selection criteria for a table in a Restore
Process. Criteria must conform to requirements described in SQL Grammar for Search and Restore, with local criteria overrides for each table
and column in a separate statement.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- columnname
- Name of column to which criteria applies.
- operator
- Logical operator.
- value
- Value or list of values appropriate for the operator,
expressed as literals or substitution variables (:variablename)
- LOCCOLCONN
- Override for connector for all local selection criteria
applied to a table.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- AND
- Restore data that meets criteria for all columns
in the table.
- OR
- Restore data that meets criteria for any columns
in the table.
- LOCSQLTEXT
- Local SQL WHERE clause specifications for a table
in the Archive File. The WHERE clause must conform to requirements
described in SQL Grammar for Search and Restore, with overrides for each table in a separate
statement.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- sqlwhereclause
- The SQL WHERE clause.
- SUBXFFILE
- The Subset Extract File generated if global or local
selection criteria are applied to the Archive File to be restored.
This keyword is an alternative to generating the name automatically
on the basis of a setting in the Restore Request or an override for
it.
- extfilename.xf
- The name of the Extract File. Provide the full path
if the file is not in the default Directory. The name is ignored if
not needed.
- VAR
- Value for substitution variable used to process
the Archive File.
- variablename
- Name of the substitution variable.
- value
- The corresponding value for the variable.
Insert or Load
- CFFILE
- Override for the Control File name in the Insert
or Load Request.
- confilename.cf
- The name of the Control File. Provide the full path
if the file is not in the default Data Directory.
- TMNAME
- Override for the local or named Table Map referenced
in the Insert or Load Request selected at run time.
- identifier.name
- 2-part name of an existing Table Map.
- COLMAPID
- Override for default identifier for Column Maps
referenced in the Table Map.
- identifier
- One to eight character identifier.
- COLMAP
- Override for Column Map designation for a destination
table referenced in the Table Map.
- [ [ dbalias. ] cid. ]tablename
- One, two, or three-part table name. If tablename is
not fully qualified, the default qualifier is used.
- [ identifier. ] name
- One or two-part Column Map name. If name is
not fully qualified, the Column Map ID is used.
- DESTQUAL
- Override for Qualifier in the Table Map.
- dbalias. [ cid]
- One or two-part default qualifier for destination
tables referenced in Table Map.
- DESTTABNAME
- Override for source to destination mapping in the
Table Map.
- [ [ dbalias. ] cid. ]
srctablename
- One, two, or three-part name of a table in the Source
File. If srctablename is not fully
qualified, the default Qualifier applies.
- [ [ dbalias. ] cid. ]
desttablename
- One, two, or three-part destination table name.
If desttablename is not fully
qualified, the default Qualifier applies.
Insert
When
the Restore Process mode is Insert, the following overrides pertain
to the Insert Request that is matched with the Archive File.
- COMMFREQ
- Override for Commit Frequency setting.
- n
- Specify any number between 1 and the maximum set
in Product Options.
- PROCTYPE
- Override for Process Option.
- INS
- Insert data.
- UPDINS
- Update and insert data.
- UPDATE/INSERT
- Update and insert data.
- UPDATE ONLY
- Update data only; do not insert.
- LOCKTABS
- Override for Lock Tables setting.
- Y
- Lock tables during insert processing.
- N
- Do not lock tables.
- DISROWLIM
- Override for Discard Row Limit setting in the Insert
Request.
- n
- 0 (to impose no limit) or a number from 1 to 99999999
to stop processing after the specified number of rows are discarded
and all rows in the array processed. You can Restart or Retry a process
that stops because the limit is reached.
Load
When the
Restore Process mode is Load, the following overrides pertain to the
Load Request that is matched with the Archive File.
- MODE
- Loader processing mode for the database.
- dbalias
- The DB Alias for the database.
- INSERT
- Insert rows into empty destination tables.
- REPLACE
- Delete all rows from destination before loading.
- APPEND
- Load rows into destination, discarding duplicate
rows or inserting them into exception tables. (Oracle only.)
- TRUNCATE
- Delete all rows from destination before loading.
(RI constraints must be disabled. Oracle only.)
- PERFLOAD
- Override for Perform Load setting in Load Request.
- dbalias
- The DB Alias for the database.
- Y
- Run the loader immediately after file conversion.
- N
- Do not run the loader.
- DELONSUCCESS
- Override for delete files option when the Load Process
completes successfully.
- dbalias
- The DB Alias for the database.
- Y
- Delete files for the database referenced by dbalias.
- N
- Do not delete files.
- DELONFAILURE
- Override for delete files option when the Load Process
fails.
- dbalias
- The DB Alias for the database.
- Y
- Delete files for the database referenced by dbalias.
- N
- Do not delete files.
- WORKPATH
- Override for temporary loader files directory path.
- dbalias
- The DB Alias for the database.
- path
- Path to location for files. Dive must be accessible
to DBMS server and client, workstation and network server.
- SERVPATH
- Override for temporary loader files Server path.
(DB2® only.)
- dbalias
- The DB Alias for the database.
- path
- Path to location for files. Drive must be accessible
to DBMS server and client, workstation and network server.
- END
- End of overrides in parameter file.