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

DBM for Db2 Plug-in for Zowe 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.

The DBM for Db2 Plug-in is compatible with Zowe CLI and is awarded a Zowe Conformance Program badge.

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.

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

1. Ensure that RC/Migrator and RC/Compare Version 20.0 is configured on the mainframe and that it is current with maintenance.
2. Ensure that the DBM Data Service is configured and running on the mainframe.
3. Zowe CLI is installed on your local machine.

For more information about the RC/Migrator, RC/Compare, and DBM Data Service, see the Database Management Solutions for Db2 documentation.

Installation

You can 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 Brightside documentation.

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 install the plug-in version compatible with Zowe CLI V1, enter:
zowe plugins install @broadcom/dbm-db2-for-zowe-cli@zowe-v1-lts

To update your existing plug-in to the most recent version, enter:
zowe plugins update @broadcom/dbm-db2-for-zowe-cli

Configuration

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.

For more information about available profile properties, see Zowe CLI dbm-db2-profile web help.

For more information about converting existing V1 profiles to a V2 team configuration, see Update Zowe CLI and Zowe CLI Plug-ins in the Brightside documentation.

To create a new Zowe CLI team configuration with default profiles, enter:
zowe config init --global-config

If you have a team configuration that is shared with you, customize and enter:
zowe config import <shared_config_location> --global-config

To update a value in a profile, customize and enter:
zowe config set "profiles.<profile_name>.properties.<parameter>" "<value>" --global-config

The following examples demonstrate how to update some parameters of the dbm-db2 profile:

• port:
  zowe config set "profiles.dbm-db2.properties.port" "7300" --global-config

• jobCards:
  zowe config set "profiles.dbm-db2.properties.jobCards" '["//DB2DVOPS JOB CLASS=A,", "// MSGCLASS=X"]' --json --global-config

• environmentList:
  zowe config set "profiles.dbm-db2.properties.environmentList" '{ "ssid1": "env1@host1:port1", "ssid2": "env2@host2:port2" }' --json --global-config

To set a default profile, customize and enter:
zowe profiles set-default dbm-db2 <profile_name>

To use a specific profile with a dbm-db2 command, specify its name using the dbm-db2-profile option:
zowe dbm check ddl … --dbm-db2-profile <profile_name>

For more information about profiles, see Using profiles in Zowe CLI documentation.

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.

Learn More

Brightside is the Broadcom enterprise-class support offering for Zowe. The Brightside documentation includes information about Broadcom plug-ins for 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. A Brightside subscription is not required for download or use.