1 11/24/86  create_mrds_dm_include, cmdmi
 2 
 3 Syntax as a command:  cmdmi path {-control_args}
 4 
 5 
 6 Function:  This command is a MRDS data model/submodel display tool that
 7 creates an include segment suitable for use in accessing the data base
 8 from PL/I programs via the dsl_ subroutine interface.  Comments are put
 9 in the include file to indicate indexed and key attributes.
10 
11 
12 Arguments:
13 path
14    is the relative or absolute pathname of the data base model or
15    submodel, with or without suffix.  It requires "r" ACL to the data
16    model.  If the data base is secured, then the path must refer to a
17    submodel in the secure.submodels directory under the data base,
18    unless the user is a DBA.  If a suffix is not supplied and both a
19    model and submodel exist in the same directory, then the model is
20    found before the submodel.
21 
22 
23 Control arguments:
24 -based
25    specifies that the resulting include file structure declaration has
26    the "based" PL/I attribute.
27 -no_based
28    specifies that the resulting include file structure declaration does
29    not have the based attribute.  (Default)
30 -order rel_name1 rel_name2...rel_namei
31    specifies that the structures generated for the relations whose
32    names follow this argument are to be placed first in the output
33    segment in the order of their names on the command line.  The
34    structures for relations not named in the ordered list are placed at
35    the end of the output segment in the order in which their names are
36    defined in the data model.  The names following the -order control
37    argument are separated by spaces.
38 
39 -output_file filename, -of filename
40     specifies the name to be assigned to the output segment.
41 -page_length N, -pl N
42    specifies the number of lines allowed between form-feed characters
43    in the output segment, where N=0 or 30<=N<=127.  A page length of 0
44    puts a form feed before each structure.  (Default is 59 lines)
45 -relation rel_name1 rel_name2...rel_namei,
46      -rel rel_name1 rel_name2...rel_namei
47    specifies the names of the relations for which the display is to
48    be created.  The relations will appear in the output segment in the
49    order specified.  The names following -rel are separated by spaces.
50    The -rel control argument is incompatible with -order.
51 
52 
53 Notes:  The output is written to a segment whose name is constructed as
54 follows:
55 
56      <entryname of the input path with the db or dsm suffix
57         removed>.incl.pl1
58 
59    or, if -output_file is specified:
60 
61      <filename>.incl.pl1
62 
63 If the segment does not exist, it is created.
64 
65 If the data base is secured and the user is not a DBA, then the "key"
66 comment on attributes is changed to "indexed" for the key head
67 attribute and remaining key attributes have no comments.
68 
69 If a -decode_declare option exists on an attribute domain, then the
70 declaration appears in the include file since this is the user view and
71 the data base storage data type is not of use.