@ibm-cloud/watsonx-data
Version:
IBM Cloud Watsonx.data Node.js SDK
87 lines (62 loc) • 2.87 kB
Markdown
[](https://travis.ibm.com/IBM/watsonxdata-node-sdk)
[](https://github.com/semantic-release/semantic-release)
<!--
[](https://www.npmjs.com/package/@ibm-cloud/watsonx-data)
-->
# IBM Cloud Watsonx.data Node.js SDK
Node.js client library to interact with various [Watsonx-data APIs](https://cloud.ibm.com/apidocs?category=watsonxdata).
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
<!--
The TOC below is generated using the `markdown-toc` node package.
https://github.com/jonschlinkert/markdown-toc
You should regenerate the TOC after making changes to this file.
npx markdown-toc -i README.md
-->
<!-- toc -->
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Using the SDK](#using-the-sdk)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
<!-- --------------------------------------------------------------- -->
## Overview
The IBM Cloud Watsonx-data Node.js SDK allows developers to programmatically interact with the following
IBM Cloud services:
Service Name | Import Path
--- | ---
[Watsonx.data](https://cloud.ibm.com/apidocs/watsonxdata) | @ibm-cloud/watsonx-data/watsonx-data
## Prerequisites
* You need an [IBM Cloud][ibm-cloud-onboarding] 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.
[ibm-cloud-onboarding]: http://cloud.ibm.com/registration
## Installation
```sh
npm install @ibm-cloud/watsonx-data
```
## Using the SDK
For general SDK usage information, please see
[this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md)
## 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](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
## Issues
If you encounter an issue with the SDK, you are welcome to submit
a [bug report](https://github.com/IBM/watsonxdata-node-sdk/issues).
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](http://ibm.github.io/)
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
## License
This project is released under the Apache 2.0 license.
The license's full text can be found in
[LICENSE](LICENSE).