Tutorials IBM Worklight Creating SQL Adapter in IBM Worklight

Creating SQL Adapter in IBM Worklight

This tutorial will help you to understand the SQL adapter and to create a SQL adapter from IBM Worklight. Here it provided step by step tutorials to create, implement and test an adapter using IBM Worklight.

1. What is SQL Adapter?

Adapter is a mediator between mobile applications and enterprise system. Adapters provide an easy and secure access to enterprise system. And it is efficient to provide enterprise data to mobile devices in a uniform data format. The data can be presented to mobile device using various interchange formats like XML or JSON (used mostly)

IBM Worklight provides three different types of adapters

  1. HTTP adapter: HTTP adapters provide access to HTTP-based enterprise services, including RESTful and SOAP-based services.
  2. SQL adapter: SQL adapters provide access to enterprise databases.
  3. Cast IRON adapter: Cast Iron adapters initiate orchestrations in IBM Web Sphere Cast Iron.

Adapters are coded in JavaScript and it runs at server-side on the IBM Worklight mobile application platform. IBM internally uses Rhino JavaScript engine for executing the JavaScript source code.

Conceptually, an adapter is a set of JavaScript functions that can be remotely invoked by an application. Typically an adapter consist of and xml file and a JavaScript implementation file. The XML file will be used for configuring connectivity from the adapter to the enterprise system. Each of the procedures for the adapters needs to be defined in this xml. The JavaScript file will contain the implementation for each of the adapter procedure.  Once you are done with the two files we can now deploy and then can test.

The two files are bundled into a .adapter archive file that is then deployed to the IBM Worklight Server. Once deployed, the adapter procedures are ready to be invoked by Worklight applications running on mobile devices and in browsers.

In this below example, you will find an SQL adapter working.

2. Creating an SQL adapter in IBM Worklight

Here at this point, I assume that your IBM Worklight development environment is ready and  working.

2.1. Creating a new Worklight project

Create a simple Worklight project. Choose project template as “Hybrid Application” and provide an application name. Here I have used “SQLAdapterSampleApp”

2.2. Creating new Worklight Adapter

Click on “adapter” folder and then New-> Worklight Adapter. You can see a dialog as shown below.

2.3. Create required tables and data in database

Now let us move to the mysql part. We need to have the database server running. I assume that you have installed the mysql and have a database running.  Create a table with and fill with some data. You may use the below SQL command

USE `ibmworklight`;
DROP TABLE IF EXISTS `studentinfo`;
CREATE TABLE `studentinfo` (`sid` varchar(20), `sname` varchar(20), `sclass` varchar(20), `sgrade` varchar(20));
INSERT INTO `studentinfo` ( `sid`, `sname`, `sclass`, `sgrade`) values ('PUC001','Rohan','PUC', 'A+');
INSERT INTO `studentinfo` ( `sid`, `sname`, `sclass`, `sgrade`) values ('PUC002','Rakesh','PUC', 'A');
INSERT INTO `studentinfo` ( `sid`, `sname`, `sclass`, `sgrade`) values ('PUC003','Raj','PUC', 'C');
INSERT INTO `studentinfo` ( `sid`, `sname`, `sclass`, `sgrade`) values ('PUC004','Roman','PUC', 'E');
select * from `studentinfo`;

By now, we are ready with the database and table setup.

2.4. Configuring adapter xml

Open your adapter .xml file. We need to change the database configurations. Driver calss is used to connect to the database from your project. Mysql database use “com.mysql.jdbc.Driver” class.

Note: You have to include “mysql-connector-java-5.1.24-bin.jar” library. If you don’t have one, then download hereDownload

As I am running my database in my local system, I have provided localhost and default port as 3306.







2.5. Defining Worklight Procedures

Now, For making my explanation simplified, I am implementing only one procedure. Here in my example “getStudentInfos” procedures fetches all of the available records from “studentinfo” table.

var selectStatement = WL.Server.createSQLStatement("select * from studentinfo");
function getStudentInfos() {	

	return WL.Server.invokeSQLStatement({
		preparedStatement : selectStatement,
		parameters : []

Now we are done.

3. Testing my SQLAdapter

Right click on the adapter folder -> run as -> Deploy as Worklight adapter. Once deployed you can see it from the admin console. Open your browser and hit http://localhost:8080/console/. You will see the console window as shown below.

Now, RunAs-> Invoke Worklight procedure. Select the procedure to test. For now you can test for getStudentInfos, results will appear as JSON data.

Newest Most Voted
Inline Feedbacks
View all comments
9 years ago

wow, awesome blog article.Much thanks again. Cool.

9 years ago

Very good post. You have the complete working project?

Sankar Padhi
Sankar Padhi
9 years ago

A big thank you for your post.Thanks Again. Do you have any post explaining HTTP adapter?

9 years ago
Reply to  Sankar Padhi
9 years ago

@All, Check my next post explains Invoking Adapter procedure in IBM Worklight

Vaibhav N Mutha
Vaibhav N Mutha
9 years ago

A big thank you for your blog article.

9 years ago

Great article.

Vicente Bisset
Vicente Bisset
9 years ago

Heya i am for the first time here. I found this board and I find It
truly useful & it helped me out much.

raul b
raul b
8 years ago

Thanks a lot Nilanchala. Great articles. I cud easily understand the way to do without reading the ibm docs. 🙂 I did try based on your blog for SQL adapter with success. invoking part is the area I am getting stuck.

8 years ago

Thanks for the usefull information on SQL Adapeter, I have tried and got the data from DB as JSON object, But I am facing troubles to show that data from html. (or in mobile to display). Could you please help me on this..I am trying since a 2 weeks on this…thanks in advance.

sagar pathare
sagar pathare
7 years ago

Great…!!! It is so helpful..

Previous Post
Java Tutorials

Java enum Programming Tutorial

Next Post
Android GridView Example

Android Gridview Example- Building Image Gallery in android

By clicking “Allow All”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Cookie Notice
Allow All