CDO$HELP.HLB  —  CDO Commands, SHOW

1  –  ALL

    Format

      SHOW ALL  [ qualifier ]

1.1  –  Qualifiers

1.1.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as data type, for each
    element in the directory and for all children.

1.1.2    /AUDIT

    Displays history list entries for each element. AUDIT=ALL
    displays history list entries for each element and all children.

1.1.3    /BRIEF_(default)

    Displays user-specified properties for each element, and provides
    the names of direct children.

1.1.4    /FULL

    Displays the user-specified properties for the element and for
    all children.

1.2  –  Description

    The SHOW ALL command displays a complete or partial list of
    properties for all visible elements in the default directory.

    If you have your default directory set to a directory in the
    compatibility repository, the SHOW ALL command displays DMU
    record definitions of the CDD$RECORD type, but cannot display
    other definitions that may be stored in your DMU repository. Some
    examples of DMU definitions that CDO cannot display include the
    following:

    o  ACMS application, menu, task group, and task definitions

    o  DATATRIEVE domain, plot, table and view definitions, and
       procedures

    o  DBMS schema, subschemas, security schemas, and storage schemas

    o  Oracle Rdb relation, constraint, index, view, and field
       definitions

    o  TDMS form, request, and request library definitions

    When you display definitions from the compatibility repository,
    CDO displays DMU definitions in CDO format.

    You must have read access to an element for CDO to display
    information on that element.

    CDO displays type definitions only if your default directory is
    set to the CDD$PROTOCOLS directory.

1.3  –  Examples

  CDO>  SHOW ALL

      In this example, because no qualifier is specified, the SHOW
      command displays default BRIEF information. This information
      includes the user-specified properties for each element and the
      names of direct children.

2  –  CHARACTER_SET

    Format

      SHOW  CHARACTER_SET

2.1  –  Description

    Displays the character set of the current CDO session.

    You must set the character-set parameter to DEC_KANJI to use
    Japanese characters with Oracle CDD/Repository. Use the SET
    CHARACTER_SET command to specify the character set for a CDO
    session.

    If the setting has not been specified using the SET CHARACTER_SET
    command, Oracle CDD/Repository references the equivalence name of
    the CDD$CHARACTER_SET logical name. If this logical name is not
    assigned, the default character set is DEC_MCS.

2.2  –  Examples

  CDO>  SHOW CHARACTER_SET
  Session Character_set is DEC_MCS

      In this example the current character set setting is DEC_MCS,
      which supports a set of international alphanumeric characters.

3  –  COLLECTION

    Format

      SHOW COLLECTION   [ qualifier ]  collection-name ,...

3.1  –  Parameters

3.1.1  –  collection-name

    Specifies the collection whose properties you are displaying.

3.2  –  Qualifiers

3.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the
    collection and for all children.

3.2.2    /AUDIT

    Displays history list entries for the collection.

3.2.3    /BRIEF_(default)

    Displays user-specified properties for the collection.

3.2.4    /FULL

    Displays user-specified properties for the collection and for all
    children.

3.3  –  Description

    The SHOW COLLECTION command displays a complete or partial list
    of properties for the collection or collections specified.

    If you do not specify a version number for the collection, CDO
    displays the properties of the highest visible version.

3.4  –  Examples

  CDO>  SHOW COLLECTION MAMMALS

      In this example, because no qualifier is specified, the SHOW
      COLLECTION command displays default BRIEF information. This
      information includes the user-specified properties for the
      MAMMALS collection and the names of direct children.

4  –  CONTEXT

    Format

      SHOW CONTEXT    [ qualifier ]   [ context-name ] ,...

4.1  –  Parameters

4.1.1  –  context-name

    Specifies the context whose properties you are displaying. If
    you omit this parameter, CDO displays the name of the current
    context.

4.2  –  Qualifiers

4.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the
    context and for all children.

4.2.2    /AUDIT

    Displays history list entries for the context.

4.2.3    /BRIEF_(default)

    Displays user-specified properties for the context, and provides
    the names of direct children.

4.2.4    /FULL

    Displays user-specified properties for the context and for all
    children.

4.3  –  Description

    The SHOW CONTEXT command displays a complete or partial list of
    properties for the context or contexts you specify.

    Because a context is a nonversioned element, CDO does not accept
    a branch designation or a version number in the context name.

4.4  –  Examples

  CDO>  SHOW CONTEXT ANIMAL_KINGDOM

      In this example, because no qualifier is specified, the SHOW
      CONTEXT command displays default BRIEF information. This
      information includes the user-specified properties for the
      ANIMAL_KINGDOM context and the names of direct children.

5  –  DATABASE

    Format

      SHOW DATABASE  [ qualifier ]   [ database-name ]

5.1  –  Parameters

5.1.1  –  database-name

    Specifies the physical database whose properties you are
    displaying. By default, if you do not specify a full path name
    for the database, CDO displays all physical database elements in
    your default directory.

5.2  –  Qualifiers

5.2.1    /ALL

    For an RMS database, displays the database name and description,
    record definition, file organization, fully qualified path name,
    and system-specified properties.

    For an Oracle Rdb database, displays the database name, file
    name, and fully qualified path name, as well as the system-
    specified properties.

5.2.2    /AUDIT

    Displays the history list entries for the database definition.
    The /AUDIT=ALL qualifier displays the history list for all
    elements owned by the database.

5.2.3    /BRIEF_(default)

    For an RMS database, displays the database name and description,
    record name, fully qualified path name, and file organization
    properties.

    For an Oracle Rdb database, displays the database name, file
    name, and fully qualified path name.

5.2.4    /FULL

    For an RMS database, displays the database name and description,
    record definition properties, file organization properties, and
    fully qualified path name.

    For an Oracle Rdb database, displays the database name, file
    name, and fully qualified path name.

5.3  –  Description

    The SHOW DATABASE command displays a complete or partial list of
    properties for the database elements specified.

    If you do not specify a version number for a database element,
    CDO displays the highest visible version.

    When you use the SHOW DATABASE command to display an Oracle Rdb
    database element, CDO shows only the database name, file name,
    and the fully qualified path name. Use the SHOW GENERIC command
    with the /FULL qualifier or use SQL (structured query language)
    to view the complete definition of an Oracle Rdb database.

5.4  –  Examples

  CDO>  SHOW DATABASE DEPT5

      In this example, because no qualifier is specified, the SHOW
      DATABASE command displays default BRIEF information. This
      information includes the DEPT5 Oracle Rdb database name, file
      name, and fully qualified path name.

6  –  DEFAULT

    Format

      SHOW DEFAULT

6.1  –  Description

    The SHOW DEFAULT command displays the current default CDO
    repository directory.

    If you set your default directory to a logical name that
    translates to a search list and you issue the SHOW DEFAULT
    command, CDO displays the names of the repository areas in the
    same order as they appear in the search list.

6.2  –  Examples

    1.CDO>  SET DEFAULT MY_DICT
      CDO>  SHOW DEFAULT

      In this example, the SHOW DEFAULT command displays the names of
      the local and remote repository areas specified by the logical
      name MY_DICT.

    2.CDO>  SHOW DEFAULT

      In this example, the SHOW DEFAULT command displays the current
      default CDO directory.

7  –  FIELD

    Format

      SHOW FIELD    [ qualifier ] ...   [ field-name ] ,...

                    [ FROM DATABASE  database-name ]

7.1  –  Parameters

7.1.1  –  field-name

    Specifies the field element whose properties you are displaying.

    When you use the FROM DATABASE clause, specify only one field
    name for each SHOW FIELD command.

    Specify an asterisk (*)  wildcard character for the entire field-
    name parameter only. If you use a wildcard character as part of
    the field-name parameter, an error occurs.

7.1.2  –  database-name

    Specifies the Oracle Rdb database that contains the field. CDO
    requires this parameter for fields from an Oracle Rdb database.
    CDO accepts wildcard characters in the database name.

7.2  –  Qualifiers

7.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the field
    name and for all children.

7.2.2    /AUDIT

    Displays history list entries for the field name. The /AUDIT=ALL
    qualifier displays the history list entries for the field name
    and for all children. Do not use this qualifier if the field name
    you specify is from an Oracle Rdb database definition.

7.2.3    /BRIEF_(default)

    Displays user-specified properties for the field name, and
    provides the names of direct children.

7.2.4    /FULL

    Displays user-specified properties for the field name and for all
    children.

7.2.5    /SYSTEM

    Format options:

       /SYSTEM
       /NOSYSTEM (default)

    Specifies whether CDO displays Oracle Rdb system relations.

7.2.6    /RDB_METADATA

    Format options:

       /RDB_METADATA
       /NORDB_METADATA (default)

    Specifies whether CDO displays Oracle Rdb system relations. This
    qualifier is synonymous with the /SYSTEM qualifier.

7.3  –  Description

    The SHOW FIELD command displays a complete or partial list of
    properties for the field names you specify, provided you have
    read privileges.

    If you do not specify a full path name (or the FROM DATABASE
    clause) for the field name, CDO searches your current default
    directory for the field name. If you do not specify a field name,
    CDO displays the properties of all field names in your default
    directory.

    If you do not specify a version number for a field name, CDO
    displays the properties of the highest visible version.

                                   NOTE

       If you make incompatible changes to the CDD$DATA_ELEMENT
       type, supplied by Oracle CDD/Repository, the SHOW FIELD
       command may not display those properties whose data types
       you have modified.

    If a field has character set attributes, you can display them
    using the SHOW and EXTRACT commands; in addition, you can use
    the SHOW command to display size information of a field in both
    character-based size and octet-based size. See the descriptions
    of SET CHARACTER_SET command and the DATATYPE_Field_Property help
    topic found under the fld-properties topic for
    more information.

7.4  –  Examples

    1.CDO>  SHOW FIELD CORPORATE_ZIPCODE FROM DATABASE DEPT3

      In this example, because no qualifier is specified, the
      SHOW FIELD command displays default BRIEF information. This
      information includes the user-specified properties for the
      CORPORATE_ZIPCODE field name and the names of direct children.

    2.CDO> DEFINE FIELD FULL_NAME
      cont> DATATYPE TEXT CHARACTER_SET KANJI
      cont> SIZE 2 CHARACTERS.
      CDO> SHOW FIELD FULL_NAME
      Definition of field FULL_NAME
      |   Datatype              text size is 2 characters (4 Octets)
      |   Character_set         KANJI

      This example defines and shows the field FULL_NAME.

8  –  FILE_ELEMENT

    Format

      SHOW FILE_ELEMENT  type-name  [ qualifier ]  element-name ,...

8.1  –  Parameters

8.1.1  –  type-name

    Specifies the type (MCS_BINARY or MCS_BINARY subtype) of the
    file element you are displaying. See the Oracle CDD/Repository
    Information Model for information on these types.

8.1.2  –  element-name

    Specifies the file element whose properties you are displaying.

8.2  –  Qualifiers

8.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the file
    element and for all children.

8.2.2    /AUDIT

    Displays history list entries for the file element.

8.2.3    /BRIEF_(default)

    Displays user-specified properties for the file element, and
    provides the names of direct children.

8.2.4    /FULL

    Displays user-specified properties for the file element and for
    all children.

8.3  –  Description

    The SHOW FILE_ELEMENT command displays a complete or partial list
    of properties for the file element or elements you specify.

    If you do not specify a version number for a file element, CDO
    displays the properties of the highest visible version.

8.4  –  Examples

  CDO>  SHOW FILE_ELEMENT MCS_TEXT CAT

      In this example, because no qualifier is specified, the SHOW
      command displays default BRIEF information. This information
      includes the user-specified properties for the CAT file element
      and the names of direct children.

9  –  GENERIC

    Format

      SHOW GENERIC  type-name  [ qualifier ]   [ element-name ]  ,...

                    [ FROM DATABASE  database-name ]

9.1  –  Parameters

9.1.1  –  type-name

    Specifies the type of the generic element whose properties you
    are displaying. This type cannot be MCS_BINARY, a subtype of MCS_
    BINARY, MCS_COLLECTION, MCS_CONTEXT, or MCS_PARTITION. See the
    Oracle CDD/Repository Information Model for information on these
    types.

9.1.2  –  element-name

    Specifies the generic element whose properties you are
    displaying.

    When you use the FROM DATABASE clause, specify only one element
    name for each SHOW GENERIC command.

    Specify an asterisk (*)  wildcard character for the entire
    element-name parameter only. If you use a wildcard character
    as part of the element-name, an error occurs.

9.1.3  –  database-name

    Specifies the Oracle Rdb database that contains the element. CDO
    requires this parameter for elements from an Oracle Rdb database.
    You can include wildcard characters in the database name.

9.2  –  Qualifiers

9.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the
    generic element and for all children.

9.2.2    /AUDIT

    Displays history list entries for the generic element. The
    /AUDIT=ALL qualifier displays the history list for all children.
    CDO displays history list entries only if you specified the
    CDD$HISTORY_LIST relationship as part of this generic element's
    type definition.

9.2.3    /BRIEF_(default)

    Displays user-specified properties for the generic element, and
    provides the names of direct children.

9.2.4    /FULL

    Displays user-specified properties for the generic element and
    for all children. CDO displays description text only if you
    specified the CDD$DESCRIPTION property as part of this generic
    element's type definition.

9.3  –  Description

    The SHOW GENERIC command displays a complete or partial list of
    properties for the generic element or elements you specify.

    If you specify the type name but not an element name, the SHOW
    GENERIC command displays all elements of the specified type
    in your default directory, provided that you have privilege to
    display them.

    You must have read access to all components of the generic
    element for CDO to display those components.

    If you do not specify a version number for a generic element, CDO
    displays the highest visible version.

    You can display a field definition by specifying CDD$DATA_ELEMENT
    as the type name and the name of the field definition as the
    element name.

    You can display a record definition by specifying CDD$DATA_
    AGGREGATE as the type name and the name of the record definition
    as the element name.

    You can display indexes or constraints in an Oracle Rdb database
    element by specifying CDD$INDEX or CDD$CONSTRAINT as the type
    name and the name of the index or constraint as the element name.
    Remember to include the FROM DATABASE clause.

9.4  –  Examples

  CDO>  SHOW GENERIC BOOK REFERENCE_MANUAL

      In this example, because no qualifier is specified, the SHOW
      command displays default BRIEF information. This information
      includes user-specified properties for the REFERENCE_MANUAL
      element and the names of direct children.

10  –  KEY

    Format

      SHOW KEY  [ qualifier ] ...   [ key-name ]

10.1  –  Parameters

10.1.1  –  key-name

    Specifies the key whose properties you are displaying.

10.2  –  Qualifiers

10.2.1    /ALL

    Displays all key definitions in a key state. You cannot use the
    /ALL qualifier if you specify one or more key names.

10.2.2    /BRIEF_(default)

    Displays the key definition and state.

10.2.3    /DIRECTORY

    Format options:

       /DIRECTORY
       /NODIRECTORY (default)

    Displays the names of all states for which you have defined keys.
    If you specify the /DIRECTORY qualifier, you cannot specify any
    other SHOW KEY qualifiers.

10.2.4    /FULL

    Format options:

       /FULL
       /NOFULL (default)

    Displays all qualifiers for the key definition you specify.
    Specifying the /NOFULL qualifier gives the same results as the
    /BRIEF qualifier.

10.2.5    /STATE

    Format options:

       /STATE=key-state
       /NOSTATE (default)

    Displays key definitions for the state you specify. The /NOSTATE
    qualifier displays key definitions for the current state.

10.3  –  Description

    The SHOW KEY command displays a complete or partial list of
    properties for the key you specify.

    If you do not specify a key name, CDO displays the definition for
    all keys.

    You use the DEFINE KEY command to create key definitions.

10.4  –  Examples

  CDO>  SHOW KEY PF3

      In this example, because no qualifier is specified, the SHOW
      command displays default BRIEF information. This information
      includes the key definition and state for the PF3 key.

11  –  NOTICES

    Format

      SHOW NOTICES  element-name  ,...

11.1  –  Parameters

11.1.1  –  element-name

    Specifies the element whose notices you are displaying.

11.2  –  Description

    The SHOW NOTICES command displays the notices at the element or
    elements you specify. CDO sends notices to elements when you:

    o  Change an element and the change affects other elements.
       For example, if you change the name of a field element in a
       database, the database element may need to be integrated.

    o  Change an element and the change affects the parent. For
       example, if you delete the name of a record element in a
       database, the database element needs to be integrated.

    o  Create a new version of an element. For example, if you create
       a new record element that appears in a program, the program
       needs to be recompiled.

    If you issue the SHOW NOTICES command for an element that does
    not have notices, CDO informs you that the element does not have
    notices.

    You can display new version notices by using the SHOW NOTICES
    command at any of the member's parents that have a CDD$NOTICE_
    ACTION property value of SUCCESS or SIGNAL.

    You can display notices that the CHANGE command generates by
    using the SHOW NOTICES command at any of the member's parents
    that have a CDD$NOTICE_ACTION property value of SIGNAL.

    CDO sends notices when you either change a member of a
    relationship with the CHANGE command or you define a new version
    of the member.

    The three types of notices that definitions receive and the
    meanings of these notices are:

    o  CDD$K_POSSIBLY_INVALID

       A definition used by this definition has changed. This change
       might affect this definition. This notice indicates the name
       of the definition that changed.

    o  CDD$K_INVALID

       A definition used by this definition changed or was removed
       from the repository. This definition is invalid. If a changed
       definition initiated the notice, the notice supplies the
       name of the definition. If a deleted definition initiated
       the notice, the notice does not supply a definition name.

    o  CDD$K_NEW_VERSION

       A new version of a definition used by this definition was
       created. The notice supplies the name of the definition that
       has the new version.

    o  CDD$K_CHILD_USAGE

       A relationship from one of the definitions used by this
       element to one of its children was changed. The notice
       indicates the owner of the changed relationship. You cannot
       generate this type of notice using CDO. Only programs using
       the Oracle CDD/Repository callable interface can cause this
       notice. You can, however, read this type of notice using CDO.

11.3  –  Examples

    1.CDO>  SHOW NOTICES EMPLOYEE_REC
         .
         .
         .
      CDO>  CLEAR NOTICES EMPLOYEE_REC

      In this example, the SHOW NOTICES command displays notices
      sent to the EMPLOYEE_REC record. You can clear any notices by
      issuing the CLEAR NOTICES command.

    2.CDO>  CHANGE FIELD FLD_A
      cont>   DATATYPE IS SIGNED LONGWORD.
      %CDO-I-DBMBR, database DISK1:[SMITH.DICT]MY_RDB_DB(1) may need to be
        integrated
      CDO>  SHOW NOTICES MY_RDB_DB
      DISK1:[SMITH.DICT]MY_RDB_DB(1) is possibly invalid, triggered by entity
      DISK1:[SMITH.DICT]FLD_A(1)
      CDO>

      In this example, CDO sends a notice that a database might
      require integration as a consequence of the CHANGE command.

      You can use the SHOW NOTICES command to display this notice at
      the MY_RDB_DB database definition.

    3.CDO>  DEFINE FIELD FLD_B
      cont> DATATYPE SIGNED LONGWORD.
      CDO>  SHOW NOTICES REC_B
      DISK1:[SMITH.DICT]RDB_REC_B(1) uses an entity which has new versions,
      triggered by CDD$DATA_ELEMENT DISK1:[SMITH.DICT]FLD_B(1)
      CDO>  SHOW NOTICES MY_RDB_DB
      DISK1:[SMITH.DICT]MY_RDB_DB(1) uses an entity which has new versions,
      triggered by CDD$DATA_ELEMENT DISK1:[SMITH.DICT]FLD_B(1)
      DISK1:[SMITH.DICT]MY_RDB_DB(1) is possibly invalid, triggered by
      CDD$DATA_ELEMENT DISK1:[SMITH.DICT]FLD_A(1)

      When you create a new version of the FLD_B field definition by
      using the DEFINE FIELD command, CDO sends new version notices
      to the parents of FLD_B. The following set of examples shows
      this sequence of events:

      1. The DEFINE FIELD command creates a new version of the FLD_B
         field definition.

      2. The first SHOW NOTICES command shows that FLD_B's immediate
         parent, REC_B record definition received the new version
         notice when CDO created the new version of FLD_B.

      3. The second SHOW NOTICES command shows two notices at the
         MY_RDB_DB CDD$DATABASE definition. The CHANGE command sends
         one notice on behalf of the FLD_A field definition from the
         previous example, and the DEFINE FIELD command sends a new
         version notice on behalf of the new version of the FLD_B
         field definition.

    4.CDO> CLEAR NOTICES MY_RDB_DB
      CDO>  SHOW NOTICES MY_RDB_DB
      %CDO-I-NONOTICES, DISK1:[SMITH.DICT]MY_RDB_DB(1) has no notices

      To clear the notices at MY_RDB_DB, use the CLEAR NOTICES
      command.

      To verify that you cleared the notices at MY_RDB_DB, use the
      SHOW NOTICES command. If you ask to see the notices at a
      definition without notices, CDO responds that there are no
      notices.

12  –  PARTITION

    Format

      SHOW PARTITION  [ qualifier ]   partition-name ,...

12.1  –  Parameters

12.1.1  –  partition-name

    Specifies the partition whose properties you are displaying.

12.2  –  Qualifiers

12.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the
    partition and for all children.

12.2.2    /AUDIT

    Displays history list entries for the partition.

12.2.3    /BRIEF_(default)

    Displays user-specified properties for the partition, and
    provides the names of direct children. /BRIEF is the default
    qualifier.

12.2.4    /FULL

    Displays user-specified properties for the partition and for all
    children.

12.3  –  Description

    The SHOW PARTITION command displays a complete or partial list of
    properties for the partition or partitions specified.

    Because a partition is a nonversioned element, CDO does not
    accept a branch designation or a version number in partition
    names.

12.4  –  Examples

  CDO>  SHOW PARTITION INITIAL_PROPOSAL

      In this example, because no qualifier is specified, the SHOW
      PARTITION command displays default BRIEF information. This
      information includes the user-specified properties for the
      INITIAL_PROPOSAL partition and the names of direct children.

13  –  PRIVILEGES

    Format

                           { DIRECTORY }
      SHOW PRIVILEGES  FOR { FIELD     }  element-name ,...
                           { RECORD    }
                           {           }

      SHOW PRIVILEGES  FOR   GENERIC  type-name

      SHOW PRIVILEGES  FOR   REPOSITORY  anchor-name

13.1  –  Parameters

13.1.1  –  element-name

    Specifies the element whose access rights you are displaying.

13.1.2  –  type-name

    Specifies the type of the generic element.

13.1.3  –  anchor-name

    Specifies the anchor directory of the repository for which you
    want to display privileges.

13.2  –  Description

    The SHOW PRIVILEGES command displays the access rights for the
    elements you specify.

    To display your privileges for a type, use the SHOW PROTOCOL
    command.

13.3  –  Examples

  CDO>  SHOW PRIVILEGES FOR FIELD CURRENT_SALARY

      In this example, the SHOW PRIVILEGES command displays your
      access rights to the CURRENT_SALARY field element.

14  –  PROTECTION

    Format

                           { DIRECTORY          }
                           { FIELD              }
      SHOW PROTECTION  FOR { RECORD             }  element-name ,...
                           {                    }
                           { GENERIC  type-name }

      SHOW PROTECTION  FOR   REPOSITORY  anchor-name

14.1  –  Parameters

14.1.1  –  type-name

    Specifies the type of the generic element.

14.1.2  –  element-name

    Specifies the element whose ACL you are displaying.

14.1.3  –  anchor-name

    Specifies the repository anchor whose ACL you are displaying.

14.2  –  Description

    The SHOW PROTECTION command displays the access control list
    (ACL) for the element you specify. When you specify FOR GENERIC
    MCS_CONTEXT or FOR REPOSITORY, SHOW PROTECTION also displays the
    default access control list.

    To display the access control list for a type, you can also use
    the SHOW PROTOCOL command.

14.3  –  Examples

    1.CDO>  SHOW PROTECTION FOR FIELD CURRENT_SALARY

      In this example, the SHOW PROTECTION command displays the
      access control list for the CURRENT_SALARY field definition.

    2.CDO> SHOW PROTECTION FOR REPOSITORY CDD$REPOSITORY2

      In this example, Oracle CDD/Repository translates the logical
      name for the repository.

15  –  PROTOCOL

    Format

      SHOW PROTOCOL  [ qualifier ]   type-name ,...

15.1  –  Parameters

15.1.1  –  type-name

    Specifies the type whose properties you are displaying.

15.2  –  Qualifiers

15.2.1    /ALL

    Displays all the possible relationships the type can own, as well
    as the access control list for the type.

15.2.2    /AUDIT

    Displays the history list entries for the type. Specifying
    the /AUDIT=ALL qualifier displays the history list for all the
    relationships that the type owns.

15.2.3    /FULL

    Displays all the possible relationships this type can own.

15.2.4    /BRIEF_(default)

    Displays the relationships most commonly owned by this type.
    /BRIEF is the default qualifier.

15.3  –  Description

    The SHOW PROTOCOL command displays a complete or partial list of
    properties for the type or types you specify.

    CDO looks for types in the CDD$PROTOCOLS directory below your
    current default anchor. It is not necessary to set default to the
    CDD$PROTOCOLS directory to display types.

    CDO uses relationships to pass notices among repository
    definitions. Every relationship protocol in the repository has
    the CDD$NOTICE_ACTION property, whose value controls the passing
    of notices. You can use the CDO SHOW PROTOCOL command to display
    the value of the CDD$NOTICE_ACTION property.

    The CDD$NOTICE_ACTION property can have one of three values:

    o  SUCCESS

       When you change a member of the relationship with the CHANGE
       command and the CDD$NOTICE_ACTION property value is SUCCESS,
       CDO does not send notices to the owner of the relationship.
       Instead, CDO sends notices to the owner's parents, provided
       that the parents are members of a relationship with the
       CDD$NOTICE_ACTION attribute value of SIGNAL.

       CDO continues to send these notices until the member you
       are changing has no more parents or until CDO encounters the
       CDD$NOTICE_ACTION property value BLOCK.

       When you define a new version of a member and the CDD$NOTICE_
       ACTION attribute value is SUCCESS, CDO sends notices to both
       the owner of the relationship and the owner's parents, until
       CDO encounters the CDD$NOTICE_ACTION property value of BLOCK
       or until there are no more parents.

    o  SIGNAL

       When you change the member with the CHANGE command or when you
       define a new version of the member and the CDD$NOTICE_ACTION
       attribute value is SIGNAL, CDO sends a notice to both the
       owner and the parents of a relationship.

       When you define a new version of a member, CDO also sends
       notices to the parents until CDO encounters the CDD$NOTICE_
       ACTION property value of BLOCK or until there are no more
       parents.

    o  BLOCK

       When the CDD$NOTICE_ACTION property value is BLOCK, CDO
       does not forward a notice from the member to the owner. CDO
       blocks the notice regardless of whether you are changing the
       member with the CHANGE command or defining new versions of the
       member.

15.4  –  Examples

    1.CDO>  SHOW PROTOCOL CDD$DATA_AGGREGATE_CONTAINS

      In this example, because no qualifier is specified, the SHOW
      PROTOCOL command displays default BRIEF information. This
      information includes the user-specified properties for the
      CDD$DATA_AGGREGATE_CONTAINS type and the names of direct
      children.

    2.CDO> SHOW PROTOCOL CDD$DATABASE_SCHEMA
      Definition of protocol CDD$DATABASE_SCHEMA    (Type :MCS_RELATION_TYPE)
       |   MCS_rdbRelation                 CDD$$O_DATABASE_REL
       |   MCS_groupingRelation            NO_GROUPING
       |   MCS_noticeAction                SIGNAL
       |   CDD$OBJECT_KIND                 CDD$RELATIONSHIP
       |   MCS_protocolMajor               1
       |   MCS_protocolMinor               0
       |   MCS_tag                         2818865
       |   MCS_createdDate                 14-MAR-1994 09:13:32.42
       |   CDD$MODIFIED_TIME               14-MAR-1994 09:13:32.42
       |   MCS_instantiable                1
       |   MCS_pattern
       |   MCS_status                      0
       |   MCS_freezeTime                  14-MAR-1994 09:13:32.42
       |   MCS_controlled                  1
       |   MCS_allowConcurrent             1
       |   MCS_HAS_PROPERTY
       |   |   MCS_attachment              (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_inherited               (Type : MCS_PROPERTY_TYPE)
       |   |   CDD$PROTOCOL_TAG            (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_containsDatabases       (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_relOwner                (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_relMember               (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_databaseElement         (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_elementType             (Type : MCS_PROPERTY_TYPE)
       |   |   MCS_allElementTypes         (Type : MCS_PROPERTY_TYPE)
       |   MCS_HAS_RELATION
       |   |   CDD$DATABASE                (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$DATABASE                (Type : MCS_ELEMENT_TYPE)
       |   MCS_RELATION_MEMBER
       |   |   CDD$DATA_AGGREGATE          (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$RDB_DATABASE            (Type : MCS_ELEMENT_TYPE)
       |   |   DBM$SCHEMA                  (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$RMS_DATABASE            (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$DATA_AGGREGATE          (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$RDB_DATABASE            (Type : MCS_ELEMENT_TYPE)
       |   |   DBM$SCHEMA                  (Type : MCS_ELEMENT_TYPE)
       |   |   CDD$RMS_DATABASE            (Type : MCS_ELEMENT_TYPE)
       |   MCS_OBJECT_VALIDATION
       |   |   CDD$RELATION_VAL            (Type : MCS_VALIDATION)
       |   |   CDD$ELEMENT_VAL             (Type : MCS_VALIDATION)

      In this example, the SHOW PROTOCOL command displays the
      CDD$NOTICE_ACTION property of SIGNAL for the CDD$DATABASE_
      SCHEMA relationship.

16  –  RECORD

    Format

      SHOW RECORD  [ qualifier ] ...   [ record-name ] ,...

                   [ FROM DATABASE  database-name ]

16.1  –  Parameters

16.1.1  –  record-name

    Specifies the record, relationship, or view whose properties you
    are displaying.

    When you use the FROM DATABASE clause, specify only one record
    name for each SHOW RECORD command.

    Specify an asterisk (*)  wildcard character for the entire
    record-name parameter only. If you use a wildcard character as
    part of the record name, an error occurs.

16.1.2  –  database-name

    Specifies the Oracle Rdb database that contains the record. CDO
    requires this parameter for records from an Oracle Rdb database.
    You can include wildcard characters in the database name.

16.2  –  Qualifiers

16.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the
    record element and for all children.

16.2.2    /AUDIT

    Displays history list entries for the record element. Specifying
    the /AUDIT=ALL qualifier displays the history list entries
    for the record element and for all children. Do not use this
    qualifier if the record you specify is from an Oracle Rdb
    database definition.

16.2.3    /BRIEF_(default)

    Displays user-specified properties for the record element, and
    provides the names of direct children. /BRIEF is the default
    qualifier.

16.2.4    /FULL

    Displays user-specified properties for the record element and for
    all children.

16.2.5    /SYSTEM

    Format options:

       /SYSTEM
       /NOSYSTEM (default)

    Specifies whether CDO displays Oracle Rdb system relations.

16.2.6    /RDB_METADATA

    Format options:

       /RDB_METADATA
       /NORDB_METADATA (default)

    Specifies whether CDO displays Oracle Rdb system relations. This
    qualifier is synonymous with the /SYSTEM qualifier.

16.3  –  Description

    The SHOW RECORD command displays a complete or partial list of
    properties for the record elements you specify, provided you have
    read privilege.

    If you do not specify a full path name (or the FROM DATABASE
    clause), CDO searches your current default directory for the
    record name. If you do not specify a record name, CDO displays
    the properties of all record elements in your default directory.

    If you do not specify a version number for a record element, CDO
    displays the properties of the highest visible version.

    If you do not have read privilege for a record and for each
    component part of that record, CDO will not display the record
    name or properties.

16.4  –  Examples

  CDO>  SHOW RECORD ADDRESS_RECORD
  cont>   FROM DATABASE SUBSCRIPTIONS

      In this example, because no qualifier is specified, the SHOW
      RECORD command displays default BRIEF information. This
      information includes the user-specified properties for the
      ADDRESS_RECORD record element and the names of direct children.

17  –  REPOSITORIES

    Format

      SHOW REPOSITORIES  [ qualifier ]

17.1  –  Qualifiers

17.1.1    /FULL

    Displays the elements within other repositories being referenced
    by your repository.

17.2  –  Description

    The SHOW REPOSITORIES command scans your repository for
    dependencies on elements in other repositories. The command
    displays the name of these other repositories and, if you specify
    the /FULL qualifier, the names of the elements.

17.3  –  Example

  CDO>  SHOW REPOSITORIES

      In this example, because no qualifier is specified, the SHOW
      REPOSITORIES command displays the names of the repositories
      that your repository references.

18  –  RESERVATIONS

    Format

      SHOW RESERVATIONS  [ qualifier ]

18.1  –  Qualifiers

18.1.1    /ALL

    Displays all the reserved elements, their types, and the contexts
    reserving them throughout the repository.

18.1.2    /BRIEF_(default)

    Displays reserved elements and their types in your current
    context. /BRIEF is the default qualifier.

18.2  –  Description

    The SHOW RESERVATIONS command displays the reserved elements for
    your current context or for the entire repository.

    An error occurs if a context has not been set.

18.3  –  Examples

  CDO>  SET CONTEXT PERSONNEL
  CDO>  RESERVE COLLECTION OFFICERS
  CDO>  SHOW RESERVATIONS
     .
     .
     .
  CDO>  REPLACE COLLECTION OFFICERS
  CDO>  SHOW RESERVATIONS
     .
     .
     .

      In this example, the first SHOW RESERVATIONS command displays
      the reserved elements, their types, and the reserving context.
      The second SHOW RESERVATIONS command displays an informational
      notice indicating that no elements are reserved.

19  –  RMS_DATABASE

    Format

      SHOW RMS_DATABASE  [ qualifier ]   [ rms-database-name ]

19.1  –  Parameters

19.1.1  –  rms-database-name

    Specifies the logical RMS database element whose properties you
    are displaying.

    If you do not specify an RMS database name, CDO displays all the
    RMS database definitions in the repository.

19.2  –  Qualifiers

19.2.1    /ALL

    Displays system-specified properties, such as time of creation,
    and user-specified properties, such as description, for the RMS
    database element and all children.

19.2.2    /AUDIT

    Displays history list entries for the RMS database element.
    Specifying the /AUDIT=ALL qualifier displays the history list
    for the database element and for all children.

19.2.3    /BRIEF_(default)

    Displays the file organization properties for the RMS database
    element. /BRIEF is the default qualifier.

19.2.4    /FULL

    Displays the file organization properties, the record definition,
    and the description for the logical RMS database element.

19.3  –  Description

    The SHOW RMS_DATABASE command displays a complete or partial list
    of properties for the RMS database element you specify.

    If you do not specify a version number for an RMS database
    element, CDO displays the highest visible version.

    When you use SHOW RMS_DATABASE or SHOW RMS_DATABASE/FULL to
    display an RMS database element with a NULL_VALUE property, CDO
    displays the null value as a decimal value.

19.4  –  Examples

  CDO>  SHOW RMS_DATABASE EMPLOYEE_STORAGE

      In this example, because no qualifier is specified, the SHOW
      RMS_DATABASE command displays default BRIEF information. This
      information includes the user-specified properties for the
      EMPLOYEE_STORAGE RMS database definition and the names of
      direct children.

20  –  UNUSED

    Format

      SHOW UNUSED  [ qualifier ] ...   element-name ,...

20.1  –  Parameters

20.1.1  –  element-name

    Specifies the element whose relationships you are investigating.

20.2  –  Qualifiers

20.2.1    /TYPE

    Format option:

       /TYPE=[ ( type-name ) ] ,...

    endcondition> Displays only owners or members of the type you
    specify. This type must be the keyword RECORD or FIELD or a
    type name that is valid for this command. Valid types include
    instances of ELEMENT_TYPE or RELATIONSHIP_TYPE; they do not
    include instances of PROPERTY_TYPE.

20.2.2    /BRIEF_(default)

    Displays the immediate owners and members of the element. /BRIEF
    is the default qualifier.

20.2.3    /FULL

    Displays all owners and members of the element.

20.3  –  Description

    The SHOW UNUSED command determines whether an element has owners
    or members. The element must have a directory name.

    If the element does not have owners or members, the name and
    type of the element is displayed. If the element has owners
    or members, CDO sends an informational notice. If you receive
    an informational notice, issue the SHOW USES and SHOW USED_BY
    commands to identify these owners or members.

20.4  –  Examples

    1.CDO>  SHOW UNUSED EMPLOYEE_DB

      In this example, because no qualifier is specified, the
      SHOW UNUSED command displays default BRIEF information. This
      information includes the names of immediate owners or members
      of the EMPLOYEE_DB database element.

    2.CDO>  SHOW UNUSED /FULL FIELD_A(2)

      In this example, the SHOW UNUSED command with the /FULL
      qualifier displays all owners or members of the FIELD_A(2)
      field element.

    3.CDO>  SHOW UNUSED /FULL /TYPE=(FIELD) EMPLOYEE_REC

      In this example, the SHOW UNUSED command with the /FULL and
      /TYPE qualifiers displays all owners or members of EMPLOYEE_REC
      that are fields.

21  –  USED_BY

    Format

      SHOW USED_BY  [ qualifier ] ...   element-name ,...

21.1  –  Parameters

21.1.1  –  element-name

    Specifies the element whose children you are displaying.

21.2  –  Qualifiers

21.2.1    /TYPE

    Format option:

       /TYPE=[ ( type-name ) ] ,...

    Displays only children of the type you specify. This type must
    be the keyword RECORD or FIELD or a type name that is valid for
    this command. Valid types include instances of ELEMENT_TYPE or
    RELATIONSHIP_TYPE; they do not include instances of PROPERTY_
    TYPE.

21.2.2    /BRIEF_(default)

    Displays the name, type, and relationship type of immediate
    children. /BRIEF is the default qualifier.

21.2.3    /FULL

    Displays the name, type, and relationship type of all children.

21.3  –  Description

    The SHOW USED_BY command displays the children of the element you
    specify. The display includes the properties of children and the
    values associated with these properties.

    The SHOW USED_BY command lists children if they have either
    directory or processing names. CDO looks first for the directory
    name and displays it if one exists. If a directory name does not
    exist, CDO then looks for and displays the processing name.

    A definition can only exist in the repository without a directory
    or processing name if it has a relationship to an owner that has
    a directory name. CDO displays a name unspecified message in this
    case.

    To display Oracle Rdb database definitions, specify the name
    of the database as the element-name parameter and use the
    /FULL qualifier. Because CDO displays the full path name of
    each repository element, you can use the SHOW USED_BY command
    to determine where each instance of a particular element occurs
    and how it relates to other elements.

21.4  –  Examples

    1.CDO>  SHOW USED_BY EMPLOYEE_DB

      In this example, because no qualifier is specified, the SHOW
      USED_BY command displays the default information (/BRIEF). This
      information includes the names of immediate children of the
      EMPLOYEE_DB database element.

    2.CDO>  SHOW USED_BY /FULL FIELD_A(2)

      In this example, the SHOW USED_BY command with the /FULL
      qualifier displays all children of the FIELD_A(2) field
      element.

    3.CDO>  SHOW USED_BY /FULL /TYPE=(FIELD) EMPLOYEE_REC

      In this example, the SHOW USED_BY command with the /FULL and
      /TYPE qualifiers displays all children of EMPLOYEE_REC that are
      fields.

22  –  USES

    Format

      SHOW USES  [ qualifier ] ...   element-name ,...

22.1  –  Parameters

22.1.1  –  element-name

    Specifies the element whose owners you are displaying.

22.2  –  Qualifiers

22.2.1    /TYPE

    Format option:

       /TYPE=[ ( type-name ) ] ,...

 Displays only owners of the type you specify. This type must be
 the keyword RECORD or FIELD or a type name that is valid for
 this command. Valid types include instances of ELEMENT_TYPE or
 RELATIONSHIP_TYPE; they do not include instances of PROPERTY_TYPE.

22.2.2    /BRIEF_(default)

    Displays the name, type, and relationship type of immediate
    owners. /BRIEF is the default qualifier.

22.2.3    /FULL

    Displays the name, type, and relationship type of all owners.

22.3  –  Description

    The SHOW USES command displays the owners of the element you
    specify. The display includes the properties of owners and the
    values associated with these properties.

    The SHOW USES command lists owners if they have either directory
    names or processing names. CDO looks first for the directory
    name and displays it if one exists. If a directory name does not
    exist, CDO then looks for and displays the processing name.

    An element can only exist in the repository without a directory
    or processing name if it has a relationship to an owner with a
    directory name. CDO displays a name unspecified message in this
    case.

    You can use the SHOW USES command to display the names of
    elements that receive new version messages if you create a new
    version of the element you specify.

22.4  –  Examples

    1.CDO>  SHOW USES EMPLOYEE_DB

      In this example, because no qualifier is specified, the SHOW
      USES command displays the default information (/BRIEF). This
      information includes the names of immediate owners of the
      EMPLOYEE_DB database element.

    2.CDO>  SHOW USES /FULL FIELD_A(2)

      In this example, the SHOW USES command with the /FULL qualifier
      displays all owners of the FIELD_A(2) field element.

    3.CDO>  SHOW USES /FULL /TYPE=(RECORD) EMPLOYEE_NAME

      In this example, the SHOW USES command with the /FULL and
      /TYPE qualifiers displays all owners of EMPLOYEE_NAME that are
      records.

23  –  VERSION

    Format

      SHOW VERSION

23.1  –  Description

    The SHOW VERSION command displays the following information about
    one or more respositories that you have invoked and to which the
    CDO session is currently attached:

    o  Version number of Oracle CDD/Repository that is installed on
       your system

    o  Major and minor version numbers of each repository

    o  Fully qualified name of each repository

    o  Version numbers of Oracle CDD/Repository with which each
       repository is compatible

    If you issue the SHOW VERSION command and you have not invoked a
    repository during the CDO session, CDO displays only the version
    of Oracle CDD/Repository that is currently installed.

    Commands such as DEFINE FIELD or SHOW FIELD will invoke a
    repository; however, the SET DEFAULT or SHOW DEFAULT commands
    will not. If you issue a DIRECTORY command and the repository
    contains elements, the session will invoke a repository.

23.2  –  Examples

    1.CDO>  SHOW DEFAULT
      CDO>  SHOW VERSION
      Installed version of Oracle CDD/Repository is V7.0.1

      In this example, the SHOW DEFAULT command does not invoke
      a repository. Therefore, the SHOW VERSION command displays
      only the version of Oracle CDD/Repository that is currently
      installed.

    2.CDO>  SHOW FIELD
      Definition of field A1
      |   Datatype                 text size is 1 characters
      |   Row_major array          1:4
      Definition of field A1_KEY
      |   Datatype                 text size is 1 characters
         .
         .
         .
      CDO> SHOW VERSION
      Installed version of Oracle CDD/Repository is V7.0.1
      Attached to repository
      CDD$R0:[SMITH.REPOS3]
      Repository Version V6.1 / V7.0.1
      Internal Major Version 26
      Internal Minor Version 3

      In this example, the SHOW FIELD command invokes a repository.
      Consequently, the SHOW VERSION command displays information
      about the repository to which it is attached.

24  –  WHAT_IF

    Format

      SHOW WHAT_IF  [ qualifier ] ...   element-name ,...

24.1  –  Parameters

24.1.1  –  element-name

    Specifies the element you are considering changing.

24.2  –  Qualifiers

24.2.1    /TYPE

    Format option:

       /TYPE=[ ( type-name ) ] ,...

    Displays those owners of the type you specify that could possibly
    receive an invalid notice if you perform a change in location
    with the CHANGE command. This type must be the keyword RECORD or
    FIELD or a type name that is valid for this command. Valid types
    include instances of ELEMENT_TYPE or RELATIONSHIP_TYPE; they do
    not include instances of PROPERTY_TYPE.

24.2.2    /BRIEF_(default)

    Displays the name, type, and relationship type of immediate
    owners that receive a possibly invalid notice if you perform a
    change in location with the CHANGE command. /BRIEF is the default
    qualifier.

24.2.3    /FULL

    Displays the name, type, and relationship type of all owners
    that receive a possibly invalid notice if you perform a change in
    location with the CHANGE command.

24.3  –  Description

    The SHOW WHAT_IF command displays the owners that are affected
    if the element you specify is modified by the CHANGE command. For
    the owners to be displayed, the relationship between owner and
    member must have an associated CDD$NOTICE_ACTION property value
    of SIGNAL.

    Owners with this property value generally represent an object
    outside the repository, such as a database. Each owner receives a
    possibly invalid warning if you issue the CHANGE command for the
    specified element.

    To determine the CDD$NOTICE_ACTION property value of a
    relationship, use the SHOW PROTOCOL command.

    The SHOW WHAT_IF command lists owners if they have either
    directory or processing names. CDO looks first for the directory
    name and displays it if one exists. If a directory name does not
    exist, CDO then looks for and displays the processing name.

    An element can only exist in the repository without either
    a directory or processing name if it has a relationship to
    an element that has a directory name. CDO displays the name
    unspecified message in this case.

24.4  –  Examples

    1.CDO>  SHOW WHAT_IF EMPLOYEE_DB

      In this example, because no qualifier is specified, the SHOW
      WHAT_IF command displays the default information (/BRIEF). This
      information includes the names of immediate owners that receive
      a possibly invalid notice if you issue the CHANGE command for
      EMPLOYEE_DB.

    2.CDO>  SHOW WHAT_IF /FULL FIELD_A(2)

      In this example, the SHOW WHAT_IF command with the /FULL
      qualifier displays all owners that receive a possibly invalid
      notice if you issue the CHANGE command for FIELD_A(2).

    3.CDO>  SHOW WHAT_IF /FULL /TYPE=(CDD$DATABASE) EMPLOYEE_REC

      In this example, the SHOW WHAT_IF command with the /FULL and
      /TYPE qualifiers displays all owners of the CDD$DATABASE type
      that receive a possibly invalid notice if you issue the CHANGE
      command for EMPLOYEE_REC.
Close Help