@kinetica/gpudb
v7.1.10-0
Published
Kinetica NodeJS Client API
Downloads
109
Keywords
Readme
Kinetica Node.js API
Overview
This module contains the Kinetica client-side API for Node.js, as well as an example usage.
The Node.js API uses promises:
- If the user provides a callback, the API will use it (and make an asynchronous calls).
- If the user does not provide a callback, the API will return a promise (also asynchronous).
The documentation can be found at https://docs.kinetica.com/7.1/.
For changes to the client-side API, please refer to
CHANGELOG.md
. For
changes to Kinetica functions, please refer to
CHANGELOG-FUNCTIONS.md
.
API
The Node.js API consists of two files in this repository:
<nodejs/GPUdb.js>
<nodejs/package.json>
The example Node.js program that demonstrates the API is here:
<example/nodejs-example.js>
To run the example, copy the project, making sure to maintain the directory
structure (nodejs-example.js
references GPUdb.js
by relative path), and
run the following at the command line from within the example
directory:
node nodejs-example.js
Processing will be logged to standard output.
The following rpm packages are required for using the library:
nodejs
npm
(the Node.js package manager)
The Node.js module documentation can be found at:
- Complete API: https://docs.kinetica.com/7.1/api/nodejs-mod/
- Tutorial: https://docs.kinetica.com/7.1/guides/nodejs_guide/
Support
For bugs, please submit an issue on Github.
For support, you can post on
stackoverflow under the
kinetica
tag or
Slack.
Contact Us
- Ask a question on Slack: Slack
- Follow on GitHub: Follow @kineticadb
- Email us: [email protected]
- Visit: https://www.kinetica.com/contact/