The loopback-connector-db2z connector enables LoopBack applications to connect to IBM® Db2® for z/OS® data sources.
Page Contents


IBM® DB2® for z/OS® is the database of choice for robust, enterprise-wide solutions handling high-volume workloads. It is optimized to deliver industry-leading performance while lowering costs. The loopback-connector-db2z module is the LoopBack connector for DB2z.

The LoopBack DB2z connector supports:


Enter the following in the top-level directory of your LoopBack application:

$ npm install loopback-connector-db2z --save

The --save option adds the dependency to the application’s package.json file.

This module is dependent on the node-ibm_db module which requires appropriate licenses be available as per instructions in its README. Once loopback-connector-db2z is installed please copy the required license file to the location described.


Use the data source generator to add the DB2z data source to your application. The resulting entry in the application’s server/datasources.json will look something like this:

"mydb": {
  "name": "mydb",
  "connector": "db2z"

Edit server/datasources.json to add other supported properties as required:

"mydb": {
  "name": "mydb",
  "connector": "db2z",
  "username": <username>,
  "password": <password>,
  "database": <database name>,
  "hostname": <db2z server hostname>,
  "port":     <port number>

The following table describes the connector properties.

Property          Type   Description
database String Database name
schema String Specifies the default schema name that is used to qualify unqualified database objects in dynamically prepared SQL statements. The value of this property sets the value in the CURRENT SCHEMA special register on the database server. The schema name is case-sensitive, and must be specified in uppercase characters
username String DB2z Username
password String DB2z password associated with the username above
hostname String DB2z server hostname or IP address
port String DB2z server TCP port number
useLimitOffset Boolean LIMIT and OFFSET must be configured on the DB2z server before use (compatibility mode)
supportDashDB Boolean Create ROW ORGANIZED tables to support dashDB.

Alternatively, you can create and configure the data source in JavaScript code. For example:

var DataSource = require('loopback-datasource-juggler').DataSource;
var DB2Z = require('loopback-connector-db2z');

var config = {
  username: process.env.DB2Z_USERNAME,
  password: process.env.DB2Z_PASSWORD,
  hostname: process.env.DB2Z_HOSTNAME,
  port: 50000,
  database: 'SQLDB',

var db = new DataSource(DB2Z, config);

var User = db.define('User', {
  name: { type: String },
  email: { type: String },

db.autoupdate('User', function(err) {
  if (err) {

    name: 'Tony',
    email: '',
  }, function(err, user) {
    console.log(err, user);

  User.find({ where: { name: 'Tony' }}, function(err, users) {
    console.log(err, users);

  User.destroyAll(function() {
    console.log('example complete');