 |
OpenVMS Record Management Utilities Reference
Manual
/DISPLAY
This qualifier specifies the type of graph you want displayed.
Format
/DISPLAY graph-option
Parameter
graph-option
Specifies the type of graph you want displayed: LINE, FILL, KEY,
RECORD, INIT, or ADD.
|
LINE
|
Plots bucket size against index depth.
|
|
FILL
|
Plots bucket size by the percentage of load fill by index depth.
|
|
KEY
|
Plots bucket size by key length by index depth.
|
|
RECORD
|
Plots bucket size by record size by index depth.
|
|
INIT
|
Plots bucket size by initial load record count by index depth.
|
|
ADD
|
Plots bucket size by additional record count by index depth.
|
The default is LINE.
Example
|
$ EDIT/FDL/DISPLAY=KEY TEMP_DATA
|
This command begins an interactive session in which the default value
for the type of graph to be displayed has been changed from LINE to
KEY. TEMP_DATA is the name of the FDL file to be created.
/EMPHASIS
This qualifier provides you with a choice between smaller buffers and
flatter files. You can use /EMPHASIS with the /NOINTERACTIVE qualifier
if you want EDIT/FDL to be executed without an interactive terminal
dialogue.
Format
/EMPHASIS tuning-bias
Qualifier Value
tuning-bias
Represents how you want to weight the default bucket size for your file.
There are two valid options, FLATTER_FILES and SMALLER_BUFFERS.
|
FLATTER_FILES
|
Generally increases bucket size. The bucket size, in turn, controls the
number of levels in the index structure. If a larger bucket size
eliminates one level, then you should use this option. At some point,
however, the benefit of having fewer levels will be offset by the cost
of scanning through the larger buckets.
|
|
SMALLER_BUFFERS
|
Generally decreases the amount of memory you have to use.
|
The default is FLATTER_FILES and it should be used unless excessive
paging or RMS CPU time occurs because of oversized buffers. However, if
your system has little extra memory or if you are not sure which tuning
bias will improve the performance of your program, try tuning your file
using SMALLER_BUFFERS and then FLATTER_FILES.
Example
|
$ EDIT/FDL/EMPHASIS=SMALLER_BUFFERS TEMP_DATA
|
This command begins an interactive session in which the default value
for the bucket size emphasis has been changed from FLATTER_FILES to
SMALLER_BUFFERS. TEMP_DATA is the name of the FDL file to be created.
/GRANULARITY
This qualifier specifies the number of key-associated areas in an
indexed file. A file can contain from 1 to 255 key-associated areas and
each area can contain one or more index levels from one or more keys.
Each key definition contains the following area designations:
- DATA_AREA
- LEVEL1_INDEX_AREA
- INDEX_AREA
During input processing, the optimization and redesign functions assign
two areas per key, one for data and one for both indexes. During output
processing, the area designators are adjusted according to the
granularity specified. Checks are made to exclude areas that have no
key indexes and to create new key indexed areas where none previously
existed.
To assign more than two areas per key (DOUBLE) or to assign nonstandard
key and area associations, you must invoke an interactive session. With
the granularity qualifier configured as GRANULARITY=DOUBLE, create new
areas and set the corresponding area designators to reference the new
areas on a per-key basis.
Format
/GRANULARITY n
Qualifier Value
n
The following table shows the relationship between granularity, key,
and area for various values of granularity.
The acceptable values are the numeric values 1, 2, 3, or 4; the literal
values ONE, TWO, THREE, FOUR; or the logical value DOUBLE. If you do
not specify granularity, the system establishes a default value of
three (3).
| Granularity |
Key and Area Relationships |
|
1
|
All indexes for all keys are assigned to AREA 0.
|
|
2
|
Primary KEY data to AREA 0, all other indexes for all other keys to
AREA 1.
|
|
3
|
Primary KEY data to AREA 0, Primary KEY indexes to AREA 1, all other
indexes for all other keys to AREA 2.
|
|
4
|
Primary KEY data to AREA 0, Primary KEY indexes to AREA 1, all other
key data to AREA 2, all other key indexes to AREA 3.
|
|
DOUBLE
|
Primary KEY data to AREA 0, Primary KEY indexes to AREA 1, all other
key data to AREA (key_number*2), all other key indexes to AREA
((key_number*2)+1).
|
Example
|
$ EDIT/FDL/GRANULARITY=2 TEMP_DATA.FDL
|
This command begins an interactive session in which the output
granularity will be two (2). TEMP_DATA.FDL is the name of the FDL file
being processed.
/NOINTERACTIVE
This qualifier causes the Edit/FDL utility to execute the Optimize
script without a terminal dialogue.
Format
/NOINTERACTIVE
Description
The /NOINTERACTIVE qualifier allows you to optimize an existing FDL
file with the Edit/FDL utility but without an interactive terminal
dialogue. You must have previously entered the ANALYZE/RMS_FILE/FDL
command, specifying your existing RMS data file as the target file, to
output an analysis FDL file. The EDIT/FDL utility requires the
following data from two sources in order for the Optimize script to
proceed noninteractively:
- The analysis sections contained in the analysis FDL file produced
by ANALYZE/RMS_FILE/FDL and unique to an analysis FDL
- The FDL definition sections contained in either the original FDL
file or the analysis FDL file
If there is no analysis section in the FDL file specified for
/ANALYSIS, the Edit/FDL utility exits without producing an output file.
Examples
| #1 |
$ ANALYZE/RMS_FILE/FDL/OUTPUT=TEMP_DATA_ANAL.FDL TEMP_DATA.IDX
|
This command should precede a noninteractive Edit/FDL session. It
generates an analysis FDL file TEMP_DATA_ANAL.FDL from the data file
TEMP_DATA.IDX. If the /OUTPUT specification was not included, this
command would have created the analysis FDL file with the default name
TEMP_DATA.FDL.
| #2 |
$EDIT/FDL/ANALYSIS=TEMP_DATA_ANAL.FDL/NOINTERACTIVE -
$_/OUTPUT=TEMP_DATA_OPT.FDL TEMP_DATA.FDL
|
This command initiates a noninteractive session in which a new
optimized FDL file TEMP_DATA_OPT.FDL is created using the FDL parameter
input file TEMP_DATA.FDL and the analysis FDL file TEMP_DATA_ANAL.FDL.
If the /OUTPUT specification was not included, this command would have
created a new version of TEMP_DATA.FDL; for example, TEMP_DATA.FDL;3
would be created, if the parameter input file was TEMP_DATA.FDL;2.
| #3 |
$EDIT/FDL/ANALYSIS=TEMP_DATA_ANAL.FDL/NOINTERACTIVE -
$_/OUTPUT=TEMP_DATA_OPT.FDL TEMP_DATA_ANAL.FDL
|
This command initiates a noninteractive session in which a new
optimized FDL file TEMP_DATA_OPT.FDL is generated from only the
analysis FDL file. However, the analysis FDL file has to be specified
in the command twice. The Edit/FDL utility will retrieve the data from
the analysis sections using the /ANALYSIS file specification and the
data from the FDL definition sections using the parameter input file
specification. While the /ANALYSIS specification has to contain FDL
analysis sections, the parameter specification does not have to, and if
it does, they will be ignored.
/NUMBER_KEYS
This qualifier allows you to specify the number of keys in your indexed
file.
Format
/NUMBER_KEYS n
Qualifier Value
n
Indicates how many keys you want to define for your indexed file. You
can define up to 255 keys. The default is 1 key.
Example
|
$ EDIT/FDL/NUMBER_KEYS=3 TEMP_DATA
|
This command begins an interactive session in which the default value
for the number of keys in an indexed file is changed from 1 key to 3
keys. TEMP_DATA is the name of the FDL file to be created.
/OUTPUT
This qualifier specifies the FDL file in which to place the definition
from the current session.
Format
/OUTPUT [=fdl-filespec]
Qualifier Value
fdl-filespec
Specifies the output FDL file.
Description
If you omit the /OUTPUT qualifier, the output FDL file will have the
same name and file type as the input file, with a version number that
is one higher than the highest existing version of the file.
The default file type is .FDL.
Example
|
$ EDIT/FDL/OUTPUT=NEWINDEX INDEX
|
Begins a session in which the contents of INDEX.FDL are read into the
FDL editor and can then be modified. NEWINDEX.FDL is created; INDEX.FDL
is not changed.
/PROMPTING
Specifies the level of prompting to be used during the terminal session.
Format
/PROMPTING prompt-option
Qualifier Value
prompt-option
Specifies the level of menu prompting to be used during the terminal
session, BRIEF or FULL.
|
BRIEF
|
Selects a terse level of prompting.
|
|
FULL
|
Provides more information about each menu question.
|
By default, the Edit/FDL utility chooses either BRIEF or FULL,
depending on the terminal type and the line speed. High-speed CRT
terminals are set to FULL; nonscope terminals and terminals operating
at less than 2400 baud are set to BRIEF.
If the Edit/FDL utility has to repeat a question, it repeats the FULL
version of the question, with a BRIEF form of the HELP text. You can
also type a question mark (?) for help on a particular question.
The extra line of HELP text is not given for menu questions.
Example
|
$ EDIT/FDL/PROMPTING=BRIEF TEMP_DATA
|
This command begins an interactive session in which the value of the
prompting level for the Edit/FDL utility menus is set to BRIEF.
/RESPONSES
This qualifier allows you to select how you want to respond to script
questions.
Format
/RESPONSES response-option
Qualifier Value
response-option
Specifies the type of script response you want to use, AUTOMATIC or
MANUAL.
|
AUTOMATIC
|
Indicates that you want all script default responses to be used
automatically. This option speeds the progress of the question and
answer session. Once you have entered the design phase, you can modify
most of the answers you took by default.
|
|
MANUAL
|
Indicates that you want to provide all script responses.
|
If you use the SET RESPONSES command during the interactive session,
the default is AUTOMATIC; otherwise the default is MANUAL.
Example
|
$ EDIT/FDL/RESPONSES=MANUAL TEMP_DATA
|
This command begins an interactive session in which the type of script
response is MANUAL.
/SCRIPT
This qualifier controls whether the Edit/FDL utility begins the session
by asking a logically grouped sequence of questions to aid you in
creating the FDL file.
Format
/SCRIPT script-title
Qualifier Value
script-title
This qualifier specifies a script title.
The valid options are as follows:
|
ADD_KEY
|
Allows you to model or add to the attributes of a new index.
|
|
DELETE_KEY
|
Allows you to remove attributes from the highest index of your file.
|
|
INDEXED
|
Begins a dialogue in which you are prompted for information about the
indexed data file to be created from the FDL file. The Edit/FDL utility
supplies values for certain attributes.
|
|
OPTIMIZE
|
Requires that you use the analysis information from an FDL file that
was created with the Analyze/RMS_File utility (ANALYZE/RMS_FILE). The
FDL file itself is one of the inputs to the Edit/FDL utility
(EDIT/FDL). In other words, you can tune the parameters of all your
indexes using the file statistics gathered from a file analysis.
|
|
RELATIVE
|
Begins a dialogue in which you are prompted for information about the
relative data file to be created from the FDL file. The Edit/FDL
utility supplies values for certain attributes.
|
|
SEQUENTIAL
|
Begins a dialogue in which you are prompted for information about the
sequential data file to be created from the FDL file. The Edit/FDL
utility supplies values for certain attributes.
|
|
TOUCHUP
|
Begins a dialogue in which you are prompted for information about the
changes you want to make to an existing index.
|
Description
The default is not to invoke a script automatically. Note that, if you
specify /NOSCRIPT, you can still use the scripts by entering the INVOKE
command in response to the main editor function prompt.
Example
|
$ EDIT/FDL/SCRIPT=INDEXED TEMP_DATA
|
This command begins an interactive session in which both the main menu
and the script menu are bypassed. Instead, the Indexed script is
generated
immediately.
EDIT/FDL Examples
This command begins an interactive session that will modify an FDL file
named INDEX.FDL.
| #2 |
$ EDIT/FDL/ANALYSIS=INDEXFILE/SCRIPT=OPTIMIZE MAKEINDEX
|
This command uses the analysis information in the file INDEXFILE.FDL to
create a more efficient MAKEINDEX.FDL file. The sequence of events is
as follows:
- The FDL file MAKEINDEX.FDL is created by the Edit/FDL utility.
- INDEXFILE.DAT is created by the CREATE/FDL=MAKEINDEX command.
- INDEXFILE.DAT is used in applications.
- INDEXFILE.FDL is created with the ANALYZE/RMS_FILE/FDL command.
- The following command uses INDEXFILE.FDL to optimize MAKEINDEX.FDL:
$ CONVERT/FDL=MAKEINDEX INDEXFILE.DAT INDEXFILE.DAT
|
| #3 |
$ EDIT/FDL/NOINT/A=INVENTORY/G=4
File: SALES
$
|
This command creates the output FDL file SALES from the analysis FDL
file INVENTORY without an interactive terminal dialogue. In addition,
the Edit/FDL utility optimizes the input file, changing the granularity
factor to 4 areas and the number of keys to 2. Otherwise, all the
defaults supplied by the Edit/FDL utility are used.
EDIT/FDL Commands
The Edit/FDL utility commands are used during the interactive session
only. The Edit/FDL utility prompts for one of the following commands at
the start of your interactive session:
ADD
DELETE
EXIT
HELP
INVOKE
MODIFY
QUIT
SET
VIEW
However, because the Edit/FDL utility is not command oriented but menu
oriented, the prompt may change during the interactive session to fit
the needs of the menu questions. In general, the prompt consists of a
short question, the type of required value or the range of acceptable
values (in parentheses), and the default answer (in brackets), as
follows:
question (keyword or range)[default] : answer
|
In addition, some prompts consist of a short question, a list or a
range of acceptable values (either in parentheses or in a table), the
required type of the value (in parentheses), and the default answer (in
brackets), as follows:
question (list of values) (keyword or range)[default] : answer
|
If no default is allowed, you see the symbol [-], in which case you
must supply an answer.
ADD
This command allows you to add one or more lines to the FDL file. If
the line already exists, you can optionally replace it with the new
line. After you insert a line, you can optionally continue to add lines
under that particular primary section. If no primary section exists to
hold the secondary attribute being added, one is automatically created.
Format
ADD
Example
|
Main Editor Function (Keyword)[Help] : ADD
|
This command allows you to add lines to your existing FDL file. When
you enter the ADD command, the Edit/FDL utility prompts you with the
following menu.
Legal Primary Attributes
ACCESS attributes set the run-time access mode of the file
AREA x attributes define the characteristics of file area x
CONNECT attributes set various RMS run-time options
DATE attributes set the date parameters of the file
FILE attributes affect the entire RMS data file
JOURNAL attributes set the journaling parameters of the file
KEY y attributes define the characteristics of key y
RECORD attributes set the non-key aspects of each record
SHARING attributes set the run-time sharing mode of the file
SYSTEM attributes document operating system-specific items
TITLE is the header line for the FDL file
Enter desired primary (Keyword)[FILE] :
|
After you enter the name of the primary attribute, the Edit/FDL utility
provides another menu showing all the secondary attributes for the
primary attribute and asks which secondary attribute value you want to
change.
|
