IBM Db2 for z/OS Developer Extension
IBM® Db2® for z/OS® Developer Extension (Db2 Developer Extension) is an extension for Visual Studio Code that provides language support for developing Db2 for z/OS SQL applications. Complete documentation is contained in our documentation repository.
This extension provides language support for the Structured Query Language (SQL) syntax that is used to define, manipulate, and control data in IBM Db2 for z/OS databases. It includes basic productivity features that make it easier to write SQL, such as:
It includes a robust set of capabilities for running SQL that include the ability to:
It also includes support for working with native stored procedures by providing the ability to:
And it enables you to analyze and tune the performance of SQL queries by providing the ability to:
See the Key features section for more details and examples.
Table of contents
Privacy notice for feedback
Db2 Developer Extension is provided free of charge, but we ask you to provide us feedback via the various means available, such as submitting an issue in our GitHub repository, submitting review comments in the VS Code Marketplace, and keeping the built-in telemetry and crash reports enabled.
This extension uses Microsoft VS Code's Telemetry solution, which collects telemetry data that is used to help understand how to improve the product. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. You can disable telemetry as described in Disable Telemetry Reporting. You can also read IBM's General Privacy Statement to learn more about our policies.
This current release of Db2 Developer Extension will collect anonymous data for the following events:
Each of these events is logged with the following information:
Prerequisites for installing Db2 Developer Extension
Installing Db2 Developer Extension requires the following software:
Because part of the SQL language server in IBM Db2 for z/OS Developer Extension is implemented using Java, a Java runtime must be defined in the program path to start Db2 Developer Extension in VS Code. You can specify the specific Java runtime that you want to use and you can set additional Java configuration parameters, such as how much memory the extension can use, in the VS Code User or Workspace Settings. You can also specify a Java runtime and set configuration parameters by editing the
Specifying the Java runtime for the Db2 Developer Extension language server
The language server client that is running in the Db2 Dev Extension checks the following places to find a matching Java runtime:
If a Java runtime is not found in any of these locations, an error message is issued. To resolve the problem, specify a Java runtime in one of these locations.
Tip: Alternatively, you can specify a path to a Java SDK on the
Specifying port numbers
You need to specify port number settings for the Db2 SQL Service and the Debugger Session Manager. You can specify a single port number, multiple port numbers, or a range of port numbers.
Db2 SQL Service
The Db2 SQL Service (DSS) provides support for parsing Db2 SQL syntax and for communicating with Db2. Complete the following steps to specify the port number or numbers that the DSS server will run on.
Debugger Session Manager
The Debugger Session Manager (DSM) provides support for debugging native stored procedures. Complete the following steps to specify the port number or numbers that the DSM will run on.
Working with stored procedures
Deploying a native stored procedure
To deploy a native stored procedure, open a
Debugging a native stored procedure
To debug a native stored procedure, open a
Db2 Developer Extension supports conditional hit-count breakpoints, which means that when the breakpoint is reached, instead of pausing, execution continues until the hit count that you specified is reached. This feature is useful for debugging stored procedures that contain loops.
You can run individual SQL statements that are embedded in any type of source code file by highlighting those statements, right-clicking, and selecting Run Selected SQL. This feature eliminates the need for copying and pasting the statements into a
Within a SQL file, you can run individual statements and even SQL elements that are on different lines by using the Run Selected SQL option, or you can run the entire file by right-clicking and selecting Run All. If your SQL contains host variables, you'll be prompted to provide a value and data type, or you can specify a null value. When the SQL finishes running, you can export the results in a
Db2 Developer Extension supports XML host variables and will validate the syntax if you specify an XML host variable. When you run multiple SQL statements, the results are displayed in in the Execution Summary page. From this page, you can drill down into individual statements, quickly identify, display, and cycle through failing SQL statements, and sort results by their timestamp.
Complete instructions for using the Db2 Developer Extension features for running SQL are in the WORKING WITH SQL category in our documentation repository.
Db2 Developer Extension takes advantage of VS Code’s Format Document and Format Selection capabilities by allowing you to format SQL within all SQL file types, including
The ability to format your SQL makes it much easier to parse large blocks of code and to understand the relationship between different blocks of SQL elements and clauses.
The formatting actions are available from the editor context menu, as keyboard shortcuts, and from the Command Palette.
Tuning SQL statements
You can set up and run Visual Explain, Statistics Advisor, and Capture Query Environment directly from Db2 Developer Extension. As mentioned in the Prerequisites section, these features require the Database Services Expansion Pack feature of Db2 Accessories Suite 4.2.
Setting up a tuning environment
You can register a SQL Tuning Services server into the extension by adding the related information, create a tuning connection profile and EXPLAIN tables if they don't already exist, and then associate the tuning connection profile with the corresponding Db2 connection profile that you defined in the extension.
Running the tuning features
After you've set up your tuning environment, you can configure SQL tuning options and then run any of the available tuning features. The results from Visual Explain are displayed in a browser. Statistics Advisor and Capture Query Environment results are displayed in the Tuning Results window. Results from all three tuning features are accessible from the TUNING HISTORY view.
You can find additional information in the Db2 for z/OS Developer Extension documentation repository, including instructions for:
Also, see our blog site to keep up with latest developments.
Limitations for this release