{"id":28401893,"url":"https://github.com/griddb/nodejs_client","last_synced_at":"2025-06-28T21:31:46.869Z","repository":{"id":57254108,"uuid":"137062878","full_name":"griddb/nodejs_client","owner":"griddb","description":"GridDB Node.JS Client","archived":false,"fork":false,"pushed_at":"2021-05-26T09:50:12.000Z","size":442,"stargazers_count":58,"open_issues_count":2,"forks_count":83,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-06-08T13:50:07.952Z","etag":null,"topics":["nodejs"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/griddb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-12T11:37:10.000Z","updated_at":"2022-11-02T09:24:02.000Z","dependencies_parsed_at":"2022-08-31T09:01:52.753Z","dependency_job_id":null,"html_url":"https://github.com/griddb/nodejs_client","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/griddb/nodejs_client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fnodejs_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fnodejs_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fnodejs_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fnodejs_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/griddb","download_url":"https://codeload.github.com/griddb/nodejs_client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fnodejs_client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260900759,"owners_count":23079650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs"],"created_at":"2025-06-01T14:06:28.381Z","updated_at":"2025-06-28T21:31:46.862Z","avatar_url":"https://github.com/griddb.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"GridDB Node.JS Client\n\n## Overview\n\nGridDB Node.JS Client is developed using GridDB C Client and [SWIG](http://www.swig.org/) (Simplified Wrapper and Interface Generator).  \n\n## Operating environment\n\nBuilding of the library and execution of the sample programs have been checked in the following environment.\n\n    OS: CentOS 7.6(x64) (GCC 4.8.5)\n    SWIG:  The development (master) version (commit ID 113d78a083aa897ffdca4ff6bd9b42e630d16d27(2020/4/7))\n    Node.js: v12\n    GridDB C client: V4.6 CE(Community Edition)\n    GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)\n\n    OS: Ubuntu 20.04(x64) (gcc 10.2.0)\n    SWIG:  The development (master) version (commit ID 113d78a083aa897ffdca4ff6bd9b42e630d16d27(2020/4/7))\n    Node.js: v12\n    GridDB C client: V4.6 CE(Community Edition)\n    GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)\n    \n    OS: Windows 10(x64) (VS2017)\n    SWIG:  The development (master) version (commit ID 27f29aef2cf00735172c28d331536d0069b0f1f4(2021/3/2))\n    Node.js: v12\n    GridDB C client: V4.6 CE(Community Edition)\n    GridDB server: V4.6 CE, CentOS 7.9 (GCC 4.8.5)\n\nNote: We can build and run Node.JS Client with SWIG 4.0.2 for Node.js v10.\n\n## QuickStart (CentOS, Ubuntu)\n### Preparations\n\nInstall SWIG:\n- Checkout SWIG with the upper commit ID at https://github.com/swig/swig\n- Run commands below in command line at SWIG folder:\n```\n    ./autogen.sh\n    ./configure\n    make\n    sudo make install\n```\n\nInstall [GridDB Server](https://github.com/griddb/griddb) and [C Client](https://github.com/griddb/c_client). (Note: If you build them from source code, please use GCC 4.8.5.) \n\nInstall Node.js(v12).\n\nIf required, change INCLUDES_JS path in Makefile.\n\nSet LIBRARY_PATH. \n\n    export LIBRARY_PATH=$LIBRARY_PATH:\u003cC client library file directory path\u003e\n\n### Build and Run \n\n    1. Execute the command on project directory.\n\n    $ npm install nan\n    $ make\n\n    2. Set the NODE_PATH variable for griddb Node.js module files.\n    \n    $ export NODE_PATH=\u003cinstalled directory path\u003e\n\n    3. Write require(\"griddb_node\") in Node.js.\n\n### How to run sample\n\nGridDB Server need to be started in advance.\n\n    1. Set LD_LIBRARY_PATH\n\n        export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:\u003cC client library file directory path\u003e\n\n    2. The command to run sample\n\n        $ node sample/sample1.js \u003cGridDB notification address\u003e \u003cGridDB notification port\u003e\n            \u003cGridDB cluster name\u003e \u003cGridDB user\u003e \u003cGridDB password\u003e\n          --\u003e[ 'name01', false, 1, \u003cBuffer 41 42 43 44 45 46 47 48 49 4a\u003e ]\n\n## QuickStart (Windows)\n### Preparations\n\nInstall CMake\n- Download and install package from https://github.com/Kitware/CMake/releases/download/v3.15.2/cmake-3.15.2-win64-x64.msi\n\nInstall Nuget\n- Download and install package from https://www.nuget.org/downloads (installed to C:\\Tools)\n\nInstall Bison using the following command:\n\n    C:\\Tools\\nuget install bison-win32 -Version 2.4.1.1 -OutputDirectory C:\\Tools\\bison\n\nInstall PCRE using Nuget using the following command:\n\n    C:\\Tools\\nuget install pcre -Version 8.33.0.1 -OutputDirectory C:\\Tools\\pcre\n\nInstall SWIG as below.\n- Checkout SWIG with the upper commit ID at https://github.com/swig/swig\n- Run commands below in cmd at SWIG folder:\n```\n    SET PATH=C:\\Tools\\bison\\bison-win32.2.4.1.1\\tools\\native\\bin;%PATH%\n    SET PCRE_ROOT=C:\\Tools\\pcre\\pcre.8.33.0.1\\build\\native\n    SET PCRE_PLATFORM=x64\n    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 .\n    cmake --build . --config Release\n```\n\n- Set path for SWIG_RESOURCE in CmakeList.txt.\n```\nset(SWIG_RESOURCE /PATH/TO/SWIG/FOLDER)\n```\n\nInstall Node.js(v12)\n- Download and install package from https://nodejs.org/dist/v12.13.0/node-v12.13.0-x64.msi\n\nInstall [GridDB Server](https://github.com/griddb/griddb) on CentOS. (Note: If you build them from source code, please use GCC 4.8.5.) \n\nInstall GridDB C Client.\n- Please refer to https://github.com/griddb/c_client to install GridDB C client.\n- After installing GridDB C client, set path for C_LIB (path for gridstore_c.lib) in CmakeList.txt.\n```\n    set(C_LIB C:/Users/User/Downloads/griddb_c_lib)\n```\n\nInstall Cmake-js\n- Use command line:\n```\n    npm install cmake-js\n```\n\n### Build and Run in cmd\n\n1. Execute the command on project directory.\n\n    ```\n    $ npm install nan\n    $ node .\\node_modules\\cmake-js\\bin\\cmake-js compile -G \"Visual Studio 15 2017 Win64\"\n    ```\n\n2. Set the NODE_PATH variable for griddb Node.js module files.\n    ```\n    $ set NODE_PATH=\u003cinstalled directory path\u003e\n    ```\n\n3. Set PATH variable for C Client library folder.\n\n\t```\n    $ set PATH=%PATH%;\u003cC Client library folder\u003e\n    ```\n\n4. Write require(\"griddb_node\") in Node.js source code.\n\n5. Copy build file to project directory.\n\n    ```\n    $ copy build\\Release\\griddb_client.node .\n    ```\n\n### How to run sample\n\nGridDB Server need to be started in advance.\n\n1. The command to run sample\n\n    ```\n    $ node sample/sample1.js \u003cGridDB notification address\u003e \u003cGridDB notification port\u003e\n        \u003cGridDB cluster name\u003e \u003cGridDB user\u003e \u003cGridDB password\u003e\n        --\u003e[ 'name01', false, 1, \u003cBuffer 41 42 43 44 45 46 47 48 49 4a\u003e ]\n    ```\n\n## Function\n\n(available)\n- STRING, BOOL, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, TIMESTAMP, BLOB type for GridDB\n- put single row, get row with key\n- normal query, aggregation with TQL\n- Multi-Put/Get/Query (batch processing)\n\n(not available)\n- GEOMETRY, Array type for GridDB\n- timeseries compression\n- timeseries-specific function like gsAggregateTimeSeries, gsQueryByTimeSeriesSampling in C client\n- trigger, affinity\n\nPlease refer to the following files for more detailed information.  \n- [Node.JS Client API Reference](https://griddb.github.io/nodejs_client/NodejsAPIReference.htm)\n\nNote:\n1. The current API might be changed in the next version. e.g. ContainerInfo()\n2. There is [Node.JS Client (0.8.4) Package for CentOS and Ubuntu on npm](https://www.npmjs.com/package/griddb_node) .\n\n## Community\n\n  * Issues  \n    Use the GitHub issue function if you have any requests, questions, or bug reports. \n  * PullRequest  \n    Use the GitHub pull request function if you want to contribute code.\n    You'll need to agree GridDB Contributor License Agreement(CLA_rev1.1.pdf).\n    By using the GitHub pull request function, you shall be deemed to have agreed to GridDB Contributor License Agreement.\n\n## License\n  \n  GridDB Node.JS Client source license is Apache License, version 2.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriddb%2Fnodejs_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgriddb%2Fnodejs_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriddb%2Fnodejs_client/lists"}