This is an automated email from the ASF dual-hosted git repository.
vkulichenko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite-website.git
The following commit(s) were added to refs/heads/master by this push:
new 81600db IGNITE-15775 - Documentation for 3.0.0-alpha3
81600db is described below
commit 81600db41fabb4bf45ddeda534c60ed8ca67e33d
Author: Valentin Kulichenko <[email protected]>
AuthorDate: Thu Oct 21 11:05:04 2021 -0700
IGNITE-15775 - Documentation for 3.0.0-alpha3
---
...talling-using-exe.html => binary-protocol.html} | 118 ++--
docs/3.0.0-alpha/ignite-cli-tool.html | 67 ++-
docs/3.0.0-alpha/index.html | 73 ++-
.../installation/installing-using-exe.html | 51 +-
.../installing-using-exe.html => persistence.html} | 110 ++--
.../quick-start/getting-started-guide.html | 108 +++-
.../installing-using-exe.html => rebalance.html} | 118 ++--
.../calcite-based-sql-engine.html} | 619 ++++++++++++++-------
.../{index.html => sql/jdbc-driver.html} | 178 +++---
9 files changed, 919 insertions(+), 523 deletions(-)
diff --git a/docs/3.0.0-alpha/installation/installing-using-exe.html
b/docs/3.0.0-alpha/binary-protocol.html
similarity index 91%
copy from docs/3.0.0-alpha/installation/installing-using-exe.html
copy to docs/3.0.0-alpha/binary-protocol.html
index 0c27ccd..09ce09c 100644
--- a/docs/3.0.0-alpha/installation/installing-using-exe.html
+++ b/docs/3.0.0-alpha/binary-protocol.html
@@ -62,9 +62,9 @@
<meta name="ignite-version" content="3.0.0-alpha" />
- <title>Installing Using Distributive | Ignite Documentation</title>
+ <title>Binary Client Protocol | Ignite Documentation</title>
- <link rel="canonical"
href="/docs/3.0.0-alpha/installation/installing-using-exe" />
+ <link rel="canonical" href="/docs/3.0.0-alpha/binary-protocol" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
@@ -192,75 +192,72 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='active'
>Binary Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </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/installation/installing-using-exe.adoc";
target="_blank">Edit</a>
+ <a class='edit-link'
href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/binary-protocol.adoc";
target="_blank">Edit</a>
- <h1>Installing Using Distributive</h1>
+ <h1>Binary Client Protocol</h1>
- <div class="sect1">
-<h2 id="prerequisites">Prerequisites</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Ignite was tested on:</p>
+ <div class="paragraph">
+<p>Ignite binary client protocol enables user applications to communicate with
an existing Ignite cluster without starting a full-fledged Ignite node.
+An application can connect to the cluster through a raw TCP socket. Once the
connection is established, the application can communicate with the Ignite
cluster and perform cache operations using the established format.</p>
</div>
-<table class="tableblock frame-all grid-all stripes-even stretch">
-<colgroup>
-<col style="width: 25%;">
-<col style="width: 75%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p
class="tableblock">JDK</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">11 and
later</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OS</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Linux
(Ubuntu 20.04), Windows (10 Home), macOS</p></td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-<div class="sect1">
-<h2 id="installing-using-distributive">Installing Using Distributive</h2>
-<div class="sectionbody">
<div class="paragraph">
-<p>To install Apache Ignite, perform the following steps:</p>
+<p>This Alpha release implementation of binary client protocol comes with the
following improvements:</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
+<div class="ulist">
+<ul>
<li>
-<p>Navigate to <a href="https://ignite.apache.org/download.cgi";
target="_blank" rel="noopener">Apache Ignite Downloads</a> page to download the
distributive.</p>
+<p>Implemented <a
href="https://cwiki.apache.org/confluence/display/IGNITE/IEP-75+Thin+Client+MsgPack+Serialization";
target="_blank" rel="noopener">MsgPack</a> as an underlying binary format;</p>
</li>
<li>
-<p>Put the distributed file into the installation folder in your system.</p>
+<p>Added new set of data types;</p>
</li>
<li>
-<p>Either execute the file or run it in the command line.</p>
+<p>Added more flexible and extensible handshake with the magic header
string.</p>
</li>
-<li>
-<p>Optionally, set the Windows PATH to point to the installation folder and
make sure there is no trailing / (or \ for Windows) in the path.</p>
-</li>
-</ol>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<div class="title">Note</div>
-</td>
-<td class="content">
-Depending on your system, you may need additional permissions during the
installation.
-To grant permissions for Linux, run the <code>chmod +x ignite</code> standard
command.
-</td>
-</tr>
-</table>
-</div>
+</ul>
</div>
+<div class="paragraph">
+<p>For more information on binary client protocol, please click <a
href="https://cwiki.apache.org/confluence/display/IGNITE/IEP-76+Thin+Client+Protocol+for+Ignite+3.0";
target="_blank" rel="noopener">here</a>.</p>
</div>
<div class="copyright">
© 2021 The Apache Software Foundation.<br/>
@@ -271,10 +268,7 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
</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="#installing-using-distributive">Installing Using
Distributive</a></li>
-</ul>
+
</div>
@@ -313,11 +307,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839435' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839435' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839435" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839435"></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>
diff --git a/docs/3.0.0-alpha/ignite-cli-tool.html
b/docs/3.0.0-alpha/ignite-cli-tool.html
index 7afdeee..bea4cdc 100644
--- a/docs/3.0.0-alpha/ignite-cli-tool.html
+++ b/docs/3.0.0-alpha/ignite-cli-tool.html
@@ -192,6 +192,41 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </li>
+
</nav>
<div class="left-nav__overlay"></div>
@@ -224,6 +259,18 @@ allowing you to configure the node.</p>
</thead>
<tbody>
<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>config</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Inspects
and updates Ignite cluster configuration.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>config get</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Gets
current Ignite cluster configuration values.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>config set</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Updates
Ignite cluster configuration values.</p></td>
+</tr>
+<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>init</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Installs
Ignite core modules locally.</p></td>
</tr>
@@ -265,18 +312,6 @@ allowing you to configure the node.</p>
</tr>
</tbody>
</table>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<div class="title">Note</div>
-</td>
-<td class="content">
-While <code>config</code>, <code>config get</code>, <code>config set</code>
commands are listed in command output, they do not work in alpha 2.
-</td>
-</tr>
-</table>
-</div>
</div>
</div>
<div class="copyright">
@@ -329,11 +364,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839435' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839435' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839435" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839435"></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>
diff --git a/docs/3.0.0-alpha/index.html b/docs/3.0.0-alpha/index.html
index 3ca7deb..aab3e6c 100644
--- a/docs/3.0.0-alpha/index.html
+++ b/docs/3.0.0-alpha/index.html
@@ -192,6 +192,41 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </li>
+
</nav>
<div class="left-nav__overlay"></div>
@@ -230,8 +265,7 @@ possesses the highest level of usability thanks to the
following improvements:</
<div class="ulist">
<ul>
<li>
-<p>Schema-first approach: This feature introduces one-to-one mapping between
data schemas and caches/tables,
-which means that the schema is defined for a cache/table before its
creation.</p>
+<p>Schema-first approach: This feature introduces one-to-one mapping between
data schemas and caches/tables, which means that the schema is defined for a
cache/table before its creation.</p>
</li>
<li>
<p>Unified Configuration: This feature is presented by a set of the following
improvements:</p>
@@ -263,37 +297,29 @@ which means that the schema is defined for a cache/table
before its creation.</p
</div>
</div>
<div class="sect1">
-<h2 id="new-in-alpha-2">New in Alpha 2</h2>
+<h2 id="new-in-alpha-3">New in Alpha 3</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Apache Ignite Alpha 2 comes with the following new features:</p>
+<p>Apache Ignite Alpha 3 comes with the following new features:</p>
</div>
<div class="ulist">
<ul>
<li>
-<p>Added replication infrastructure based on Raft.</p>
+<p>New SQL engine based on Apache Calcite with implemented JDBC driver;</p>
</li>
<li>
-<p>New in-memory atomic storage with the basic insert-read functionality.</p>
+<p>Persistence implementation based on RocksDB;</p>
</li>
<li>
-<p>New schema management engine and API.</p>
+<p>New binary client protocol with an implementation in Java;</p>
+</li>
+<li>
+<p>Data rebalancing.</p>
</li>
</ul>
</div>
</div>
</div>
-<div class="sect1">
-<h2 id="known-issues">Known Issues</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Due to changes between alpha 1 and alpha 2, Ignite cluster configuration
commands no longer work. This will be fixed in alpha 3.</p>
-</div>
-<div class="paragraph">
-<p>Affected commands: <code>config</code>, <code>config get</code>,
<code>config set</code>.</p>
-</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.
@@ -304,8 +330,7 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
<nav class="right-nav" data-swiftype-index='false'>
<div class="toc-wrapper">
<ul class="sectlevel1">
-<li><a href="#new-in-alpha-2">New in Alpha 2</a></li>
-<li><a href="#known-issues">Known Issues</a></li>
+<li><a href="#new-in-alpha-3">New in Alpha 3</a></li>
</ul>
</div>
@@ -345,11 +370,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839435' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839435' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839435" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839435"></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>
diff --git a/docs/3.0.0-alpha/installation/installing-using-exe.html
b/docs/3.0.0-alpha/installation/installing-using-exe.html
index 0c27ccd..315c928 100644
--- a/docs/3.0.0-alpha/installation/installing-using-exe.html
+++ b/docs/3.0.0-alpha/installation/installing-using-exe.html
@@ -192,6 +192,41 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </li>
+
</nav>
<div class="left-nav__overlay"></div>
@@ -229,6 +264,14 @@
<h2 id="installing-using-distributive">Installing Using Distributive</h2>
<div class="sectionbody">
<div class="paragraph">
+<p>WARNING:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>If you have installed one of the Ignite 3 Alpha releases before, please
remove the `~/.ignitecfg` file before proceeding. This is a temporary step, the
procedure will be improved in the future releases.</pre>
+</div>
+</div>
+<div class="paragraph">
<p>To install Apache Ignite, perform the following steps:</p>
</div>
<div class="olist arabic">
@@ -313,11 +356,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
diff --git a/docs/3.0.0-alpha/installation/installing-using-exe.html
b/docs/3.0.0-alpha/persistence.html
similarity index 91%
copy from docs/3.0.0-alpha/installation/installing-using-exe.html
copy to docs/3.0.0-alpha/persistence.html
index 0c27ccd..95d68d4 100644
--- a/docs/3.0.0-alpha/installation/installing-using-exe.html
+++ b/docs/3.0.0-alpha/persistence.html
@@ -62,9 +62,9 @@
<meta name="ignite-version" content="3.0.0-alpha" />
- <title>Installing Using Distributive | Ignite Documentation</title>
+ <title>Ignite Persistence | Ignite Documentation</title>
- <link rel="canonical"
href="/docs/3.0.0-alpha/installation/installing-using-exe" />
+ <link rel="canonical" href="/docs/3.0.0-alpha/persistence" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
@@ -192,60 +192,57 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='active' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </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/installation/installing-using-exe.adoc";
target="_blank">Edit</a>
+ <a class='edit-link'
href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/persistence.adoc";
target="_blank">Edit</a>
- <h1>Installing Using Distributive</h1>
+ <h1>Ignite Persistence</h1>
- <div class="sect1">
-<h2 id="prerequisites">Prerequisites</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Ignite was tested on:</p>
+ <div class="paragraph">
+<p>Ignite Persistence, or Native Persistence, is a set of features designed to
provide persistent storage.
+When it is enabled, Ignite always stores all the data on disk, and loads as
much data as it can into RAM for processing.
+For example, if there are 100 entries and RAM has the capacity to store only
20, then all 100 are stored on disk and only 20 are cached in RAM for better
performance.</p>
</div>
-<table class="tableblock frame-all grid-all stripes-even stretch">
-<colgroup>
-<col style="width: 25%;">
-<col style="width: 75%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p
class="tableblock">JDK</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">11 and
later</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OS</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Linux
(Ubuntu 20.04), Windows (10 Home), macOS</p></td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-<div class="sect1">
-<h2 id="installing-using-distributive">Installing Using Distributive</h2>
-<div class="sectionbody">
<div class="paragraph">
-<p>To install Apache Ignite, perform the following steps:</p>
-</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Navigate to <a href="https://ignite.apache.org/download.cgi";
target="_blank" rel="noopener">Apache Ignite Downloads</a> page to download the
distributive.</p>
-</li>
-<li>
-<p>Put the distributed file into the installation folder in your system.</p>
-</li>
-<li>
-<p>Either execute the file or run it in the command line.</p>
-</li>
-<li>
-<p>Optionally, set the Windows PATH to point to the installation folder and
make sure there is no trailing / (or \ for Windows) in the path.</p>
-</li>
-</ol>
+<p>When Native persistence is turned off and no external storage is used,
Ignite behaves as a pure in-memory store.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -254,13 +251,13 @@
<div class="title">Note</div>
</td>
<td class="content">
-Depending on your system, you may need additional permissions during the
installation.
-To grant permissions for Linux, run the <code>chmod +x ignite</code> standard
command.
+In this Apache Ignite Alpha release, persistence is enabled by default.
</td>
</tr>
</table>
</div>
-</div>
+<div class="paragraph">
+<p>The current Alpha release persistence functionality is based on <a
href="https://github.com/facebook/rocksdb/wiki/RocksDB-Overview";
target="_blank" rel="noopener">RocksDB</a>.</p>
</div>
<div class="copyright">
© 2021 The Apache Software Foundation.<br/>
@@ -271,10 +268,7 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
</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="#installing-using-distributive">Installing Using
Distributive</a></li>
-</ul>
+
</div>
@@ -313,11 +307,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
diff --git a/docs/3.0.0-alpha/quick-start/getting-started-guide.html
b/docs/3.0.0-alpha/quick-start/getting-started-guide.html
index d543505..be47f40 100644
--- a/docs/3.0.0-alpha/quick-start/getting-started-guide.html
+++ b/docs/3.0.0-alpha/quick-start/getting-started-guide.html
@@ -192,6 +192,41 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </li>
+
</nav>
<div class="left-nav__overlay"></div>
@@ -204,7 +239,7 @@
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>This guide provides essential details on how to start working with Ignite
3.0 alpha 2 by using the Ignite CLI tool, including the following
information:</p>
+<p>This guide provides essential details on how to start working with Ignite
3.0 alpha 3 by using the Ignite CLI tool, including the following
information:</p>
</div>
<div class="ulist">
<ul>
@@ -228,7 +263,7 @@
<h2 id="prerequisites">Prerequisites</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Ignite 3.0 alpha 2 was officially tested on:</p>
+<p>Ignite 3.0 alpha 3 was officially tested on:</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
@@ -260,15 +295,15 @@
<p>Download the archive with the Ignite CLI tool:</p>
<code-tabs><code-tab data-tab='Unix'><div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="nt">-L</span> <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">curl <span
class="nt">-L</span> <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha3/apache-ignite-3.0.0-alpha3.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha3.zip</code></pre>
</div>
</div></code-tab><code-tab data-tab='Windows (PowerShell)'><div
class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha3/apache-ignite-3.0.0-alpha3.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha3.zip</code></pre>
</div>
</div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha3/apache-ignite-3.0.0-alpha3.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha3.zip</code></pre>
</div>
</div></code-tab></code-tabs>
</li>
@@ -276,15 +311,15 @@
<p>Unpack the archive:</p>
<code-tabs><code-tab data-tab='Unix'><div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">unzip
apache-ignite-3.0.0-alpha2.zip <span class="o">&&</span> <span
class="nb">cd </span>apache-ignite-3.0.0-alpha2</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">unzip
apache-ignite-3.0.0-alpha3.zip <span class="o">&&</span> <span
class="nb">cd </span>apache-ignite-3.0.0-alpha3</code></pre>
</div>
</div></code-tab><code-tab data-tab='Windows (PowerShell)'><div
class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">Expand-Archive
apache-ignite-3.0.0-alpha2.zip <span class="nt">-DestinationPath</span> <span
class="nb">.</span> <span class="p">;</span> <span class="nb">cd
</span>apache-ignite-3.0.0-alpha2</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">Expand-Archive
apache-ignite-3.0.0-alpha3.zip <span class="nt">-DestinationPath</span> <span
class="nb">.</span> <span class="p">;</span> <span class="nb">cd
</span>apache-ignite-3.0.0-alpha3</code></pre>
</div>
</div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell"><span
class="nb">tar</span> <span class="nt">-xf</span>
apache-ignite-3.0.0-alpha2.zip & <span class="nb">cd
</span>apache-ignite-3.0.0-alpha2</code></pre>
+<pre class="rouge highlight"><code data-lang="shell"><span
class="nb">tar</span> <span class="nt">-xf</span>
apache-ignite-3.0.0-alpha3.zip & <span class="nb">cd
</span>apache-ignite-3.0.0-alpha3</code></pre>
</div>
</div></code-tab></code-tabs>
</li>
@@ -313,7 +348,7 @@
<div class="title">Note</div>
</td>
<td class="content">
-On Windows, this latter change is not permanent and will only affect the
current terminal session. If you want the
+On Windows, this latter change is not permanent and only affects the current
terminal session. If you want the
<code>ignite</code> command to be available after terminal or system restart,
use the <code>System Properties</code> dialog to
permanently update the <code>PATH</code> environment variable by adding a full
path to the Ignite installation directory.
</td>
@@ -375,10 +410,18 @@ permanently update the <code>PATH</code> environment
variable by adding a full p
<div class="paragraph">
<p>Ignite CLI allows to install Ignite modules and 3rd party Maven
dependencies.</p>
</div>
+<div class="paragraph">
+<p>WARNING:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>If you have installed one of the Ignite 3 Alpha releases before, please
remove the `~/.ignitecfg` file before proceeding. This is a temporary step, the
procedure will be improved in the future releases.</pre>
+</div>
+</div>
<div class="olist arabic">
<ol class="arabic">
<li>
-<p>To start an Ignite 3.0 alpha 2 cluster, you need to install Ignite core
artifacts first:</p>
+<p>To start an Ignite 3.0 alpha 3 cluster, you need to install Ignite core
artifacts first:</p>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="shell">ignite init</code></pre>
@@ -414,10 +457,10 @@ permanently update the <code>PATH</code> environment
variable by adding a full p
<div class="olist arabic">
<ol class="arabic">
<li>
-<p>Start a cluster node setting <code>node-1</code> as a node unique
identifier:</p>
+<p>Start a cluster node setting <code>my-first-node</code> as a node unique
identifier:</p>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite node start <span
class="nt">--config</span><span
class="o">=</span>examples/config/ignite-config.json node-1</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">ignite node start <span
class="nt">--config</span><span
class="o">=</span>examples/config/ignite-config.json my-first-node</code></pre>
</div>
</div>
</li>
@@ -444,7 +487,7 @@ For example, use the <code>cat</code> command on a Unix
operating system.</p>
<h2 id="built-in-examples">Built-in Examples</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Ignite 3.0 alpha 2 comes with examples that are configured as a separate
Maven project located in the <code>examples</code> folder.</p>
+<p>Ignite 3.0 alpha 3 comes with examples that are configured as a separate
Maven project located in the <code>examples</code> folder.</p>
</div>
<div class="paragraph">
<p>The project includes the following examples:</p>
@@ -452,23 +495,40 @@ For example, use the <code>cat</code> command on a Unix
operating system.</p>
<div class="ulist">
<ul>
<li>
-<p><code>TableExample</code> demonstrates the usage of the
<code>org.apache.ignite.table.Table</code> API to create a table. It also shows
how to get data from a table, or insert a line into a table.</p>
+<p><code>RecordViewExample</code> demonstrates the usage of the
<code>org.apache.ignite.table.RecordView</code> API to create a table. It also
shows how to get data from a table, or insert a line into a table.</p>
</li>
<li>
-<p><code>KeyValueBinaryViewExample</code> - demonstrates the usage of the
<code>org.apache.ignite.table.KeyValueBinaryView</code> API to insert a line
into a table.</p>
+<p><code>KeyValueViewExample</code> - demonstrates the usage of the
<code>org.apache.ignite.table.KeyValueView</code> API to insert a line into a
table.</p>
+</li>
+<li>
+<p><code>SqlJdbcExample</code> - demonstrates the usage of the Apache Ignite
JDBC driver.</p>
+</li>
+<li>
+<p><code>RebalanceExample</code> - demonstrates the data rebalancing
process.</p>
</li>
</ul>
</div>
<div class="paragraph">
-<p>To run an example:</p>
+<p>To run the <code>RebalanceExample</code>, refer to its <a
href="https://github.com/apache/ignite-3/blob/3.0.0-alpha3/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java";
target="_blank" rel="noopener">JavaDoc</a> for instructions.</p>
+</div>
+<div class="paragraph">
+<p>To run any other example, perform the following steps:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
-<p>Import the <code>examples</code> folder into your IDE as a Maven
project.</p>
+<p>Import the examples project into you IDE.</p>
+</li>
+<li>
+<p>Start a server node using the CLI tool:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="shell script">ignite node start
--config=$IGNITE_HOME/examples/config/ignite-config.json
my-first-node</code></pre>
+</div>
+</div>
</li>
<li>
-<p>Follow the steps in the specific example to start it.</p>
+<p>Run the preferred example in the IDE.</p>
</li>
</ol>
</div>
@@ -478,11 +538,11 @@ For example, use the <code>cat</code> command on a Unix
operating system.</p>
<h2 id="stopping-the-cluster">Stopping the Cluster</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>To stop the node, use the command below passing <code>node-1</code> as a
node unique identifier:</p>
+<p>To stop the node, use the command below passing <code>my-first-node</code>
as a node unique identifier:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite node stop
node-1</code></pre>
+<pre class="rouge highlight"><code data-lang="shell">ignite node stop
my-first-node</code></pre>
</div>
</div>
</div>
@@ -559,11 +619,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
diff --git a/docs/3.0.0-alpha/installation/installing-using-exe.html
b/docs/3.0.0-alpha/rebalance.html
similarity index 89%
copy from docs/3.0.0-alpha/installation/installing-using-exe.html
copy to docs/3.0.0-alpha/rebalance.html
index 0c27ccd..3a9c349 100644
--- a/docs/3.0.0-alpha/installation/installing-using-exe.html
+++ b/docs/3.0.0-alpha/rebalance.html
@@ -62,9 +62,9 @@
<meta name="ignite-version" content="3.0.0-alpha" />
- <title>Installing Using Distributive | Ignite Documentation</title>
+ <title>Data Rebalancing | Ignite Documentation</title>
- <link rel="canonical"
href="/docs/3.0.0-alpha/installation/installing-using-exe" />
+ <link rel="canonical" href="/docs/3.0.0-alpha/rebalance" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
@@ -192,73 +192,74 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='active' >Data
Rebalancing</a>
+
+ </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/installation/installing-using-exe.adoc";
target="_blank">Edit</a>
+ <a class='edit-link'
href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/rebalance.adoc";
target="_blank">Edit</a>
- <h1>Installing Using Distributive</h1>
+ <h1>Data Rebalancing</h1>
- <div class="sect1">
-<h2 id="prerequisites">Prerequisites</h2>
+ <div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>Ignite was tested on:</p>
+<p>When a new node joins the cluster, some of the partitions are relocated to
the new node so that the data remains distributed equally in the cluster. This
process is called data rebalancing.
+If an existing node permanently leaves the cluster and backups are not
configured, you lose the partitions stored on this node. When backups are
configured, one of the backup copies of the lost partitions becomes a primary
partition and the rebalancing process is initiated.</p>
+</div>
+<div class="paragraph">
+<p>WARNING:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>Data rebalancing is triggered by changes in the Baseline Topology. In
pure in-memory clusters, the default behavior is to start rebalancing
immediately when a node leaves or joins the cluster (the baseline topology
changes automatically). In clusters with persistence, the baseline topology has
to be changed manually (default behavior), or can be changed automatically when
automatic baseline adjustment is enabled.</pre>
+</div>
</div>
-<table class="tableblock frame-all grid-all stripes-even stretch">
-<colgroup>
-<col style="width: 25%;">
-<col style="width: 75%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p
class="tableblock">JDK</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">11 and
later</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OS</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Linux
(Ubuntu 20.04), Windows (10 Home), macOS</p></td>
-</tr>
-</tbody>
-</table>
</div>
</div>
<div class="sect1">
-<h2 id="installing-using-distributive">Installing Using Distributive</h2>
+<h2 id="running-an-example">Running an Example</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>To install Apache Ignite, perform the following steps:</p>
+<p>Examples are shipped as a separate Maven project, which is located in the
<code>examples</code> folder. <code>RebalanceExample</code> demonstrates the
data rebalancing process.</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Navigate to <a href="https://ignite.apache.org/download.cgi";
target="_blank" rel="noopener">Apache Ignite Downloads</a> page to download the
distributive.</p>
-</li>
-<li>
-<p>Put the distributed file into the installation folder in your system.</p>
-</li>
-<li>
-<p>Either execute the file or run it in the command line.</p>
-</li>
-<li>
-<p>Optionally, set the Windows PATH to point to the installation folder and
make sure there is no trailing / (or \ for Windows) in the path.</p>
-</li>
-</ol>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<div class="title">Note</div>
-</td>
-<td class="content">
-Depending on your system, you may need additional permissions during the
installation.
-To grant permissions for Linux, run the <code>chmod +x ignite</code> standard
command.
-</td>
-</tr>
-</table>
+<div class="paragraph">
+<p>To start running <code>RebalanceExample</code>, please refer to its <a
href="https://github.com/apache/ignite-3/blob/3.0.0-alpha3/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java";
target="_blank" rel="noopener">JavaDoc</a> for instructions.</p>
</div>
</div>
</div>
@@ -272,8 +273,7 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
<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="#installing-using-distributive">Installing Using
Distributive</a></li>
+<li><a href="#running-an-example">Running an Example</a></li>
</ul>
</div>
@@ -313,11 +313,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
diff --git a/docs/3.0.0-alpha/quick-start/getting-started-guide.html
b/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html
similarity index 67%
copy from docs/3.0.0-alpha/quick-start/getting-started-guide.html
copy to docs/3.0.0-alpha/sql/calcite-based-sql-engine.html
index d543505..7250dfa 100644
--- a/docs/3.0.0-alpha/quick-start/getting-started-guide.html
+++ b/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html
@@ -62,9 +62,9 @@
<meta name="ignite-version" content="3.0.0-alpha" />
- <title>Getting Started Guide | Ignite Documentation</title>
+ <title>Calcite-Based SQL Engine | Ignite Documentation</title>
- <link rel="canonical"
href="/docs/3.0.0-alpha/quick-start/getting-started-guide" />
+ <link rel="canonical"
href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
@@ -181,7 +181,7 @@
<li>
- <a href="/docs/3.0.0-alpha/quick-start/getting-started-guide"
class='active' >Getting Started Guide</a>
+ <a href="/docs/3.0.0-alpha/quick-start/getting-started-guide"
class='' >Getting Started Guide</a>
</li>
@@ -192,316 +192,492 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='active' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='' >JDBC
Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </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/quick-start/getting-started-guide.adoc";
target="_blank">Edit</a>
+ <a class='edit-link'
href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/sql/calcite-based-sql-engine.adoc";
target="_blank">Edit</a>
- <h1>Getting Started Guide</h1>
+ <h1>Calcite-Based SQL Engine</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>This guide provides essential details on how to start working with Ignite
3.0 alpha 2 by using the Ignite CLI tool, including the following
information:</p>
+<p>This Alpha release introduces new SQL engine based on the Apache Calcite
framework to parse and optimize queries and generate execution plans.
Previously, it was based on H2 Database.</p>
+</div>
+<div class="paragraph">
+<p>Apache Calcite is a dynamic data management framework, which mainly serves
for mediating between applications and one or more data storage locations and
data processing engines.
+For more information on Apache Calcite, please see the <a
href="https://calcite.apache.org/docs/"; target="_blank" rel="noopener">product
documentation</a>.</p>
+</div>
+<div class="paragraph">
+<p>Replacing H2 SQL engine with Apache Calcite incorporates the following
general improvements:</p>
</div>
<div class="ulist">
<ul>
<li>
-<p>How to download and install the tool.</p>
+<p><strong>Wider SQL support</strong>: Apache Calcite, unlike H2, is
specifically designed for SQL enablement on top of an arbitrary external data
storage;</p>
</li>
<li>
-<p>How to use the Ignite CLI tool to manage nodes.</p>
+<p><strong>Better optimization algorithms</strong>: Apache Calcite optimizes
queries by repeatedly applying planner rules to a relational expression;</p>
</li>
<li>
-<p>How to run built-in examples.</p>
-</li>
-<li>
-<p>Additional information regarding the use of the tool.</p>
+<p><strong>Higher overall performance</strong>: Calcite offers much higher
levels of execution flexibility, as well as higher efficiency in terms of both
memory and CPU consumption.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="prerequisites">Prerequisites</h2>
+<h2 id="data-manipulation-language-dml">Data Manipulation Language (DML)</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Ignite 3.0 alpha 2 was officially tested on:</p>
-</div>
-<table class="tableblock frame-all grid-all stripes-even stretch">
-<colgroup>
-<col style="width: 25%;">
-<col style="width: 75%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p
class="tableblock">JDK</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">11 and
later</p></td>
-</tr>
+<p>This section walks you through all data manipulation language (DML)
commands supported by Apache Ignite Alpha 3.</p>
+</div>
+<div class="admonitionblock warning">
+<table>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OS</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Linux
(Ubuntu 20.04), Windows (10 Home), macOS</p></td>
+<td class="icon">
+<div class="title">Warning</div>
+</td>
+<td class="content">
+Currently, <code>WITH</code> and <code>MERGE</code> commands are not supported.
+</td>
</tr>
-</tbody>
</table>
</div>
-</div>
-<div class="sect1">
-<h2 id="installing-ignite-cli-tool">Installing Ignite CLI Tool</h2>
-<div class="sectionbody">
+<div class="sect2">
+<h3 id="select">SELECT</h3>
<div class="paragraph">
-<p>To download and install the Ignite CLI Tool, follow the steps below:</p>
+<p>Retrieves data from a table or multiple tables.</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Download the archive with the Ignite CLI tool:</p>
-<code-tabs><code-tab data-tab='Unix'><div class="listingblock">
+<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="nt">-L</span> <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">SELECT</span> <span class="p">[</span> <span
class="n">hintComment</span> <span class="p">]</span> <span class="p">[</span>
<span class="n">STREAM</span> <span class="p">]</span> <span class="p">[</span>
<span class="k">ALL</span> <span class="o">|</span> <span
class="k">DISTINCT</span> <span class="p">]</span>
+ <span class="err">{</span> <span class="o">*</span> <span
class="o">|</span> <span class="n">projectItem</span> <span class="p">[,</span>
<span class="n">projectItem</span> <span class="p">]</span><span
class="o">*</span> <span class="err">}</span>
+<span class="k">FROM</span> <span class="n">tableExpression</span>
+<span class="p">[</span> <span class="k">WHERE</span> <span
class="n">booleanExpression</span> <span class="p">]</span>
+<span class="p">[</span> <span class="k">GROUP</span> <span
class="k">BY</span> <span class="err">{</span> <span class="n">groupItem</span>
<span class="p">[,</span> <span class="n">groupItem</span> <span
class="p">]</span><span class="o">*</span> <span class="err">}</span> <span
class="p">]</span>
+<span class="p">[</span> <span class="k">HAVING</span> <span
class="n">booleanExpression</span> <span class="p">]</span></code></pre>
</div>
-</div></code-tab><code-tab data-tab='Windows (PowerShell)'><div
class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
</div>
-</div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">curl <span
class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip";</span>
<span class="nt">-o</span> apache-ignite-3.0.0-alpha2.zip</code></pre>
</div>
-</div></code-tab></code-tabs>
-</li>
-<li>
-<p>Unpack the archive:</p>
-<code-tabs><code-tab data-tab='Unix'><div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">unzip
apache-ignite-3.0.0-alpha2.zip <span class="o">&&</span> <span
class="nb">cd </span>apache-ignite-3.0.0-alpha2</code></pre>
+<div class="sect2">
+<h3 id="insert">INSERT</h3>
+<div class="paragraph">
+<p>Inserts data into a table.</p>
</div>
-</div></code-tab><code-tab data-tab='Windows (PowerShell)'><div
class="listingblock">
+<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">Expand-Archive
apache-ignite-3.0.0-alpha2.zip <span class="nt">-DestinationPath</span> <span
class="nb">.</span> <span class="p">;</span> <span class="nb">cd
</span>apache-ignite-3.0.0-alpha2</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span class="err">{</span>
<span class="k">INSERT</span> <span class="o">|</span> <span
class="n">UPSERT</span> <span class="err">}</span> <span class="k">INTO</span>
<span class="n">tablePrimary</span>
+<span class="p">[</span> <span class="s1">'('</span> <span
class="k">column</span> <span class="p">[,</span> <span class="k">column</span>
<span class="p">]</span><span class="o">*</span> <span class="s1">')'</span>
<span class="p">]</span>
+<span class="n">query</span></code></pre>
</div>
-</div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell"><span
class="nb">tar</span> <span class="nt">-xf</span>
apache-ignite-3.0.0-alpha2.zip & <span class="nb">cd
</span>apache-ignite-3.0.0-alpha2</code></pre>
</div>
-</div></code-tab></code-tabs>
-</li>
-<li>
-<p>Add your installation directory to the PATH environment variable:</p>
-<code-tabs><code-tab data-tab='Unix'><div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell"><span
class="nb">echo</span> <span class="s1">'export PATH="'</span><span
class="sb">`</span><span class="nb">pwd</span><span class="sb">`</span><span
class="s1">':$PATH"'</span> <span class="o">>></span> ~/.bash_profile
<span class="o">&&</span> <span class="nb">source</span>
~/.bash_profile</code></pre>
</div>
-</div></code-tab><code-tab data-tab='Windows (PowerShell)'><div
class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell"><span
class="nv">$ENV</span>:PATH +<span class="o">=</span> <span
class="s2">";."</span></code></pre>
+<div class="sect2">
+<h3 id="update">UPDATE</h3>
+<div class="paragraph">
+<p>Updates data in a table.</p>
</div>
-</div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock">
+<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="text">set
PATH=%cd%;%PATH%</code></pre>
-</div>
-</div></code-tab></code-tabs>
-</li>
-</ol>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<div class="title">Note</div>
-</td>
-<td class="content">
-On Windows, this latter change is not permanent and will only affect the
current terminal session. If you want the
-<code>ignite</code> command to be available after terminal or system restart,
use the <code>System Properties</code> dialog to
-permanently update the <code>PATH</code> environment variable by adding a full
path to the Ignite installation directory.
-</td>
-</tr>
-</table>
-</div>
-</div>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">UPDATE</span> <span class="n">tablePrimary</span>
+<span class="k">SET</span> <span class="n">assign</span> <span
class="p">[,</span> <span class="n">assign</span> <span class="p">]</span><span
class="o">*</span>
+<span class="p">[</span> <span class="k">WHERE</span> <span
class="n">booleanExpression</span> <span class="p">]</span></code></pre>
</div>
-<div class="sect1">
-<h2 id="using-ignite-cli-tool">Using Ignite CLI Tool</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Ignite CLI is a single entry point for all the Ignite operations. You can
perform the following actions with it:</p>
</div>
-<div class="ulist">
-<ul>
-<li>
-<p>Manage existing nodes.</p>
-</li>
-<li>
-<p>Install new nodes.</p>
-</li>
-<li>
-<p>Update old nodes to new versions.</p>
-</li>
-<li>
-<p>Install or remove optional modules.</p>
-</li>
-</ul>
</div>
+<div class="sect2">
+<h3 id="delete">DELETE</h3>
<div class="paragraph">
-<p>Let’s use some of the <<Ignite CLI Tool Commands>>.</p>
-</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Use the command below to see the full list:</p>
-<div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite</code></pre>
-</div>
+<p>Deletes data from a table.</p>
</div>
-</li>
-<li>
-<p>Pass the <code>--help</code> parameter to the previous command to get its
detailed description:</p>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite init <span
class="nt">--help</span></code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">DELETE</span> <span class="k">FROM</span> <span
class="n">tablePrimary</span> <span class="p">[</span> <span class="p">[</span>
<span class="k">AS</span> <span class="p">]</span> <span class="k">alias</span>
<span class="p">]</span>
+<span class="p">[</span> <span class="k">WHERE</span> <span
class="n">booleanExpression</span> <span class="p">]</span></code></pre>
</div>
</div>
-</li>
-</ol>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="installing-ignite-artifacts-and-dependencies">Installing Ignite
Artifacts and Dependencies</h2>
+<h2 id="supported-operators-and-functions">Supported Operators and
Functions</h2>
<div class="sectionbody">
-<div class="paragraph">
-<p>Ignite CLI allows to install Ignite modules and 3rd party Maven
dependencies.</p>
-</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>To start an Ignite 3.0 alpha 2 cluster, you need to install Ignite core
artifacts first:</p>
+<div class="sect2">
+<h3 id="aggregate-functions">Aggregate Functions</h3>
+<div class="sect3">
+<h4 id="count">COUNT</h4>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite init</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">COUNT</span><span class="p">(</span> <span class="p">[</span> <span
class="k">ALL</span> <span class="o">|</span> <span class="k">DISTINCT</span>
<span class="p">]</span> <span class="n">value</span> <span class="p">[,</span>
<span class="n">value</span> <span class="p">]</span><span
class="o">*</span><span class="p">)</span></code></pre>
</div>
</div>
-</li>
-<li>
-<p>Use the <code>module add</code> command to download Guava from Maven and
add it to the Ignite classpath:</p>
+<div class="paragraph">
+<p>Returns the number of input rows for which value is not null (wholly not
null if value is composite).</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="avg">AVG</h4>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite module add
mvn:com.google.guava:guava:23.0</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">AVG</span><span class="p">(</span> <span class="p">[</span> <span
class="k">ALL</span> <span class="o">|</span> <span class="k">DISTINCT</span>
<span class="p">]</span> <span class="nb">numeric</span><span
class="p">)</span></code></pre>
</div>
</div>
-</li>
-<li>
-<p>Confirm the library is added to the Ignite dependencies list:</p>
+<div class="paragraph">
+<p>Returns the average (arithmetic mean) of numeric across all input
values.</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="sum">SUM</h4>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite module
list</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">SUM</span><span class="p">(</span> <span class="p">[</span> <span
class="k">ALL</span> <span class="o">|</span> <span class="k">DISTINCT</span>
<span class="p">]</span> <span class="nb">numeric</span><span
class="p">)</span></code></pre>
</div>
</div>
-</li>
-</ol>
+<div class="paragraph">
+<p>Returns the sum of numeric across all input values.</p>
+</div>
</div>
+<div class="sect3">
+<h4 id="min">MIN</h4>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">MIN</span><span class="p">(</span> <span class="p">[</span> <span
class="k">ALL</span> <span class="o">|</span> <span class="k">DISTINCT</span>
<span class="p">]</span> <span class="n">value</span><span
class="p">)</span></code></pre>
</div>
</div>
-<div class="sect1">
-<h2 id="starting-a-node">Starting a Node</h2>
-<div class="sectionbody">
<div class="paragraph">
-<p>This section explains how to start a node, how to stop, and perform other
basic operations with it.</p>
+<p>Returns the minimum value of value across all input values.</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Start a cluster node setting <code>node-1</code> as a node unique
identifier:</p>
+</div>
+<div class="sect3">
+<h4 id="max">MAX</h4>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite node start <span
class="nt">--config</span><span
class="o">=</span>examples/config/ignite-config.json node-1</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="k">MAX</span><span class="p">(</span> <span class="p">[</span> <span
class="k">ALL</span> <span class="o">|</span> <span class="k">DISTINCT</span>
<span class="p">]</span> <span class="n">value</span><span
class="p">)</span></code></pre>
</div>
</div>
-</li>
-<li>
-<p>Confirm the node is started and running:</p>
+<div class="paragraph">
+<p>Returns the maximum value of value across all input values.</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="string_agg">STRING_AGG</h4>
<div class="listingblock">
<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite node
list</code></pre>
+<pre class="rouge highlight"><code data-lang="sql"><span
class="n">STRING_AGG</span><span class="p">(</span> <span
class="n">value</span> <span class="p">[,</span> <span
class="n">separator</span> <span class="p">]</span> <span class="p">[</span>
<span class="k">ORDER</span> <span class="k">BY</span> <span
class="p">...])</span></code></pre>
</div>
</div>
<div class="paragraph">
-<p>This command also displays the path to the log file.</p>
+<p>Concatenates the values of string expressions and places separator values
between them.</p>
</div>
-</li>
-<li>
-<p>To view the log, use the log file path from the previous step result. To
open the log file, use any suitable approach.
-For example, use the <code>cat</code> command on a Unix operating system.</p>
-</li>
-</ol>
</div>
+<div class="sect3">
+<h4 id="string_concat">STRING_CONCAT</h4>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="sql"><span
class="n">STRING_CONCAT</span><span class="p">(</span><span
class="n">string1</span><span class="p">,</span> <span
class="n">string2</span><span class="p">,</span> <span class="p">...</span>
<span class="n">stringN</span><span class="p">)</span></code></pre>
</div>
</div>
-<div class="sect1">
-<h2 id="built-in-examples">Built-in Examples</h2>
-<div class="sectionbody">
<div class="paragraph">
-<p>Ignite 3.0 alpha 2 comes with examples that are configured as a separate
Maven project located in the <code>examples</code> folder.</p>
+<p>Concatenates the text values in the specified data ranges.</p>
</div>
-<div class="paragraph">
-<p>The project includes the following examples:</p>
</div>
+</div>
+<div class="sect2">
+<h3 id="functions">Functions</h3>
+<div class="sect3">
+<h4 id="json">JSON</h4>
<div class="ulist">
<ul>
<li>
-<p><code>TableExample</code> demonstrates the usage of the
<code>org.apache.ignite.table.Table</code> API to create a table. It also shows
how to get data from a table, or insert a line into a table.</p>
+<p>JSON_EXISTS</p>
+</li>
+<li>
+<p>JSON_VALUE</p>
+</li>
+<li>
+<p>JSON_QUERY</p>
+</li>
+<li>
+<p>JSON_OBJECT</p>
+</li>
+<li>
+<p>JSON_ARRAY</p>
+</li>
+<li>
+<p>JSON_PRETTY</p>
+</li>
+<li>
+<p>STRING</p>
+</li>
+<li>
+<p>CHAR_LENGTH</p>
+</li>
+<li>
+<p>CHARACTER_LENGTH</p>
+</li>
+<li>
+<p>UPPER</p>
</li>
<li>
-<p><code>KeyValueBinaryViewExample</code> - demonstrates the usage of the
<code>org.apache.ignite.table.KeyValueBinaryView</code> API to insert a line
into a table.</p>
+<p>LOWER</p>
+</li>
+<li>
+<p>POSITION</p>
+</li>
+<li>
+<p>TRIM</p>
+</li>
+<li>
+<p>OVERLAY</p>
+</li>
+<li>
+<p>SUBSTRING</p>
+</li>
+<li>
+<p>INITCAP</p>
+</li>
+<li>
+<p>SPACE</p>
+</li>
+<li>
+<p>STRCMP</p>
+</li>
+<li>
+<p>REVERSE</p>
+</li>
+<li>
+<p>REGEXP_REPLACE</p>
+</li>
+<li>
+<p>SHA1</p>
+</li>
+<li>
+<p>MD5</p>
+</li>
+<li>
+<p>LTRIM</p>
+</li>
+<li>
+<p>TO_BASE64</p>
+</li>
+<li>
+<p>FROM_BASE64</p>
+</li>
+<li>
+<p>COMPRESS</p>
+</li>
+<li>
+<p>CONCAT</p>
+</li>
+<li>
+<p>TRANSLATE</p>
+</li>
+<li>
+<p>ASCII</p>
+</li>
+<li>
+<p>LEFT</p>
+</li>
+<li>
+<p>RIGHT</p>
+</li>
+<li>
+<p>REPEAT</p>
+</li>
+<li>
+<p>SOUNDEX</p>
+</li>
+<li>
+<p>For more information on functions supported by Apache Calcite, see the <a
href="https://calcite.apache.org/docs/reference.html#operators-and-functions";
target="_blank" rel="noopener">product documentation</a>.</p>
</li>
</ul>
</div>
-<div class="paragraph">
-<p>To run an example:</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
+<div class="sect3">
+<h4 id="numeric">NUMERIC</h4>
+<div class="ulist">
+<ul>
<li>
-<p>Import the <code>examples</code> folder into your IDE as a Maven
project.</p>
+<p>POWER</p>
</li>
<li>
-<p>Follow the steps in the specific example to start it.</p>
+<p>ABS</p>
</li>
-</ol>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="stopping-the-cluster">Stopping the Cluster</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>To stop the node, use the command below passing <code>node-1</code> as a
node unique identifier:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="rouge highlight"><code data-lang="shell">ignite node stop
node-1</code></pre>
-</div>
+<li>
+<p>MOD</p>
+</li>
+<li>
+<p>SQRT</p>
+</li>
+<li>
+<p>LN</p>
+</li>
+<li>
+<p>LOG10</p>
+</li>
+<li>
+<p>EXP</p>
+</li>
+<li>
+<p>CEIL</p>
+</li>
+<li>
+<p>FLOOR</p>
+</li>
+<li>
+<p>RAND</p>
+</li>
+<li>
+<p>ACOS</p>
+</li>
+<li>
+<p>ASIN</p>
+</li>
+<li>
+<p>ATAN</p>
+</li>
+<li>
+<p>ATAN2</p>
+</li>
+<li>
+<p>CBRT</p>
+</li>
+<li>
+<p>COS</p>
+</li>
+<li>
+<p>COT</p>
+</li>
+<li>
+<p>DEGREES</p>
+</li>
+<li>
+<p>PI()</p>
+</li>
+<li>
+<p>RADIANS</p>
+</li>
+<li>
+<p>ROUND</p>
+</li>
+<li>
+<p>SIGN</p>
+</li>
+<li>
+<p>SIN</p>
+</li>
+<li>
+<p>TAN</p>
+</li>
+<li>
+<p>TRUNCATE</p>
+</li>
+<li>
+<p>CHR</p>
+</li>
+<li>
+<p>COSH</p>
+</li>
+<li>
+<p>SINH</p>
+</li>
+<li>
+<p>TANH</p>
+</li>
+<li>
+<p>For more information on functions supported by Apache Calcite, see the <a
href="https://calcite.apache.org/docs/reference.html#operators-and-functions";
target="_blank" rel="noopener">product documentation</a>.</p>
+</li>
+</ul>
</div>
</div>
+<div class="sect3">
+<h4 id="general">GENERAL</h4>
+<div class="ulist">
+<ul>
+<li>
+<p>NULLIF</p>
+</li>
+<li>
+<p>COALESCE</p>
+</li>
+<li>
+<p>CAST</p>
+</li>
+<li>
+<p>NVL</p>
+</li>
+<li>
+<p>GREATEST</p>
+</li>
+<li>
+<p>For more information on functions supported by Apache Calcite, see the <a
href="https://calcite.apache.org/docs/reference.html#operators-and-functions";
target="_blank" rel="noopener">product documentation</a>.</p>
+</li>
+</ul>
</div>
-<div class="sect1">
-<h2 id="next-steps">Next Steps</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>From here, you may want to:</p>
</div>
+<div class="sect3">
+<h4 id="timestamp">TIMESTAMP</h4>
<div class="ulist">
<ul>
<li>
-<p>Check out the <a href="/docs/3.0.0-alpha/ignite-cli-tool">Ignite CLI
Tool</a> page for more detail on supported commands.</p>
+<p>TIMESTAMP_ADD</p>
+</li>
+<li>
+<p>TIMESTAMP_DIFF</p>
+</li>
+<li>
+<p>EXTRACT</p>
+</li>
+<li>
+<p>LAST_DAY</p>
+</li>
+<li>
+<p>For more information on functions supported by Apache Calcite, see the <a
href="https://calcite.apache.org/docs/reference.html#operators-and-functions";
target="_blank" rel="noopener">product documentation</a>.</p>
</li>
</ul>
</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.
@@ -512,14 +688,37 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
<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="#installing-ignite-cli-tool">Installing Ignite CLI Tool</a></li>
-<li><a href="#using-ignite-cli-tool">Using Ignite CLI Tool</a></li>
-<li><a href="#installing-ignite-artifacts-and-dependencies">Installing Ignite
Artifacts and Dependencies</a></li>
-<li><a href="#starting-a-node">Starting a Node</a></li>
-<li><a href="#built-in-examples">Built-in Examples</a></li>
-<li><a href="#stopping-the-cluster">Stopping the Cluster</a></li>
-<li><a href="#next-steps">Next Steps</a></li>
+<li><a href="#data-manipulation-language-dml">Data Manipulation Language
(DML)</a>
+<ul class="sectlevel2">
+<li><a href="#select">SELECT</a></li>
+<li><a href="#insert">INSERT</a></li>
+<li><a href="#update">UPDATE</a></li>
+<li><a href="#delete">DELETE</a></li>
+</ul>
+</li>
+<li><a href="#supported-operators-and-functions">Supported Operators and
Functions</a>
+<ul class="sectlevel2">
+<li><a href="#aggregate-functions">Aggregate Functions</a>
+<ul class="sectlevel3">
+<li><a href="#count">COUNT</a></li>
+<li><a href="#avg">AVG</a></li>
+<li><a href="#sum">SUM</a></li>
+<li><a href="#min">MIN</a></li>
+<li><a href="#max">MAX</a></li>
+<li><a href="#string_agg">STRING_AGG</a></li>
+<li><a href="#string_concat">STRING_CONCAT</a></li>
+</ul>
+</li>
+<li><a href="#functions">Functions</a>
+<ul class="sectlevel3">
+<li><a href="#json">JSON</a></li>
+<li><a href="#numeric">NUMERIC</a></li>
+<li><a href="#general">GENERAL</a></li>
+<li><a href="#timestamp">TIMESTAMP</a></li>
+</ul>
+</li>
+</ul>
+</li>
</ul>
</div>
@@ -559,11 +758,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
diff --git a/docs/3.0.0-alpha/index.html b/docs/3.0.0-alpha/sql/jdbc-driver.html
similarity index 80%
copy from docs/3.0.0-alpha/index.html
copy to docs/3.0.0-alpha/sql/jdbc-driver.html
index 3ca7deb..68b5b8a 100644
--- a/docs/3.0.0-alpha/index.html
+++ b/docs/3.0.0-alpha/sql/jdbc-driver.html
@@ -62,9 +62,9 @@
<meta name="ignite-version" content="3.0.0-alpha" />
- <title>Apache Ignite Documentation | Ignite Documentation</title>
+ <title>JDBC Driver | Ignite Documentation</title>
- <link rel="canonical" href="/docs/3.0.0-alpha/index" />
+ <link rel="canonical" href="/docs/3.0.0-alpha/sql/jdbc-driver" />
<META NAME="ROBOTS" CONTENT="NOINDEX" />
@@ -174,7 +174,7 @@
<li>
- <a href="/docs/3.0.0-alpha/index" class='active'
>Documentation Overview</a>
+ <a href="/docs/3.0.0-alpha/index" class='' >Documentation
Overview</a>
</li>
@@ -192,105 +192,151 @@
</li>
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/calcite-based-sql-engine"
class='' >Calcite-Based SQL Engine</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/sql/jdbc-driver" class='active'
>JDBC Driver</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/binary-protocol" class='' >Binary
Client Protocol</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/persistence" class='' >Native
Persistence</a>
+
+ </li>
+
+ <li>
+
+
+ <a href="/docs/3.0.0-alpha/rebalance" class='' >Data
Rebalancing</a>
+
+ </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/index.adoc";
target="_blank">Edit</a>
+ <a class='edit-link'
href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/sql/jdbc-driver.adoc";
target="_blank">Edit</a>
- <h1>Apache Ignite Documentation</h1>
+ <h1>JDBC Driver</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>Apache Ignite is a distributed database for high-performance computing with
in-memory speed.</p>
+<p>Apache Ignite is shipped with JDBC driver that allows processing of
distributed data using standard SQL statements like <code>SELECT</code>,
<code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code> directly from
the JDBC side.</p>
</div>
<div class="paragraph">
-<p>The technical documentation introduces you to the key capabilities, shows
how to use certain features of
-the current Apache Ignite version.</p>
+<p>WARNING:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>This Alpha release implementation of JDBC driver does not support the
following functionality:
+
+* SSL/TLS connection;
+* Multiple Endpoints;
+* Partition Awareness;
+* `CREATE TABLE`, `ALTER TABLE`, `WITH`, and `MERGE` commands.</pre>
+</div>
</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<div class="title">Note</div>
-</td>
-<td class="content">
-Though this alpha release version does not support most of the Apache Ignite
functionality,
-it introduces several new features, which are to be accompanied with other
improvements from the <a
href="https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0";
target="_blank" rel="noopener">Ignite Enhancement Proposal</a> list.
-</td>
-</tr>
-</table>
</div>
+</div>
+<div class="sect1">
+<h2 id="setting-up">Setting Up</h2>
+<div class="sectionbody">
<div class="paragraph">
-<p>This alpha version of Apache Ignite, incorporating all the best solutions
over the past years,
-possesses the highest level of usability thanks to the following
improvements:</p>
+<p>The name of the driver’s class is
<code>org.apache.ignite.IgniteJdbcThinDriver</code>. For instance, this is how
you can open a JDBC connection to the cluster node listening on IP address
<code>192.168.0.50</code>:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Load
JDBC drivers.</span>
+<span class="nc">ServiceLoader</span><span class="o">.</span><span
class="na">load</span><span class="o">(</span><span class="n">java</span><span
class="o">.</span><span class="na">sql</span><span class="o">.</span><span
class="na">Driver</span><span class="o">.</span><span
class="na">class</span><span class="o">);</span>
+
+<span class="c1">// Open the JDBC connection.</span>
+<span class="nc">Connection</span> <span class="n">conn</span> <span
class="o">=</span> <span class="nc">DriverManager</span><span
class="o">.</span><span class="na">getConnection</span><span
class="o">(</span><span
class="s">"jdbc:ignite:thin://127.0.1.1:10800"</span><span
class="o">);</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The driver connects to one of the cluster nodes and forwards all the
queries to it for final execution. The node handles the query distribution and
the result’s aggregations. Then the result is sent back to the client
application.</p>
+</div>
+<div class="paragraph">
+<p>The JDBC connection string may be formatted with one of two patterns:
<code>URL query</code> or <code>semicolon</code>:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="java"><span class="c1">// URL
query pattern</span>
+<span class="nl">jdbc:ignite:thin:</span><span
class="c1">//<hostAndPortRange0>[,<hostAndPortRange1>]...[,<hostAndPortRangeN>][/schema][?<params>]</span>
+
+<span class="n">hostAndPortRange</span> <span class="o">:=</span> <span
class="n">host</span><span class="o">[:</span><span
class="n">port_from</span><span class="o">[..</span><span
class="na">port_to</span><span class="o">]]</span>
+
+<span class="n">params</span> <span class="o">:=</span> <span
class="n">param1</span><span class="o">=</span><span
class="n">value1</span><span class="o">[&</span><span
class="n">param2</span><span class="o">=</span><span
class="n">value2</span><span class="o">]...[&</span><span
class="n">paramN</span><span class="o">=</span><span
class="n">valueN</span><span class="o">]</span>
+
+<span class="c1">// Semicolon pattern</span>
+<span class="nl">jdbc:ignite:thin:</span><span
class="c1">//<hostAndPortRange0>[,<hostAndPortRange1>]...[,<hostAndPortRangeN>][;schema=<schema_name>][;param1=value1]...[;paramN=valueN]</span></code></pre>
+</div>
</div>
<div class="ulist">
<ul>
<li>
-<p>Schema-first approach: This feature introduces one-to-one mapping between
data schemas and caches/tables,
-which means that the schema is defined for a cache/table before its
creation.</p>
-</li>
-<li>
-<p>Unified Configuration: This feature is presented by a set of the following
improvements:</p>
-<div class="ulist">
-<ul>
-<li>
-<p>Platform-agnostic configuration representation</p>
-</li>
-<li>
-<p>Clear separation between configuration and any third-party code</p>
+<p><code>host</code> is required and defines the host of the cluster node to
connect to.</p>
</li>
<li>
-<p>Predictable configuration lifecycle</p>
+<p><code>port_from</code> is the beginning of the port range to use to open
the connection. 10800 is used by default if this parameter is omitted.</p>
</li>
<li>
-<p>Consistent runtime configuration change support</p>
-</li>
-</ul>
-</div>
+<p><code>port_to</code> is optional. It is set to the <code>port_from</code>
value by default if this parameter is omitted.</p>
</li>
<li>
-<p>Ignite CLI tool: This tool functions as a single sign-on for any
operational, management, and development needs.</p>
+<p><code>schema</code> is the schema name to access. PUBLIC is used by
default. This name should correspond to the SQL ANSI-99 standard. Non-quoted
identifiers are not case sensitive. Quoted identifiers are case sensitive. When
semicolon format is used, the schema may be defined as a parameter with name
schema.</p>
</li>
<li>
-<p>See a <a
href="https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0";
target="_blank" rel="noopener">full list of improvements</a>.</p>
+<p><code><params></code> are optional.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="new-in-alpha-2">New in Alpha 2</h2>
+<h2 id="running-an-example">Running an Example</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Apache Ignite Alpha 2 comes with the following new features:</p>
+<p>Examples are shipped as a separate Maven project, which is located in the
<code>examples</code> folder. <code>SqlJdbcExample</code> demonstrates the
usage of the Apache Ignite JDBC driver.</p>
</div>
-<div class="ulist">
-<ul>
+<div class="paragraph">
+<p>To run <code>SqlJdbcExample</code>, perform the following steps:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
<li>
-<p>Added replication infrastructure based on Raft.</p>
+<p>Import the examples project into you IDE;</p>
</li>
<li>
-<p>New in-memory atomic storage with the basic insert-read functionality.</p>
+<p>Start a server node using the CLI tool:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="rouge highlight"><code data-lang="shell">ignite node start <span
class="nt">--config</span><span class="o">=</span><span
class="nv">$IGNITE_HOME</span>/examples/config/ignite-config.json
my-first-node</code></pre>
+</div>
+</div>
</li>
<li>
-<p>New schema management engine and API.</p>
+<p>Run <code>SqlJdbcExample</code> in the IDE.</p>
</li>
-</ul>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="known-issues">Known Issues</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Due to changes between alpha 1 and alpha 2, Ignite cluster configuration
commands no longer work. This will be fixed in alpha 3.</p>
-</div>
-<div class="paragraph">
-<p>Affected commands: <code>config</code>, <code>config get</code>,
<code>config set</code>.</p>
+</ol>
</div>
</div>
</div>
@@ -304,8 +350,8 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
<nav class="right-nav" data-swiftype-index='false'>
<div class="toc-wrapper">
<ul class="sectlevel1">
-<li><a href="#new-in-alpha-2">New in Alpha 2</a></li>
-<li><a href="#known-issues">Known Issues</a></li>
+<li><a href="#setting-up">Setting Up</a></li>
+<li><a href="#running-an-example">Running an Example</a></li>
</ul>
</div>
@@ -345,11 +391,11 @@ Apache, Apache Ignite, the Apache feather and the Apache
Ignite logo are either
debug: false,
});
</script>
-<script type='module' src='/assets/js/index.js?1628277221' async
crossorigin></script>
-<script type='module' src='/assets/js/versioning.js?1628277221' async
crossorigin></script>
+<script type='module' src='/assets/js/index.js?1634839436' async
crossorigin></script>
+<script type='module' src='/assets/js/versioning.js?1634839436' async
crossorigin></script>
-<link rel="stylesheet" href="/assets/css/styles.css?1628277221" media="print"
onload="this.media='all'">
-<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1628277221"></noscript>
+<link rel="stylesheet" href="/assets/css/styles.css?1634839436" media="print"
onload="this.media='all'">
+<noscript><link media="all" rel="stylesheet"
href="/assets/css/styles.css?1634839436"></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>
