zowe › dbm-db2 › compare › ddl🖨️

Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.

Usage

zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]

Positional Arguments

• local-input-ddl-filename (string)

  • Specifies the local input file that contains DDL statements for the Db2 objects that you want to compare to Db2 objects on a target subsystem. Typically, this file is created by a 'zowe dbm-db2 generate ddl' command or retrieved from an archive. You can edit this file.

Required Options

• --target-db2 | --td (string)

  • Specifies the target Db2 subsystem ID where the objects that you are comparing reside.

Options

• --match-set | --ms (string)

  • Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

    Format:

    <match-set-creator.match-set-name>

    For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

    Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

• --match-set-file | --msf (string)

  • Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

    Format:

    <object-type> <source-name-mask> <target-name-mask>;

    STOGROUP <name> <name>
    DATABASE <name> <name>
    TABLESPACE <database.name> <database.name>
    TABLE <schema.name> <schema.name>
    INDEX <schema.name> <schema.name>
    VIEW <schema.name> <schema.name>
    SYNONYM <schema.name> <schema.name>
    ALIAS <schema.name> <schema.name>
    TRIGGER <schema.name> <schema.name>
    SEQUENCE <schema.name> <schema.name>
    FUNCTION <schema.name[.version]> <schema.name[.version]>
    PROCEDURE <schema.name[.version]> <schema.name[.version]>

    Note: <schema> must be 8 characters or less. <name> must be 18 characters or less. The SEQUENCE <name> must be 8 characters or less.

    A mask specification can include the following wildcard characters:

    % (percent sign) indicates that zero or more characters can occupy that position. Other non-wildcard characters must match.

    - (hyphen) indicates that any character can occupy that position, but a character must exist at that position.

    * (asterisk) indicates that like named objects on the source and target should be mapped. No other characters can appear together with this character.

    Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

    Example:

    The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

    TABLE MY%.%TABLE YOUR%.%TABLE;
    TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
    TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
    TABLE *.MYTABLE *.YOURTABLE;

    For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

    Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

• --change-set | --cs (string)

  • Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.

    Format:

    <change-set-creator.change-set-name>

    For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

    Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

• --change-set-file | --csf (string)

  • Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.

    Format:

    <object-attribute> <from-value> <to-value>

    The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

    Example:

    The following example demonstrates changes to table’s schema (creator) and tablespace names:

    TBCR TEST% PROD%
    TBTS TESTTS% PRODTS%

    For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

    Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

• --rule-set | --rs (string)

  • Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).

    Format:

    <rule-set-creator.rule-set-name>

    For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

• --id (string)

  • Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem by the execution of this command.

    Format: The name must begin with a non-numeric character, and can consist of the characters A to Z (uppercase only), 0 to 9, $, #, and @.

• --description | -d (string)

  • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.

• --output-compare-script | --ocs (string)

  • Specifies the local output file name that contains the update script to make changes to the target Db2 subsystem.

    Default value: compare.txt

• --output-summary-file | --osf (string)

  • Specifies the local output file name that contains the change summary report in textual format. This report provides an overview of the changes to be performed to the Db2 objects on the target Db2 subsystem, but it does not describe how the changes are made.

    Default value: summary.txt

• --output-impact-file | --oif (string)

  • Specifies the local output file name that contains the parseable impact analysis report in JSON or YAML format. This report helps identify significant DDL operations to be performed on Db2 objects. It provides the total number and type of DDL operations that are being performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.

    The report format is determined by the supplied file name extension: .json for JSON and .yaml or .yml for YAML. If no extension is provided, JSON format is used.

    Default value: impact.json

    For more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.

• --modification | -m (string)

  • Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.

    For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.

• --error-file | --ef (string)

  • Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

    Default value: error.log

Profile Options

• --dbm-db2-profile | --dbm-db2-p (string)

  • The name of a (dbm-db2) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --host | -H (string)

  • Host name of service on the mainframe.

• --port | -P (number)

  • Port number of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

• --password | --pass | --pw (string)

  • Password to authenticate to service on the mainframe.

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:

  • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST Copy

• Generate a script to update objects and apply a rule set for the matched objects:

  • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET Copy

• Generate a script to update objects and apply a rule set for the objects matched as determined by the local mask specifications in the pair.txt file:

  • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt Copy