@broadcom/dbm-db2-for-zowe-cli

# DBM for Db2 Plug-in for Zowe CLI <img align="left" hspace="10px" src="https://techdocs.broadcom.com/us/en/ca-mainframe-software/devops/enterprise-support-for-zowe/1-0/_jcr_content/assetversioncopies/b9afc43d-e446-4ec2-8e36-589e9a70f1cc.original.png" width="200" alt="Zowe V2 conformant CLI"/> The DBM for Db2 Plug-in for Zowe CLI lets database administrators, application developers, and DevOps engineers interact with Db2 for z/OS using the Database Management Solutions for Db2 from the Zowe CLI interface. <br clear="left"/> Using the DBM for Db2 Plug-in for Zowe CLI, you can: - Generate DDL statements for one or more Db2 objects and related objects to make schema changes. - Validate DDL statement (schema) changes and verify that you can create Db2 objects that have dependencies on the target subsystem. - Deploy schema changes to a target Db2 subsystem. - Compare schema changes to a target Db2 subsystem in preparation of promoting the changes to the subsystem. - Migrate Db2 objects and data from one Db2 subsystem to another. <img align="right" hspace="10px" src="https://techdocs.broadcom.com/us/en/ca-mainframe-software/database-management/ca-database-management-solutions-for-db2-for-z-os/20/_jcr_content/assetversioncopies/b11d6b5f-ff10-4cf1-8e9a-fe265c1179f7.original.png" width="300" alt="DevOps code, build, test provisioning workflow"/> Use the DBM for Db2 Plug-in for Zowe CLI to integrate Db2 schema provisioning and deployment into continuous integration/continuous development (CI/CD) pipelines and continue to leverage your existing investment in the Database Management Solutions for Db2 by reusing global change sets, compare rule sets, and mask specifications from RC/Migrator. ## Prerequisites To use the DBM for Db2 Plug-in for Zowe CLI, address the following prerequisites: 1. Ensure that RC/Migrator and RC/Compare Version 20.0 is configured and running and that you are current with maintenance. 2. Ensure that the DBM Data Service is configured and running.\ \ This task assumes that you have completed the post-installation configuration tasks for the Batch Processor, the DBM Data Service, the Xmanager, Xnet, and RC/Migrator. DBM Data Service customization includes customizing the DevOps templates, which can be used with the zowe dbm-db2 commands. For more information, see Customize the DBM Data Service REST API in the [Database Management Solutions for Db2 documentation]. 3. Review the Zowe CLI, Zowe CLI Plug-in, and other software requirements.\ \ For more information, see Address Software Requirements for Zowe CLI and Zowe CLI Plug-ins in the [Enterprise Support for Zowe] documentation. 4. Install Zowe CLI and Zowe CLI Plug-ins.\ \ Install the core Zowe CLI and plug-ins using a local package, or from an [NPM public online registry], or a Broadcom online registry. For more information, see Install Zowe CLI and Zowe CLI Plug-ins in the [Enterprise Support for Zowe] documentation. 5. Address profile requirements. ## Installation To install the plug-in version compatible with Zowe CLI V2, enter:\ `zowe plugins install @broadcom/dbm-db2-for-zowe-cli@zowe-v2-lts` To update your existing plug-in to the most recent version, enter:\ `zowe plugins update @broadcom/dbm-db2-for-zowe-cli` ## Profile Requirements Create a `dbm-db2` user profile to avoid entering your connection details, user credentials, and execution details each time that you issue a dbm-db2 command. You can create multiple profiles and switch between them as needed. Use `dbm-db2-options` profiles to store relevant options for a specific Db2 subsystem or sandbox. For example, you can define global change specifications to modify object attributes before promoting changes, or use a specific modification that invokes a JCL template with additional cleanup steps. You can also hardcode the source and target Db2 subsystems to reduce the number of parameters that you need to specify during command invocation. The dbm-db2 profile includes: - JOB statement information (jobCards). - The work data set prefix for data sets that are created during execution of the commands. - User credentials (user, password), the primary Db2 authorization ID, and SQL ID. - Connection information for the Database Management Solutions for Db2 that is being used by the commands. For example, host, port, protocol (http or https), and basePath for routing requests to the correct DBM DS instance. - Other options, such as those that control the interaction between commands and the Database Management Solutions for Db2. For more information about the custom template settings that you can define for use with the DBM for Db2 plug-in commands, see Customize DevOps Template Settings in the [Database Management Solutions for Db2 documentation]. ### Managing Team Profiles Use zowe commands to create, import, or update a profile. To create a profile using a team configuration, execute the following command:\ `zowe config init --global-config` To import a profile from a team configuration file, execute the following command:\ `zowe config import <shared_config_location> --global-config` To update a profile, use the `zowe config set` command: - In the following example, we update the "port" value:\ `zowe config set "profiles.dbm-db2.properties.port" "7300" --global-config` - In the following example, we update “jobCards”:\ `zowe config set "profiles.dbm-db2.properties.jobCards" '["//DB2DVOPS JOB CLASS=A,", "// MSGCLASS=X"]' --json --global-config`\ \ **Note:** You can also manually edit the configuration file and add these values. For profile parameters descriptions and definition examples, see the schema file `~\.zowe\zowe.schema.json` ## Using For details about the commands, actions, and options in the DBM for Db2 Plug-in for Zowe CLI, see [Zowe CLI web help]. To obtain help for the available command groups, enter:\ `zowe dbm --help` To obtain help for a specific command, append the --help argument to your command. For example, enter the following command to view help for the _generate ddl_ command:\ `zowe dbm generate ddl --help` For more information about command usage for automation, see [DBM-Db2 samples]. [//]: # (getting this paragraph from the integrate article) ## Learn More To learn more about Broadcom support for the Zowe CLI and the DBM for Db2 Plug-in for Zowe CLI, see the [Enterprise Support for Zowe] documentation. The Enterprise Support for Zowe documentation includes information about Broadcom plug-ins for the Zowe CLI that are available for general use and simplified installation methods. Licensed Database Management Solutions for Db2 users are entitled to support for this plug-in. This plug-in has earned Zowe Conformant status. For the supported Zowe versions, see [Zowe Conformance Program]. To learn how to install and use the Zowe CLI open-source component of the Zowe project, open source plug-ins, and other components such as the Zowe API Mediation Layer go to the [Zowe Docs] site. [Database Management Solutions for Db2 documentation]: https://techdocs.broadcom.com/db2mgmt [Zowe Conformance program]: https://www.openmainframeproject.org/projects/zowe/conformance/ [Zowe Docs]: https://docs.zowe.org/ [Zowe CLI web help]: https://docs.zowe.org/stable/web_help/index.html?p=zowe_dbm-db2 [DBM-Db2 samples]: https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli [Enterprise Support for Zowe]: https://techdocs.broadcom.com/us/en/ca-mainframe-software/devops/enterprise-support-for-zowe/1-0.html [NPM public online registry]: https://www.npmjs.com/