1.0.1 • Public • Published


This is a database connectior for Db2 on IBM i intended for use with LoopBack 3 (LoopBack 4 testing soon). It uses the npm odbc package to connect to the database, so installing an ODBC driver manager and driver and setting up a datasource is required for use (see below).

Major differences from version 0.x of loopback-connector-ibmi

This version of the module is significantly different from version 0.x and constitutes a complete rewrite. This project is a derivative of loopback-connector-db2iseries and the v0.x loopback-connector-ibmi.

The main difference between this and the other packages for IBM i (including v0.x of this package) is that it uses ODBC to communicate to the database. Version 0.x of this package was built using the Db2 for i CLI API set, hence the need for important prerequisites (below).


Before installing this package, you will need an ODBC driver and a driver manager (with development libraries). This package is primarily developed and tested with the IBM i Access ODBC driver, which is supported as part of IBM i software maintenance agreements (SWMA) and comes with no additional licensing fees.

On IBM i

On Linux

  • Install the unixODBC-devel package with your operating system's package manager (apt-get, zypper, yum, etc).
  • Install the "Linux Application Package" of IBM i Access Client Solutions. Consult this document for assistance.

On Windows

  • Install the "Windows Application Package" of IBM i Access Client Solutions. Consult this document for assistance.


Once the prerequisites are satisfied, enter the following in the top-level directory of your LoopBack application and install this package:

$ npm install loopback-connector-ibmi 


In LoopBack, datasources are used to store the information about your database so it can be used by the program. Use the data source generator to add to your application:

lb datasource

The datasource generator will then walk you through the process of setting up a datasource:

  1. Enter the datasource name: Any name will do, such as the name of the schema you will use or the name of your system.
  2. Select connector for <name>: LoopBack 3 does not have knowledge of loopback-connector-ibmi, so just press up on the arrow key once and select other.
  3. Enter the connector's module name: Enter loopback-connector-ibmi.
  4. Install loopback-connector-ibmi: If you haven't installed it, enter Y. If you have already installed it, select n.

This will generate an entry in your server/datasources.json file. It should know have an entry similar to:

    "name": "test",
    "connector": "loopback-connector-ibmi"

You should edit this entry to add information on how to connect to Db2. For loopback-connector-ibmi, you need to pass either a connectionString, or pass your username, password, and dsn (which will be the DSN name you set up for your ODBC driver).

  "name": "test",
  "connector": "loopback-connector-ibmi",
  "connectionString": "DSN=MYDSN"


  "name": "test",
  "connector": "loopback-connector-ibmi",
  "dsn": "MYDSN",
  "username": "FIRSTLAST",
  "password": "password123"

The following table describes the connector properties.

Property Type Description
connectionString String ODBC connection string for connecting to the database
dsn String ODBC DSN to use for the connection
username String Username on the IBM i
password String Password on the IBM i
schema String Specifies the default schema name that is used to qualify unqualified database objects in dynamically prepared SQL statements. The schema name is case-sensitive.

More connector properties will be added as requested by the community

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

var DataSource = require('loopback-datasource-juggler').DataSource;
var DB2 = require('loopback-connector-ibmi');
var config = {
  dsn:      process.env.DSN
  username: process.env.DB2_USERNAME,
  password: process.env.DB2_PASSWORD,
var db = new DataSource(DB2, config);
var User = db.define('User', {
  name: { type: String },
  email: { type: String },
// Will make sure that 'User' table has the same format as the model
db.autoupdate('User', function(err) {
  if (err) {
    name: 'Tony',
    email: 'tony@t.com',
  }, 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');

Package Sidebar


npm i loopback-connector-ibmi

Weekly Downloads






Unpacked Size

116 kB

Total Files


Last publish


  • markdirish
  • theprez