Zowe CLI Plug-in for IBM Db2 Database

Last Updated: 5/9/2019, 6:23:21 PM

Zowe CLI Plug-in for IBM Db2 Database

The Zowe CLI plug-in for IBM® Db2® Database lets you interact with Db2 for z/OS to perform tasks through Zowe CLI and integrate with modern development tools. The plug-in also lets you interact with Db2 to advance continuous integration and to validate product quality and stability.

Zowe CLI Plug-in for IBM Db2 Database lets you execute SQL statements against a Db2 region, export a Db2 table, and call a stored procedure. The plug-in also exposes its API so that the plug-in can be used directly in other products.

Use cases

As an application developer, you can use Zowe CLI Plug-in for IBM DB2 Database to perform the following tasks:

  • Execute SQL and interact with databases.
  • Execute a file with SQL statements.
  • Export tables to a local file on your computer in SQL format.
  • Call a stored procedure and pass parameters.

Software requirements

Before you install the plug-in, meet the software requirements in Software requirements for Zowe CLI plug-ins.

Installing

Use one of the following methods to install the the Zowe CLI Plug-in for IBM Db2 Database:

Installing from an online registry

If you installed Zowe CLI from online registry, complete the following steps:

  1. Open a command line window and issue the following command:

    zowe plugins install @brightside/db2@lts-incremental
    
  2. After the command execution completes, issue the following command to validate that the installation completed successfully.

    zowe plugins validate @brightside/db2
    

    Successful validation of the IBM Db2 plug-in returns the response: Successfully validated.

  3. Address the license requirements to begin using the plug-in.

Installing from a local package

Follow these procedures if you downloaded the Zowe installation package:

Downloading the ODBC driver

Download the ODBC driver before you install the Db2 plug-in.

Follow these steps:

  1. Download the ODBC CLI Driver. Use the table within the download URL to select the correct CLI Driver for your platform and architecture.

  2. Create a new directory named odbc_cli on your computer. Remember the path to the new directory. You will need to provide the full path to this directory immediately before you install the Db2 plug-in.

  3. Place the ODBC driver in the odbc_cli folder. Do not extract the ODBC driver.

You downloaded and prepared to use the ODBC driver successfully. Proceed to install the plug-in to Zowe CLI.

Installing the plug-in

Now that the Db2 ODBC CLI driver is downloaded, set the IBM_DB_INSTALLER_URL environment variable and install the Db2 plug-in to Zowe CLI.

Follow these steps:

  1. Open a command line window and change the directory to the location where you extracted the zowe-cli-bundle.zip file. If you do not have the zowe-cli-bundle.zip file, see the topic Install Zowe CLI from local package in Installing Zowe CLI for information about how to obtain and extract it.

  2. From a command line window, set the IBM_DB_INSTALLER_URL environment variable by issuing the following command:

    • Windows operating systems:

      set IBM_DB_INSTALLER_URL=<path_to_your_odbc_folder>/odbc_cli
      
    • Linux and Mac operating systems:

      export IBM_DB_INSTALLER_URL=<path_to_your_odbc_folder>/odbc_cli
      

    For example, if you downloaded the Windows x64 driver (ntx64_odbc_cli.zip) to C:\odbc_cli, you would issue the following command:

     set IBM_DB_INSTALLER_URL=C:\odbc_cli
    
  3. Issue the following command to install the plug-in:

    zowe plugins install zowe-db2.tgz
    
  4. (Optional) After the command execution completes, issue the following command to validate that the installation completed successfully.

    zowe plugins validate @brightside/db2
    

    Successful validation of the IBM Db2 plug-in returns the response: Successfully validated.

  5. Address the license requirements to begin using the plug-in.

Addressing the license requirement

The following steps are required for both the registry and offline package installation methods:

  1. Locate your client copy of the Db2 license. You must have a properly licensed and configured Db2 instance for the Db2 plugin to successfully connect to Db2 on z/OS.

    Note: The license must be of version 11.1 if the Db2 server is not db2connectactivated. You can buy a db2connect license from IBM. The connectivity can be enabled either on server using db2connectactivate utility or on client using client side license file. To know more about DB2 license and purchasing cost, please contact IBM Customer Support.

  2. Copy your Db2 license file and place it in the following directory.

    • Windows:
      <zowe_home>\plugins\installed\node_modules\@brightside\db2\node_modules\ibm_db\installer\clidriver\license
      
    • Linux:
      <zowe_home>/plugins/installed/lib/node_modules/@brightside/db2/node_modules/ibm_db/installer/clidriver/license
      

    Tip: By default, <zowe_home> is set to ~/.zowe on *NIX systems, and C:\Users\<Your_User>\.zowe on Windows systems.

    After the license is copied, you can use the Db2 plugin functionality.

Creating a user profile

Before you start using the IBM Db2 plug-in, create a profile.

Issue the command -DISPLAY DDF in the SPUFI or ask your DBA for the following information:

  • The Db2 server host name
  • The Db2 server port number
  • The database name (you can also use the location)
  • The user name
  • The password
  • If your Db2 systems use a secure connection, you can also provide an SSL/TSL certificate file.

To create a db2 profile in Zowe CLI, issue the following command with your connection details for the Db2 instance:

zowe profiles create db2 <profile name> -H <host> -P <port> -d <database> -u <user> -p <password>  

Note For more information, issue the command zowe profiles create db2-profile --help

Commands

The following commands can be issued with the Zowe CLI Plug-in for IBM Db2:

Tip: At any point, you can issue the help command -h to see a list of available commands.

Calling a stored procedure

Issue the following command to call a stored procedure that returns a result set:

$ zowe db2 call sp "DEMOUSER.EMPBYNO('000120')"

Issue the following command to call a stored procedure and pass parameters:

$ zowe db2 call sp "DEMOUSER.SUM(40, 2, ?)" --parameters 0

Issue the following command to call a stored procedure and pass a placeholder buffer:

$ zowe db2 call sp "DEMOUSER.TIME1(?)" --parameters "....placeholder..

Executing an SQL statement

Issue the following command to count rows in the EMP table:

$ zowe db2 execute sql -q "SELECT COUNT(*) AS TOTAL FROM DSN81210.EMP;"

Issue the following command to get a department name by ID:

$ zowe db2 execute sql -q "SELECT DEPTNAME FROM DSN81210.DEPT WHERE DEPTNO='D01'

Exporting a table in SQL format

Issue the following command to export the PROJ table and save the generated SQL statements:

$ zowe db2 export table DSN81210.PROJ

Issue the following command to export the PROJ table and save the output to a file:

$ zowe db2 export table DSN81210.PROJ --outfile projects-backup.sql 

You can also pipe the output to gzip for on-the-fly compression.