Command-line Keywords For Search and Restore Processing

Use the following command line keywords for Search and Restore processing.

PR0CMND
The command to initiate command line processing. The character following PR is the number 0 (zero).
/R
Command to run the specified job, action request(s) specified in a parameter file, or action request specified on the command line. Use /R or –R.
TYPE=
Type of process as one of the following:
SEARCHANDRESTORE
Search and Restore process.
REQUEST=
The Restore Request to be processed.
identifier.name
Two-part name of the action request.
OV=
Source of process overrides. The OV keyword must follow all other command line keywords.
overridefilename.txt
The name of a text file containing process overrides only, with each override on a separate line.
*
If you use a parameter file, overrides follow on successive lines of the parameter file. The first override (keyword and associated argument) must begin on the following line, and each additional override must be on a separate line.

An override file is the only method available to provide overrides unless you use a parameter file. If using a parameter file, however, you can provide overrides in a text file or in the parameter file with the END keyword following the last override.

Search and Restore Filters

Use the following filtering parameters to describe the registered Archive File(s) to be searched for data to restore. Use the FILTER keyword as many times as needed to select the files to search.

FILTER

You can use the % (percent) symbol and the _ (underscore) as wildcard values. Use the % (percent) symbol to represent any number of characters or the _ (underscore) to represent a single character. If a specific filter is not used, the default wildcard value is assumed.

Valid filters and values are:

FILENAME
The registered Archive File(s) to be searched.
arcfilename.af
Archive File name or a pattern using wildcards.
SERVERNAME
Optim™ Server(s) on which Archive Files reside.
arcservername
Name or pattern for Server(s).
(local)
Archive Files reside on the local Server. (Default)
GROUP
Group identifier for Archive File(s).
groupidentifier
1- to 8-character identifier or pattern.
CREATOR
Creator ID associated with Archive File(s).
cid
Creator ID or pattern.
TABLENAME
Table in Archive File(s).
dbalias.cid.tablename
Fully qualified table name, or pattern.
DESC
Description associated with Archive File(s).
description
1- to 8-character description or pattern.
STARTDATE
Earliest creation date for Archive File(s).
mm/dd/yyyy
Date or pattern.
ENDDATE
Latest creation date for Archive File(s).
mm/dd/yyyy
Date or pattern.

Search Criteria and Parameters

Use the following overrides to specify selection criteria for data to be restored.

GLOCONN
Connector for criteria applied to more than one table.
AND
Data in Archive File must match criteria for all tables.
OR
Data in Archive File must match criteria for any table.
GLOSELCRIT
Global criteria specifications for data to be restored. Criteria must conform to requirements described in SQL Grammar for Search and Restore, with global criteria for each table and column in a separate statement. The criteria are applied to any Archive File that meets the filtering criteria and override any global criteria specifications in the model Restore Request.
[ [ 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
Connector for all global 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
Global SQL WHERE clause criteria for data to be restored. The WHERE clause must conform to requirements described in SQL Grammar for Search and Restore, with WHERE clauses for each table in a separate statement. The WHERE clause is applied to any Archive File that meets the filtering criteria and overrides any global criteria specifications in the model Restore Request.
[ [ 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.
SORTORDER
Order in which Archive Files that meet Filter and selection criteria are processed.
A
Process the oldest file first and the newest file last.
D
Process the newest file first and the oldest file last.
MAXFILES
Maximum number of Archive Files that can be processed. Processing terminates if the number of files that match Filter and selection criteria exceeds the limit.
n
0 (to impose no limit) or a number from 1 to 99999999 to stop processing after the specified number of files match the Filter and selection criteria. You can Restart or Retry a process that stops because the limit is reached.
ONLYFIRST
Files from which to restore data.
Y
Only restore data from the first file that matches the filter and search criteria. (Use the SORTORDER option to establish the file that is first.)
N
Restore data from all files that match the filter and search criteria. (You can use the SORTORDER option to establish the order in which the data is restored.)
IGNINACC
Indicator for processing files located on inaccessible Servers.
Y
Exclude inaccessible files from the subsequent Insert or Load phase of processing (inaccessible files are noted in the information area of the processing report).
N
Terminate Search and Restore processing when a file is inaccessible.
CONONERR
Indicator for processing when errors occur.
Y
Insert or Load Processing errors are noted in the process report and processing continues with the next Archive File.
N
Insert or Load Processing errors are noted in the process report and further processing is halted.
DELARES
Indicator for treatment of Subset Extract Files, if any, at the conclusion of the Restore Process.
Y
Delete Subset Extract Files.
N
Retain Subset Extract Files.
SEASCOPE
Indicator for scope of search.
P
Search on the basis of the Only Use Index To Perform Search setting in Personal Options (default).
A
Search Archive Indexes and, if indexes are insufficient, search the native file system.
I
Limit search to Archive Indexes.

Restore Process

Use the following overrides to control how the Search and Restore Process restores data to your database.

Search and Restore processing uses the Restore Selection mode and Insert or Load Request information from the model Restore Request and unless you override Insert or Load parameters, Insert or Load Requests are matched with Archive files in the normal way. Overrides, however, apply to all processing. You cannot provide separate overrides for each Archive File as in the [AFn] overrides for a Restore Process.

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
Two-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 tablename is not fully qualified, the default Qualifier applies.
[ [ dbalias. ] cid. ] desttablename
One, two, or three-part destination table name. If tablename is not fully qualified, the default Qualifier applies.

Insert

When the model Restore Request Process mode is Insert, the following overrides can be used, and pertain to the Insert Process for all Archive Files identified for Search and Restore processing.

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 model Restore Request Process mode is Load, the following overrides can be used, and pertain to the Load Process for all Archive Files identified for Search and Restore processing.

MODE
Loader processing mode for the database.
dbalias
The DBAlias 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 DBAlias 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 DBAlias 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 DBAlias 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 DBAlias for the database.
path
Path to location for files. Drive must be accessible to DBMS server and client, workstation and network server.
SERVPATH
Override for temporary loader files Server path. (DB2® UDB only.)
dbalias
The DBAlias 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 Search and Restore Process.