zowe › dbm-db2 › check › ddl🖨️

Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

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

Positional Arguments

• local-input-ddl-filename (string)

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

Required Options

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

  • Specifies the target Db2 subsystem or data sharing group where you want to use a command.

    Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

Options

• --verify | -v (string)

  • Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

    Default value: no

    Allowed values: yes, no

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

  • Specifies the local output error file in YAML format. The file 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

• --modification | -m (string)

  • Specifies 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 current set of default values.

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

Profile Options

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

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

• --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.

DBM-Db2 Connection Options

• --protocol (string)

  • Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

    Allowed values: http, https

• --environment-list | --el (string)

  • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt

• --job-cards | --jc (array)

  • Specifies a string array of z/OS JCL JOB statements.

• --work-dataset-prefix | --wdp (string)

  • Specifies the prefix (high-level qualifier) in z/OS work data set names.

• --delete-work-datasets | --dwd (boolean)

  • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.

• --overwrite-output-files | --oof (boolean)

  • Specifies whether to overwrite output files if they exist.

• --authid | -a (string)

  • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.

• --sqlid | -s (string)

  • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.

• --base-path | --bp (string)

  • The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

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.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

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

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

Examples

• Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem:

  • zowe dbm-db2 check ddl sample.sql --target-db2 TEST Copy

• Validate DDL statement syntax and verify object dependencies:

  • zowe dbm-db2 check ddl sample.sql --target-db2 TEST --verify yes Copy