blob: da6bb7db02c6110a92cbdf33433f21b7ec36d845 [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>External Storage | Ignite Documentation</title>
<link rel="canonical" href="/docs/2.9.0/persistence/external-storage" />
<link rel="stylesheet" href="/assets/css/styles.css?1600286558">
<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?1600286558"></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>
<nav>
</nav>
<select id="version-selector">
<option value="2.9.0">2.9.0</option>
</select>
<a href="https://github.com/apache/ignite" title='GitHub' class='github' target="_blank">
<img src="/assets/images/github-gray.svg" alt="GitHub logo">
</a>
<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>
<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/preface" class='' >Preface</a>
</li>
<li>
<button type='button' data-guide-url="" 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' data-guide-url="/installation" 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>
</nav>
</li>
<li>
<button type='button' data-guide-url="" 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/setup"
class=''
>Setting Up Ignite for Java</a>
</li>
<li>
<a href="/docs/2.9.0/setup-dotnet"
class=''
>Setting Up Ignite for .NET/C#</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/understanding-configuration" class='' >Understanding Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/logging" class='' >Configuring Logging</a>
</li>
<li>
<a href="/docs/2.9.0/starting-nodes" class='' >Starting and Stopping Nodes</a>
</li>
<li>
<button type='button' data-guide-url="" 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/running-client-nodes-behind-nat"
class=''
>Running Client Nodes Behind NAT</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" 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>
</nav>
</li>
<li>
<button type='button' data-guide-url="" 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' data-guide-url="" 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/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>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle expanded '>Persistence<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group expanded'>
<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='active'
>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/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>
<a href="/docs/2.9.0/baseline-topology" class='' >Baseline Topology</a>
</li>
<li>
<a href="/docs/2.9.0/cluster-states" class='' >Cluster States</a>
</li>
<li>
<a href="/docs/2.9.0/data-rebalancing" class='' >Data Rebalancing</a>
</li>
<li>
<a href="/docs/2.9.0/partition-loss-policy" class='' >Partition Loss Policy</a>
</li>
<li>
<a href="/docs/2.9.0/deploying-user-code" class='' >Deploying User Code</a>
</li>
<li>
<a href="/docs/2.9.0/peer-class-loading" class='' >Peer Class Loading</a>
</li>
<li>
<a href="/docs/2.9.0/data-streaming" class='' >Data Streaming</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Using Key-Value Cache 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/continuous-queries" class='' >Using Continuous Queries</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/transactions" class='' >Performing Transactions</a>
</li>
<li>
<button type='button' data-guide-url="" 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>
<a href="/docs/2.9.0/transactions/mvcc"
class=''
>Multiversion Concurrency Control</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" 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>
</nav>
</li>
<li>
<a href="/docs/2.9.0/collocated-computations" class='' >Colocating Computations with Data</a>
</li>
<li>
<button type='button' data-guide-url="" 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>
<a href="/docs/2.9.0/near-cache" class='' >Near Caches</a>
</li>
<li>
<a href="/docs/2.9.0/platform-cache" class='' >.NET Platform Cache</a>
</li>
<li>
<a href="/docs/2.9.0/services/services" class='' >Services</a>
</li>
<li>
<button type='button' data-guide-url="" 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>
</nav>
</li>
<li>
<button type='button' data-guide-url="" 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>
<button type='button' data-guide-url="" 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>
<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' data-guide-url="/security" 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>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Thin Clients<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients"
class=''
>Thin Clients Overview</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/java-thin-client"
class=''
>Java Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/dotnet-thin-client"
class=''
>.NET Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/cpp-thin-client"
class=''
>C++ Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/python-thin-client"
class=''
>Python Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/php-thin-client"
class=''
>PHP Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/nodejs-thin-client"
class=''
>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' data-guide-url="" class='group-toggle collapsed '>ODBC Driver<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/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/restapi" class='' >REST API</a>
</li>
<li>
<a href="/docs/2.9.0/control-script" class='' >Control Script</a>
</li>
<li>
<a href="/docs/2.9.0/plugins" class='' >Plugins</a>
</li>
<li>
<a href="/docs/2.9.0/sqlline" class='' >SQLLine</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Ignite for Spark<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/ignite-for-spark/overview"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/ignitecontext-and-rdd"
class=''
>IgniteContext and IgniteRDD</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/ignite-dataframe"
class=''
>Ignite DataFrame</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/installation"
class=''
>Installation</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/spark-shell"
class=''
>Test Ignite with Spark-shell</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/troubleshooting"
class=''
>Troubleshooting</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="/sql-reference/sql-reference-overview" 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>
</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/persistence/external-storage.adoc" target="_blank">Edit</a>
<h1>External Storage</h1>
<div class="sect1">
<h2 id="overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can use Ignite as a caching layer on top of an existing database such as an RDBMS or NoSQL databases, for example, Apache Cassandra or MongoDB.
This use case accelerates the underlying database by employing in-memory processing.</p>
</div>
<div class="paragraph">
<p>Ignite provides an out-of-the-box integration with Apache Cassandra.
For other NoSQL databases for which integration is not available off-the-shelf, you can provide your own <a href="/docs/2.9.0/persistence/custom-cache-store">implementation of the <code>CacheStore</code> interface</a>.</p>
</div>
<div class="paragraph">
<p>The two main use cases where an external storage can be used include:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>A caching layer to an existing database. In this scenario, you can improve the processing speed by loading data into memory. You can also bring SQL support to a database that does not have it (when all data is loaded into memory).</p>
</li>
<li>
<p>You want to persist the data in an external database (instead of using the <a href="/docs/2.9.0/persistence/native-persistence">native persistence</a>).</p>
</li>
</ul>
</div>
<div class="imageblock">
<div class="content">
<img src="/docs/2.9.0/images/external_storage.png" alt="external storage">
</div>
</div>
<div class="paragraph">
<p>The <code>CacheStore</code> interface extends both <code>javax.cache.integration.CacheLoader</code> and <code>javax.cache.integration.CacheWriter</code>, which are used for <em>read-through</em> and <em>write-through</em> features respectively. You can also implement each of the interfaces individually and provide them to the cache configuration separately.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
In addition to key-value operations, Ignite writes through the results of SQL INSERT, UPDATE, and MERGE queries. However, SELECT queries never read through data from the external database.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="read-through-and-write-through">Read-Through and Write-Through</h3>
<div class="paragraph">
<p>Read-through means that the data is read from the underlying persistent store if it is not available in the cache.
Note that this is true only for get operations made through the key-value API; SELECT queries never read through data from the external database.
To execute select queries, the data must be pre-loaded from the database into the cache by calling the <code>loadCache()</code> method.</p>
</div>
<div class="paragraph">
<p>Write-through means that the data is automatically persisted when it is updated in the cache.
All read-through and write-through operations participate in cache transactions and are committed or rolled back as a whole.</p>
</div>
</div>
<div class="sect2">
<h3 id="write-behind-caching">Write-Behind Caching</h3>
<div class="paragraph">
<p>In a simple write-through mode, each put and remove operation involves a corresponding request to the persistent store; therefore, the overall duration of the update operation might be relatively long. Additionally, an intensive cache update rate can cause an extremely high storage load.</p>
</div>
<div class="paragraph">
<p>For such cases, you can enable the <em>write-behind</em> mode, in which update operations are performed asynchronously. The key concept of this approach is to accumulate updates and asynchronously flush them to the underlying database as a bulk operation.
You can trigger flushing of data based on time-based events (the maximum time that data entry can reside in the queue is limited), queue-size events (the queue is flushed when its size reaches some particular point), or both of them (whichever occurs first).</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<h3 id="performance-vs-consistency" class="discrete">Performance vs. Consistency</h3>
<div class="paragraph">
<p>Enabling write-behind caching increases performance by performing asynchronous updates, but this can lead to a potential drop in consistency as some updates could be lost due to node failures or crashes.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>With the write-behind approach, only the last update to an entry is written to the underlying storage.
If a cache entry with a key named <code>key1</code> is sequentially updated with values <code>value1</code>, <code>value2</code>, and <code>value3</code> respectively, then only a single store request for the <code>(key1, value3)</code> pair is propagated to the persistent store.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<h3 id="update-performance" class="discrete">Update Performance</h3>
<div class="paragraph">
<p>Batch operations are usually more efficient than a sequence of individual operations.
You can exploit this feature by enabling batch operations in the write-behind mode.
Update sequences of similar types (put or remove) can be grouped to a single batch.
For example, if you put the pairs <code>(key1, value1)</code>, <code>(key2, value2)</code>, <code>(key3, value3)</code> into the cache sequentially, the three operations are batched into a single <code>CacheStore.putAll(&#8230;&#8203;)</code> operation.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="rdbms-integration">RDBMS Integration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To use an RDBMS as an underlying storage, you can use one of the following implementations of <code>CacheStore</code>.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>CacheJdbcPojoStore</code>&#8201;&#8212;&#8201;stores objects as a set of fields using reflection. Use this implementation if you are adding Ignite on top of an existing database and want to use specific fields (or all of them) from the underlying table.</p>
</li>
<li>
<p><code>CacheJdbcBlobStore</code>&#8201;&#8212;&#8201;stores objects in the underlying database in the Blob format. This option is useful in scenarios when you use an external database as a persistent storage and want to store your data in a simple format.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Below are configuration examples for both implementations of <code>CacheStore</code>.</p>
</div>
<div class="sect2">
<h3 id="cachejdbcpojostore">CacheJdbcPojoStore</h3>
<div class="paragraph">
<p>With <code>CacheJdbcPojoStore</code>, you can store objects as a set of fields and can configure the mapping between table columns and objects fields via the configuration.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Set the <code>CacheConfiguration.cacheStoreFactory</code> property to <code>org.apache.ignite.cache.store.jdbc.CacheJdbcPojoStoreFactory</code> and provide the following properties:</p>
<div class="openblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p><code>dataSourceBean</code>&#8201;&#8212;&#8201;database connection credentials: URL, user, password.</p>
</li>
<li>
<p><code>dialect</code>&#8201;&#8212;&#8201;the class that implements the SQL dialect compatible with your database.
Ignite provides out-of-the-box implementations for MySQL, Oracle, H2, SQLServer, and DB2 databases.
These dialects can be found in the <code>org.apache.ignite.cache.store.jdbc.dialect</code> package of the Ignite distribution.</p>
</li>
<li>
<p><code>types</code>&#8201;&#8212;&#8201;this property is required to define mappings between the database table and the corresponding POJO (see POJO configuration example below).</p>
</li>
</ul>
</div>
</div>
</div>
</li>
<li>
<p>Optionally, configure <a href="/docs/2.9.0/SQL/sql-api#query-entities">query entities</a> if you want to execute SQL queries on the cache.</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>The following example demonstrates how to configure an Ignite cache on top of a MySQL table.
The table has 2 columns: <code>id</code> (INTEGER) and <code>name</code> (VARCHAR), which are mapped to objects of the <code>Person</code> class.</p>
</div>
<div class="paragraph">
<p>You can configure <code>CacheJdbcPojoStore</code> via both the XML configuration and Java code.</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="cp">&lt;?xml version="1.0" encoding="UTF-8"?&gt;</span>
<span class="nt">&lt;beans</span> <span class="na">xmlns=</span><span class="s">"http://www.springframework.org/schema/beans"</span> <span class="na">xmlns:util=</span><span class="s">"http://www.springframework.org/schema/util"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd"</span><span class="nt">&gt;</span>
<span class="c">&lt;!-- Data source bean --&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"com.mysql.cj.jdbc.MysqlDataSource"</span> <span class="na">id=</span><span class="s">"mysqlDataSource"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"URL"</span> <span class="na">value=</span><span class="s">"jdbc:mysql://[host]:[port]/[database]"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"user"</span> <span class="na">value=</span><span class="s">"YOUR_USER_NAME"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"password"</span> <span class="na">value=</span><span class="s">"YOUR_PASSWORD"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="c">&lt;!-- Ignite Configuration --&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.IgniteConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="c">&lt;!-- Configuration for PersonCache --&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.CacheConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"name"</span> <span class="na">value=</span><span class="s">"PersonCache"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheMode"</span> <span class="na">value=</span><span class="s">"PARTITIONED"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"atomicityMode"</span> <span class="na">value=</span><span class="s">"ATOMIC"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheStoreFactory"</span><span class="nt">&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.CacheJdbcPojoStoreFactory"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"dataSourceBean"</span> <span class="na">value=</span><span class="s">"mysqlDataSource"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"dialect"</span><span class="nt">&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.dialect.MySQLDialect"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"types"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.JdbcType"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheName"</span> <span class="na">value=</span><span class="s">"PersonCache"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"keyType"</span> <span class="na">value=</span><span class="s">"java.lang.Integer"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"valueType"</span> <span class="na">value=</span><span class="s">"org.apache.ignite.snippets.Person"</span><span class="nt">/&gt;</span>
<span class="c">&lt;!--Specify the schema if applicable --&gt;</span>
<span class="c">&lt;!--property name="databaseSchema" value="MY_DB_SCHEMA"/--&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"databaseTable"</span> <span class="na">value=</span><span class="s">"PERSON"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"keyFields"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.JdbcTypeField"</span><span class="nt">&gt;</span>
<span class="nt">&lt;constructor-arg&gt;</span>
<span class="nt">&lt;util:constant</span> <span class="na">static-field=</span><span class="s">"java.sql.Types.INTEGER"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/constructor-arg&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"id"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"int"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"id"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/list&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"valueFields"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.JdbcTypeField"</span><span class="nt">&gt;</span>
<span class="nt">&lt;constructor-arg&gt;</span>
<span class="nt">&lt;util:constant</span> <span class="na">static-field=</span><span class="s">"java.sql.Types.INTEGER"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/constructor-arg&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"id"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"int"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"id"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.JdbcTypeField"</span><span class="nt">&gt;</span>
<span class="nt">&lt;constructor-arg&gt;</span>
<span class="nt">&lt;util:constant</span> <span class="na">static-field=</span><span class="s">"java.sql.Types.VARCHAR"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/constructor-arg&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"name"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"java.lang.String"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;constructor-arg</span> <span class="na">value=</span><span class="s">"name"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/list&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/list&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;property</span> <span class="na">name=</span><span class="s">"readThrough"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"writeThrough"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/&gt;</span>
<span class="c">&lt;!-- Configure query entities if you want to use SQL queries --&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"queryEntities"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.QueryEntity"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"keyType"</span> <span class="na">value=</span><span class="s">"java.lang.Integer"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"valueType"</span> <span class="na">value=</span><span class="s">"org.apache.ignite.snippets.Person"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"keyFieldName"</span> <span class="na">value=</span><span class="s">"id"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"keyFields"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;value&gt;</span>id<span class="nt">&lt;/value&gt;</span>
<span class="nt">&lt;/list&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"fields"</span><span class="nt">&gt;</span>
<span class="nt">&lt;map&gt;</span>
<span class="nt">&lt;entry</span> <span class="na">key=</span><span class="s">"name"</span> <span class="na">value=</span><span class="s">"java.lang.String"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;entry</span> <span class="na">key=</span><span class="s">"id"</span> <span class="na">value=</span><span class="s">"java.lang.Integer"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/map&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/list&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="c">&lt;!-- Provide similar configurations for other caches/tables --&gt;</span>
<span class="nt">&lt;/list&gt;</span>
<span class="nt">&lt;/property&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;/beans&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">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="nc">CacheConfiguration</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">personCacheCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">CacheConfiguration</span><span class="o">&lt;&gt;();</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"PersonCache"</span><span class="o">);</span>
<span class="n">personCacheCfg</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">PARTITIONED</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setAtomicityMode</span><span class="o">(</span><span class="nc">CacheAtomicityMode</span><span class="o">.</span><span class="na">ATOMIC</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setReadThrough</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setWriteThrough</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="nc">CacheJdbcPojoStoreFactory</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">factory</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">CacheJdbcPojoStoreFactory</span><span class="o">&lt;&gt;();</span>
<span class="n">factory</span><span class="o">.</span><span class="na">setDialect</span><span class="o">(</span><span class="k">new</span> <span class="nc">MySQLDialect</span><span class="o">());</span>
<span class="n">factory</span><span class="o">.</span><span class="na">setDataSourceFactory</span><span class="o">((</span><span class="nc">Factory</span><span class="o">&lt;</span><span class="nc">DataSource</span><span class="o">&gt;)()</span> <span class="o">-&gt;</span> <span class="o">{</span>
<span class="nc">MysqlDataSource</span> <span class="n">mysqlDataSrc</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">MysqlDataSource</span><span class="o">();</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setURL</span><span class="o">(</span><span class="s">"jdbc:mysql://[host]:[port]/[database]"</span><span class="o">);</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setUser</span><span class="o">(</span><span class="s">"YOUR_USER_NAME"</span><span class="o">);</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setPassword</span><span class="o">(</span><span class="s">"YOUR_PASSWORD"</span><span class="o">);</span>
<span class="k">return</span> <span class="n">mysqlDataSrc</span><span class="o">;</span>
<span class="o">});</span>
<span class="nc">JdbcType</span> <span class="n">personType</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">JdbcType</span><span class="o">();</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setCacheName</span><span class="o">(</span><span class="s">"PersonCache"</span><span class="o">);</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setKeyType</span><span class="o">(</span><span class="nc">Integer</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setValueType</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="c1">// Specify the schema if applicable</span>
<span class="c1">// personType.setDatabaseSchema("MY_DB_SCHEMA");</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setDatabaseTable</span><span class="o">(</span><span class="s">"PERSON"</span><span class="o">);</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setKeyFields</span><span class="o">(</span><span class="k">new</span> <span class="nc">JdbcTypeField</span><span class="o">(</span><span class="n">java</span><span class="o">.</span><span class="na">sql</span><span class="o">.</span><span class="na">Types</span><span class="o">.</span><span class="na">INTEGER</span><span class="o">,</span> <span class="s">"id"</span><span class="o">,</span> <span class="nc">Integer</span><span class="o">.</span><span class="na">class</span><span class="o">,</span> <span class="s">"id"</span><span class="o">));</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setValueFields</span><span class="o">(</span><span class="k">new</span> <span class="nc">JdbcTypeField</span><span class="o">(</span><span class="n">java</span><span class="o">.</span><span class="na">sql</span><span class="o">.</span><span class="na">Types</span><span class="o">.</span><span class="na">INTEGER</span><span class="o">,</span> <span class="s">"id"</span><span class="o">,</span> <span class="nc">Integer</span><span class="o">.</span><span class="na">class</span><span class="o">,</span> <span class="s">"id"</span><span class="o">));</span>
<span class="n">personType</span><span class="o">.</span><span class="na">setValueFields</span><span class="o">(</span><span class="k">new</span> <span class="nc">JdbcTypeField</span><span class="o">(</span><span class="n">java</span><span class="o">.</span><span class="na">sql</span><span class="o">.</span><span class="na">Types</span><span class="o">.</span><span class="na">VARCHAR</span><span class="o">,</span> <span class="s">"name"</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="s">"name"</span><span class="o">));</span>
<span class="n">factory</span><span class="o">.</span><span class="na">setTypes</span><span class="o">(</span><span class="n">personType</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setCacheStoreFactory</span><span class="o">(</span><span class="n">factory</span><span class="o">);</span>
<span class="nc">QueryEntity</span> <span class="n">qryEntity</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">QueryEntity</span><span class="o">();</span>
<span class="n">qryEntity</span><span class="o">.</span><span class="na">setKeyType</span><span class="o">(</span><span class="nc">Integer</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="n">qryEntity</span><span class="o">.</span><span class="na">setValueType</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="n">qryEntity</span><span class="o">.</span><span class="na">setKeyFieldName</span><span class="o">(</span><span class="s">"id"</span><span class="o">);</span>
<span class="nc">Set</span><span class="o">&lt;</span><span class="nc">String</span><span class="o">&gt;</span> <span class="n">keyFields</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">HashSet</span><span class="o">&lt;&gt;();</span>
<span class="n">keyFields</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"id"</span><span class="o">);</span>
<span class="n">qryEntity</span><span class="o">.</span><span class="na">setKeyFields</span><span class="o">(</span><span class="n">keyFields</span><span class="o">);</span>
<span class="nc">LinkedHashMap</span><span class="o">&lt;</span><span class="nc">String</span><span class="o">,</span> <span class="nc">String</span><span class="o">&gt;</span> <span class="n">fields</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">LinkedHashMap</span><span class="o">&lt;&gt;();</span>
<span class="n">fields</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"id"</span><span class="o">,</span> <span class="s">"java.lang.Integer"</span><span class="o">);</span>
<span class="n">fields</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="s">"java.lang.String"</span><span class="o">);</span>
<span class="n">qryEntity</span><span class="o">.</span><span class="na">setFields</span><span class="o">(</span><span class="n">fields</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setQueryEntities</span><span class="o">(</span><span class="nc">Collections</span><span class="o">.</span><span class="na">singletonList</span><span class="o">(</span><span class="n">qryEntity</span><span class="o">));</span>
<span class="n">igniteCfg</span><span class="o">.</span><span class="na">setCacheConfiguration</span><span class="o">(</span><span class="n">personCacheCfg</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
<div class="listingblock">
<div class="title">Person Class</div>
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="kd">class</span> <span class="nc">Person</span> <span class="kd">implements</span> <span class="nc">Serializable</span> <span class="o">{</span>
<span class="kd">private</span> <span class="kd">static</span> <span class="kd">final</span> <span class="kt">long</span> <span class="n">serialVersionUID</span> <span class="o">=</span> <span class="mi">0L</span><span class="o">;</span>
<span class="kd">private</span> <span class="kt">int</span> <span class="n">id</span><span class="o">;</span>
<span class="kd">private</span> <span class="nc">String</span> <span class="n">name</span><span class="o">;</span>
<span class="kd">public</span> <span class="nf">Person</span><span class="o">()</span> <span class="o">{</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="nc">String</span> <span class="nf">getName</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">name</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setName</span><span class="o">(</span><span class="nc">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">int</span> <span class="nf">getId</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">id</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setId</span><span class="o">(</span><span class="kt">int</span> <span class="n">id</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">id</span> <span class="o">=</span> <span class="n">id</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="cachejdbcblobstore">CacheJdbcBlobStore</h3>
<div class="paragraph">
<p><code>CacheJdbcBlobStore</code> stores objects in the underlying database in the blob format.
It creates a table named 'ENTRIES', with the 'akey' and 'val' columns (both have the <code>binary</code> type).</p>
</div>
<div class="paragraph">
<p>You can change the default table definition by providing a custom create table query and DML queries used to load, delete, and update the data.
Refer to <a href="https://ignite.apache.org/releases/2.9.0/javadoc/org/apache/ignite/cache/store/jdbc/CacheJdbcBlobStore.html" target="_blank" rel="noopener">CacheJdbcBlobStore</a> for details.</p>
</div>
<div class="paragraph">
<p>In the example below, the objects of the Person class are stored as an array of bytes in a single column.</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">id=</span><span class="s">"mysqlDataSource"</span> <span class="na">class=</span><span class="s">"com.mysql.jdbc.jdbc2.optional.MysqlDataSource"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"URL"</span> <span class="na">value=</span><span class="s">"jdbc:mysql://[host]:[port]/[database]"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"user"</span> <span class="na">value=</span><span class="s">"YOUR_USER_NAME"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"password"</span> <span class="na">value=</span><span class="s">"YOUR_PASSWORD"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/bean&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">id=</span><span class="s">"ignite.cfg"</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.IgniteConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;list&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.configuration.CacheConfiguration"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"name"</span> <span class="na">value=</span><span class="s">"PersonCache"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"cacheStoreFactory"</span><span class="nt">&gt;</span>
<span class="nt">&lt;bean</span> <span class="na">class=</span><span class="s">"org.apache.ignite.cache.store.jdbc.CacheJdbcBlobStoreFactory"</span><span class="nt">&gt;</span>
<span class="nt">&lt;property</span> <span class="na">name=</span><span class="s">"dataSourceBean"</span> <span class="na">value =</span> <span class="s">"mysqlDataSource"</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;/list&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">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="nc">CacheConfiguration</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">personCacheCfg</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">CacheConfiguration</span><span class="o">&lt;&gt;();</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"PersonCache"</span><span class="o">);</span>
<span class="nc">CacheJdbcBlobStoreFactory</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">cacheStoreFactory</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">CacheJdbcBlobStoreFactory</span><span class="o">&lt;&gt;();</span>
<span class="n">cacheStoreFactory</span><span class="o">.</span><span class="na">setUser</span><span class="o">(</span><span class="s">"USER_NAME"</span><span class="o">);</span>
<span class="nc">MysqlDataSource</span> <span class="n">mysqlDataSrc</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">MysqlDataSource</span><span class="o">();</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setURL</span><span class="o">(</span><span class="s">"jdbc:mysql://[host]:[port]/[database]"</span><span class="o">);</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setUser</span><span class="o">(</span><span class="s">"USER_NAME"</span><span class="o">);</span>
<span class="n">mysqlDataSrc</span><span class="o">.</span><span class="na">setPassword</span><span class="o">(</span><span class="s">"PASSWORD"</span><span class="o">);</span>
<span class="n">cacheStoreFactory</span><span class="o">.</span><span class="na">setDataSource</span><span class="o">(</span><span class="n">mysqlDataSrc</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setCacheStoreFactory</span><span class="o">(</span><span class="n">cacheStoreFactory</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setWriteThrough</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">personCacheCfg</span><span class="o">.</span><span class="na">setReadThrough</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">igniteCfg</span><span class="o">.</span><span class="na">setCacheConfiguration</span><span class="o">(</span><span class="n">personCacheCfg</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='C#/.NET'></code-tab><code-tab data-tab='C++'></code-tab></code-tabs>
</div>
</div>
</div>
<div class="sect1">
<h2 id="loading-data">Loading Data</h2>
<div class="sectionbody">
<div class="paragraph">
<p>After you configure the cache store and start the cluster, load the data from the database into your cluster as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Load data from person table into PersonCache.</span>
<span class="nc">IgniteCache</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">ignite</span><span class="o">.</span><span class="na">cache</span><span class="o">(</span><span class="s">"PersonCache"</span><span class="o">);</span>
<span class="n">personCache</span><span class="o">.</span><span class="na">loadCache</span><span class="o">(</span><span class="kc">null</span><span class="o">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="nosql-database-integration">NoSQL Database Integration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can integrate Ignite with any NoSQL database by implementing the <code>CacheStore</code> interface.</p>
</div>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<div class="title">Caution</div>
</td>
<td class="content">
Even though Ignite supports distributed transactions, it doesn&#8217;t make your NoSQL database transactional, unless the database supports transactions out of the box.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="cassandra-integration">Cassandra Integration</h3>
<div class="paragraph">
<p>Ignite provides an out-of-the-box implementation of <code>CacheStore</code> that enables you to use Apache Cassandra as a persistent storage. This implementation utilizes Cassandra&#8217;s <a href="http://www.datastax.com/dev/blog/java-driver-async-queries">asynchronous queries</a> to provide high performance batch operations such as <code>loadAll()</code>, <code>writeAll()</code> and <code>deleteAll()</code>, and automatically creates all necessary tables and namespaces in Cassandra.</p>
</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>
<ul class="sectlevel2">
<li><a href="#read-through-and-write-through">Read-Through and Write-Through</a></li>
<li><a href="#write-behind-caching">Write-Behind Caching</a></li>
</ul>
</li>
<li><a href="#rdbms-integration">RDBMS Integration</a>
<ul class="sectlevel2">
<li><a href="#cachejdbcpojostore">CacheJdbcPojoStore</a></li>
<li><a href="#cachejdbcblobstore">CacheJdbcBlobStore</a></li>
</ul>
</li>
<li><a href="#loading-data">Loading Data</a></li>
<li><a href="#nosql-database-integration">NoSQL Database Integration</a>
<ul class="sectlevel2">
<li><a href="#cassandra-integration">Cassandra Integration</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?1600286558' async crossorigin></script>
<script type='module' src='/assets/js/versioning.js?1600286558' async crossorigin></script>
</body>
</html>