Google Git
Sign in
apache / ignite-website / d45ad6211cd34e9a9c94726a6e61babe9c1d5fb8 / . / docs / 2.11.0 / thin-clients / python-thin-client.html
blob: 947e05916ca093668faf34f3df977a313098c1da [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!-- 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>
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<!-- LuckyOrange code -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<!-- /LuckyOrange code -->
<!-- Bugyard widget embed -->
<script type="text/javascript">!function(){if("function"!=typeof window.bugyard){var a=function(){a.c(arguments)};a.q=[],a.c=function(b){a.q.push(b)},window.bugyard=a;var b=document.createElement("script");b.setAttribute("data-bugyard","610961912c35ff001493163a"),b.setAttribute("async","async"),b.setAttribute("defer","defer"),b.setAttribute("src","https://widget.bugyard.io/bugyard.min.js"),document.getElementsByTagName("head")[0].appendChild(b)}}(); window.bugyard("hideButton"); </script>
<link rel="preload" href='/assets/js/code-tabs.js?1' as="script" crossorigin>
<link rel="preload" href='/assets/js/page-nav.js' as="script" crossorigin>
<link rel="preload" href='/assets/js/docs-menu.js?20201005' as="script" crossorigin>
<style>:root{--gg-red:#ec1c24;--gg-orange:#ec1c24;--gg-orange-dark:#bc440b;--gg-orange-filter:invert(47%) sepia(61%) saturate(1950%) hue-rotate(345deg) brightness(100%) contrast(95%);--gg-dark-gray:#333333;--orange-line-thickness:3px;--block-code-background:rgba(241, 241, 241, 20%);--inline-code-background:rgba(241, 241, 241, 90%);--padding-top:25px;--link-color:#ec1c24;--body-background:#fcfcfc}header{min-height:var(--header-height);background:#fff;box-shadow:0 4px 10px 0 #eee,0 0 4px 0 #d5d5d5;z-index:1}header>.container{display:grid;grid-template-columns:auto auto 1fr auto auto auto;grid-template-areas:'left-toggle home nav ver api search lang';grid-template-rows:40px;flex-direction:row;align-items:center;justify-content:flex-start;padding:12px 20px;max-width:1400px;margin:0 auto}header nav>ul{padding:0;margin:0;list-style:none;display:inherit}header .dropdown{display:none;position:fixed;top:calc(var(--header-height) - 12px);width:auto;background:#fff;box-shadow:0 4px 4px 0 rgba(0,0,0,.24),0 0 4px 0 rgba(0,0,0,.12);border-radius:4px;padding-top:10px;padding-bottom:12px;z-index:2}header .dropdown li{display:flex}header .dropdown a{color:grey!important;font-size:16px;padding-top:5px;padding-bottom:4px}header .menu{border:none;background:0 0;width:40px;height:40px;margin-right:12px;grid-area:left-toggle}header .menu img{width:18px;height:12px}header .search-close,header .top-nav-toggle{background:0 0;border:none;padding:0;width:36px;height:36px;display:inline-flex;align-items:center;justify-content:center;color:var(--gg-dark-gray);font-size:26px}header .search-toggle{grid-area:search}header .top-nav-toggle{grid-area:top-toggle}header .home{grid-area:home;margin-right:auto}header .home img{height:36px}header #api-docs{grid-area:api;margin:0;display:flex}header #api-docs .dropdown{padding:.5em 0}header #api-docs a{padding:9px 14px;color:var(--gg-dark-gray)!important;text-decoration:none;white-space:nowrap}header #api-docs .dropdown-item a{font-weight:400;display:block;width:100%;min-width:150px}header #lang-selector li{list-style:none;display:flex;padding:9px 14px}header #lang-selector li a{display:flex;color:#000;align-items:center}header #lang-selector li a span{font-size:10px;margin-left:5px}header #lang-selector li a img{width:25px}header #lang-selector li .dropdown{margin-left:-70px}header #lang-selector li .dropdown .dropdown-item{padding:0 1em;margin-bottom:8px}header #lang-selector li .dropdown .dropdown-item a span{font-size:14px}header .search{margin-left:auto;margin-right:20px;grid-area:search}header .search input[type=search]{color:var(--gg-dark-gray);background:rgba(255,255,255,.8);border:1px solid #ccc;padding:10px 15px;font-family:inherit;max-width:148px;height:37px;font-size:14px;-webkit-appearance:unset;appearance:unset}header #version-selector{list-style:none;grid-area:ver;line-height:28px;border-radius:0;margin-right:10px;border:none;color:var(--gg-dark-gray);padding:5px 16px 5px 10px;white-space:nowrap;font-size:14px;width:auto;text-align:right;box-sizing:border-box;text-align-last:right;-moz-appearance:none;-webkit-appearance:none;appearance:none;direction:rtl}header #version-selector option{direction:ltr}header>nav{grid-area:nav;font-size:18px;display:flex;flex-direction:row;margin:0 20px}header #lang-selector{grid-area:lang}header .search-close{margin-right:10px}@media (max-width:600px){header .search{margin-right:5px}header .search input[type=search]{max-width:110px}}header:not(.narrow-header) .search-close,header:not(.narrow-header) .top-nav-toggle{display:none}@media (max-width:670px){header>.container{grid-template-columns:auto 1fr auto;grid-template-areas:'left-toggle home search' 'ver api lang'}header #lang-selector li{justify-content:flex-end}}pre,pre.rouge{padding:8px 15px;background:var(--block-code-background)!important;border-radius:5px;border:1px solid #e5e5e5;overflow-x:auto;min-height:36px;line-height:18px;color:#545454}code{color:#545454}pre.rouge code{background:0 0!important}:not(pre)>code{background:var(--inline-code-background);padding:.1em .5em;background-clip:padding-box;border-radius:3px;color:#545454;font-size:90%}.listingblock .content{position:relative}.highlight{color:#586e75}.highlight .c1{color:#657b83}.highlight .nt{color:#b58900}.highlight .o{color:#93a1a1}.highlight .k{color:#6c71c4}.highlight .kt{color:#cb4b16}.highlight .s,.highlight .s1{color:#859900}.highlight .nc{color:#b58900}.highlight .na{color:#268bd2}body{font-family:'Open Sans',sans-serif}h1,h2{color:#000;font-weight:400;font-family:'Open Sans'}h1{font-size:36px;line-height:40px}a{text-decoration:none;color:var(--link-color)}section{color:#545454}.admonitionblock .icon .title{display:none}body{--header-height:64px;--promotion-bar-height:35px;--footer-height:104px;--footer-gap:60px;padding:0;margin:0;display:flex;flex-direction:column;min-height:100vh;background-color:var(--body-background);font-family:'Open Sans',sans-serif}body>section{flex:1}header{position:-webkit-sticky;position:sticky;top:0;z-index:2}*{box-sizing:border-box}@media (max-width:670px){body{--header-height:97px}}.left-nav{padding:10px 20px;width:289px;overflow-y:auto;top:calc(var(--header-height) + var(--promotion-bar-height));height:calc(100vh - var(--header-height) - var(--promotion-bar-height));font-family:'Open Sans';padding-top:var(--padding-top);background-color:var(--body-background)}.left-nav li{list-style:none}.left-nav a,.left-nav button{text-decoration:none;color:#757575;font-size:16px;display:inline-flex;width:100%;margin:2px 0;padding:.25em .375em;background:0 0;border:none;font:inherit;text-align:left}.left-nav a.active{color:var(--link-color)}.left-nav .nav-group{margin-left:6px;font-size:14px}.left-nav nav{border-left:2px solid #ddd;margin-bottom:5px}.left-nav nav.collapsed{display:none}.left-nav nav>li>a,.left-nav nav>li>button{padding-left:20px;text-align:left}.left-nav nav>li>a.active{border-left:var(--orange-line-thickness) solid var(--active-color);padding-left:calc(20px - var(--orange-line-thickness))}.left-nav nav.sub_pages{border:none}.left-nav nav.sub_pages a{padding-left:32px}.left-nav .state-indicator{margin-left:auto;margin-top:5px;width:6.2px;height:10px;flex:0 0 auto;filter:invert(49%) sepia(4%) saturate(5%) hue-rotate(23deg) brightness(92%) contrast(90%)}.left-nav button.expanded .state-indicator{transform:rotate(90deg)}.right-nav{width:289px;padding:12px 26px;overflow-y:auto;height:calc(100vh - var(--header-height));top:0;position:-webkit-sticky;position:sticky;display:flex;flex-direction:column;font-family:'Open sans';padding-top:var(--padding-top);background-color:#fff}.right-nav ul{list-style:none;padding:0;margin:0}.right-nav li{padding:0}.right-nav a{--border-width:0px;font-size:14px;color:#757575;padding-left:calc(15px * var(--nesting-level) + 8px - var(--border-width));margin:.3em 0;display:inline-block}.right-nav .sectlevel1{border-left:2px solid #ddd}.right-nav .sectlevel1{--nesting-level:0}.right-nav .sectlevel2{--nesting-level:1}.right-nav .sectlevel3{--nesting-level:2}@media (max-width:1200px){.right-nav{width:230px}}.right-nav footer{font-size:12px;padding:calc(var(--footer-gap) * .3) 0 5px;text-align:left;margin:auto 0 0}section.page-docs{display:grid;grid-template-columns:auto 1fr auto;grid-template-rows:100%;grid-template-areas:'left-nav content right-nav';line-height:20px;max-width:1440px;margin:auto;width:100%}section.page-docs>article{border-left:1px solid #eee;background-color:#fff;padding:0 50px 30px;grid-area:content;overflow:hidden;font-family:sans-serif;font-size:16px;color:#545454;line-height:1.6em}section.page-docs>article h1,section.page-docs>article h2{font-family:'Open Sans'}@media (max-width:800px){section.page-docs>article{padding-left:15px;padding-right:15px}}section.page-docs .edit-link{position:relative;top:10px;right:10px;float:right;padding-top:calc(var(--header-height) + var(--padding-top));margin-top:calc((-1 * var(--header-height)))}section.page-docs h1,section.page-docs h2{margin-bottom:0}section.page-docs h2[id]{margin-top:var(--margin-top);margin-bottom:calc(var(--margin-top) * .5);z-index:-1}section.page-docs .title{font-style:italic}section.page-docs h2[id]{--margin-top:1.2em}.left-nav{bottom:0;position:-webkit-sticky;position:sticky}.left-nav{grid-area:left-nav}.right-nav{grid-area:right-nav}.left-nav__overlay{display:none;background:rgba(0,0,0,.5);z-index:1;position:fixed;top:var(--header-height);bottom:0;left:0;right:0}@media (max-width:990px){body:not(.hide-left-nav) .left-nav__overlay{display:block}nav.left-nav{background:#fafafa;grid-area:left-nav;box-shadow:0 4px 4px 0 rgba(0,0,0,.24),0 0 4px 0 rgba(0,0,0,.12);min-height:calc(100vh - var(--header-height));max-height:calc(100vh - var(--header-height));position:fixed;bottom:0;top:var(--header-height);z-index:2}section.page-docs>article{grid-column-start:left-nav;grid-column-end:content;grid-row:content}}@media (max-width:800px){nav.right-nav{display:none}}:target:before{content:"";display:block;margin-top:calc(var(--header-height) * -1);height:var(--header-height);width:1px}@media (min-width:600px) and (max-width:900px){:target:before{content:"";display:block;width:1px;margin-top:-150px;height:150px}}
#header #promotion-bar { background-color: #333333; padding: 8px; }
#header #promotion-bar p { font-size: 14px; line-height: 1.4em; font-weight: 600; padding: 0; margin: 0; color: #f0f0f0; text-align: center;}
#header #promotion-bar p a { color: #FCB903; } </style>
<meta name="ignite-version" content="2.11.0" />
<title>Python Thin Client | Ignite Documentation</title>
<link rel="canonical" href="/docs/latest/thin-clients/python-thin-client" />
<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'>
<link rel="preload" as="style" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" media="print" onload="this.media='all'">
<noscript>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" rel="stylesheet">
</noscript>
<script>
// AnchorJS - v4.2.0 - 2019-01-01
// https://github.com/bryanbraun/anchorjs
// Copyright (c) 2019 Bryan Braun; Licensed MIT
!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";return function(A){function f(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.ariaLabel=A.hasOwnProperty("ariaLabel")?A.ariaLabel:"Anchor",A.class=A.hasOwnProperty("class")?A.class:"",A.base=A.hasOwnProperty("base")?A.base:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64,A.titleText=A.hasOwnProperty("titleText")?A.titleText:""}function p(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}this.options=A||{},this.elements=[],f(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var e,t,i,n,o,s,a,r,c,h,l,u,d=[];if(f(this.options),"touch"===(l=this.options.visible)&&(l=this.isTouchDevice()?"always":"hover"),A||(A="h2, h3, h4, h5, h6"),0===(e=p(A)).length)return this;for(function(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style");e.className="anchorjs",e.appendChild(document.createTextNode("")),void 0===(A=document.head.querySelector('[rel="stylesheet"], style'))?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(" .anchorjs-link { opacity: 0; text-decoration: none; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; }",e.sheet.cssRules.length),e.sheet.insertRule(" *:hover > .anchorjs-link, .anchorjs-link:focus { opacity: 1; }",e.sheet.cssRules.length),e.sheet.insertRule(" [data-anchorjs-icon]::after { content: attr(data-anchorjs-icon); }",e.sheet.cssRules.length),e.sheet.insertRule(' @font-face { font-family: "anchorjs-icons"; src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',e.sheet.cssRules.length)}}(),t=document.querySelectorAll("[id]"),i=[].map.call(t,function(A){return A.id}),o=0;o<e.length;o++)if(this.hasAnchorJSLink(e[o]))d.push(o);else{if(e[o].hasAttribute("id"))n=e[o].getAttribute("id");else if(e[o].hasAttribute("data-anchor-id"))n=e[o].getAttribute("data-anchor-id");else{for(c=r=this.urlify(e[o].textContent),a=0;void 0!==s&&(c=r+"-"+a),a+=1,-1!==(s=i.indexOf(c)););s=void 0,i.push(c),e[o].setAttribute("id",c),n=c}n.replace(/-/g," "),(h=document.createElement("a")).className="anchorjs-link "+this.options.class,h.setAttribute("aria-label",this.options.ariaLabel),h.setAttribute("data-anchorjs-icon",this.options.icon),this.options.titleText&&(h.title=this.options.titleText),u=document.querySelector("base")?window.location.pathname+window.location.search:"",u=this.options.base||u,h.href=u+"#"+n,"always"===l&&(h.style.opacity="1"),""===this.options.icon&&(h.style.font="1em/1 anchorjs-icons","left"===this.options.placement&&(h.style.lineHeight="inherit")),"left"===this.options.placement?(h.style.position="absolute",h.style.marginLeft="-1em",h.style.paddingRight="0.5em",e[o].insertBefore(h,e[o].firstChild)):(h.style.paddingLeft="0.375em",e[o].appendChild(h))}for(o=0;o<d.length;o++)e.splice(d[o]-o,1);return this.elements=this.elements.concat(e),this},this.remove=function(A){for(var e,t,i=p(A),n=0;n<i.length;n++)(t=i[n].querySelector(".anchorjs-link"))&&(-1!==(e=this.elements.indexOf(i[n]))&&this.elements.splice(e,1),i[n].removeChild(t));return this},this.removeAll=function(){this.remove(this.elements)},this.urlify=function(A){return this.options.truncate||f(this.options),A.trim().replace(/\'/gi,"").replace(/[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\\n\t\b\v]/g,"-").replace(/-{2,}/g,"-").substring(0,this.options.truncate).replace(/^-+|-+$/gm,"").toLowerCase()},this.hasAnchorJSLink=function(A){var e=A.firstChild&&-1<(" "+A.firstChild.className+" ").indexOf(" anchorjs-link "),t=A.lastChild&&-1<(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ");return e||t||!1}}});
</script>
</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" width="18" height="12" alt="menu icon" />
</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" height="36" >
</a>
</div>
<select id="version-selector">
<option value="2.11.0">2.11.0</option>
</select>
<nav id="api-docs"><ul>
<li><a href="#">APIs</a>
<nav class='dropdown'>
<ul>
<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>
</ul>
</nav>
</li>
<li><a href="#">Examples</a>
<nav class="dropdown">
<ul>
<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>
</ul>
</nav>
</li></ul>
</nav>
<form class='search'>
<button class="search-close" type='button'><img src='/assets/images/cancel.svg' alt="close" width="10" height="10" /></button>
<input type="search" placeholder="Search…" id="search-input">
</form>
<nav id="lang-selector"><ul>
<li><a href="#"><img src="/assets/images/icon_lang_en_75x75.jpg" alt="English language icon" width="25" height="25" /><span>▼</span></a>
<nav class="dropdown">
<li class="dropdown-item"><a href="/docs/latest/" ><img src="/assets/images/icon_lang_en_75x75.jpg" alt="English language icon" width="25" height="25" /><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_75x75.jpg" width="25" height="25" alt="Chinese language icon" /><span>Chinese</span></a></li>
</nav>
</li></ul>
</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/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/quick-start/java"
class=''
>Java</a>
</li>
<li>
<a href="/docs/latest/quick-start/dotnet"
class=''
>.NET/C#</a>
</li>
<li>
<a href="/docs/latest/quick-start/cpp"
class=''
>C++</a>
</li>
<li>
<a href="/docs/latest/quick-start/python"
class=''
>Python</a>
</li>
<li>
<a href="/docs/latest/quick-start/nodejs"
class=''
>Node.JS</a>
</li>
<li>
<a href="/docs/latest/quick-start/sql"
class=''
>SQL</a>
</li>
<li>
<a href="/docs/latest/quick-start/php"
class=''
>PHP</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/installation/installing-using-zip"
class=''
>Installing Using ZIP Archive</a>
</li>
<li>
<a href="/docs/latest/installation/installing-using-docker"
class=''
>Installing Using Docker</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/installation/kubernetes/amazon-eks-deployment" class=''>Amazon EKS</a></li>
<li><a href="/docs/latest/installation/kubernetes/azure-deployment" class=''>Azure Kubernetes Service</a></li>
<li><a href="/docs/latest/installation/kubernetes/gke-deployment" class=''>Google Kubernetes Engine</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/understanding-configuration"
class=''
>Understanding Configuration</a>
</li>
<li>
<a href="/docs/latest/setup"
class=''
>Setting Up</a>
</li>
<li>
<a href="/docs/latest/logging"
class=''
>Configuring Logging</a>
</li>
<li>
<a href="/docs/latest/resources-injection"
class=''
>Resources Injection</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/clustering/clustering"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/latest/clustering/tcp-ip-discovery"
class=''
>TCP/IP Discovery</a>
</li>
<li>
<a href="/docs/latest/clustering/zookeeper-discovery"
class=''
>ZooKeeper Discovery</a>
</li>
<li>
<a href="/docs/latest/clustering/discovery-in-the-cloud"
class=''
>Discovery in the Cloud</a>
</li>
<li>
<a href="/docs/latest/clustering/network-configuration"
class=''
>Network Configuration</a>
</li>
<li>
<a href="/docs/latest/clustering/connect-client-nodes"
class=''
>Connecting Client Nodes</a>
</li>
<li>
<a href="/docs/latest/clustering/baseline-topology"
class=''
>Baseline Topology</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group expanded'>
<li>
<a href="/docs/latest/thin-clients/getting-started-with-thin-clients"
class=''
>Thin Clients Overview</a>
</li>
<li>
<a href="/docs/latest/thin-clients/java-thin-client"
class=''
>Java Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/dotnet-thin-client"
class=''
>.NET Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/cpp-thin-client"
class=''
>C++ Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/python-thin-client"
class='active'
>Python Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/php-thin-client"
class=''
>PHP Thin Client</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/binary-client-protocol/binary-client-protocol" class=''>Binary Client Protocol</a></li>
<li><a href="/docs/latest/binary-client-protocol/data-format" class=''>Data Format</a></li>
<li><a href="/docs/latest/binary-client-protocol/key-value-queries" class=''>Key-Value Queries</a></li>
<li><a href="/docs/latest/binary-client-protocol/sql-and-scan-queries" class=''>SQL and Scan Queries</a></li>
<li><a href="/docs/latest/binary-client-protocol/binary-type-metadata" class=''>Binary Types Metadata</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/data-modeling/data-modeling"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/data-modeling/data-partitioning"
class=''
>Data Partitioning</a>
</li>
<li>
<a href="/docs/latest/data-modeling/affinity-collocation"
class=''
>Affinity Colocation</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/memory-architecture"
class=''
>Memory Architecture</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/data-regions"
class=''
>Configuring Data Regions</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/eviction-policies"
class=''
>Eviction Policies</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/replacement-policies"
class=''
>Replacement 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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/persistence/native-persistence"
class=''
>Ignite Persistence</a>
</li>
<li>
<a href="/docs/latest/persistence/external-storage"
class=''
>External Storage</a>
</li>
<li>
<a href="/docs/latest/persistence/swap"
class=''
>Swapping</a>
</li>
<li>
<a href="/docs/latest/persistence/custom-cache-store"
class=''
>Implementing Custom Cache Store</a>
</li>
<li>
<a href="/docs/latest/persistence/snapshot-directory"
class=''
>Configuring Snapshot Directory</a>
</li>
<li>
<a href="/docs/latest/persistence/disk-compression"
class=''
>Disk Compression</a>
</li>
<li>
<a href="/docs/latest/persistence/persistence-tuning"
class=''
>Tuning Persistence</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/snapshots/snapshots" class='' >Cluster Snapshots</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Caches<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/configuring-caches/configuration-overview"
class=''
>Cache Configuration</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/configuring-backups"
class=''
>Configuring Partition Backups</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/partition-loss-policy"
class=''
>Partition Loss Policy</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/atomicity-modes"
class=''
>Atomicity Modes</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/expiry-policies"
class=''
>Expiry Policy</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/on-heap-caching"
class=''
>On-Heap Caching</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/cache-groups"
class=''
>Cache Groups</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/near-cache"
class=''
>Near Caches</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/data-rebalancing" class='' >Data Rebalancing</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/key-value-api/basic-cache-operations"
class=''
>Basic Cache Operations</a>
</li>
<li>
<a href="/docs/latest/key-value-api/binary-objects"
class=''
>Working with Binary Objects</a>
</li>
<li>
<a href="/docs/latest/key-value-api/using-scan-queries"
class=''
>Using Scan Queries</a>
</li>
<li>
<a href="/docs/latest/read-repair"
class=''
>Read Repair</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/SQL/sql-introduction"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/SQL/schemas"
class=''
>Understanding Schemas</a>
</li>
<li>
<a href="/docs/latest/SQL/indexes"
class=''
>Defining Indexes</a>
</li>
<li>
<a href="/docs/latest/SQL/sql-api"
class=''
>Using SQL API</a>
</li>
<li>
<a href="/docs/latest/SQL/distributed-joins"
class=''
>Distributed Joins</a>
</li>
<li>
<a href="/docs/latest/SQL/sql-transactions"
class=''
>SQL Transactions</a>
</li>
<li>
<a href="/docs/latest/SQL/custom-sql-func"
class=''
>Custom SQL Functions</a>
</li>
<li>
<a href="/docs/latest/SQL/JDBC/jdbc-driver"
class=''
>JDBC Driver</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/SQL/ODBC/odbc-driver" class=''>ODBC Driver</a></li>
<li><a href="/docs/latest//SQL/ODBC/connection-string-dsn" class=''>Connection String and DSN</a></li>
<li><a href="/docs/latest/SQL/ODBC/querying-modifying-data" class=''>Querying and Modifying Data</a></li>
<li><a href="/docs/latest/SQL/ODBC/specification" class=''>Specification</a></li>
<li><a href="/docs/latest/SQL/ODBC/data-types" class=''>Data Types</a></li>
<li><a href="/docs/latest/SQL/ODBC/error-codes" class=''>Error Codes</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/sql-reference/sql-conformance"
class=''
>SQL Conformance</a>
</li>
<li>
<a href="/docs/latest/sql-reference/ddl"
class=''
>Data Definition Language (DDL)</a>
</li>
<li>
<a href="/docs/latest/sql-reference/dml"
class=''
>Data Manipulation Language (DML)</a>
</li>
<li>
<a href="/docs/latest/sql-reference/transactions"
class=''
>Transactions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/operational-commands"
class=''
>Operational Commands</a>
</li>
<li>
<a href="/docs/latest/sql-reference/aggregate-functions"
class=''
>Aggregate functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/numeric-functions"
class=''
>Numeric Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/string-functions"
class=''
>String Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/date-time-functions"
class=''
>Data and Time Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/system-functions"
class=''
>System Functions</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/distributed-computing/distributed-computing"
class=''
>Distributed Computing API</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/cluster-groups"
class=''
>Cluster Groups</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/executor-service"
class=''
>Executor Service</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/map-reduce"
class=''
>MapReduce API</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/load-balancing"
class=''
>Load Balancing</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/fault-tolerance"
class=''
>Fault Tolerance</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/job-scheduling"
class=''
>Job Scheduling</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/code-deployment/deploying-user-code"
class=''
>Deploying User Code</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/machine-learning/machine-learning"
class=''
>Machine Learning</a>
</li>
<li>
<a href="/docs/latest/machine-learning/partition-based-dataset"
class=''
>Partition Based Dataset</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/binary-classification/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/linear-svm" class=''>Linear SVM (Support Vector Machine)</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/decision-trees" class=''>Decision Trees</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/multilayer-perceptron" class=''>Multilayer Perceptron</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/logistic-regression" class=''>Logistic Regression</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/knn-classification" class=''>k-NN Classification</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/ann" class=''>ANN (Approximate Nearest Neighbor)</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/regression/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/regression/linear-regression" class=''>Linear Regression</a></li>
<li><a href="/docs/latest/machine-learning/regression/decision-trees-regression" class=''>Decision Trees Regression</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/clustering/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/clustering/k-means-clustering" class=''>K-Means Clustering</a></li>
<li><a href="/docs/latest/machine-learning/clustering/gaussian-mixture" class=''>Gaussian mixture (GMM)</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/model-selection/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/evaluator" class=''>Evaluator</a></li>
<li><a href="/docs/latest/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/latest/machine-learning/model-selection/hyper-parameter-tuning" class=''>Hyper-parameter tuning</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/pipeline-api" class=''>Pipeline API</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/ensemble-methods/introduction" class=''></a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/stacking" class=''>Stacking</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/baggin" class=''>Bagging</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/random-forest" class=''>Random Forest</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/gradient-boosting" class=''>Gradient Boosting</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/importing-model/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/importing-model/model-import-from-gxboost" class=''>Import Model from XGBoost</a></li>
<li><a href="/docs/latest/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/latest/key-value-api/continuous-queries" class='' >Using Continuous Queries</a>
</li>
<li>
<a href="/docs/latest/services/services" class='' >Using Ignite Services</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/data-structures/queue-and-set"
class=''
>Queue and Set</a>
</li>
<li>
<a href="/docs/latest/data-structures/atomic-types"
class=''
>Atomic Types</a>
</li>
<li>
<a href="/docs/latest/data-structures/countdownlatch"
class=''
>CountDownLatch</a>
</li>
<li>
<a href="/docs/latest/data-structures/atomic-sequence"
class=''
>Atomic Sequence</a>
</li>
<li>
<a href="/docs/latest/data-structures/semaphore"
class=''
>Semaphore</a>
</li>
<li>
<a href="/docs/latest/data-structures/id-generator"
class=''
>ID Generator</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/distributed-locks" class='' >Distributed Locks</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/net-specific/net-configuration-options"
class=''
>Configuration Options</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-deployment-options"
class=''
>Deployment Options</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-standalone-nodes"
class=''
>Standalone Nodes</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-async"
class=''
>Asynchronous APIs</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-logging"
class=''
>Logging</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-linq"
class=''
>LINQ</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-java-services-execution"
class=''
>Java Services Execution</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-platform-cache"
class=''
>.NET Platform Cache</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-plugins"
class=''
>Plugins</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-cross-platform-support"
class=''
>Cross-Platform Support</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-remote-assembly-loading"
class=''
>Remote Assembly Loading</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/net-specific/asp-net-output-caching" class=''>ASP.NET Output Caching</a></li>
<li><a href="/docs/latest/net-specific/asp-net-session-state-caching" class=''>ASP.NET Session State Caching</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/cpp-specific/cpp-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/latest/cpp-specific/cpp-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/monitoring-metrics/intro"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/cluster-id"
class=''
>Cluster ID and Tag</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/monitoring-metrics/configuring-metrics" class=''>Configuring Metrics</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/monitoring-metrics/new-metrics-system" class=''>Introduction</a></li>
<li><a href="/docs/latest/monitoring-metrics/new-metrics" class=''>Metrics</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/system-views"
class=''
>System Views</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/performance-statistics"
class=''
>Performance Statistics</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/events/listening-to-events"
class=''
>Enabling and Listenting to Events</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/tools/control-script"
class=''
>Control Script</a>
</li>
<li>
<a href="/docs/latest/tools/visor-cmd"
class=''
>Visor CMD</a>
</li>
<li>
<a href="/docs/latest/tools/gg-control-center"
class=''
>GridGain Control Center</a>
</li>
<li>
<a href="/docs/latest/tools/sqlline"
class=''
>SQLLine</a>
</li>
<li>
<a href="/docs/latest/tools/tableau"
class=''
>Tableau</a>
</li>
<li>
<a href="/docs/latest/tools/informatica"
class=''
>Informatica</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/security/authentication"
class=''
>Authentication</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/security/tde" class=''>Introduction</a></li>
<li><a href="/docs/latest/security/master-key-rotation" class=''>Master key rotation</a></li>
<li><a href="/docs/latest/security/cache-encryption-key-rotation" class=''>Cache encryption key rotation</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<button
type='button'
class='collapsed '>Spring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-boot" class=''>Spring Boot</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-data" class=''>Spring Data</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-caching" class=''>Spring Caching</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-tx" class=''>Spring Transactions</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Ignite for Spark<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/overview" class=''>Overview</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/ignitecontext-and-rdd" class=''>IgniteContext and IgniteRDD</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/ignite-dataframe" class=''>Ignite DataFrame</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/installation" class=''>Installation</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/spark-shell" class=''>Test Ignite with Spark-shell</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/troubleshooting" class=''>Troubleshooting</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/hibernate-l2-cache"
class=''
>Hibernate L2 Cache</a>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/streaming/kafka-streamer" class=''>Kafka Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/camel-streamer" class=''>Camel Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/flink-streamer" class=''>Flink Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/flume-sink" class=''>Flume Sink</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/jms-streamer" class=''>JMS Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/mqtt-streamer" class=''>MQTT Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/rocketmq-streamer" class=''>RocketMQ Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/storm-streamer" class=''>Storm Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/zeromq-streamer" class=''>ZeroMQ Streamer</a></li>
<li><a href="/docs/latest/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" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/cassandra/overview" class=''>Overview</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/configuration" class=''>Configuration</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/usage-examples" class=''>Usage Examples</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/ddl-generator" class=''>DDL Generator</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/php-pdo"
class=''
>PHP PDO</a>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/performance-statistics"
class=''
>Performance Statistics</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/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" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/perf-and-troubleshooting/general-perf-tips"
class=''
>General Performance Tips</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/memory-tuning"
class=''
>Memory and JVM Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/persistence-tuning"
class=''
>Persistence Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/sql-tuning"
class=''
>SQL Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/thread-pools-tuning"
class=''
>Thread Pools Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/troubleshooting"
class=''
>Troubleshooting and Debugging</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/handling-exceptions"
class=''
>Handling Exceptions</a>
</li>
<li>
<a href="/docs/latest/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/python-thin-client.adoc" target="_blank">Edit</a>
<h1>Python Thin Client</h1>
<div class="sect1">
<h2 id="prerequisites">Prerequisites</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Python 3.4 or above.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="installation">Installation</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can install the Python thin client either using <code>pip</code> or from a zip archive.</p>
</div>
<div class="sect2">
<h3 id="using-pip">Using PIP</h3>
<div class="paragraph">
<p>The python thin client package is called <code>pyignite</code>. You can install it using the following command:</p>
</div>
<code-tabs><code-tab data-tab='pip3'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip3 <span class="nb">install </span>pyignite</code></pre>
</div>
</div></code-tab><code-tab data-tab='pip'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip <span class="nb">install </span>pyignite</code></pre>
</div>
</div></code-tab></code-tabs>
</div>
<div class="sect2">
<h3 id="using-zip-archive">Using ZIP Archive</h3>
<div class="paragraph">
<p>The thin client can be installed from the zip archive available for download from the Apache Ignite website:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Download the <a href="https://ignite.apache.org/download.cgi#binaries" target="_blank" rel="noopener">Apache Ignite Python Thin Client</a>.</p>
</li>
<li>
<p>Unpack the archive and navigate to the root folder.</p>
</li>
<li>
<p>Install the client using the command below.</p>
</li>
</ul>
</div>
<code-tabs><code-tab data-tab='pip3'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip3 <span class="nb">install</span> .</code></pre>
</div>
</div></code-tab><code-tab data-tab='pip'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip <span class="nb">install</span> .</code></pre>
</div>
</div></code-tab></code-tabs>
<div class="paragraph">
<p>This will install <code>pyignite</code> in your environment in the so-called "develop" or "editable" mode. Learn more
about the mode from the <a href="https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs" target="_blank" rel="noopener">official documentation</a>.</p>
</div>
<div class="paragraph">
<p>Check the <code>requirements</code> folder and install additional requirements, if needed, using the following command:</p>
</div>
<code-tabs><code-tab data-tab='pip3'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip3 <span class="nb">install</span> <span class="nt">-r</span> requirements/&lt;your task&gt;.txt</code></pre>
</div>
</div></code-tab><code-tab data-tab='pip'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">pip <span class="nb">install</span> <span class="nt">-r</span> requirements/&lt;your task&gt;.txt</code></pre>
</div>
</div></code-tab></code-tabs>
<div class="paragraph">
<p>Refer to the <a href="https://setuptools.readthedocs.io/en/latest/">Setuptools manual</a> for more details about <code>setup.py</code> usage.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="connecting-to-cluster">Connecting to Cluster</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The ZIP distribution package contains runnable examples that demonstrate basic usage scenarios of the Python thin client.
The examples are located in the <code>{client_dir}/examples</code> directory.</p>
</div>
<div class="paragraph">
<p>The following code snippet shows how to connect to a cluster from the Python thin client:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="c1">## Open a connection
</span><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="client-failover">Client Failover</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can configure the client to automatically fail over to another node if the connection to the current node fails or times out.</p>
</div>
<div class="paragraph">
<p>When the connection fails, the client propagates the initial exception (<code>OSError</code> or <code>SocketError</code>), but keeps its constructor’s parameters intact and tries to reconnect transparently.
When the client fails to reconnect, it throws a special <code>ReconnectError</code> exception.</p>
</div>
<div class="paragraph">
<p>In the following example, the client is given the addresses of three cluster nodes.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">pyignite.datatypes.cache_config</span> <span class="kn">import</span> <span class="n">CacheMode</span>
<span class="kn">from</span> <span class="nn">pyignite.datatypes.prop_codes</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">pyignite.exceptions</span> <span class="kn">import</span> <span class="n">SocketError</span>
<span class="n">nodes</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">(</span><span class="s">'217.29.2.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">(</span><span class="s">'200.10.33.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">]</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mf">40.0</span><span class="p">)</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="n">nodes</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s">'Connected to {}'</span><span class="p">.</span><span class="nb">format</span><span class="p">(</span><span class="n">client</span><span class="p">))</span>
<span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">get_or_create_cache</span><span class="p">({</span>
<span class="n">PROP_NAME</span><span class="p">:</span> <span class="s">'my_cache'</span><span class="p">,</span>
<span class="n">PROP_CACHE_MODE</span><span class="p">:</span> <span class="n">CacheMode</span><span class="p">.</span><span class="n">REPLICATED</span><span class="p">,</span>
<span class="p">})</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'test_key'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="c1"># Abstract main loop
</span><span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Do the work
</span> <span class="n">test_value</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'test_key'</span><span class="p">)</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'test_key'</span><span class="p">,</span> <span class="n">test_value</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="nb">OSError</span><span class="p">,</span> <span class="n">SocketError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="c1"># Recover from error (repeat last command, check data
</span> <span class="c1"># consistency or just continue − depends on the task)
</span> <span class="k">print</span><span class="p">(</span><span class="s">'Error: {}'</span><span class="p">.</span><span class="nb">format</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
<span class="k">print</span><span class="p">(</span><span class="s">'Last value: {}'</span><span class="p">.</span><span class="nb">format</span><span class="p">(</span><span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'test_key'</span><span class="p">)))</span>
<span class="k">print</span><span class="p">(</span><span class="s">'Reconnected to {}'</span><span class="p">.</span><span class="nb">format</span><span class="p">(</span><span class="n">client</span><span class="p">))</span></code></pre>
</div>
</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.11.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.11.0/images/partitionawareness02.png" alt="With Partition Awareness">
</div>
</div>
<div class="paragraph">
<p>To enable partition awareness, set the <code>partition_aware</code> parameter to true in the client constructor and provide
addresses of all the server nodes in the connection string.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="n">partition_aware</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="n">nodes</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">(</span><span class="s">'217.29.2.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">(</span><span class="s">'200.10.33.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">),</span>
<span class="p">]</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="n">nodes</span><span class="p">)</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="creating-a-cache">Creating a Cache</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can get an instance of a cache using one of the following methods:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>get_cache(settings)</code> — creates a local Cache object with the given name or set of parameters. The cache must exist in the cluster; otherwise, an exception will be thrown when you attempt to perform operations on that cache.</p>
</li>
<li>
<p><code>create_cache(settings)</code> — creates a cache with the given name or set of parameters.</p>
</li>
<li>
<p><code>get_or_create_cache(settings)</code> — returns an existing cache or creates it if the cache does not exist.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Each method accepts a cache name or a dictionary of properties that represents a cache configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="c1"># Open a connection
</span><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="c1"># Create a cache
</span><span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">create_cache</span><span class="p">(</span><span class="s">'myCache'</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Here is an example of creating a cache with a set of properties:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
<span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span><span class="p">,</span> <span class="n">GenericObjectMeta</span>
<span class="kn">from</span> <span class="nn">pyignite.datatypes</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">pyignite.datatypes.prop_codes</span> <span class="kn">import</span> <span class="o">*</span>
<span class="c1"># Open a connection
</span><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="n">cache_config</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">PROP_NAME</span><span class="p">:</span> <span class="s">'my_cache'</span><span class="p">,</span>
<span class="n">PROP_BACKUPS_NUMBER</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="n">PROP_CACHE_KEY_CONFIGURATION</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">'type_name'</span><span class="p">:</span> <span class="s">'PersonKey'</span><span class="p">,</span>
<span class="s">'affinity_key_field_name'</span><span class="p">:</span> <span class="s">'companyId'</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">create_cache</span><span class="p">(</span><span class="n">cache_config</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">PersonKey</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">GenericObjectMeta</span><span class="p">,</span> <span class="n">type_name</span><span class="o">=</span><span class="s">'PersonKey'</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">OrderedDict</span><span class="p">([</span>
<span class="p">(</span><span class="s">'personId'</span><span class="p">,</span> <span class="n">IntObject</span><span class="p">),</span>
<span class="p">(</span><span class="s">'companyId'</span><span class="p">,</span> <span class="n">IntObject</span><span class="p">),</span>
<span class="p">])):</span>
<span class="k">pass</span>
<span class="n">personKey</span> <span class="o">=</span> <span class="n">PersonKey</span><span class="p">(</span><span class="n">personId</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">companyId</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="n">personKey</span><span class="p">,</span> <span class="s">'test'</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="n">personKey</span><span class="p">))</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>See the next section for the list of supported cache properties.</p>
</div>
<div class="sect2">
<h3 id="cache-configuration">Cache Configuration</h3>
<div class="paragraph">
<p>The list of property keys that you can specify are provided in the <code>prop_codes</code> module.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 11.1111%;">
<col style="width: 55.5556%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property name</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">str</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache name. This is the only required property.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_CACHE_MODE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="/docs/latest/data-modeling/data-partitioning#partitionedreplicated-mode">Cache mode</a>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>REPLICATED=1,</p>
</li>
<li>
<p>PARTITIONED=2</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_CACHE_ATOMICITY_MODE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="/docs/latest/configuring-caches/atomicity-modes">Cache atomicity mode</a>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>TRANSACTIONAL=0,</p>
</li>
<li>
<p>ATOMIC=1</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_BACKUPS_NUMBER</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="/docs/latest/data-modeling/data-partitioning#backup-partitions">Number of backup partitions</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_WRITE_SYNCHRONIZATION_MODE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Write synchronization mode:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>FULL_SYNC=0,</p>
</li>
<li>
<p>FULL_ASYNC=1,</p>
</li>
<li>
<p>PRIMARY_SYNC=2</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_COPY_ON_READ</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The copy on read flag. The default value is <code>true</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_READ_FROM_BACKUP</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The flag indicating whether entries will be read from the local backup partitions, when available, or will always be requested from the primary partitions. The default value is <code>true</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_DATA_REGION_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">str</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="/docs/latest/memory-configuration/data-regions">Data region</a> name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_IS_ONHEAP_CACHE_ENABLED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable <a href="/docs/latest/configuring-caches/on-heap-caching">on-heap caching</a> for the cache.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_QUERY_ENTITIES</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">list</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A list of query entities. See the <a href="#query-entities">Query Entities</a> section below for details.)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_QUERY_PARALLELISM</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ignite.apache.org/releases/2.11.0/javadoc/org/apache/ignite/configuration/CacheConfiguration.html#getQueryParallelism" target="_blank" rel="noopener">Query parallelism</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_QUERY_DETAIL_METRIC_SIZE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Query detail metric size</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_SQL_SCHEMA</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">str</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">SQL Schema</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_SQL_INDEX_INLINE_MAX_SIZE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">SQL index inline maximum size</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_SQL_ESCAPE_ALL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Turns on SQL escapes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_MAX_QUERY_ITERATORS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of query iterators</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_MODE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Rebalancing mode:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>SYNC=0,</p>
</li>
<li>
<p>ASYNC=1,</p>
</li>
<li>
<p>NONE=2</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_DELAY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing delay (ms)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_TIMEOUT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing timeout (ms)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_BATCH_SIZE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing batch size</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_BATCHES_PREFETCH_COUNT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing prefetch count</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_ORDER</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing order</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_REBALANCE_THROTTLE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rebalancing throttle interval (ms)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_GROUP_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">str</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Group name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_CACHE_KEY_CONFIGURATION</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">list</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache Key Configuration
(see <a href="#cache-key">Cache key</a>)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_DEFAULT_LOCK_TIMEOUT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default lock timeout (ms)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_MAX_CONCURRENT_ASYNC_OPERATIONS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of concurrent asynchronous operations</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_PARTITION_LOSS_POLICY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="/docs/latest/configuring-caches/partition-loss-policy">Partition loss policy</a>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>READ_ONLY_SAFE=0,</p>
</li>
<li>
<p>READ_ONLY_ALL=1,</p>
</li>
<li>
<p>READ_WRITE_SAFE=2,</p>
</li>
<li>
<p>READ_WRITE_ALL=3,</p>
</li>
<li>
<p>IGNORE=4</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_EAGER_TTL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="/docs/latest/configuring-caches/expiry-policies#eager-ttl">Eager TTL</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROP_STATISTICS_ENABLED</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The flag that enables statistics.</p></td>
</tr>
</tbody>
</table>
<div class="sect3">
<h4 id="query-entities">Query Entities</h4>
<div class="paragraph">
<p>Query entities are objects that describe <a href="/docs/latest/SQL/sql-api#configuring-queryable-fields">queryable fields</a>, i.e. the fields of the cache objects that can be queried using SQL queries.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>table_name</code>: SQL table name.</p>
</li>
<li>
<p><code>key_field_name</code>: name of the key field.</p>
</li>
<li>
<p><code>key_type_name</code>: name of the key type (Java type or complex object).</p>
</li>
<li>
<p><code>value_field_name</code>: name of the value field.</p>
</li>
<li>
<p><code>value_type_name</code>: name of the value type.</p>
</li>
<li>
<p><code>field_name_aliases</code>: a list of 0 or more dicts of aliases (see <a href="#field-name-aliases">Field Name Aliases</a>).</p>
</li>
<li>
<p><code>query_fields</code>: a list of 0 or more query field names (see <a href="#query-fields">Query Fields</a>).</p>
</li>
<li>
<p><code>query_indexes</code>: a list of 0 or more query indexes (see <a href="#query-indexes">Query Indexes</a>).</p>
</li>
</ul>
</div>
<div class="sect4">
<h5 id="field-name-aliases">Field Name Aliases</h5>
<div class="paragraph">
<p>Field name aliases are used to give a convenient name for the full property name (object.name &#8594; objectName).</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>field_name</code>: field name.</p>
</li>
<li>
<p><code>alias</code>: alias (str).</p>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="query-fields">Query Fields</h5>
<div class="paragraph">
<p>Query fields define the fields that are queryable.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>name</code>: field name.</p>
</li>
<li>
<p><code>type_name</code>: name of Java type or complex object.</p>
</li>
<li>
<p><code>is_key_field</code>: (optional) boolean value, False by default.</p>
</li>
<li>
<p><code>is_notnull_constraint_field</code>: boolean value.</p>
</li>
<li>
<p><code>default_value</code>: (optional) anything that can be converted to type_name type. None (Null) by default.</p>
</li>
<li>
<p><code>precision</code>: (optional) decimal precision: total number of digits in decimal value. Defaults to -1 (use cluster default). Ignored for non-decimal SQL types (other than java.math.BigDecimal).</p>
</li>
<li>
<p><code>scale</code>: (optional) decimal precision: number of digits after the decimal point. Defaults to -1 (use cluster default). Ignored for non-decimal SQL types.</p>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="query-indexes">Query Indexes</h5>
<div class="paragraph">
<p>Query indexes define the fields that will be indexed.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>index_name</code>: index name.</p>
</li>
<li>
<p><code>index_type</code>: index type code as an integer value in unsigned byte range.</p>
</li>
<li>
<p><code>inline_size</code>: integer value.</p>
</li>
<li>
<p><code>fields</code>: a list of 0 or more indexed fields (see Fields).</p>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="fields">Fields</h5>
<div class="ulist">
<ul>
<li>
<p><code>name</code>: field name.</p>
</li>
<li>
<p><code>is_descending</code>: (optional) boolean value; False by default.</p>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="cache-key">Cache key</h5>
<div class="ulist">
<ul>
<li>
<p><code>type_name</code>: name of the complex object.</p>
</li>
<li>
<p><code>affinity_key_field_name</code>: name of the affinity key field.</p>
</li>
</ul>
</div>
</div>
</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 <code>pyignite.cache.Cache</code> class provides methods for working with cache entries by using key-value operations, such as put, get, put all, get all, replace, and others.
The following example shows how to do that:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="c1"># Create cache
</span><span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">create_cache</span><span class="p">(</span><span class="s">'my cache'</span><span class="p">)</span>
<span class="c1"># Put value in cache
</span><span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'my key'</span><span class="p">,</span> <span class="mi">42</span><span class="p">)</span>
<span class="c1"># Get value from cache
</span><span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'my key'</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="c1"># 42
</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'non-existent key'</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="c1"># None
</span>
<span class="c1"># Get multiple values from cache
</span><span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get_all</span><span class="p">([</span>
<span class="s">'my key'</span><span class="p">,</span>
<span class="s">'non-existent key'</span><span class="p">,</span>
<span class="s">'other-key'</span><span class="p">,</span>
<span class="p">])</span>
<span class="k">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="c1"># {'my key': 42}</span></code></pre>
</div>
</div>
<div class="sect2">
<h3 id="using-type-hints">Using type hints</h3>
<div class="paragraph">
<p>The pyignite methods that deal with a single value or key have an additional optional parameter, either <code>value_hint</code> or <code>key_hint</code>, that accepts a parser/constructor class.
Nearly any structure element (inside dict or list) can be replaced with a 2-tuple <code>(the element, type hint)</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">pyignite.datatypes</span> <span class="kn">import</span> <span class="n">CharObject</span><span class="p">,</span> <span class="n">ShortObject</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">get_or_create_cache</span><span class="p">(</span><span class="s">'my cache'</span><span class="p">)</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'my key'</span><span class="p">,</span> <span class="mi">42</span><span class="p">)</span>
<span class="c1"># Value ‘42’ takes 9 bytes of memory as a LongObject
</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'my key'</span><span class="p">,</span> <span class="mi">42</span><span class="p">,</span> <span class="n">value_hint</span><span class="o">=</span><span class="n">ShortObject</span><span class="p">)</span>
<span class="c1"># Value ‘42’ takes only 3 bytes as a ShortObject
</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'a'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="c1"># ‘a’ is a key of type String
</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">'a'</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">key_hint</span><span class="o">=</span><span class="n">CharObject</span><span class="p">)</span>
<span class="c1"># Another key ‘a’ of type CharObject is created
</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'a'</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="c1"># 1
</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">'a'</span><span class="p">,</span> <span class="n">key_hint</span><span class="o">=</span><span class="n">CharObject</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="c1"># 2
</span>
<span class="c1"># Now let us delete both keys at once
</span><span class="n">my_cache</span><span class="p">.</span><span class="n">remove_keys</span><span class="p">([</span>
<span class="s">'a'</span><span class="p">,</span> <span class="c1"># a default type key
</span> <span class="p">(</span><span class="s">'a'</span><span class="p">,</span> <span class="n">CharObject</span><span class="p">),</span> <span class="c1"># a key of type CharObject
</span><span class="p">])</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="asynchronous-execution">Asynchronous Execution</h3>
</div>
</div>
</div>
<div class="sect1">
<h2 id="scan-queries">Scan Queries</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>scan()</code> method of the cache object can be used to get all objects from the cache. It returns a generator that yields
<code>(key,value)</code> tuples. You can iterate through the generated pairs as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="n">my_cache</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">create_cache</span><span class="p">(</span><span class="s">'myCache'</span><span class="p">)</span>
<span class="n">my_cache</span><span class="p">.</span><span class="n">put_all</span><span class="p">({</span><span class="s">'key_{}'</span><span class="p">.</span><span class="nb">format</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> <span class="n">v</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">20</span><span class="p">)})</span>
<span class="c1"># {
# 'key_0': 0,
# 'key_1': 1,
# 'key_2': 2,
# ... 20 elements in total...
# 'key_18': 18,
# 'key_19': 19
# }
</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">scan</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="c1"># 'key_17' 17
# 'key_10' 10
# 'key_6' 6,
# ... 20 elements in total...
# 'key_16' 16
# 'key_12' 12
</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">scan</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="c1"># {
# 'key_17': 17,
# 'key_10': 10,
# 'key_6': 6,
# ... 20 elements in total...
# 'key_16': 16,
# 'key_12': 12
# }
</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Alternatively, you can convert the generator to a dictionary in one go:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="n">result</span> <span class="o">=</span> <span class="n">my_cache</span><span class="p">.</span><span class="n">scan</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="c1"># {
# 'key_17': 17,
# 'key_10': 10,
# 'key_6': 6,
# ... 20 elements in total...
# 'key_16': 16,
# 'key_12': 12
# }</span></code></pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
Be cautious: if the cache contains a large set of data, the dictionary may consume too much memory!
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="executing-sql-statements">Executing SQL Statements</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Python thin client supports all <a href="/docs/latest/sql-reference/index">SQL commands</a> that are supported by Ignite.
The commands are executed via the <code>sql()</code> method of the cache object.
The <code>sql()</code> method returns a generator that yields the resulting rows.</p>
</div>
<div class="paragraph">
<p>Refer to the <a href="/docs/latest/sql-reference/index">SQL Reference</a> section for the list of supported commands.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
</span>
<span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span>
<span class="n">CITY_CREATE_TABLE_QUERY</span> <span class="o">=</span> <span class="s">'''CREATE TABLE City (
ID INT(11),
Name CHAR(35),
CountryCode CHAR(3),
District CHAR(20),
Population INT(11),
PRIMARY KEY (ID, CountryCode)
) WITH "affinityKey=CountryCode"'''</span>
<span class="n">client</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="n">CITY_CREATE_TABLE_QUERY</span><span class="p">)</span>
<span class="n">CITY_CREATE_INDEX</span> <span class="o">=</span> <span class="s">'''CREATE INDEX idx_country_code ON city (CountryCode)'''</span>
<span class="n">client</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="n">CITY_CREATE_INDEX</span><span class="p">)</span>
<span class="n">CITY_INSERT_QUERY</span> <span class="o">=</span> <span class="s">'''INSERT INTO City(
ID, Name, CountryCode, District, Population
) VALUES (?, ?, ?, ?, ?)'''</span>
<span class="n">CITY_DATA</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">[</span><span class="mi">3793</span><span class="p">,</span> <span class="s">'New York'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'New York'</span><span class="p">,</span> <span class="mi">8008278</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3794</span><span class="p">,</span> <span class="s">'Los Angeles'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'California'</span><span class="p">,</span> <span class="mi">3694820</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3795</span><span class="p">,</span> <span class="s">'Chicago'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'Illinois'</span><span class="p">,</span> <span class="mi">2896016</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3796</span><span class="p">,</span> <span class="s">'Houston'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'Texas'</span><span class="p">,</span> <span class="mi">1953631</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3797</span><span class="p">,</span> <span class="s">'Philadelphia'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'Pennsylvania'</span><span class="p">,</span> <span class="mi">1517550</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3798</span><span class="p">,</span> <span class="s">'Phoenix'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'Arizona'</span><span class="p">,</span> <span class="mi">1321045</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3799</span><span class="p">,</span> <span class="s">'San Diego'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'California'</span><span class="p">,</span> <span class="mi">1223400</span><span class="p">],</span>
<span class="p">[</span><span class="mi">3800</span><span class="p">,</span> <span class="s">'Dallas'</span><span class="p">,</span> <span class="s">'USA'</span><span class="p">,</span> <span class="s">'Texas'</span><span class="p">,</span> <span class="mi">1188580</span><span class="p">],</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">CITY_DATA</span><span class="p">:</span>
<span class="n">client</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="n">CITY_INSERT_QUERY</span><span class="p">,</span> <span class="n">query_args</span><span class="o">=</span><span class="n">row</span><span class="p">)</span>
<span class="n">CITY_SELECT_QUERY</span> <span class="o">=</span> <span class="s">"SELECT * FROM City"</span>
<span class="n">cities</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="n">CITY_SELECT_QUERY</span><span class="p">)</span>
<span class="k">for</span> <span class="n">city</span> <span class="ow">in</span> <span class="n">cities</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="o">*</span><span class="n">city</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>sql()</code> method returns a generator that yields the resulting rows.</p>
</div>
<div class="paragraph">
<p>Note that if you set the <code>include_field_names</code> argument to <code>True</code>, the <code>sql()</code> method will generate a list of column names in the first yield. You can access the field names using the <code>next</code> function of Python.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="n">field_names</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">sql</span><span class="p">(</span><span class="n">CITY_SELECT_QUERY</span><span class="p">,</span> <span class="n">include_field_names</span><span class="o">=</span><span class="bp">True</span><span class="p">).</span><span class="n">__next__</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="n">field_names</span><span class="p">)</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="security">Security</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="ssltls">SSL/TLS</h3>
<div class="paragraph">
<p>To use encrypted communication between the thin client and the cluster, you have to enable SSL/TLS both in the cluster configuration and the client configuration.
Refer to the <a href="/docs/latest/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>Here is an example configuration for enabling SSL in the thin client:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">import</span> <span class="nn">ssl</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span>
<span class="n">use_ssl</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
<span class="n">ssl_cert_reqs</span><span class="o">=</span><span class="n">ssl</span><span class="p">.</span><span class="n">CERT_REQUIRED</span><span class="p">,</span>
<span class="n">ssl_keyfile</span><span class="o">=</span><span class="s">'/path/to/key/file'</span><span class="p">,</span>
<span class="n">ssl_certfile</span><span class="o">=</span><span class="s">'/path/to/client/cert'</span><span class="p">,</span>
<span class="n">ssl_ca_certfile</span><span class="o">=</span><span class="s">'/path/to/trusted/cert/or/chain'</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'localhost'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Supported parameters:</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>use_ssl</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to True to enable SSL/TLS on the client.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_keyfile</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path to the file containing the SSL key.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_certfile</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path to the file containing the SSL certificate.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_ca_certfile</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The path to the file with trusted certificates.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_cert_reqs</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><code>ssl.CERT_NONE</code> − remote certificate is ignored (default),</p>
</li>
<li>
<p><code>ssl.CERT_OPTIONAL</code> − remote certificate will be validated,
if provided,</p>
</li>
<li>
<p><code>ssl.CERT_REQUIRED</code> − valid remote certificate is required,</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_version</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ssl_ciphers</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="authentication">Authentication</h3>
<div class="paragraph">
<p>Configure <a href="/docs/latest/security/authentication">authentication on the cluster side</a> and provide a valid user name and password in the client configuration.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
</span>
<span class="kn">from</span> <span class="nn">pyignite</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">import</span> <span class="nn">ssl</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span>
<span class="n">ssl_cert_reqs</span><span class="o">=</span><span class="n">ssl</span><span class="p">.</span><span class="n">CERT_REQUIRED</span><span class="p">,</span>
<span class="n">ssl_keyfile</span><span class="o">=</span><span class="s">'/path/to/key/file'</span><span class="p">,</span>
<span class="n">ssl_certfile</span><span class="o">=</span><span class="s">'/path/to/client/cert'</span><span class="p">,</span>
<span class="n">ssl_ca_certfile</span><span class="o">=</span><span class="s">'/path/to/trusted/cert/or/chain'</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="s">'ignite'</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s">'ignite'</span><span class="p">,)</span>
<span class="n">client</span><span class="p">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'localhost'</span><span class="p">,</span> <span class="mi">10800</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Note that supplying credentials automatically turns SSL on.
This is because sending credentials over an insecure channel is not a best practice and is strongly discouraged.
If you still want to use authentication without securing the connection, simply disable SSL when creating the client object:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="python"><span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s">'ignite'</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s">'ignite'</span><span class="p">,</span> <span class="n">use_ssl</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span></code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="copyright">
© 2021 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'>
<div class="toc-wrapper">
<ul class="sectlevel1">
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a>
<ul class="sectlevel2">
<li><a href="#using-pip">Using PIP</a></li>
<li><a href="#using-zip-archive">Using ZIP Archive</a></li>
</ul>
</li>
<li><a href="#connecting-to-cluster">Connecting to Cluster</a></li>
<li><a href="#client-failover">Client Failover</a></li>
<li><a href="#partition-awareness">Partition Awareness</a></li>
<li><a href="#creating-a-cache">Creating a Cache</a>
<ul class="sectlevel2">
<li><a href="#cache-configuration">Cache Configuration</a>
<ul class="sectlevel3">
<li><a href="#query-entities">Query Entities</a>
<ul class="sectlevel4">
<li><a href="#field-name-aliases">Field Name Aliases</a></li>
<li><a href="#query-fields">Query Fields</a></li>
<li><a href="#query-indexes">Query Indexes</a></li>
<li><a href="#fields">Fields</a></li>
<li><a href="#cache-key">Cache key</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><a href="#using-key-value-api">Using Key-Value API</a>
<ul class="sectlevel2">
<li><a href="#using-type-hints">Using type hints</a></li>
<li><a href="#asynchronous-execution">Asynchronous Execution</a></li>
</ul>
</li>
<li><a href="#scan-queries">Scan Queries</a></li>
<li><a href="#executing-sql-statements">Executing SQL Statements</a></li>
<li><a href="#security">Security</a>
<ul class="sectlevel2">
<li><a href="#ssltls">SSL/TLS</a></li>
<li><a href="#authentication">Authentication</a></li>
</ul>
</li>
</ul>
</div>
<nav class="promo-nav">
<!--#include virtual="/includes/docs_rightnav_promotion.html" -->
<a href="#" data-trigger-bugyard-feedback="true" id="doc-feedback-btn">Docs Feedback</a>
</nav>
</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>
<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?1634150562' async crossorigin></script>
<script type='module' src='/assets/js/versioning.js?1634150562' async crossorigin></script>
<link rel="stylesheet" href="/assets/css/styles.css?1634150562" media="print" onload="this.media='all'">
<noscript><link media="all" rel="stylesheet" href="/assets/css/styles.css?1634150562"></noscript>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" media="print" onload="this.media='all'">
<noscript><link media="all" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"></noscript>
</body>
</html>