@ibm-cloud/ibm-sql-query-sdk

Data Engine Node.js SDK

The IBM Cloud Data Engine Node SDK allows developers to programmatically interact with Data Engine.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

• Overview
• Prerequisites
• Installation
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud Data Engine Node.js SDK allows developers to programmatically interact with the following service.

Service Name	Import Path
Data Engine	sql-query-sdk/sql/v2

Prerequisites

• You need an IBM Cloud account.
• Node.js >=10: This SDK is tested with Node.js versions 10 and up. It may work on previous versions but this is not officially supported.

Installation

npm install @ibm-cloud/ibm-sql-query-sdk

Using the SDK

const Sqlquery = require('@ibm-cloud/ibm-sql-query-sdk/sql/v2');
const { IamAuthenticator } =require('@ibm-cloud/ibm-sql-query-sdk/auth');

// Create an IAM authenticator.
const authenticator = new IamAuthenticator({
  apikey: <Your api key>,
});

// Set up the client.
const sqlqueryClient = new Sqlquery({
  authenticator,
  serviceUrl: `https://api.sql-query.cloud.ibm.com/v2`,
  instanceCrn: <Your sql query instance crn>,

// ...
});

Example and how to run it are available in the example folder.

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.