​

Kinetica Node.js API

The Node.js API is published to npm as @kinetica/gpudb-api:

npm install @kinetica/gpudb-api

Both require and import resolve to it:

const { GPUdb } = require('@kinetica/gpudb-api');      // CommonJS

import GPUdb from '@kinetica/gpudb-api';               // ES modules (default export)

const gpudb = new GPUdb('http://localhost:9191', { username: 'admin', password: 'password' });
const response = await gpudb.show_system_properties({});

Each endpoint is available in two forms, both returning a Promise and both accepting an optional callback:

• positional parameters, e.g. admin_add_host(host_address, options)
• a single request object, e.g. admin_add_host_request( host_address, options )

Node.js 16 or later is required; 18 or later is recommended.

​

Compatibility with @kinetica/gpudb

@kinetica/gpudb, the former Node.js API, is now a compatibility wrapper around @kinetica/gpudb-api, kept so that existing code keeps working unchanged:

const GPUdb = require('@kinetica/gpudb');      // the module is the constructor, as before

It has no API of its own: it is the same GPUdb class, pinned to the same version, with everything the old API hung off the constructor (GPUdb.Type, GPUdb.RingList, GPUdb.FileHandler, GPUdb.encode / decode, GPUdb.END_OF_SET, GPUdb.api_version) still in place. New code should use @kinetica/gpudb-api directly.

The source is on GitHub.