Skip to content

IBM/ibm-iae-node-sdk

Repository files navigation

Build Status semantic-release

IBM Cloud Analytics Engine Node.js SDK

Node.js client library to interact with various IBM Analytics Engine APIs.

Table of Contents

Overview

The IBM Cloud iaesdk Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Import Path
IBM Analytics Engine v2 iaesdk/ibm-analytics-engine-api/v2
IBM Analytics Engine v3 iaesdk/ibm-analytics-engine-api/v3

NOTE:

IBM Analytics Engine v2 is for the classic plans : Lite, Standard Hourly and Standard monthly. The classic plans are now deprecated.

IBM Analytics Engine v3 is for the Standard Serverless Spark plan

Prerequisites

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

Installation

npm install iaesdk

Using the SDK

For general SDK usage information, please see this link

In setting client options programatically to instantiate the class, provide the following two values:

  1. IAM API Key
  2. Service URLs

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at dW Answers or 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.