Google Git
Sign in
apache / ignite-website / refs/heads/ignite-13779 / . / docs / 2.9.0 / thin-clients / java-thin-client.html
blob: d8c6a70352c9d9c0f8fe53d1c6944d9d01f5d537 [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>Java Thin Client | Ignite Documentation</title>
<link rel="canonical" href="/docs/2.9.0/thin-clients/java-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='active'
>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=''
>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/java-thin-client.adoc" target="_blank">Edit</a>
<h1>Java Thin Client</h1>
<div class="sect1">
<h2 id="overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Java thin client is a lightweight client that connects to the cluster via a standard socket connection. It does not become a part of the cluster topology, never holds any data, and is not used as a destination for compute calculations. The thin client simply establishes a socket connection to a standard node​ and performs all operations through that node.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="setting-up">Setting Up</h2>
<div class="sectionbody">
<div class="paragraph">
<p>If you use maven or gradle, add the <code>ignite-core</code> dependency to your application:</p>
</div>
<code-tabs><code-tab data-tab='Maven'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="xml"><span class="nt">&lt;properties&gt;</span>
<span class="nt">&lt;ignite.version&gt;</span>2.9.0<span class="nt">&lt;/ignite.version&gt;</span>
<span class="nt">&lt;/properties&gt;</span>
<span class="nt">&lt;dependencies&gt;</span>
<span class="nt">&lt;dependency&gt;</span>
<span class="nt">&lt;groupId&gt;</span>org.apache.ignite<span class="nt">&lt;/groupId&gt;</span>
<span class="nt">&lt;artifactId&gt;</span>ignite-core<span class="nt">&lt;/artifactId&gt;</span>
<span class="nt">&lt;version&gt;</span>${ignite.version}<span class="nt">&lt;/version&gt;</span>
<span class="nt">&lt;/dependency&gt;</span>
<span class="nt">&lt;/dependencies&gt;</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Gradle'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="groovy"><span class="kt">def</span> <span class="n">igniteVersion</span> <span class="o">=</span> <span class="s1">'2.9.0'</span>
<span class="n">dependencies</span> <span class="o">{</span>
<span class="n">compile</span> <span class="nl">group:</span> <span class="s1">'org.apache.ignite'</span><span class="o">,</span> <span class="nl">name:</span> <span class="s1">'ignite-core'</span><span class="o">,</span> <span class="nl">version:</span> <span class="n">igniteVersion</span>
<span class="o">}</span></code></pre>
</div>
</div></code-tab></code-tabs>
<div class="paragraph">
<p>Alternatively, you can use the <code>ignite-core-2.9.0.jar</code> library from the Ignite distribution package.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="connecting-to-cluster">Connecting to Cluster</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To initialize a thin client, use the <code>Ignition.startClient(ClientConfiguration)</code> method. The method accepts a <code>ClientConfiguration</code> object, which defines client connection parameters.</p>
</div>
<div class="paragraph">
<p>The method returns the <code>IgniteClient</code> interface, which provides various methods for accessing data. <code>IgniteClient</code> is an auto-closable resource. Use the <em>try-with-resources</em> statement to close the thin client and release the resources associated with the connection.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientConfiguration</span> <span class="n">cfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">().</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"127.0.0.1:10800"</span><span class="o">);</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">cfg</span><span class="o">))</span> <span class="o">{</span>
<span class="nc">ClientCache</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">String</span><span class="o">&gt;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">cache</span><span class="o">(</span><span class="s">"myCache"</span><span class="o">);</span>
<span class="c1">// Get data from the cache</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>You can provide addresses of multiple nodes. In this case, the thin client randomly tries all the servers in the list and throws <code>ClientConnectionException</code> if none is available.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">().</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"node1_address:10800"</span><span class="o">,</span>
<span class="s">"node2_address:10800"</span><span class="o">,</span> <span class="s">"node3_address:10800"</span><span class="o">)))</span> <span class="o">{</span>
<span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="nc">ClientConnectionException</span> <span class="n">ex</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// All the servers are unavailable</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Note that the code above provides a failover mechanism in case of server node failures. Refer to the <a href="#handling-node-failures">Handling Node Failures</a> section for more information.</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>The following code sample illustrates how to use the partition awareness feature with the java thin client.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientConfiguration</span> <span class="n">cfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">()</span>
<span class="o">.</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"node1_address:10800"</span><span class="o">,</span> <span class="s">"node2_address:10800"</span><span class="o">,</span> <span class="s">"node3_address:10800"</span><span class="o">)</span>
<span class="o">.</span><span class="na">setPartitionAwarenessEnabled</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">cfg</span><span class="o">))</span> <span class="o">{</span>
<span class="nc">ClientCache</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">String</span><span class="o">&gt;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">cache</span><span class="o">(</span><span class="s">"myCache"</span><span class="o">);</span>
<span class="c1">// Put, get or remove data from the cache...</span>
<span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="nc">ClientException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
<span class="nc">System</span><span class="o">.</span><span class="na">err</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">e</span><span class="o">.</span><span class="na">getMessage</span><span class="o">());</span>
<span class="o">}</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="paragraph">
<p>The Java thin client supports most of the key-value operations available in the thick client.
To execute key-value operations on a specific cache, you need to get an instance of the cache and use one of its methods.</p>
</div>
<div class="sect2">
<h3 id="getting-a-cache-instance">Getting a Cache Instance</h3>
<div class="paragraph">
<p>The <code>ClientCache</code> interface provides the key-value API. You can use the following methods to obtain an instance of <code>ClientCache</code>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>IgniteClient.cache(String)</code>: assumes a cache with the specified name exists. The method does not communicate with the cluster to check if the cache really exists. Subsequent cache operations fail if the cache does not exist.</p>
</li>
<li>
<p><code>IgniteClient.getOrCreateCache(String)</code>, <code>IgniteClient.getOrCreateCache(ClientCacheConfiguration)</code>: get existing cache with the specified name or create the cache if it does not exist. The former operation creates a cache with default configuration.</p>
</li>
<li>
<p><code>IgniteClient.createCache(String)</code>, <code>IgniteClient.createCache(ClientCacheConfiguration)</code>: create a cache with the specified name and fail if the cache already exists.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Use <code>IgniteClient.cacheNames()</code> to list all existing caches.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientCacheConfiguration</span> <span class="n">cacheCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientCacheConfiguration</span><span class="o">().</span><span class="na">setName</span><span class="o">(</span><span class="s">"References"</span><span class="o">)</span>
<span class="o">.</span><span class="na">setCacheMode</span><span class="o">(</span><span class="nc">CacheMode</span><span class="o">.</span><span class="na">REPLICATED</span><span class="o">)</span>
<span class="o">.</span><span class="na">setWriteSynchronizationMode</span><span class="o">(</span><span class="nc">CacheWriteSynchronizationMode</span><span class="o">.</span><span class="na">FULL_SYNC</span><span class="o">);</span>
<span class="nc">ClientCache</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">String</span><span class="o">&gt;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getOrCreateCache</span><span class="o">(</span><span class="n">cacheCfg</span><span class="o">);</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="basic-cache-operations">Basic Cache Operations</h3>
<div class="paragraph">
<p>The following code snippet demonstrates how to execute basic cache operations from the thin client.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">Map</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">String</span><span class="o">&gt;</span> <span class="n">data</span> <span class="o">=</span> <span class="nc">IntStream</span><span class="o">.</span><span class="na">rangeClosed</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="mi">100</span><span class="o">).</span><span class="na">boxed</span><span class="o">()</span>
<span class="o">.</span><span class="na">collect</span><span class="o">(</span><span class="nc">Collectors</span><span class="o">.</span><span class="na">toMap</span><span class="o">(</span><span class="n">i</span> <span class="o">-&gt;</span> <span class="n">i</span><span class="o">,</span> <span class="nl">Object:</span><span class="o">:</span><span class="n">toString</span><span class="o">));</span>
<span class="n">cache</span><span class="o">.</span><span class="na">putAll</span><span class="o">(</span><span class="n">data</span><span class="o">);</span>
<span class="k">assert</span> <span class="o">!</span><span class="n">cache</span><span class="o">.</span><span class="na">replace</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="s">"2"</span><span class="o">,</span> <span class="s">"3"</span><span class="o">);</span>
<span class="k">assert</span> <span class="s">"1"</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="n">cache</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="mi">1</span><span class="o">));</span>
<span class="k">assert</span> <span class="n">cache</span><span class="o">.</span><span class="na">replace</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="s">"1"</span><span class="o">,</span> <span class="s">"3"</span><span class="o">);</span>
<span class="k">assert</span> <span class="s">"3"</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="n">cache</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="mi">1</span><span class="o">));</span>
<span class="n">cache</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="mi">101</span><span class="o">,</span> <span class="s">"101"</span><span class="o">);</span>
<span class="n">cache</span><span class="o">.</span><span class="na">removeAll</span><span class="o">(</span><span class="n">data</span><span class="o">.</span><span class="na">keySet</span><span class="o">());</span>
<span class="k">assert</span> <span class="n">cache</span><span class="o">.</span><span class="na">size</span><span class="o">()</span> <span class="o">==</span> <span class="mi">1</span><span class="o">;</span>
<span class="k">assert</span> <span class="s">"101"</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="n">cache</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="mi">101</span><span class="o">));</span>
<span class="n">cache</span><span class="o">.</span><span class="na">removeAll</span><span class="o">();</span>
<span class="k">assert</span> <span class="mi">0</span> <span class="o">==</span> <span class="n">cache</span><span class="o">.</span><span class="na">size</span><span class="o">();</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="executing-scan-queries">Executing Scan Queries</h3>
<div class="paragraph">
<p>Use the <code>ScanQuery&lt;K, V&gt;</code> class to get a set of entries that satisfy a given condition. The thin client sends the query to the cluster node where it is executed as a normal <a href="/docs/2.9.0/key-value-api/using-scan-queries">scan query</a>.</p>
</div>
<div class="paragraph">
<p>The query condition is specified by an <code>IgniteBiPredicate&lt;K, V&gt;</code> object that is passed to the query constructor as an argument. The predicate is applied on the server side. If you don&#8217;t provide any predicate, the query returns all cache entries.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
The classes of the predicates must be available on the server nodes of the cluster.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The results of the query are transferred to the client page by page. Each page contains a specific number of entries and is fetched to the client only when the entries from that page are requested. To change the number of entries in a page, use the <code>ScanQuery.setPageSize(int pageSize)</code> method (default value is 1024).</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientCache</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">Person</span><span class="o">&gt;</span> <span class="n">personCache</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getOrCreateCache</span><span class="o">(</span><span class="s">"personCache"</span><span class="o">);</span>
<span class="nc">Query</span><span class="o">&lt;</span><span class="nc">Cache</span><span class="o">.</span><span class="na">Entry</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">Person</span><span class="o">&gt;&gt;</span> <span class="n">qry</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ScanQuery</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">Person</span><span class="o">&gt;(</span>
<span class="o">(</span><span class="n">i</span><span class="o">,</span> <span class="n">p</span><span class="o">)</span> <span class="o">-&gt;</span> <span class="n">p</span><span class="o">.</span><span class="na">getName</span><span class="o">().</span><span class="na">contains</span><span class="o">(</span><span class="s">"Smith"</span><span class="o">));</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">QueryCursor</span><span class="o">&lt;</span><span class="nc">Cache</span><span class="o">.</span><span class="na">Entry</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">Person</span><span class="o">&gt;&gt;</span> <span class="n">cur</span> <span class="o">=</span> <span class="n">personCache</span><span class="o">.</span><span class="na">query</span><span class="o">(</span><span class="n">qry</span><span class="o">))</span> <span class="o">{</span>
<span class="k">for</span> <span class="o">(</span><span class="nc">Cache</span><span class="o">.</span><span class="na">Entry</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">Person</span><span class="o">&gt;</span> <span class="n">entry</span> <span class="o">:</span> <span class="n">cur</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// Process the entry ...</span>
<span class="o">}</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>IgniteClient.query(&#8230;&#8203;)</code> method returns an instance of <code>FieldsQueryCursor</code>. Make sure to always close the cursor after you obtain all results.</p>
</div>
</div>
<div class="sect2">
<h3 id="transactions">Transactions</h3>
<div class="paragraph">
<p>Client transactions are supported for caches with <code>AtomicityMode.TRANSACTIONAL</code> mode.</p>
</div>
<div class="sect3">
<h4 id="executing-transactions">Executing Transactions</h4>
<div class="paragraph">
<p>To start a transaction, obtain the <code>ClientTransactions</code> object from <code>IgniteClient</code>.
<code>ClientTransactions</code> has a number of <code>txStart(&#8230;&#8203;)</code> methods, each of which starts a new transaction and returns an object (<code>ClientTransaction</code>) that represents the transaction.
Use this object to commit or rollback the transaction.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="ruby"><span class="no">ClientCache</span><span class="o">&lt;</span><span class="no">Integer</span><span class="p">,</span> <span class="no">String</span><span class="o">&gt;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">cache</span><span class="p">(</span><span class="s2">"my_transactional_cache"</span><span class="p">);</span>
<span class="no">ClientTransactions</span> <span class="n">tx</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">transactions</span><span class="p">();</span>
<span class="n">try</span> <span class="p">(</span><span class="no">ClientTransaction</span> <span class="n">t</span> <span class="o">=</span> <span class="n">tx</span><span class="p">.</span><span class="nf">txStart</span><span class="p">())</span> <span class="p">{</span>
<span class="n">cache</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"new value"</span><span class="p">);</span>
<span class="n">t</span><span class="p">.</span><span class="nf">commit</span><span class="p">();</span>
<span class="p">}</span></code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="transaction-configuration">Transaction Configuration</h4>
<div class="paragraph">
<p>Client transactions can have different <a href="/docs/2.9.0/key-value-api/transactions#concurrency-modes-and-isolation-levels">concurrency modes, isolation levels</a>, and execution timeout, which can be set for all transactions or on a per transaction basis.</p>
</div>
<div class="paragraph">
<p>The <code>ClientConfiguration</code> object supports setting the default concurrency mode, isolation level, and timeout for all transactions started with this client interface.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientConfiguration</span> <span class="n">cfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">();</span>
<span class="n">cfg</span><span class="o">.</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"localhost:10800"</span><span class="o">);</span>
<span class="n">cfg</span><span class="o">.</span><span class="na">setTransactionConfiguration</span><span class="o">(</span><span class="k">new</span> <span class="nc">ClientTransactionConfiguration</span><span class="o">().</span><span class="na">setDefaultTxTimeout</span><span class="o">(</span><span class="mi">10000</span><span class="o">)</span>
<span class="o">.</span><span class="na">setDefaultTxConcurrency</span><span class="o">(</span><span class="nc">TransactionConcurrency</span><span class="o">.</span><span class="na">OPTIMISTIC</span><span class="o">)</span>
<span class="o">.</span><span class="na">setDefaultTxIsolation</span><span class="o">(</span><span class="nc">TransactionIsolation</span><span class="o">.</span><span class="na">REPEATABLE_READ</span><span class="o">));</span>
<span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">cfg</span><span class="o">);</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>You can specify the concurrency mode, isolation level, and timeout when starting an individual transaction.
In this case, the provided values override the default settings.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientTransactions</span> <span class="n">tx</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">transactions</span><span class="o">();</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">ClientTransaction</span> <span class="n">t</span> <span class="o">=</span> <span class="n">tx</span><span class="o">.</span><span class="na">txStart</span><span class="o">(</span><span class="nc">TransactionConcurrency</span><span class="o">.</span><span class="na">OPTIMISTIC</span><span class="o">,</span>
<span class="nc">TransactionIsolation</span><span class="o">.</span><span class="na">REPEATABLE_READ</span><span class="o">))</span> <span class="o">{</span>
<span class="n">cache</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="s">"new value"</span><span class="o">);</span>
<span class="n">t</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="working-with-binary-objects">Working with Binary Objects</h3>
<div class="paragraph">
<p>The thin client fully supports Binary Object API described in the <a href="/docs/2.9.0/key-value-api/binary-objects">Working with Binary Objects</a> section.
Use <code>CacheClient.withKeepBinary()</code> to switch the cache to binary mode and start working directly with binary objects to avoid serialization/deserialization.
Use <code>IgniteClient.binary()</code> to get an instance of <code>IgniteBinary</code> and build an object from scratch.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">IgniteBinary</span> <span class="n">binary</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">binary</span><span class="o">();</span>
<span class="nc">BinaryObject</span> <span class="n">val</span> <span class="o">=</span> <span class="n">binary</span><span class="o">.</span><span class="na">builder</span><span class="o">(</span><span class="s">"Person"</span><span class="o">).</span><span class="na">setField</span><span class="o">(</span><span class="s">"id"</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="kt">int</span><span class="o">.</span><span class="na">class</span><span class="o">).</span><span class="na">setField</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="s">"Joe"</span><span class="o">,</span> <span class="nc">String</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
<span class="nc">ClientCache</span><span class="o">&lt;</span><span class="nc">Integer</span><span class="o">,</span> <span class="nc">BinaryObject</span><span class="o">&gt;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">cache</span><span class="o">(</span><span class="s">"persons"</span><span class="o">).</span><span class="na">withKeepBinary</span><span class="o">();</span>
<span class="n">cache</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="n">val</span><span class="o">);</span>
<span class="nc">BinaryObject</span> <span class="n">value</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="mi">1</span><span class="o">);</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Refer to the <a href="/docs/2.9.0/key-value-api/binary-objects">Working with Binary Objects</a> page for detailed information.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="executing-sql-statements">Executing SQL Statements</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Java thin client provides a SQL API to execute SQL statements. SQL statements are declared using the <code>SqlFieldsQuery</code> objects and executed through the <code>IgniteClient.query(SqlFieldsQuery)</code> method.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="n">client</span><span class="o">.</span><span class="na">query</span><span class="o">(</span><span class="k">new</span> <span class="nc">SqlFieldsQuery</span><span class="o">(</span><span class="nc">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span>
<span class="s">"CREATE TABLE IF NOT EXISTS Person (id INT PRIMARY KEY, name VARCHAR) WITH \"VALUE_TYPE=%s\""</span><span class="o">,</span>
<span class="nc">Person</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">())).</span><span class="na">setSchema</span><span class="o">(</span><span class="s">"PUBLIC"</span><span class="o">)).</span><span class="na">getAll</span><span class="o">();</span>
<span class="kt">int</span> <span class="n">key</span> <span class="o">=</span> <span class="mi">1</span><span class="o">;</span>
<span class="nc">Person</span> <span class="n">val</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="s">"Person 1"</span><span class="o">);</span>
<span class="n">client</span><span class="o">.</span><span class="na">query</span><span class="o">(</span><span class="k">new</span> <span class="nc">SqlFieldsQuery</span><span class="o">(</span><span class="s">"INSERT INTO Person(id, name) VALUES(?, ?)"</span><span class="o">).</span><span class="na">setArgs</span><span class="o">(</span><span class="n">val</span><span class="o">.</span><span class="na">getId</span><span class="o">(),</span> <span class="n">val</span><span class="o">.</span><span class="na">getName</span><span class="o">())</span>
<span class="o">.</span><span class="na">setSchema</span><span class="o">(</span><span class="s">"PUBLIC"</span><span class="o">)).</span><span class="na">getAll</span><span class="o">();</span>
<span class="nc">FieldsQueryCursor</span><span class="o">&lt;</span><span class="nc">List</span><span class="o">&lt;?&gt;&gt;</span> <span class="n">cursor</span> <span class="o">=</span> <span class="n">client</span>
<span class="o">.</span><span class="na">query</span><span class="o">(</span><span class="k">new</span> <span class="nc">SqlFieldsQuery</span><span class="o">(</span><span class="s">"SELECT name from Person WHERE id=?"</span><span class="o">).</span><span class="na">setArgs</span><span class="o">(</span><span class="n">key</span><span class="o">).</span><span class="na">setSchema</span><span class="o">(</span><span class="s">"PUBLIC"</span><span class="o">));</span>
<span class="c1">// Get the results; the `getAll()` methods closes the cursor; you do not have to</span>
<span class="c1">// call cursor.close();</span>
<span class="nc">List</span><span class="o">&lt;</span><span class="nc">List</span><span class="o">&lt;?&gt;&gt;</span> <span class="n">results</span> <span class="o">=</span> <span class="n">cursor</span><span class="o">.</span><span class="na">getAll</span><span class="o">();</span>
<span class="n">results</span><span class="o">.</span><span class="na">stream</span><span class="o">().</span><span class="na">findFirst</span><span class="o">().</span><span class="na">ifPresent</span><span class="o">(</span><span class="n">columns</span> <span class="o">-&gt;</span> <span class="o">{</span>
<span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"name = "</span> <span class="o">+</span> <span class="n">columns</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="mi">0</span><span class="o">));</span>
<span class="o">});</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>query(SqlFieldsQuery)</code> method returns an instance of <code>FieldsQueryCursor</code>, which can be used to iterate over the results. After getting the results, the cursor must be closed to release the resources associated with it.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
The <code>getAll()</code> method retrieves the results from the cursor and closes it.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Read more about using <code>SqlFieldsQuery</code> and SQL API in the <a href="/docs/2.9.0/SQL/sql-api">Using SQL API</a> section.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="using-cluster-apis">Using Cluster APIs</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The cluster APIs let you create a group of cluster nodes and run various operations against the group. The <code>ClientCluster</code>
interface is the entry-point to the APIs that can be used as follows:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Get or change the state of a cluster</p>
</li>
<li>
<p>Get a list of all cluster nodes</p>
</li>
<li>
<p>Create logical groups our of cluster nodes and use other Ignite APIs to perform certain operations on the group</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Use the instance of <code>IgniteClient</code> to obtain a reference to the <code>ClientCluster</code> interface:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="nc">ClientCluster</span> <span class="n">clientCluster</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">cluster</span><span class="o">();</span>
<span class="n">clientCluster</span><span class="o">.</span><span class="na">state</span><span class="o">(</span><span class="nc">ClusterState</span><span class="o">.</span><span class="na">ACTIVE</span><span class="o">);</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="sect2">
<h3 id="logical-nodes-grouping">Logical Nodes Grouping</h3>
<div class="paragraph">
<p>You can use the <code>ClientClusterGroup</code> interface of the cluster APIs to create various groups of cluster nodes. For instance,
one group can comprise all servers nodes, while the other group can include only those nodes that match a specific
TCP/IP address format. The example below shows how to create a group of server nodes located in the <code>dc1</code> data center:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="nc">ClientClusterGroup</span> <span class="n">serversInDc1</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">cluster</span><span class="o">().</span><span class="na">forServers</span><span class="o">().</span><span class="na">forAttribute</span><span class="o">(</span><span class="s">"dc"</span><span class="o">,</span> <span class="s">"dc1"</span><span class="o">);</span>
<span class="n">serversInDc1</span><span class="o">.</span><span class="na">nodes</span><span class="o">().</span><span class="na">forEach</span><span class="o">(</span><span class="n">n</span> <span class="o">-&gt;</span> <span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Node ID: "</span> <span class="o">+</span> <span class="n">n</span><span class="o">.</span><span class="na">id</span><span class="o">()));</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Refer to the main <a href="/docs/2.9.0/distributed-computing/cluster-groups">cluster groups</a> documentation page for more details on the capability.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="executing-compute-tasks">Executing Compute Tasks</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Presently, the Java thin client supports basic <a href="/docs/2.9.0/distributed-computing/distributed-computing">compute capabilities</a>
by letting you execute those compute tasks that are <strong>already deployed</strong> in the cluster. You can either run a task across all
cluster nodes or a specific <a href="/docs/2.9.0/thin-clients/java-thin-client#logical-nodes-grouping">cluster group</a>. The deployment
assumes that you create a JAR file with the compute tasks and add the JAR to the cluster nodes' classpath.</p>
</div>
<div class="paragraph">
<p>By default, the execution of tasks, triggered by the thin client, is disabled on the cluster side. You need to set the
<code>ThinClientConfiguration.maxActiveComputeTasksPerConnection</code> parameter to a non-zero value in the configuration of your
server nodes and thick clients:</p>
</div>
<code-tabs><code-tab data-tab='XML'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="xml"><span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.IgniteConfiguration"</span> <span class="na">id=</span><span class="s">"ignite.cfg"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"clientConnectorConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.ClientConnectorConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"thinClientConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.ThinClientConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"maxActiveComputeTasksPerConnection"</span> <span class="na">value=</span><span class="s">"100"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Java'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ThinClientConfiguration</span> <span class="n">thinClientCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ThinClientConfiguration</span><span class="o">()</span>
<span class="o">.</span><span class="na">setMaxActiveComputeTasksPerConnection</span><span class="o">(</span><span class="mi">100</span><span class="o">);</span>
<span class="nc">ClientConnectorConfiguration</span> <span class="n">clientConnectorCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConnectorConfiguration</span><span class="o">()</span>
<span class="o">.</span><span class="na">setThinClientConfiguration</span><span class="o">(</span><span class="n">thinClientCfg</span><span class="o">);</span>
<span class="nc">IgniteConfiguration</span> <span class="n">igniteCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">IgniteConfiguration</span><span class="o">()</span>
<span class="o">.</span><span class="na">setClientConnectorConfiguration</span><span class="o">(</span><span class="n">clientConnectorCfg</span><span class="o">);</span>
<span class="nc">Ignite</span> <span class="n">ignite</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">start</span><span class="o">(</span><span class="n">igniteCfg</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
<div class="paragraph">
<p>The example below shows how to get access to the compute APIs via the <code>ClientCompute</code> interface and execute the compute
task named <code>MyTask</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">// Suppose that the MyTask class is already deployed in the cluster</span>
<span class="n">client</span><span class="o">.</span><span class="na">compute</span><span class="o">().</span><span class="na">execute</span><span class="o">(</span>
<span class="nc">MyTask</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">(),</span> <span class="s">"argument"</span><span class="o">);</span>
<span class="o">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="executing-ignite-services">Executing Ignite Services</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can use the <code>ClientServices</code> APIs of the Java thin client to invoke an <a href="/docs/2.9.0/services/services">Ignite Service</a> that
is <strong>already deployed</strong> in the cluster.</p>
</div>
<div class="paragraph">
<p>The example below shows how to invoke the service named <code>MyService</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">// Executing the service named MyService</span>
<span class="c1">// that is already deployed in the cluster.</span>
<span class="n">client</span><span class="o">.</span><span class="na">services</span><span class="o">().</span><span class="na">serviceProxy</span><span class="o">(</span>
<span class="s">"MyService"</span><span class="o">,</span> <span class="nc">MyService</span><span class="o">.</span><span class="na">class</span><span class="o">).</span><span class="na">myServiceMethod</span><span class="o">();</span>
<span class="o">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="handling-exceptions">Handling Exceptions</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="handling-node-failures">Handling Node Failures</h3>
<div class="paragraph">
<p>When you provide the addresses of multiple nodes in the client configuration, the client automatically switches to the next node if the current connection fails and retries any ongoing operation.</p>
</div>
<div class="paragraph">
<p>In the case of atomic operations, failover to another node is transparent to the user. However, if you execute a scan query or a SELECT query, iteration over query cursor may throw an <code>ClientConnectionException</code>. This can happen because queries return data in pages, and if the node that the client is connected to goes down while the client retrieves the pages, to keep query result consistent exception is thrown.</p>
</div>
<div class="paragraph">
<p>If explicit transaction is started, cache operations binded to this transaction also can throw an <code>ClientException</code> in case of failed connection to server node.</p>
</div>
<div class="paragraph">
<p>User code should handle these exceptions and implement retry logic accordingly.</p>
</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 in both 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 the instruction on the cluster configuration.</p>
</div>
<div class="paragraph">
<p>To enable encrypted communication in the thin client, provide a keystore that contains the encryption key and a truststore with the trusted certificates in the thin client configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientConfiguration</span> <span class="n">clientCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">().</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"127.0.0.1:10800"</span><span class="o">);</span>
<span class="n">clientCfg</span><span class="o">.</span><span class="na">setSslMode</span><span class="o">(</span><span class="nc">SslMode</span><span class="o">.</span><span class="na">REQUIRED</span><span class="o">).</span><span class="na">setSslClientCertificateKeyStorePath</span><span class="o">(</span><span class="no">KEYSTORE</span><span class="o">)</span>
<span class="o">.</span><span class="na">setSslClientCertificateKeyStoreType</span><span class="o">(</span><span class="s">"JKS"</span><span class="o">).</span><span class="na">setSslClientCertificateKeyStorePassword</span><span class="o">(</span><span class="s">"123456"</span><span class="o">)</span>
<span class="o">.</span><span class="na">setSslTrustCertificateKeyStorePath</span><span class="o">(</span><span class="no">TRUSTSTORE</span><span class="o">).</span><span class="na">setSslTrustCertificateKeyStorePassword</span><span class="o">(</span><span class="s">"123456"</span><span class="o">)</span>
<span class="o">.</span><span class="na">setSslTrustCertificateKeyStoreType</span><span class="o">(</span><span class="s">"JKS"</span><span class="o">).</span><span class="na">setSslKeyAlgorithm</span><span class="o">(</span><span class="s">"SunX509"</span><span class="o">).</span><span class="na">setSslTrustAll</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="o">.</span><span class="na">setSslProtocol</span><span class="o">(</span><span class="nc">SslProtocol</span><span class="o">.</span><span class="na">TLS</span><span class="o">);</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">// ...</span>
<span class="o">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The following table explains encryption parameters of the client configuration:</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 60%;">
<col style="width: 20%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslMode</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Either <code>REQURED</code> or <code>DISABLED</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DISABLED</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslClientCertificateKeyStorePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The path to the keystore file with the private key.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslClientCertificateKeyStoreType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the keystore.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>JKS</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslClientCertificateKeyStorePassword</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The password to the keystore.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslTrustCertificateKeyStorePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The path to the truststore file.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslTrustCertificateKeyStoreType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the truststore.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>JKS</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslTrustCertificateKeyStorePassword</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The password to the truststore.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslKeyAlgorithm</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the key manager algorithm that is used to create a key manager.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>SunX509</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslTrustAll</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If this parameter is set to <code>true</code>, the certificates are not validated.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">N/A</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sslProtocol</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the protocol that is used for data encryption.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>TLS</code></p></td>
</tr>
</tbody>
</table>
</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 the user name and password in the client configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">ClientConfiguration</span> <span class="n">clientCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">ClientConfiguration</span><span class="o">().</span><span class="na">setAddresses</span><span class="o">(</span><span class="s">"127.0.0.1:10800"</span><span class="o">).</span><span class="na">setUserName</span><span class="o">(</span><span class="s">"joe"</span><span class="o">)</span>
<span class="o">.</span><span class="na">setUserPassword</span><span class="o">(</span><span class="s">"passw0rd!"</span><span class="o">);</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">IgniteClient</span> <span class="n">client</span> <span class="o">=</span> <span class="nc">Ignition</span><span class="o">.</span><span class="na">startClient</span><span class="o">(</span><span class="n">clientCfg</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">// ...</span>
<span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="nc">ClientAuthenticationException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// Handle authentication failure</span>
<span class="o">}</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="#overview">Overview</a></li>
<li><a href="#setting-up">Setting Up</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="#using-key-value-api">Using Key-Value API</a>
<ul class="sectlevel2">
<li><a href="#getting-a-cache-instance">Getting a Cache Instance</a></li>
<li><a href="#basic-cache-operations">Basic Cache Operations</a></li>
<li><a href="#executing-scan-queries">Executing Scan Queries</a></li>
<li><a href="#transactions">Transactions</a>
<ul class="sectlevel3">
<li><a href="#executing-transactions">Executing Transactions</a></li>
<li><a href="#transaction-configuration">Transaction Configuration</a></li>
</ul>
</li>
<li><a href="#working-with-binary-objects">Working with Binary Objects</a></li>
</ul>
</li>
<li><a href="#executing-sql-statements">Executing SQL Statements</a></li>
<li><a href="#using-cluster-apis">Using Cluster APIs</a>
<ul class="sectlevel2">
<li><a href="#logical-nodes-grouping">Logical Nodes Grouping</a></li>
</ul>
</li>
<li><a href="#executing-compute-tasks">Executing Compute Tasks</a></li>
<li><a href="#executing-ignite-services">Executing Ignite Services</a></li>
<li><a href="#handling-exceptions">Handling Exceptions</a>
<ul class="sectlevel2">
<li><a href="#handling-node-failures">Handling Node Failures</a></li>
</ul>
</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>