Awesome

GridDB Node.JS Client

Overview

GridDB Node.JS Client is developed using GridDB C Client and SWIG (Simplified Wrapper and Interface Generator).

Operating environment

Building of the library and execution of the sample programs have been checked in the following environment.

OS: CentOS 7.6(x64) (GCC 4.8.5)
SWIG:  The development (master) version (commit ID 113d78a083aa897ffdca4ff6bd9b42e630d16d27(2020/4/7))
Node.js: v12
GridDB C client: V4.6 CE(Community Edition)
GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)

OS: Ubuntu 20.04(x64) (gcc 10.2.0)
SWIG:  The development (master) version (commit ID 113d78a083aa897ffdca4ff6bd9b42e630d16d27(2020/4/7))
Node.js: v12
GridDB C client: V4.6 CE(Community Edition)
GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)

OS: Windows 10(x64) (VS2017)
SWIG:  The development (master) version (commit ID 27f29aef2cf00735172c28d331536d0069b0f1f4(2021/3/2))
Node.js: v12
GridDB C client: V4.6 CE(Community Edition)
GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)

Note: We can build and run Node.JS Client with SWIG 4.0.2 for Node.js v10.

QuickStart (CentOS, Ubuntu)

Preparations

Install SWIG:

Checkout SWIG with the upper commit ID at https://github.com/swig/swig
Run commands below in command line at SWIG folder:

    ./autogen.sh
    ./configure
    make
    sudo make install

Install GridDB Server and C Client. (Note: If you build them from source code, please use GCC 4.8.5.)

Install Node.js(v12).

If required, change INCLUDES_JS path in Makefile.

Set LIBRARY_PATH.

export LIBRARY_PATH=$LIBRARY_PATH:<C client library file directory path>

Build and Run

1. Execute the command on project directory.

$ npm install nan
$ make

2. Set the NODE_PATH variable for griddb Node.js module files.

$ export NODE_PATH=<installed directory path>

3. Write require("griddb_node") in Node.js.

How to run sample

GridDB Server need to be started in advance.

1. Set LD_LIBRARY_PATH

    export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:<C client library file directory path>

2. The command to run sample

    $ node sample/sample1.js <GridDB notification address> <GridDB notification port>
        <GridDB cluster name> <GridDB user> <GridDB password>
      -->[ 'name01', false, 1, <Buffer 41 42 43 44 45 46 47 48 49 4a> ]

QuickStart (Windows)

Preparations

Install CMake

Download and install package from https://github.com/Kitware/CMake/releases/download/v3.15.2/cmake-3.15.2-win64-x64.msi

Install Nuget

Download and install package from https://www.nuget.org/downloads (installed to C:\Tools)

Install Bison using the following command:

C:\Tools\nuget install bison-win32 -Version 2.4.1.1 -OutputDirectory C:\Tools\bison

Install PCRE using Nuget using the following command:

C:\Tools\nuget install pcre -Version 8.33.0.1 -OutputDirectory C:\Tools\pcre

Install SWIG as below.

Checkout SWIG with the upper commit ID at https://github.com/swig/swig
Run commands below in cmd at SWIG folder:

    SET PATH=C:\Tools\bison\bison-win32.2.4.1.1\tools\native\bin;%PATH%
    SET PCRE_ROOT=C:\Tools\pcre\pcre.8.33.0.1\build\native
    SET PCRE_PLATFORM=x64
    cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX="%CD:\=/%/install2" -DCMAKE_C_FLAGS="/DPCRE_STATIC /MT" -DCMAKE_CXX_FLAGS="/DPCRE_STATIC /MT"  -DPCRE_INCLUDE_DIR=%PCRE_ROOT%/include -DPCRE_LIBRARY=%PCRE_ROOT%/lib/v110/%PCRE_PLATFORM%/Release/static/utf8/pcre8.lib .
    cmake --build . --config Release

Set path for SWIG_RESOURCE in CmakeList.txt.

set(SWIG_RESOURCE /PATH/TO/SWIG/FOLDER)

Install Node.js(v12)

Download and install package from https://nodejs.org/dist/v12.13.0/node-v12.13.0-x64.msi

Install GridDB Server on CentOS. (Note: If you build them from source code, please use GCC 4.8.5.)

Install GridDB C Client.

Please refer to https://github.com/griddb/c_client to install GridDB C client.
After installing GridDB C client, set path for C_LIB (path for gridstore_c.lib) in CmakeList.txt.

    set(C_LIB C:/Users/User/Downloads/griddb_c_lib)

Install Cmake-js

Use command line:

    npm install cmake-js

Build and Run in cmd

Execute the command on project directory.

$ npm install nan
$ node .\node_modules\cmake-js\bin\cmake-js compile -G "Visual Studio 15 2017 Win64"

Set the NODE_PATH variable for griddb Node.js module files.
```
$ set NODE_PATH=<installed directory path>
```
Set PATH variable for C Client library folder.
```
$ set PATH=%PATH%;<C Client library folder>
```
Write require("griddb_node") in Node.js source code.

Copy build file to project directory.

$ copy build\Release\griddb_client.node .

How to run sample

GridDB Server need to be started in advance.

The command to run sample

$ node sample/sample1.js <GridDB notification address> <GridDB notification port>
    <GridDB cluster name> <GridDB user> <GridDB password>
    -->[ 'name01', false, 1, <Buffer 41 42 43 44 45 46 47 48 49 4a> ]

Function

(available)

STRING, BOOL, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, TIMESTAMP, BLOB type for GridDB
put single row, get row with key
normal query, aggregation with TQL
Multi-Put/Get/Query (batch processing)

(not available)

GEOMETRY, Array type for GridDB
timeseries compression
timeseries-specific function like gsAggregateTimeSeries, gsQueryByTimeSeriesSampling in C client
trigger, affinity

Please refer to the following files for more detailed information.

Node.JS Client API Reference

Note:

The current API might be changed in the next version. e.g. ContainerInfo()
There is Node.JS Client (0.8.4) Package for CentOS and Ubuntu on npm .

Community

Issues
Use the GitHub issue function if you have any requests, questions, or bug reports.
PullRequest
Use the GitHub pull request function if you want to contribute code. You'll need to agree GridDB Contributor License Agreement(CLA_rev1.1.pdf). By using the GitHub pull request function, you shall be deemed to have agreed to GridDB Contributor License Agreement.

License

GridDB Node.JS Client source license is Apache License, version 2.0.