blob: c0cf3cb97b59de604bedd25fa48d442ce759af26 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-61232409-1');
</script>
<meta charset="UTF-8">
<meta name="ignite-version" content="2.9.0" />
<title>Node.js Thin Client | Ignite Documentation</title>
<link rel="canonical" href="/docs/2.9.0/thin-clients/nodejs-thin-client" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
<link rel="stylesheet" href="/assets/css/styles.css?1609302783">
<link rel="stylesheet" href="/assets/css/asciidoc-pygments.css">
<link rel="shortcut icon" href="/favicon.ico">
<meta name='viewport' content='width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0'>
<script type="text/javascript" src="/assets/js/anchor.min.js?1609302783"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
</head>
<body>
<header>
<!--#include virtual="/includes/promotion_banner.html" -->
<div class="container">
<button type='button' class='menu' title='Docs menu'>
<img src="/assets/images/menu-icon.svg"/>
</button>
<div class='home'>
<a href="/" class='home' title='Apache Ignite home'>
<img src="/assets/images/apache_ignite_logo.svg" alt="Apache Ignite logo" width="103" >
</a>
</div>
<select id="version-selector">
<option value="2.9.0">2.9.0</option>
</select>
<nav id="api-docs">
<li><a href="#">APIs</a>
<nav class='dropdown'>
<li class="dropdown-item"><a href="/releases/latest/javadoc/index.html">Java</a></li>
<li class="dropdown-item"><a href="/releases/latest/dotnetdoc/api/">C#/.NET</a></li>
<li class="dropdown-item"><a href="/releases/latest/cppdoc/index.html">C++</a></li>
<li class="dropdown-item"><a href="/releases/latest/scaladoc/scalar/index.html#org.apache.ignite.scalar.scalar$">Scala</a></li>
</nav>
</li>
<li><a href="#">Examples</a>
<nav class="dropdown">
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/examples" target="_blank" rel="noopener" title="Apache Ignite Java examples">Java</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples" target="_blank" rel="noopener" title="Apache Ignite C#/.NET examples">C#/.NET</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples" target="_blank" rel="noopener" title="Apache Ignite C++ examples">C++</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/python/examples" target="_blank" rel="noopener" title="Apache Ignite Python examples">Python</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples" target="_blank" rel="noopener" title="Apache Ignite NodeJS examples">NodeJS</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/php/examples" target="_blank" rel="noopener" title="Apache Ignite PHP examples">PHP</a></li>
</nav>
</li>
</nav>
<form class='search'>
<button class="search-close" type='button'><img src='/assets/images/cancel.svg'></button>
<input type="search" placeholder="Search…" id="search-input">
</form>
<button type='button' class='search-toggle'><img src='/assets/images/search.svg'></button>
<nav id="lang-selector">
<li><a href="#"><img src="/assets/images/icon_lang_en.png" alt="English language icon" /><span></span></a>
<nav class="dropdown">
<li class="dropdown-item"><a href="/docs/latest/" ><img src="/assets/images/icon_lang_en.png" alt="English language icon" /><span>English</span></a></li>
<li class="dropdown-item"><a href="https://www.ignite-service.cn/doc/java/" target="_blank" rel="noopener"><img src="/assets/images/icon_lang_cn.png" alt="Chinese language icon" /><span>Chinese</span></a></li>
</nav>
</li>
</nav>
<button type='button' class='top-nav-toggle'></button>
</div>
</header>
<link rel="stylesheet" href="/assets/css/docs.css">
<section class='page-docs'>
<nav class='left-nav' data-swiftype-index='false'>
<li>
<a href="/docs/2.9.0/index" class='' >Documentation Overview</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Quick Start Guides<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/quick-start/java"
class=''
>Java</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/dotnet"
class=''
>.NET/C#</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/cpp"
class=''
>C++</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/python"
class=''
>Python</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/nodejs"
class=''
>Node.JS</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/sql"
class=''
>SQL</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/php"
class=''
>PHP</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/restapi"
class=''
>REST API</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Installation<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/installation/installing-using-zip"
class=''
>Installing Using ZIP Archive</a>
</li>
<li>
<a href="/docs/2.9.0/installation/installing-using-docker"
class=''
>Installing Using Docker</a>
</li>
<li>
<a href="/docs/2.9.0/installation/deb-rpm"
class=''
>Installing DEB or RPM package</a>
</li>
<li>
<button
type='button'
class='collapsed '>Kubernetes<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/installation/kubernetes/amazon-eks-deployment" class=''>Amazon EKS</a></li>
<li><a href="/docs/2.9.0/installation/kubernetes/azure-deployment" class=''>Azure Kubernetes Service</a></li>
<li><a href="/docs/2.9.0/installation/kubernetes/gke-deployment" class=''>Google Kubernetes Engine</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/installation/vmware-installation"
class=''
>VMWare</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Setting Up<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/understanding-configuration"
class=''
>Understanding Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/setup"
class=''
>Setting Up</a>
</li>
<li>
<a href="/docs/2.9.0/logging"
class=''
>Configuring Logging</a>
</li>
<li>
<a href="/docs/2.9.0/resources-injection"
class=''
>Resources Injection</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/starting-nodes" class='' >Starting and Stopping Nodes</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/clustering/clustering"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/tcp-ip-discovery"
class=''
>TCP/IP Discovery</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/zookeeper-discovery"
class=''
>ZooKeeper Discovery</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/discovery-in-the-cloud"
class=''
>Discovery in the Cloud</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/network-configuration"
class=''
>Network Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/connect-client-nodes"
class=''
>Connecting Client Nodes</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/baseline-topology"
class=''
>Baseline Topology</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/running-client-nodes-behind-nat"
class=''
>Running Client Nodes Behind NAT</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle expanded '>Thin Clients<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group expanded'>
<li>
<a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients"
class=''
>Thin Clients Overview</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/java-thin-client"
class=''
>Java Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/dotnet-thin-client"
class=''
>.NET Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/cpp-thin-client"
class=''
>C++ Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/python-thin-client"
class=''
>Python Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/php-thin-client"
class=''
>PHP Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/nodejs-thin-client"
class='active'
>Node.js Thin Client</a>
</li>
<li>
<button
type='button'
class='collapsed '>Binary Client Protocol<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/binary-client-protocol/binary-client-protocol" class=''>Binary Client Protocol</a></li>
<li><a href="/docs/2.9.0/binary-client-protocol/data-format" class=''>Data Format</a></li>
<li><a href="/docs/2.9.0/binary-client-protocol/key-value-queries" class=''>Key-Value Queries</a></li>
<li><a href="/docs/2.9.0/binary-client-protocol/sql-and-scan-queries" class=''>SQL and Scan Queries</a></li>
<li><a href="/docs/2.9.0/binary-client-protocol/binary-type-metadata" class=''>Binary Types Metadata</a></li>
<li><a href="/docs/2.9.0/binary-client-protocol/cache-configuration" class=''>Cache Configuration</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Data Modeling<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/data-modeling/data-modeling"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/data-modeling/data-partitioning"
class=''
>Data Partitioning</a>
</li>
<li>
<a href="/docs/2.9.0/data-modeling/affinity-collocation"
class=''
>Affinity Colocation</a>
</li>
<li>
<a href="/docs/2.9.0/data-modeling/binary-marshaller"
class=''
>Binary Marshaller</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Memory<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/memory-architecture"
class=''
>Memory Architecture</a>
</li>
<li>
<a href="/docs/2.9.0/memory-configuration/data-regions"
class=''
>Configuring Data Regions</a>
</li>
<li>
<a href="/docs/2.9.0/memory-configuration/eviction-policies"
class=''
>Eviction Policies</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Persistence<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/persistence/native-persistence"
class=''
>Ignite Persistence</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/external-storage"
class=''
>External Storage</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/swap"
class=''
>Swapping</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/custom-cache-store"
class=''
>Implementing Custom Cache Store</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/snapshots"
class=''
>Cluster Snapshots</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/disk-compression"
class=''
>Disk Compression</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/persistence-tuning"
class=''
>Tuning Persistence</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Caches<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/configuring-caches/configuration-overview"
class=''
>Cache Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/configuring-backups"
class=''
>Configuring Partition Backups</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/partition-loss-policy"
class=''
>Partition Loss Policy</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/atomicity-modes"
class=''
>Atomicity Modes</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/expiry-policies"
class=''
>Expiry Policy</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/on-heap-caching"
class=''
>On-Heap Caching</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/cache-groups"
class=''
>Cache Groups</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/near-cache"
class=''
>Near Caches</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/data-rebalancing" class='' >Data Rebalancing</a>
</li>
<li>
<a href="/docs/2.9.0/data-streaming" class='' >Data Streaming</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Using Key-Value API<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/key-value-api/basic-cache-operations"
class=''
>Basic Cache Operations</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/binary-objects"
class=''
>Working with Binary Objects</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/using-scan-queries"
class=''
>Using Scan Queries</a>
</li>
<li>
<a href="/docs/2.9.0/read-repair"
class=''
>Read Repair</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/transactions" class='' >Performing Transactions</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Working with SQL<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/SQL/sql-introduction"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/schemas"
class=''
>Understanding Schemas</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/indexes"
class=''
>Defining Indexes</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/sql-api"
class=''
>Using SQL API</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/distributed-joins"
class=''
>Distributed Joins</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/sql-transactions"
class=''
>SQL Transactions</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/custom-sql-func"
class=''
>Custom SQL Functions</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/JDBC/jdbc-driver"
class=''
>JDBC Driver</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/JDBC/jdbc-client-driver"
class=''
>JDBC Client Driver</a>
</li>
<li>
<button
type='button'
class='collapsed '>ODBC Driver<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/SQL/ODBC/odbc-driver" class=''>ODBC Driver</a></li>
<li><a href="/docs/2.9.0//SQL/ODBC/connection-string-dsn" class=''>Connection String and DSN</a></li>
<li><a href="/docs/2.9.0/SQL/ODBC/querying-modifying-data" class=''>Querying and Modifying Data</a></li>
<li><a href="/docs/2.9.0/SQL/ODBC/specification" class=''>Specification</a></li>
<li><a href="/docs/2.9.0/SQL/ODBC/data-types" class=''>Data Types</a></li>
<li><a href="/docs/2.9.0/SQL/ODBC/error-codes" class=''>Error Codes</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/transactions/mvcc"
class=''
>Multiversion Concurrency Control</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>SQL Reference<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/sql-reference/sql-conformance"
class=''
>SQL Conformance</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/ddl"
class=''
>Data Definition Language (DDL)</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/dml"
class=''
>Data Manipulation Language (DML)</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/transactions"
class=''
>Transactions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/operational-commands"
class=''
>Operational Commands</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/aggregate-functions"
class=''
>Aggregate functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/numeric-functions"
class=''
>Numeric Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/string-functions"
class=''
>String Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/date-time-functions"
class=''
>Data and Time Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/system-functions"
class=''
>System Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/data-types"
class=''
>Data Types</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Distributed Computing<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/distributed-computing/distributed-computing"
class=''
>Distributed Computing API</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/cluster-groups"
class=''
>Cluster Groups</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/executor-service"
class=''
>Executor Service</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/map-reduce"
class=''
>MapReduce API</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/load-balancing"
class=''
>Load Balancing</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/fault-tolerance"
class=''
>Fault Tolerance</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/job-scheduling"
class=''
>Job Scheduling</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/collocated-computations"
class=''
>Colocating Computations with Data</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Code Deployment<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/code-deployment/deploying-user-code"
class=''
>Deploying User Code</a>
</li>
<li>
<a href="/docs/2.9.0/code-deployment/peer-class-loading"
class=''
>Peer Class Loading</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Machine Learning<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/machine-learning/machine-learning"
class=''
>Machine Learning</a>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/partition-based-dataset"
class=''
>Partition Based Dataset</a>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/updating-trained-models"
class=''
>Updating Trained Models</a>
</li>
<li>
<button
type='button'
class='collapsed '>Binary Classification<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/binary-classification/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/linear-svm" class=''>Linear SVM (Support Vector Machine)</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/decision-trees" class=''>Decision Trees</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/multilayer-perceptron" class=''>Multilayer Perceptron</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/logistic-regression" class=''>Logistic Regression</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/knn-classification" class=''>k-NN Classification</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/ann" class=''>ANN (Approximate Nearest Neighbor)</a></li>
<li><a href="/docs/2.9.0/machine-learning/binary-classification/naive-bayes" class=''>Naive Bayes</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Regression<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/regression/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/machine-learning/regression/linear-regression" class=''>Linear Regression</a></li>
<li><a href="/docs/2.9.0/machine-learning/regression/decision-trees-regression" class=''>Decision Trees Regression</a></li>
<li><a href="/docs/2.9.0/machine-learning/regression/knn-regression" class=''>k-NN Regression</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/clustering/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/machine-learning/clustering/k-means-clustering" class=''>K-Means Clustering</a></li>
<li><a href="/docs/2.9.0/machine-learning/clustering/gaussian-mixture" class=''>Gaussian mixture (GMM)</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/preprocessing"
class=''
>Preprocessing</a>
</li>
<li>
<button
type='button'
class='collapsed '>Model Selection<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/model-selection/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/machine-learning/model-selection/evaluator" class=''>Evaluator</a></li>
<li><a href="/docs/2.9.0/machine-learning/model-selection/split-the-dataset-on-test-and-train-datasets" class=''>Split the dataset on test and train datasets</a></li>
<li><a href="/docs/2.9.0/machine-learning/model-selection/hyper-parameter-tuning" class=''>Hyper-parameter tuning</a></li>
<li><a href="/docs/2.9.0/machine-learning/model-selection/pipeline-api" class=''>Pipeline API</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/multiclass-classification"
class=''
>Multiclass Classification</a>
</li>
<li>
<button
type='button'
class='collapsed '>Ensemble Methods<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/ensemble-methods/introduction" class=''></a></li>
<li><a href="/docs/2.9.0/machine-learning/ensemble-methods/stacking" class=''>Stacking</a></li>
<li><a href="/docs/2.9.0/machine-learning/ensemble-methods/baggin" class=''>Bagging</a></li>
<li><a href="/docs/2.9.0/machine-learning/ensemble-methods/random-forest" class=''>Random Forest</a></li>
<li><a href="/docs/2.9.0/machine-learning/ensemble-methods/gradient-boosting" class=''>Gradient Boosting</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/recommendation-systems"
class=''
>Recommendation Systems</a>
</li>
<li>
<button
type='button'
class='collapsed '>Importing Model<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/machine-learning/importing-model/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/machine-learning/importing-model/model-import-from-gxboost" class=''>Import Model from XGBoost</a></li>
<li><a href="/docs/2.9.0/machine-learning/importing-model/model-import-from-apache-spark" class=''>Import Model from Apache Spark</a></li>
</nav>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/continuous-queries" class='' >Using Continuous Queries</a>
</li>
<li>
<a href="/docs/2.9.0/services/services" class='' >Using Ignite Services</a>
</li>
<li>
<a href="/docs/2.9.0/messaging" class='' >Using Ignite Messaging</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Distributed Data Structures<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/data-structures/queue-and-set"
class=''
>Queue and Set</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/atomic-types"
class=''
>Atomic Types</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/countdownlatch"
class=''
>CountDownLatch</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/atomic-sequence"
class=''
>Atomic Sequence</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/semaphore"
class=''
>Semaphore</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/id-generator"
class=''
>ID Generator</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/distributed-locks" class='' >Distributed Locks</a>
</li>
<li>
<a href="/docs/2.9.0/restapi" class='' >REST API</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>.NET Specific<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/net-specific/net-configuration-options"
class=''
>Configuration Options</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-deployment-options"
class=''
>Deployment Options</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-standalone-nodes"
class=''
>Standalone Nodes</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-logging"
class=''
>Logging</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-linq"
class=''
>LINQ</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-java-services-execution"
class=''
>Java Services Execution</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-platform-cache"
class=''
>.NET Platform Cache</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-plugins"
class=''
>Plugins</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-cross-platform-support"
class=''
>Cross-Platform Support</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-remote-assembly-loading"
class=''
>Remote Assembly Loading</a>
</li>
<li>
<a href="/docs/2.9.0/net-specific/net-troubleshooting"
class=''
>Troubleshooting</a>
</li>
<li>
<button
type='button'
class='collapsed '>Integrations<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/net-specific/asp-net-output-caching" class=''>ASP.NET Output Caching</a></li>
<li><a href="/docs/2.9.0/net-specific/asp-net-session-state-caching" class=''>ASP.NET Session State Caching</a></li>
<li><a href="/docs/2.9.0/net-specific/net-entity-framework-cache" class=''>Entity Framework 2nd Level Cache</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>C++ Specific<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/cpp-specific/cpp-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/2.9.0/cpp-specific/cpp-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/2.9.0/cpp-specific/cpp-objects-lifetime"
class=''
>Objects Lifetime</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Monitoring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/monitoring-metrics/intro"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/cluster-id"
class=''
>Cluster ID and Tag</a>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/cluster-states"
class=''
>Cluster States</a>
</li>
<li>
<button
type='button'
class='collapsed '>Metrics<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/monitoring-metrics/configuring-metrics" class=''>Configuring Metrics</a></li>
<li><a href="/docs/2.9.0/monitoring-metrics/metrics" class=''>JMX Metrics</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>New Metrics System<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/monitoring-metrics/new-metrics-system" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/monitoring-metrics/new-metrics" class=''>Metrics</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/system-views"
class=''
>System Views</a>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/tracing"
class=''
>Tracing</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Working with Events<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/events/listening-to-events"
class=''
>Enabling and Listenting to Events</a>
</li>
<li>
<a href="/docs/2.9.0/events/events"
class=''
>Events</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Tools<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/tools/control-script"
class=''
>Control Script</a>
</li>
<li>
<a href="/docs/2.9.0/tools/visor-cmd"
class=''
>Visor CMD</a>
</li>
<li>
<a href="/docs/2.9.0/tools/gg-control-center"
class=''
>GridGain Control Center</a>
</li>
<li>
<a href="/docs/2.9.0/tools/sqlline"
class=''
>SQLLine</a>
</li>
<li>
<a href="/docs/2.9.0/tools/tableau"
class=''
>Tableau</a>
</li>
<li>
<a href="/docs/2.9.0/tools/informatica"
class=''
>Informatica</a>
</li>
<li>
<a href="/docs/2.9.0/tools/pentaho"
class=''
>Pentaho</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Security<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/security/authentication"
class=''
>Authentication</a>
</li>
<li>
<a href="/docs/2.9.0/security/ssl-tls"
class=''
>SSL/TLS</a>
</li>
<li>
<button
type='button'
class='collapsed '>Transparent Data Encryption<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/security/tde" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0/security/master-key-rotation" class=''>Master key rotation</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/security/sandbox"
class=''
>Sandbox</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Extensions and Integrations<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<button
type='button'
class='collapsed '>Spring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/extensions-and-integrations/spring/spring-boot" class=''>Spring Boot</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/spring/spring-data" class=''>Spring Data</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/spring/spring-caching" class=''>Spring Caching</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Ignite for Spark<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/overview" class=''>Overview</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/ignitecontext-and-rdd" class=''>IgniteContext and IgniteRDD</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/ignite-dataframe" class=''>Ignite DataFrame</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/installation" class=''>Installation</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/spark-shell" class=''>Test Ignite with Spark-shell</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/ignite-for-spark/troubleshooting" class=''>Troubleshooting</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/extensions-and-integrations/hibernate-l2-cache"
class=''
>Hibernate L2 Cache</a>
</li>
<li>
<a href="/docs/2.9.0/extensions-and-integrations/mybatis-l2-cache"
class=''
>MyBatis L2 Cache</a>
</li>
<li>
<button
type='button'
class='collapsed '>Streaming<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/kafka-streamer" class=''>Kafka Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/camel-streamer" class=''>Camel Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/flink-streamer" class=''>Flink Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/flume-sink" class=''>Flume Sink</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/jms-streamer" class=''>JMS Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/mqtt-streamer" class=''>MQTT Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/rocketmq-streamer" class=''>RocketMQ Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/storm-streamer" class=''>Storm Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/zeromq-streamer" class=''>ZeroMQ Streamer</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/streaming/twitter-streamer" class=''>Twitter Streamer</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Cassandra Integration<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0/extensions-and-integrations/cassandra/overview" class=''>Overview</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/cassandra/configuration" class=''>Configuration</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/cassandra/usage-examples" class=''>Usage Examples</a></li>
<li><a href="/docs/2.9.0/extensions-and-integrations/cassandra/ddl-generator" class=''>DDL Generator</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/extensions-and-integrations/php-pdo"
class=''
>PHP PDO</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/plugins" class='' >Plugins</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Performance and Troubleshooting<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/general-perf-tips"
class=''
>General Performance Tips</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/memory-tuning"
class=''
>Memory and JVM Tuning</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/persistence-tuning"
class=''
>Persistence Tuning</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/sql-tuning"
class=''
>SQL Tuning</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/thread-pools-tuning"
class=''
>Thread Pools Tuning</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/troubleshooting"
class=''
>Troubleshooting and Debugging</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/handling-exceptions"
class=''
>Handling Exceptions</a>
</li>
<li>
<a href="/docs/2.9.0/perf-and-troubleshooting/yardstick-benchmarking"
class=''
>Benchmarking With Yardstick</a>
</li>
</nav>
</li>
</nav>
<div class="left-nav__overlay"></div>
<article data-swiftype-index='true'>
<a class='edit-link' href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/thin-clients/nodejs-thin-client.adoc" target="_blank">Edit</a>
<h1>Node.js Thin Client</h1>
<div class="sect1">
<h2 id="prerequisites">Prerequisites</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p>Node.js version 8 or higher. Either download the Node.js <a href="https://nodejs.org/en/download/">pre-built binary</a> for the target platform, or install Node.js via a <a href="https://nodejs.org/en/download/package-manager">package manager</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Once <code>node</code> and <code>npm</code> are installed, you can use one of the following installation options.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="installation">Installation</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Node.js thin client is shipped as an <code>npm</code> package and as a zip archive. Use any of the methods to install the client in your environment.</p>
</div>
<div class="sect2">
<h3 id="using-npm">Using NPM</h3>
<div class="paragraph">
<p>Use the following command to install the client from the NPM repository:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">npm <span class="nb">install</span> <span class="nt">-g</span> apache-ignite-client</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="using-zip-archive">Using ZIP Archive</h3>
<div class="paragraph">
<p>The thin client can be installed from the zip archive available for download from the Ignite website:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Download the <a href="https://ignite.apache.org/download.cgi#binaries" target="_blank" rel="noopener">Apache Ignite binary package</a>.</p>
</li>
<li>
<p>Unpack the archive and navigate to the <code>{IGNITE_HOME}/platforms/nodejs</code> folder.</p>
</li>
<li>
<p>Run the commands below to finish the installation.</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">npm <span class="nb">link
</span>npm <span class="nb">link </span>apache-ignite-client</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="creating-a-client-instance">Creating a Client Instance</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>IgniteClient</code> class provides the thin client API. You can obtain an instance of the client as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">(</span><span class="nx">onStateChanged</span><span class="p">);</span>
<span class="kd">function</span> <span class="nx">onStateChanged</span><span class="p">(</span><span class="nx">state</span><span class="p">,</span> <span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">CONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is started</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">DISCONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is stopped</span><span class="dl">'</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">reason</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The constructor accepts one optional parameter that represents a callback function, which is called every time the connection state changes (see below).</p>
</div>
<div class="paragraph">
<p>You can create as many <code>IgniteClient</code> instances as needed. All of them will work independently.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="connecting-to-cluster">Connecting to Cluster</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To connect the client to a cluster, use the <code>IgniteClient.connect()</code> method.
It accepts an object of the <code>IgniteClientConfiguration</code> class that represents connection parameters. The connection parameters must contain a list of nodes (in the <code>host:port</code> format) that will be used for <a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients#client-connection-failover">failover purposes</a>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">IgniteClientConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">IgniteClientConfiguration</span><span class="p">;</span>
<span class="k">async</span> <span class="kd">function</span> <span class="nx">connectClient</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">(</span><span class="nx">onStateChanged</span><span class="p">);</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClientConfiguration</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span>
<span class="dl">'</span><span class="s1">127.0.0.1:10800</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">127.0.0.1:10801</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">127.0.0.1:10802</span><span class="dl">'</span><span class="p">);</span>
<span class="c1">// Connect to Ignite node</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="nx">igniteClientConfiguration</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">err</span><span class="p">.</span><span class="nx">message</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">function</span> <span class="nx">onStateChanged</span><span class="p">(</span><span class="nx">state</span><span class="p">,</span> <span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">CONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is started</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">CONNECTING</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is connecting</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">DISCONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is stopped</span><span class="dl">'</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">reason</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">connectClient</span><span class="p">();</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The client has three connection states: <code>CONNECTING</code>, <code>CONNECTED</code>, <code>DISCONNECTED</code>.
You can specify a callback function in the client configuration object, which will be called every time the connection state changes.</p>
</div>
<div class="paragraph">
<p>Interactions with the cluster are only possible in the <code>CONNECTED</code> state.
If the client loses the connection, it automatically switches to the <code>CONNECTING</code> state and tries to re-connect using the <a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients#client-connection-failover">failover mechanism</a>. If it fails to reconnect to all the endpoints from the provided list, the client switches to the <code>DISCONNECTED</code> state.</p>
</div>
<div class="paragraph">
<p>You can call the <code>disconnect()</code> method to close the connection. This will switch the client to the <code>DISCONNECTED</code> state.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="partition-awareness">Partition Awareness</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Partition awareness allows the thin client to send query requests directly to the node that owns the queried data.</p>
</div>
<div class="paragraph">
<p>Without partition awareness, an application that is connected to the cluster via a thin client executes all queries and operations via a single server node that acts as a proxy for the incoming requests.
These operations are then re-routed to the node that stores the data that is being requested.
This results in a bottleneck that could prevent the application from scaling linearly.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/docs/2.9.0/images/partitionawareness01.png" alt="Without Partition Awareness">
</div>
</div>
<div class="paragraph">
<p>Notice how queries must pass through the proxy server node, where they are routed to the correct node.</p>
</div>
<div class="paragraph">
<p>With partition awareness in place, the thin client can directly route queries and operations to the primary nodes that own the data required for the queries.
This eliminates the bottleneck, allowing the application to scale more easily.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/docs/2.9.0/images/partitionawareness02.png" alt="With Partition Awareness">
</div>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<div class="paragraph">
<p>Note that presently you need to provide addresses of all the server nodes in the connection properties.
This also means that if a new server node joins the cluster, you should add the server&#8217;s address to the connection properties and reconnect the thin client.
Otherwise, the thin client will not be able to send direct requests to this server.
This limitation is planned to be addressed before the GA release of the feature.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>To enable partition awareness, set the <code>partitionAwareness</code> configuration parameter to <code>true</code> as shown in the following code snippet:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">ENDPOINTS</span> <span class="o">=</span> <span class="p">[</span><span class="dl">'</span><span class="s1">127.0.0.1:10800</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">127.0.0.1:10801</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">127.0.0.1:10802</span><span class="dl">'</span><span class="p">];</span>
<span class="kd">let</span> <span class="nx">cfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(...</span><span class="nx">ENDPOINTS</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">useTls</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">partitionAwareness</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="nx">cfg</span><span class="p">.</span><span class="nx">setConnectionOptions</span><span class="p">(</span><span class="nx">useTls</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">partitionAwareness</span><span class="p">);</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="nx">cfg</span><span class="p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="enabling-debug">Enabling Debug</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">();</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">setDebug</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="using-key-value-api">Using Key-Value API</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="getting-cache-instance">Getting Cache Instance</h3>
<div class="paragraph">
<p>The key-value API is provided through an instance of a cache. The thin client provides several methods for obtaining a cache instance:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Get a cache by its name.</p>
</li>
<li>
<p>Create a cache with a specified name and optional cache configuration.</p>
</li>
<li>
<p>Get or create a cache, destroys a cache, etc.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>You can obtain as many cache instances as needed - for the same or different caches - and work with all of them in parallel.</p>
</div>
<div class="paragraph">
<p>The following example shows how to get access to a cache by name and destroy its later:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">IgniteClientConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">IgniteClientConfiguration</span><span class="p">;</span>
<span class="k">async</span> <span class="kd">function</span> <span class="nx">getOrCreateCacheByName</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">();</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span><span class="dl">'</span><span class="s1">127.0.0.1:10800</span><span class="dl">'</span><span class="p">));</span>
<span class="c1">// Get or create cache by name</span>
<span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">);</span>
<span class="c1">// Perform cache key-value operations</span>
<span class="c1">// ...</span>
<span class="c1">// Destroy cache</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">destroyCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">err</span><span class="p">.</span><span class="nx">message</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">finally</span> <span class="p">{</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">disconnect</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">getOrCreateCacheByName</span><span class="p">();</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="cache-configuration">Cache Configuration</h3>
<div class="paragraph">
<p>When creating a new cache, you can provide an instance of the cache configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">IgniteClientConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">IgniteClientConfiguration</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">CacheConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">CacheConfiguration</span><span class="p">;</span>
<span class="k">async</span> <span class="kd">function</span> <span class="nx">createCacheByConfiguration</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">();</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span><span class="dl">'</span><span class="s1">127.0.0.1:10800</span><span class="dl">'</span><span class="p">));</span>
<span class="c1">// Create cache by name and configuration</span>
<span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">createCache</span><span class="p">(</span>
<span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">,</span>
<span class="k">new</span> <span class="nx">CacheConfiguration</span><span class="p">().</span><span class="nx">setSqlSchema</span><span class="p">(</span><span class="dl">'</span><span class="s1">PUBLIC</span><span class="dl">'</span><span class="p">));</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">err</span><span class="p">.</span><span class="nx">message</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">finally</span> <span class="p">{</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">disconnect</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">createCacheByConfiguration</span><span class="p">();</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="type-mapping-configuration">Type Mapping Configuration</h3>
<div class="paragraph">
<p>The node.js types do not always uniquely map to the java types, and in some cases you may want to explicitly specify the key and value types in the cache configuration.
The client will use these types to convert the key and value objects between java/javascript data types when executing read/write cache operations.</p>
</div>
<div class="paragraph">
<p>If you don&#8217;t specify the types, the client will use the <a href="#default-mapping">Default Mapping</a>.
Here is an example of type mapping:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">);</span>
<span class="c1">// Set cache key/value types</span>
<span class="nx">cache</span><span class="p">.</span><span class="nx">setKeyType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">INTEGER</span><span class="p">)</span>
<span class="p">.</span><span class="nx">setValueType</span><span class="p">(</span><span class="k">new</span> <span class="nx">MapObjectType</span><span class="p">(</span>
<span class="nx">MapObjectType</span><span class="p">.</span><span class="nx">MAP_SUBTYPE</span><span class="p">.</span><span class="nx">LINKED_HASH_MAP</span><span class="p">,</span>
<span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">SHORT</span><span class="p">,</span>
<span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">BYTE_ARRAY</span><span class="p">));</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="data-types">Data Types</h3>
<div class="paragraph">
<p>The client supports type mapping between Ignite types and JavaScript types in two ways:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Explicit mapping</p>
</li>
<li>
<p>Default mapping</p>
</li>
</ul>
</div>
<div class="sect3">
<h4 id="explicit-mapping">Explicit Mapping</h4>
<div class="paragraph">
<p>A mapping occurs every time an application writes or reads a field to/from the cluster via the client&#8217;s API. The field here is any data stored in Ignite - the whole key or value of an Ignite entry, an element of an array or set, a field of a complex object, etc.</p>
</div>
<div class="paragraph">
<p>By using the client&#8217;s API methods, an application can explicitly specify an Ignite type for a particular field. The client uses this information to transform the field from JavaScript to Java type and vice versa during the read/write operations. The field is transformed into JavaScript type as a result of read operations. It validates the corresponding JavaScript type in inputs of write operations.</p>
</div>
<div class="paragraph">
<p>If an application does not explicitly specify an Ignite type for a field, the client uses the default mapping during the field read/write operations.</p>
</div>
</div>
<div class="sect3">
<h4 id="default-mapping">Default Mapping</h4>
<div class="paragraph">
<p>The default mapping is explained <a href="https://www.gridgain.com/sdk/nodejs-thin-client/latest/ObjectType.html">here</a>.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="basic-key-value-operations">Basic Key-Value Operations</h3>
<div class="paragraph">
<p>The <code>CacheClient</code> class provides methods for working with the cache entries using key-value operations - put, get, put all, get all, replace and others.
The following example shows how to do that:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">apache-ignite-client</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">IgniteClientConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">IgniteClientConfiguration</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">ObjectType</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">ObjectType</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">CacheEntry</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">CacheEntry</span><span class="p">;</span>
<span class="k">async</span> <span class="kd">function</span> <span class="nx">performCacheKeyValueOperations</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">();</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span><span class="dl">'</span><span class="s1">127.0.0.1:10800</span><span class="dl">'</span><span class="p">));</span>
<span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">)).</span>
<span class="nx">setKeyType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">INTEGER</span><span class="p">);</span>
<span class="c1">// Put and get value</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="dl">'</span><span class="s1">abc</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">value</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">value</span><span class="p">);</span>
<span class="c1">// Put and get multiple values using putAll()/getAll() methods</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">putAll</span><span class="p">([</span><span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="dl">'</span><span class="s1">value2</span><span class="dl">'</span><span class="p">),</span> <span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="dl">'</span><span class="s1">value3</span><span class="dl">'</span><span class="p">)]);</span>
<span class="kd">const</span> <span class="nx">values</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">getAll</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]);</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">values</span><span class="p">.</span><span class="nx">flatMap</span><span class="p">(</span><span class="nx">val</span> <span class="o">=&gt;</span> <span class="nx">val</span><span class="p">.</span><span class="nx">getValue</span><span class="p">()));</span>
<span class="c1">// Removes all entries from the cache</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">clear</span><span class="p">();</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">err</span><span class="p">.</span><span class="nx">message</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">finally</span> <span class="p">{</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">disconnect</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">performCacheKeyValueOperations</span><span class="p">();</span></code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="scan-queries">Scan Queries</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>IgniteClient.query(scanquery)</code> method can be used to fetch all entries from the cache.
It returns a cursor object that can be used to iterate over a result set lazily or to get all results at once.</p>
</div>
<div class="paragraph">
<p>To execute a scan query, create a <code>ScanQuery</code> object and call <code>IgniteClient.query(scanquery)</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">myCache</span><span class="dl">'</span><span class="p">)).</span>
<span class="nx">setKeyType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">INTEGER</span><span class="p">);</span>
<span class="c1">// Put multiple values using putAll()</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">putAll</span><span class="p">([</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="dl">'</span><span class="s1">value1</span><span class="dl">'</span><span class="p">),</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="dl">'</span><span class="s1">value2</span><span class="dl">'</span><span class="p">),</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="dl">'</span><span class="s1">value3</span><span class="dl">'</span><span class="p">)]);</span>
<span class="c1">// Create and configure scan query</span>
<span class="kd">const</span> <span class="nx">scanQuery</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ScanQuery</span><span class="p">().</span>
<span class="nx">setPageSize</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="c1">// Obtain scan query cursor</span>
<span class="kd">const</span> <span class="nx">cursor</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">query</span><span class="p">(</span><span class="nx">scanQuery</span><span class="p">);</span>
<span class="c1">// Get all cache entries returned by the scan query</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">let</span> <span class="nx">cacheEntry</span> <span class="k">of</span> <span class="k">await</span> <span class="nx">cursor</span><span class="p">.</span><span class="nx">getAll</span><span class="p">())</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">cacheEntry</span><span class="p">.</span><span class="nx">getValue</span><span class="p">());</span>
<span class="p">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="executing-sql-statements">Executing SQL Statements</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Node.js thin client supports all <a href="/docs/2.9.0/sql-reference">SQL commands</a> that are supported by Ignite.
The commands are executed via the <code>query(SqlFieldQuery)</code> method of the cache object.
The method accepts an instance of <code>SqlFieldsQuery</code> that represents a SQL statement and returns an instance of the <code>SqlFieldsCursor</code> class. Use the cursor to iterate over the result set or get all results at once.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="c1">// Cache configuration required for sql query execution</span>
<span class="kd">const</span> <span class="nx">cacheConfiguration</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CacheConfiguration</span><span class="p">().</span>
<span class="nx">setQueryEntities</span><span class="p">(</span>
<span class="k">new</span> <span class="nx">QueryEntity</span><span class="p">().</span>
<span class="nx">setValueTypeName</span><span class="p">(</span><span class="dl">'</span><span class="s1">Person</span><span class="dl">'</span><span class="p">).</span>
<span class="nx">setFields</span><span class="p">([</span>
<span class="k">new</span> <span class="nx">QueryField</span><span class="p">(</span><span class="dl">'</span><span class="s1">name</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">java.lang.String</span><span class="dl">'</span><span class="p">),</span>
<span class="k">new</span> <span class="nx">QueryField</span><span class="p">(</span><span class="dl">'</span><span class="s1">salary</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">java.lang.Double</span><span class="dl">'</span><span class="p">)</span>
<span class="p">]));</span>
<span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="dl">'</span><span class="s1">sqlQueryPersonCache</span><span class="dl">'</span><span class="p">,</span> <span class="nx">cacheConfiguration</span><span class="p">)).</span>
<span class="nx">setKeyType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">INTEGER</span><span class="p">).</span>
<span class="nx">setValueType</span><span class="p">(</span><span class="k">new</span> <span class="nx">ComplexObjectType</span><span class="p">({</span> <span class="dl">'</span><span class="s1">name</span><span class="dl">'</span> <span class="p">:</span> <span class="dl">''</span><span class="p">,</span> <span class="dl">'</span><span class="s1">salary</span><span class="dl">'</span> <span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="dl">'</span><span class="s1">Person</span><span class="dl">'</span><span class="p">));</span>
<span class="c1">// Put multiple values using putAll()</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">putAll</span><span class="p">([</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">{</span> <span class="dl">'</span><span class="s1">name</span><span class="dl">'</span> <span class="p">:</span> <span class="dl">'</span><span class="s1">John Doe</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">salary</span><span class="dl">'</span> <span class="p">:</span> <span class="mi">1000</span> <span class="p">}),</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="p">{</span> <span class="dl">'</span><span class="s1">name</span><span class="dl">'</span> <span class="p">:</span> <span class="dl">'</span><span class="s1">Jane Roe</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">salary</span><span class="dl">'</span> <span class="p">:</span> <span class="mi">2000</span> <span class="p">}),</span>
<span class="k">new</span> <span class="nx">CacheEntry</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="p">{</span> <span class="dl">'</span><span class="s1">name</span><span class="dl">'</span> <span class="p">:</span> <span class="dl">'</span><span class="s1">Mary Major</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">salary</span><span class="dl">'</span> <span class="p">:</span> <span class="mi">1500</span> <span class="p">})]);</span>
<span class="c1">// Create and configure sql query</span>
<span class="kd">const</span> <span class="nx">sqlQuery</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">SqlQuery</span><span class="p">(</span><span class="dl">'</span><span class="s1">Person</span><span class="dl">'</span><span class="p">,</span> <span class="dl">'</span><span class="s1">salary &gt; ? and salary &lt;= ?</span><span class="dl">'</span><span class="p">).</span>
<span class="nx">setArgs</span><span class="p">(</span><span class="mi">900</span><span class="p">,</span> <span class="mi">1600</span><span class="p">);</span>
<span class="c1">// Obtain sql query cursor</span>
<span class="kd">const</span> <span class="nx">cursor</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">query</span><span class="p">(</span><span class="nx">sqlQuery</span><span class="p">);</span>
<span class="c1">// Get all cache entries returned by the sql query</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">let</span> <span class="nx">cacheEntry</span> <span class="k">of</span> <span class="k">await</span> <span class="nx">cursor</span><span class="p">.</span><span class="nx">getAll</span><span class="p">())</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">cacheEntry</span><span class="p">.</span><span class="nx">getValue</span><span class="p">());</span>
<span class="p">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="security">Security</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="ssltls">SSL/TLS</h3>
<div class="paragraph">
<p>To use encrypted communication between the thin client and the cluster, you have to enable SSL/TLS both in the cluster configuration and the client configuration. Refer to the <a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients#enabling-ssltls-for-thin-clients">Enabling SSL/TLS for Thin Clients</a> section for instructions on the cluster configuration.</p>
</div>
<div class="paragraph">
<p>Here is an example configuration for enabling SSL in the thin client:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">tls</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">tls</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">FS</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">fs</span><span class="dl">'</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">IgniteClient</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">apache-ignite-client</span><span class="dl">"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">ObjectType</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">ObjectType</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">IgniteClientConfiguration</span> <span class="o">=</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">IgniteClientConfiguration</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">ENDPOINT</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">localhost:10800</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">USER_NAME</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">ignite</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">PASSWORD</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">ignite</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">TLS_KEY_FILE_NAME</span> <span class="o">=</span> <span class="nx">__dirname</span> <span class="o">+</span> <span class="dl">'</span><span class="s1">/certs/client.key</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">TLS_CERT_FILE_NAME</span> <span class="o">=</span> <span class="nx">__dirname</span> <span class="o">+</span> <span class="dl">'</span><span class="s1">/certs/client.crt</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">TLS_CA_FILE_NAME</span> <span class="o">=</span> <span class="nx">__dirname</span> <span class="o">+</span> <span class="dl">'</span><span class="s1">/certs/ca.crt</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">CACHE_NAME</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">AuthTlsExample_cache</span><span class="dl">'</span><span class="p">;</span>
<span class="c1">// This example demonstrates how to establish a secure connection to an Ignite node and use username/password authentication,</span>
<span class="c1">// as well as basic Key-Value Queries operations for primitive types:</span>
<span class="c1">// - connects to a node using TLS and providing username/password</span>
<span class="c1">// - creates a cache, if it doesn't exist</span>
<span class="c1">// - specifies key and value type of the cache</span>
<span class="c1">// - put data of primitive types into the cache</span>
<span class="c1">// - get data from the cache</span>
<span class="c1">// - destroys the cache</span>
<span class="kd">class</span> <span class="nx">AuthTlsExample</span> <span class="p">{</span>
<span class="k">async</span> <span class="nx">start</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">igniteClient</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClient</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">onStateChanged</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="k">this</span><span class="p">));</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">setDebug</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">connectionOptions</span> <span class="o">=</span> <span class="p">{</span>
<span class="dl">'</span><span class="s1">key</span><span class="dl">'</span> <span class="p">:</span> <span class="nx">FS</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="nx">TLS_KEY_FILE_NAME</span><span class="p">),</span>
<span class="dl">'</span><span class="s1">cert</span><span class="dl">'</span> <span class="p">:</span> <span class="nx">FS</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="nx">TLS_CERT_FILE_NAME</span><span class="p">),</span>
<span class="dl">'</span><span class="s1">ca</span><span class="dl">'</span> <span class="p">:</span> <span class="nx">FS</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="nx">TLS_CA_FILE_NAME</span><span class="p">)</span>
<span class="p">};</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">connect</span><span class="p">(</span><span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span><span class="nx">ENDPOINT</span><span class="p">).</span>
<span class="nx">setUserName</span><span class="p">(</span><span class="nx">USER_NAME</span><span class="p">).</span>
<span class="nx">setPassword</span><span class="p">(</span><span class="nx">PASSWORD</span><span class="p">).</span>
<span class="nx">setConnectionOptions</span><span class="p">(</span><span class="kc">true</span><span class="p">,</span> <span class="nx">connectionOptions</span><span class="p">));</span>
<span class="kd">const</span> <span class="nx">cache</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">getOrCreateCache</span><span class="p">(</span><span class="nx">CACHE_NAME</span><span class="p">)).</span>
<span class="nx">setKeyType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">INTEGER</span><span class="p">).</span>
<span class="nx">setValueType</span><span class="p">(</span><span class="nx">ObjectType</span><span class="p">.</span><span class="nx">PRIMITIVE_TYPE</span><span class="p">.</span><span class="nx">SHORT_ARRAY</span><span class="p">);</span>
<span class="k">await</span> <span class="k">this</span><span class="p">.</span><span class="nx">putGetData</span><span class="p">(</span><span class="nx">cache</span><span class="p">);</span>
<span class="k">await</span> <span class="nx">igniteClient</span><span class="p">.</span><span class="nx">destroyCache</span><span class="p">(</span><span class="nx">CACHE_NAME</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">ERROR: </span><span class="dl">'</span> <span class="o">+</span> <span class="nx">err</span><span class="p">.</span><span class="nx">message</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">finally</span> <span class="p">{</span>
<span class="nx">igniteClient</span><span class="p">.</span><span class="nx">disconnect</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">async</span> <span class="nx">putGetData</span><span class="p">(</span><span class="nx">cache</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">let</span> <span class="nx">keys</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">];</span>
<span class="kd">let</span> <span class="nx">values</span> <span class="o">=</span> <span class="nx">keys</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="nx">key</span> <span class="o">=&gt;</span> <span class="k">this</span><span class="p">.</span><span class="nx">generateValue</span><span class="p">(</span><span class="nx">key</span><span class="p">));</span>
<span class="c1">// Put multiple values in parallel</span>
<span class="k">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">([</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="nx">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nx">values</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="nx">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="nx">values</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span>
<span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="nx">keys</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="nx">values</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
<span class="p">]);</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Cache values put successfully</span><span class="dl">'</span><span class="p">);</span>
<span class="c1">// Get values sequentially</span>
<span class="kd">let</span> <span class="nx">value</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">let</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">keys</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">value</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">cache</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="nx">keys</span><span class="p">[</span><span class="nx">i</span><span class="p">]);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">this</span><span class="p">.</span><span class="nx">compareValues</span><span class="p">(</span><span class="nx">value</span><span class="p">,</span> <span class="nx">values</span><span class="p">[</span><span class="nx">i</span><span class="p">]))</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Unexpected cache value!</span><span class="dl">'</span><span class="p">);</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Cache values get successfully</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">compareValues</span><span class="p">(</span><span class="nx">array1</span><span class="p">,</span> <span class="nx">array2</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">array1</span><span class="p">.</span><span class="nx">length</span> <span class="o">===</span> <span class="nx">array2</span><span class="p">.</span><span class="nx">length</span> <span class="o">&amp;&amp;</span>
<span class="nx">array1</span><span class="p">.</span><span class="nx">every</span><span class="p">((</span><span class="nx">value1</span><span class="p">,</span> <span class="nx">index</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="nx">value1</span> <span class="o">===</span> <span class="nx">array2</span><span class="p">[</span><span class="nx">index</span><span class="p">]);</span>
<span class="p">}</span>
<span class="nx">generateValue</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">length</span> <span class="o">=</span> <span class="nx">key</span> <span class="o">+</span> <span class="mi">5</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">result</span> <span class="o">=</span> <span class="k">new</span> <span class="nb">Array</span><span class="p">(</span><span class="nx">length</span><span class="p">);</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">let</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">result</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nx">key</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">+</span> <span class="nx">i</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">result</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onStateChanged</span><span class="p">(</span><span class="nx">state</span><span class="p">,</span> <span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">CONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is started</span><span class="dl">'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">state</span> <span class="o">===</span> <span class="nx">IgniteClient</span><span class="p">.</span><span class="nx">STATE</span><span class="p">.</span><span class="nx">DISCONNECTED</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="dl">'</span><span class="s1">Client is stopped</span><span class="dl">'</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">reason</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">reason</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">const</span> <span class="nx">authTlsExample</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">AuthTlsExample</span><span class="p">();</span>
<span class="nx">authTlsExample</span><span class="p">.</span><span class="nx">start</span><span class="p">().</span><span class="nx">then</span><span class="p">();</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="authentication">Authentication</h3>
<div class="paragraph">
<p>Configure <a href="/docs/2.9.0/security/authentication">authentication on the cluster side</a> and provide a valid user name and password in the client configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="js"><span class="kd">const</span> <span class="nx">ENDPOINT</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">localhost:10800</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">USER_NAME</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">ignite</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">PASSWORD</span> <span class="o">=</span> <span class="dl">'</span><span class="s1">ignite</span><span class="dl">'</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">igniteClientConfiguration</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">IgniteClientConfiguration</span><span class="p">(</span>
<span class="nx">ENDPOINT</span><span class="p">).</span><span class="nx">setUserName</span><span class="p">(</span><span class="nx">USER_NAME</span><span class="p">).</span><span class="nx">setPassword</span><span class="p">(</span><span class="nx">PASSWORD</span><span class="p">);</span></code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="copyright">
© 2020 The Apache Software Foundation.<br/>
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.
</div>
</article>
<nav class="right-nav" data-swiftype-index='false'>
<ul class="sectlevel1">
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a>
<ul class="sectlevel2">
<li><a href="#using-npm">Using NPM</a></li>
<li><a href="#using-zip-archive">Using ZIP Archive</a></li>
</ul>
</li>
<li><a href="#creating-a-client-instance">Creating a Client Instance</a></li>
<li><a href="#connecting-to-cluster">Connecting to Cluster</a></li>
<li><a href="#partition-awareness">Partition Awareness</a></li>
<li><a href="#enabling-debug">Enabling Debug</a></li>
<li><a href="#using-key-value-api">Using Key-Value API</a>
<ul class="sectlevel2">
<li><a href="#getting-cache-instance">Getting Cache Instance</a></li>
<li><a href="#cache-configuration">Cache Configuration</a></li>
<li><a href="#type-mapping-configuration">Type Mapping Configuration</a></li>
<li><a href="#data-types">Data Types</a>
<ul class="sectlevel3">
<li><a href="#explicit-mapping">Explicit Mapping</a></li>
<li><a href="#default-mapping">Default Mapping</a></li>
</ul>
</li>
<li><a href="#basic-key-value-operations">Basic Key-Value Operations</a></li>
</ul>
</li>
<li><a href="#scan-queries">Scan Queries</a></li>
<li><a href="#executing-sql-statements">Executing SQL Statements</a></li>
<li><a href="#security">Security</a>
<ul class="sectlevel2">
<li><a href="#ssltls">SSL/TLS</a></li>
<li><a href="#authentication">Authentication</a></li>
</ul>
</li>
</ul>
<footer>
</footer>
</nav>
</section>
<script type='module' src='/assets/js/code-copy-to-clipboard.js' async crossorigin></script>
<script>
// inits deep anchors -- needs to be done here because of https://www.bryanbraun.com/anchorjs/#dont-run-it-too-late
anchors.add('.page-docs h1, .page-docs h2, .page-docs h3:not(.discrete), .page-docs h4, .page-docs h5');
anchors.options = {
placement: 'right',
visible: 'always'
};
</script>
<!-- load google fonts async -->
<script type="text/javascript">
WebFontConfig = {
google: { families: [ 'Open+Sans:300,400,600,700&display=swap' ] }
};
(function() {
var wf = document.createElement('script');
wf.src = 'https://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js';
wf.type = 'text/javascript';
wf.async = 'true';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(wf, s);
})(); </script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
docsearch({
// Your apiKey and indexName will be given to you once
// we create your config
apiKey: '3eee686c0ebe39eff3baeb18c56fa5f8',
indexName: 'apache_ignite',
// Replace inputSelector with a CSS selector
// matching your search input
inputSelector: '#search-input',
// algoliaOptions: { 'facetFilters': ["version:$VERSION"] },
// Set debug to true to inspect the dropdown
debug: false,
});
</script>
<script type='module' src='/assets/js/index.js?1609302783' async crossorigin></script>
<script type='module' src='/assets/js/versioning.js?1609302783' async crossorigin></script>
</body>
</html>