GridGain Quick Start Guide for Node.JS
This chapter explains system requirements for running GridGain, how to install GridGain, start a cluster and run a simple Hello World example using a thin client for Node.js.
Thin Client is a lightweight GridGain connection mode. It does not participate in cluster, never holds any data, or performs computations. All it does is establish a socket connection to an individual GridGain node and perform all operations through that node.
Since GridGain is built on top of Apache Ignite, GridGain reuses Ignite’s system properties, environment properties, startup scripts, etc. wherever possible.
Prerequisites
This section describes the platform requirements for machines running GridGain. GridGain system requirements scale depending on the size of the cluster.
JDK |
Oracle JDK 8, 11, 17 or 21 |
OS |
Linux (any flavor), Windows (10 and up). For Docker environment, we provide Linux docker containers. |
ISA |
x86-64, SPARC, PowerPC |
Network |
No restrictions (10G recommended) |
and:
Node.js |
Version 8 or higher is required. Either download the Node.js pre-built binary for the target platform, or install Node.js via package manager. |
(Optional) Open Ports
Depending on your environment and what your plan is, you may want to open additional ports. GridGain uses the following ports:
-
47100-47200 — ports used by GridGain nodes to communicate. Specific ports used depend on node configuration.
-
47500-47600 — ports used by GridGain nodes to discover other nodes in the network. Specific ports used depend on node configuration.
-
10800 — the port used for thin clients, JDBC and ODBC connections.
-
8080 — the port used for REST API.
-
11211 — the port used by control script calls. This port should only be opened on nodes that need to send control script messages to other nodes.
Installing GridGain
GridGain is available in three editions: Community Edition (CE), Enterprise Edition (EE) and Ultimate Edition (UE). For this example, we’ll use the GridGain CE, which is distributed as binary, docker, and cloud images, and via RPM/DEB. This chapter explains how to install the GridGain CE binary distribution.
To get started with the GridGain CE binary distribution:
-
Download the GridGain binary as a zip archive.
-
Unzip the zip archive into the installation folder in your system.
-
Move the
ignite-rest-httpfolder from{gridgain}/libs/optionalto{gridgain}/libsto enable the Ignite REST library for the cluster. The library is used by GridGain Nebula for cluster management and monitoring needs. -
(Optional) Enable required modules.
-
(Optional) Set the
IGNITE_HOMEenvironment variable or Windows PATH to point to the installation folder and make sure there is no trailing/(or\for Windows) in the path.
Once that’s done, execute the following command to install the Node.js Thin Client package:
npm install -g @gridgain/thin-clientStarting a GridGain Node
Before connecting to GridGain from Node.JS thin client, you must start at least one GridGain cluster node.
You can start a GridGain node from the command line using the default configuration or by passing a custom configuration file. You can start as many nodes as you like and they will all automatically discover each other.
Navigate into the bin folder of GridGain installation directory from the command shell. Your command might look like this:
cd {gridgain}/bin/cd {gridgain}\bin\Start a node with a custom configuration file that is passed as a parameter to ignite.sh|bat like this:
./ignite.sh ../examples/config/example-ignite.xmlignite.bat ..\examples\config\example-ignite.xmlYou will see output similar to this:
[08:53:45] Ignite node started OK (id=7b30bc8e) [08:53:45] Topology snapshot [ver=1, locNode=7b30bc8e, servers=1, clients=0, state=ACTIVE, CPUs=4, offheap=1.6GB, heap=2.0GB]
Open another tab from your command shell and run the same command again:
./ignite.sh ../examples/config/example-ignite.xmlignite.bat ..\examples\config\example-ignite.xmlCheck the Topology snapshot line in the output.
Now you have a cluster of two server nodes with more CPUs and RAM available cluster-wide:
[08:54:34] Ignite node started OK (id=3a30b7a4) [08:54:34] Topology snapshot [ver=2, locNode=3a30b7a4, servers=2, clients=0, state=ACTIVE, CPUs=4, offheap=3.2GB, heap=4.0GB]
Running Your First GridGain Application
Once the cluster is started, you can use the GridGain Node.js Thin
Client to perform cache operations. ZIP installation of Node.js
Thin Client includes several ready-to-run examples in the {client_dir}/examples
directory. Here is example how to run one of them:
cd {client_dir}/examples
node CachePutGetExample.jsAssuming that the server node is running locally, and that you have completed all of the pre-requisites listed above, here is a very simple HelloWorld example that puts and gets values from the cache. If you followed the instructions above, and if you place this hello world example in your examples folder, it should work.
const IgniteClient = require('gridgain-client');
const IgniteClientConfiguration = IgniteClient.IgniteClientConfiguration;
const ObjectType = IgniteClient.ObjectType;
const CacheEntry = IgniteClient.CacheEntry;
async function performCacheKeyValueOperations() {
const igniteClient = new IgniteClient();
try {
await igniteClient.connect(new IgniteClientConfiguration('127.0.0.1:10800'));
const cache = (await igniteClient.getOrCreateCache('myCache')).
setKeyType(ObjectType.PRIMITIVE_TYPE.INTEGER);
// put and get value
await cache.put(1, 'Hello World');
const value = await cache.get(1);
console.log(value);
}
catch (err) {
console.log(err.message);
}
finally {
igniteClient.disconnect();
}
}
performCacheKeyValueOperations();Next Steps
From here, you may want to:
-
Read more about using GridGain
-
Explore the additional examples included with GridGain
© 2024 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.