The following syntax is used to generate a statement for
each exported Extract Request definition:
Keywords
The
keywords correspond to values that can be specified for an Extract
Request. For more information about individual parameters, see the Move
User Manual or the Compare User Manual
- EXTR identifier.name
- The name of the Extract Request, specified in two
parts (identifier.name), is required following
the CREATE EXTR keyword.
- DESC //description//
- A description of the Extract Request, delimited
by double slashes.
- XF xfilname
- The fully qualified name of the Extract File, which
is the output of the Extract Process.
AD Keywords
An
Access Definition parameter must be included. The Access Definition
can be Local or Named:
- AD adname
- The full two-part name of the Named Access Definition
being used.
- LOCALAD (addef)
- A full definition of the Local Access Definition
being used, contained in parentheses, follows this keyword. The syntax
and parameters for the definition of a Local Access Definition are
identical to those for a Named Access Definition.
Point and Shoot
The PNSOPT, LOCALRL and ROWLIST keywords
are related:
- PNSOPT or PNSOVERRIDE specifies
the Point and Shoot option for the Extract Request.
- If PNSOPT is F, the ROWLIST parameter
must follow.
- If PNSOPT is L, the LOCALRL parameter may follow,
as an option (you can select LOCAL for Point and Shoot without defining
a Row List file).
- ROWLIST may be included
in the exported definition even if the PNSOPT is
N or L (or omitted), because the Extract Request may have previously
had a ROWLIST in use. A previously used Named
Row List file reference will be retained as part of the Extract Request,
even if the PNSOPT is no longer F.
- PNSOVERRIDE {Y|N}
- Indicates whether to override the Point and Shoot
Definition in the Access Definition for the Extract Request.
- Y
- Override the Point and Shoot Definition in the
Access Definition.
- N
- Do not override the Point and Shoot Definition
in the Access Definition.
- PNSOPT {L|F|N}
- (Point and Shoot) indicates
the Point and Shoot option for the Extract Request. The options are:
- L
- Local Row List; LOCALRL and ROWLIST are
optional additional keywords.
- F
- Named Row List; ROWLIST must
follow.
- N
- None; ROWLIST is an optional
additional keyword.
- ROWLIST filname
- The fully qualified name of the external Named Row
List for the Extract Request.
- LOCALRL //rowlistdef//
- The definition of the Local Row List for the Extract
Request. Long character strings such as Row List definitions are delimited
by two forward slashes (//). Continuation characters are not used,
and no spaces or indentations are added. If additional spaces or continuation
characters are inserted, the string is imported incorrectly. The text
continues for the complete length of the line, wrapping to the next
line until the forward slashes are reached, indicating the end of
the text.
- PNSSTART starttable
- The start table name for the Point and Shoot Row
List.
Variables
There
is a VARS entry only when a variable(s) has
been defined for the Access Definition being used in the Extract Request.
- VARS //varname/dfltvalue//
- A list of the variables used in the Extract Request:
- The information is delimited by double slashes.
- Commas are used between variables.
- Single slashes are used between variable names and
default values.
- ALWAYSPROMPT {Y|N}
- (Always Prompt for Values at Run Time)
indicates whether a prompt for variable values is automatically displayed
during Extract Processing.
- Y
- The prompt for variable values is automatically
displayed during Extract Processing.
- N
- The prompt for variable values is not automatically
displayed during Extract Processing.
Note: Prompt strings are not exported as part of the
Extract Request, only variable names and default values. If the Access
Definition used in the Extract Request is exported as a subordinate
object (or if a Local Access Definition is used), prompt strings are
exported as part of the Access Definition.
Options
This
parameter relates to the ability to extract either data, objects,
or data and objects when performing extracts.
- OPTION {D|O|B}
- Indicates whether data, objects, or both are extracted.
- D
- Only data is extracted.
- O
- Only objects are extracted.
- B
- Data and objects are extracted.
- INCLPK {Y|N}
- Indicates whether primary keys are included in the
Extract if OPTION is O or B.
- INCLFK {Y|N}
- Indicates whether foreign keys and relationships
are included in the Extract if OPTION is O
or B.
- INCLIDX {Y|N}
- Indicates whether indexes are included in the Extract
if OPTION is O or B.
- INCLALIAS {Y|N}
- Indicates whether aliases are included in the Extract
if OPTION is O or B.
- INCLFUNCTION {Y|N}
- Indicates whether functions are included in the
Extract if OPTION is O or B.
- INCLPACKAGE {Y|N}
- Indicates whether packages are included in the Extract
if OPTION is O or B.
- INCLPROCEDURE {Y|N}
- Indicates whether procedures are included in the
Extract if OPTION is O or B.
- INCLSEQUENCE {Y|N}
- Indicates whether sequences are included in the
Extract if OPTION is O or B.
- INCLTRIGGER {Y|N}
- Indicates whether triggers are included in the Extract
if OPTION is O or B.
- INCLVIEW {Y|N}
- Indicates whether views are included in the Extract
if OPTION is O or B.
- INCLDEFAULT {Y|N}
- Indicates whether defaults are included in the
Extract if OPTION is O or B.
- INCLRULE {Y|N}
- Indicates whether rules are included in the Extract
if OPTION is O or B.
- INCLDT {Y|N}
- Indicates whether UDTs (user defined types) are
included in the Extract if OPTION is O or B.
Extract Options
The
following keywords relate to options for the Extract Process.
- COMPRESSFILE {Y|N}
- Indicates if the process automatically compresses the Extract
File for storage.
- GENSTATISTIC {Y|N}
- Indicates if statistical information is included in the Extract
Process Report.
- PROCESS_FILEATTACH {Y|N}
- Indicates if file attachments specified in the Access Definition
are extracted.
- ROWLIMIT n
- A limit for the number of rows (n) which can be extracted.
The default value for this keyword is “0.”
- DBCONNECTIONS n
- Indicate the number of concurrent database connections for the
Extract Process. Increasing database connections improves performance
when processing large quantities of data by allowing multiple threads
to extract rows concurrently.
To increase the maximum
number of connections, enter an even number from 2 to the site maximum
(O) as specified on the Product Options dialog.
Object List
This
parameter relates to the ability to extract extended objects.
- OBJECT name=type
- Each extended object, identified by name, and type
of object: Default, Function, Package, Procedure, Rule, Sequence,
UDT, or View.
- OBJQUAL identifier.name
- The name of the Default Qualifier for the extended
objects (identifier.name).
- IGNOREUNKNOWN {Y|N}
- Indicator for ignoring unknown or unavailable objects.
Notify
This
parameter relates to the ability to send notification via email about
the outcome of the process.
- EMAILNOTIFY {A|S|F} emailaddress
- Indicates the process outcome under which to send
notification to the corresponding email address.
- A
- Always send notification.
- S
- Send notification when process succeeds.
- F
- Send notification when process fails.
Convert
This
parameter relates to the ability to run the Convert Process immediately
following the Extract Process. The Convert Request can be Local or
Named:
- CV identifier.name
- The full two-part name of the Convert Request being
used.
- LOCALCV (cvdef)
- A full definition of the Local Convert Request being
used, contained in parentheses, follows this keyword. The syntax and
parameters for the definition of a Local Convert Request are identical
to those for a Named Convert Request.
- CVDELEXF {Y|N}
- Indicator for deleting the Extract
File if the Convert Process fails.