This is an automated email from the ASF dual-hosted git repository.
isapego pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new f91fb08697 IGNITE-17948 Description for packages (#1251)
f91fb08697 is described below
commit f91fb08697757069f5277edc1a76bff23a019e96
Author: IgGusev <[email protected]>
AuthorDate: Mon Nov 14 18:15:30 2022 +0300
IGNITE-17948 Description for packages (#1251)
---
docs/_data/toc.yaml | 9 +
docs/_docs/binary-protocol.adoc | 2 +-
docs/_docs/ignite-cli-tool.adoc | 51 +++---
docs/_docs/index.adoc | 38 +++--
docs/_docs/installation/deb-rpm.adoc | 62 +++++++
.../installation/installing-using-docker.adoc | 80 +++++++++
docs/_docs/installation/installing-using-zip.adoc | 100 +++++++++++
docs/_docs/quick-start/getting-started-guide.adoc | 187 ++++-----------------
docs/_docs/sql/calcite-based-sql-engine.adoc | 2 +-
docs/_docs/sql/jdbc-driver.adoc | 2 +-
.../transactions/performing-transactions.adoc | 2 +-
11 files changed, 339 insertions(+), 196 deletions(-)
diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml
index bd6d611127..2dda5311b3 100644
--- a/docs/_data/toc.yaml
+++ b/docs/_data/toc.yaml
@@ -16,6 +16,15 @@
url: index
- title: Getting Started Guide
url: quick-start/getting-started-guide
+- title: Installation
+ url: installation
+ items:
+ - title: Installing Using ZIP Archive
+ url: installation/installing-using-zip
+ - title: Installing Using Docker
+ url: installation/installing-using-docker
+ - title: Installing DEB or RPM package
+ url: installation/deb-rpm
- title: Ignite CLI Tool
url: ignite-cli-tool
- title: Working with SQL
diff --git a/docs/_docs/binary-protocol.adoc b/docs/_docs/binary-protocol.adoc
index d7d5c136cb..1242281cac 100644
--- a/docs/_docs/binary-protocol.adoc
+++ b/docs/_docs/binary-protocol.adoc
@@ -17,7 +17,7 @@
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.
-This Alpha release implementation of binary client protocol comes with the
following improvements:
+This Beta release implementation of binary client protocol comes with the
following improvements:
* Implemented
link:https://cwiki.apache.org/confluence/display/IGNITE/IEP-75+Thin+Client+MsgPack+Serialization[MsgPack,window=_blank]
as an underlying binary format;
* Added new set of data types;
diff --git a/docs/_docs/ignite-cli-tool.adoc b/docs/_docs/ignite-cli-tool.adoc
index a64c124dd5..0d03962222 100644
--- a/docs/_docs/ignite-cli-tool.adoc
+++ b/docs/_docs/ignite-cli-tool.adoc
@@ -31,15 +31,18 @@ The following commands can be executed in REPL mode of the
command line tool:
[cols="1,1,3",opts="header", stripes=none]
|===
| Command| Parameters | Description
-| `bootsrap` || Installs Ignite core modules locally. Previously `init`.
+//| `bootsrap` || Installs Ignite core modules locally. Previously `init`.
| `clear` || Clears the terminal.
| `cli config` || Gets all CLI tool configuration values.
| `cli config get` | `<config key-value>` | Gets the value of the specified
CLI tool configuration.
| `cli config set` | `<config key-value>` | Sets the value of the specified
CLI tool configuration.
+| `cli config show` | `<config key-value>` | Shows the cluster configuration.
| `cluster init` | `[--cluster-url] <--meta-storage-node> [--cmg-node]`|
Initializes the cluster on the specified URL.
-| `cluster show` | `[--cluster-url]` | Displays the detailed status of the
specified cluster.
+| `cluster status` | `[--cluster-url]` | Displays the detailed status of the
specified cluster.
| `cluster config show` | `[--cluster-url] [--selector]` | Gets the
configuration of the specified cluster.
| `cluster config update` | `[--cluster-url] <config in HOCON format>` |
Updates the configuration of the cluster with the provided configuration in
HOCON format.
+| `cluster topology physical` | `[--cluster-url]` | Shows physical cluster
topology.
+| `cluster topology logical` | `[--cluster-url]` | Shows logical cluster
topology.
| `connect` | [--cluster-url] | Connects to the specified cluster, or
`localhost:3000` if no cluster url is specified. All subsequent commands use
the specified cluster url.
| `disconnect` || Disconnects from the cluster.
| `exit` || Stops current interactive session.
@@ -47,10 +50,10 @@ The following commands can be executed in REPL mode of the
command line tool:
| `node classpath` || Shows the current classpath used by Ignite nodes.
| `node config show` | `[--node-url][--selector]` | Gets the local node
configuration.
|`node config update` | `[--node-url] <config in HOCON format>` | Updates the
local node configuration with the provided configuration in HOCON format.
-| `node list` || Shows the list of currently running local Ignite nodes.
-| `node start` | `[--config] <nodeName>` | Starts an Ignite node locally.
-| `node stop` | `<nodeName>` | Stops a locally running Ignite node.
-| `status` | `--cluster-url` |Shows the status of the default cluster, or a
different one if cluster-url is provided.
+//| `node list` || Shows the list of currently running local Ignite nodes.
+//| `node start` | `[--config] <nodeName>` | Starts an Ignite node locally.
+//| `node stop` | `<nodeName>` | Stops a locally running Ignite node.
+| `node status` | `--node-url` |Shows the status of the default cluster, or a
different one if cluster-url is provided.
| `sql` | `[--cluster-url][--script-file] <query>` | Executes the specified
SQL query.
| `version` || Displays current CLI tool version.
|===
@@ -62,22 +65,22 @@ The following commands can be executed in non-REPL mode of
the command-line tool
[cols="1,1,3",opts="header", stripes=none]
|===
| Command| Parameters | Description
-| `ignite cli config` || Gets all CLI tool configuration values.
-| `ignite cli config get` | `<config key-value>` | Gets the value of the
specified CLI tool configuration.
-| `ignite cli config set` | `<config key-value>` | Sets the value of the
specified CLI tool configuration.
-| `ignite bootsrap` || Installs Ignite core modules locally. Previously `init`.
-| `ignite cluster config show` | `[--cluster-url] [--selector]` | Gets the
configuration of the specified cluster.
-| `ignite cluster config update` | `[--cluster-url] <config in HOCON format>`
| Sets the configuration of the cluster with the provided configuration in
HOCON format.
-| `ignite cluster init` | `[--cluster-url] <--meta-storage-node>
[--cmg-node]`| Initializes the cluster on the specified URL.
-| `ignite cluster show` | `[--cluster-url]` | Displays the detailed status of
the specified cluster.
-| `ignite help` | `<command>` | Provides information on available commands, or
for specific command if the `command` parameter is specified.
-| `ignite node classpath` || Shows the current classpath used by Ignite nodes.
-| `ignite node config show` | `[--node-url][--selector]` | Gets the local node
configuration.
-| `ignite node list` || Shows the list of currently running local Ignite nodes.
-| `ignite node start` | `[--config] <nodeName>` | Starts an Ignite node
locally.
-| `ignite node stop` | `<nodeName>` | Stops a locally running Ignite node.
-|`ignite node config update` | `[--node-url] <config in HOCON format>` |
Updates the local node configuration with the provided configuration in HOCON
format.
-| `ignite status` | `--cluster-url` |Shows the status of the default cluster,
or a different one if cluster-url is provided.
-| `ignite sql` | `[--cluster-url][--script-file] <query>` | Executes the
specified SQL query.
-| `ignite version` || Displays current CLI tool version.
+| `ignite3 cli config` || Gets all CLI tool configuration values.
+| `ignite3 cli config get` | `<config key-value>` | Gets the value of the
specified CLI tool configuration.
+| `ignite3 cli config set` | `<config key-value>` | Sets the value of the
specified CLI tool configuration.
+//| `ignite3 bootsrap` || Installs Ignite core modules locally. Previously
`init`.
+| `ignite3 cluster config show` | `[--cluster-url] [--selector]` | Gets the
configuration of the specified cluster.
+| `ignite3 cluster config update` | `[--cluster-url] <config in HOCON format>`
| Sets the configuration of the cluster with the provided configuration in
HOCON format.
+| `ignite3 cluster init` | `[--cluster-url] <--meta-storage-node>
[--cmg-node]`| Initializes the cluster on the specified URL.
+| `ignite3 cluster status` | `[--cluster-url]` | Displays the detailed status
of the specified cluster.
+| `ignite3 help` | `<command>` | Provides information on available commands,
or for specific command if the `command` parameter is specified.
+//| `ignite3 node classpath` || Shows the current classpath used by Ignite
nodes.
+| `ignite3 node config show` | `[--node-url][--selector]` | Gets the local
node configuration.
+//| `ignite3 node list` || Shows the list of currently running local Ignite
nodes.
+//| `ignite3 node start` | `[--config] <nodeName>` | Starts an Ignite node
locally.
+//| `ignite3 node stop` | `<nodeName>` | Stops a locally running Ignite node.
+|`ignite3 node config update` | `[--node-url] <config in HOCON format>` |
Updates the local node configuration with the provided configuration in HOCON
format.
+| `ignite3 node status` | `[--node-url]` |Shows the status of the default
node, or a different one if node-url is provided.
+| `ignite3 sql` | `[--cluster-url][--script-file] <query>` | Executes the
specified SQL query.
+| `ignite3 version` || Displays current CLI tool version.
|===
\ No newline at end of file
diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc
index 56a9812cd4..db48bd3913 100644
--- a/docs/_docs/index.adoc
+++ b/docs/_docs/index.adoc
@@ -19,10 +19,10 @@ Apache Ignite is a distributed database for
high-performance computing with in-m
The technical documentation introduces you to the key capabilities, shows how
to use certain features of
the current Apache Ignite version.
-NOTE: Though this alpha release version does not support most of the Apache
Ignite functionality,
+NOTE: Though this beta release version does not support most of the Apache
Ignite 2 functionality,
it introduces several new features, which are to be accompanied with other
improvements from the
link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[Ignite
Enhancement Proposal,window=_blank] list.
-This alpha version of Apache Ignite, incorporating all the best solutions over
the past years,
+This beta version of Apache Ignite, incorporating all the best solutions over
the past years,
possesses the highest level of usability thanks to the following improvements:
* 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.
@@ -34,14 +34,26 @@ possesses the highest level of usability thanks to the
following improvements:
* Ignite CLI tool: This tool functions as a single sign-on for any
operational, management, and development needs.
* See a
link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[full
list of improvements,window=_blank].
-
-== New in Alpha 5
-
-Apache Ignite Alpha 5 comes with the following new features:
-
-* New CLI tool;
-* Distributed computing;
-* Java SQL API;
-* Data colocation;
-* REST API.
-
+== New in Beta
+
+Apache Ignite 3 Beta release includes the following features:
+
+
+- RPM and DEB packages: simplified installation and node management
+with system services.
+- SQL Transactions.
+- Transactional Protocol: improved locking model, multi-version based
+lock-free read-only transactions.
+- Storage: A number of improvements to memory-only and on-disk engines
+based on Page Memory.
+- Indexes: Basic functionality, hash and sorted indexes.
+- Client logging: A LoggerFactory may be provided during client
+creation to specify a custom logger for logs generated by the client.
+- Metrics framework: Collection and export of cluster metrics.
+- Client's Partition Awareness: Clients are now aware of data
+distribution over the cluster nodes which helps avoid additional
+network transmissions and lowers operations latency.
+- C++ client: Basic C++ client, able to perform operations on data.
+- Autogenerated values: now a function can be specified as a default
+value generator during a table creation. Currently only
+gen_random_uuid is supported.
diff --git a/docs/_docs/installation/deb-rpm.adoc
b/docs/_docs/installation/deb-rpm.adoc
new file mode 100644
index 0000000000..fff1703d5e
--- /dev/null
+++ b/docs/_docs/installation/deb-rpm.adoc
@@ -0,0 +1,62 @@
+// 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.
+= Installing Using DEP and RPM Package
+
+Apache Ignite can be installed from the official
link:https://www.apache.org/dist/ignite/rpm[RPM] or
link:https://www.apache.org/dist/ignite/deb[DEB] repositories.
+
+== Installing Deb Package
+
+//Configure the repository:
+
+//[source, shell]
+//----
+//sudo apt update
+//sudo apt install gnupg ca-certificates --no-install-recommends -y
+//----
+
+
+//[source, shell]
+//----
+//sudo bash -c 'cat <<EOF > /etc/apt/sources.list.d/ignite.list
+//deb http://apache.org/dist/ignite/deb/ apache-ignite main
+//EOF'
+//sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys
0EE62FB37A00258D
+//sudo apt update
+//sudo apt install apache-ignite --no-install-recommends
+//----
+
+. Download the archive with the Ignite CLI tool:
++
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-cli_3.0.0-beta1_all.deb";
-o ignite3-cli_3.0.0-beta1_all.deb
+
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-db_3.0.0-beta1_all.deb";
-o ignite3-db_3.0.0-beta1_all.deb
+----
+--
+
+NOTE: RPM packages are available as `ignite3-cli-3.0.0-beta1.noarch.rpm` and
`ignite3-db-3.0.0-beta1.noarch.rpm`.
+
+
+Install the Apache Ignite 3 package:
+
+[source, shell]
+----
+sudo apt install ignite3-db_3.0.0-beta1_all.deb --no-install-recommends
+sudo apt install ignite3-cli_3.0.0-beta1_all.deb --no-install-recommends
+----
\ No newline at end of file
diff --git a/docs/_docs/installation/installing-using-docker.adoc
b/docs/_docs/installation/installing-using-docker.adoc
new file mode 100644
index 0000000000..d7e7cce6e1
--- /dev/null
+++ b/docs/_docs/installation/installing-using-docker.adoc
@@ -0,0 +1,80 @@
+// 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.
+= Installing Using Docker
+
+== Prerequisites
+
+Ignite was tested on:
+
+include::../includes/prereqs.adoc[]
+
+== Building Docker Image
+
+Apache Ignite 3 Beta is not currently available on DockerHub. To use a Docker
image, you need to build it locally:
+
+- Check out the Apache Ignite 3
link:https://github.com/apache/ignite-3[repository].
+- Run the Gradle command to build a Docker image:
+----
+./gradlew docker
+----
+
+The build will result in a docker image you can use locally.
+
+== Running In-Memory Cluster
+
+Run Ignite in a docker container using the `docker run` command.
+
+[source,shell]
+----
+# Run the latest version
+sudo docker run -it --rm -p 10300:10300 apacheignite/ignite3
+----
+
+This command will launch a single Ignite node.
+
+To run multiple nodes, instead use a docker-compose file:
+
+----
+version: "3.9"
+
+name: ignite3
+
+x-ignite-def:
+ &ignite-def
+ image: apacheignite/ignite3:${IGNITE3_VERSION:-latest}
+
+services:
+ node1:
+ << : *ignite-def
+ command: --join node1:3344,node2:3344,node3:3344 --node-name node1
+ ports:
+ - 10300:10300
+ - 3344:3344
+ node2:
+ << : *ignite-def
+ command: --join node1:3344,node2:3344,node3:3344 --node-name node2
+ ports:
+ - 10301:10300
+ - 3345:3344
+ node3:
+ << : *ignite-def
+ command: --join node1:3344,node2:3344,node3:3344 --node-name node3
+ ports:
+ - 10302:10300
+ - 3346:3344
+----
+
+
+
diff --git a/docs/_docs/installation/installing-using-zip.adoc
b/docs/_docs/installation/installing-using-zip.adoc
new file mode 100644
index 0000000000..63d7c7185a
--- /dev/null
+++ b/docs/_docs/installation/installing-using-zip.adoc
@@ -0,0 +1,100 @@
+// 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.
+= Installing Using ZIP Archive
+
+== Prerequisites
+
+Ignite was tested on:
+
+include::../includes/prereqs.adoc[]
+
+
+== Installing Using ZIP Archive
+
+
+. Download the archive with the Ignite CLI tool:
++
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-3.0.0-beta1.zip";
-o ignite3-3.0.0-beta1.zip
+----
+
+tab:Windows (PowerShell)[]
+[source,shell]
+----
+include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0]
+----
+
+tab:Windows (CMD)[]
+[source,shell]
+----
+include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0]
+----
+--
+
+. Unpack the archive:
++
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+unzip ignite3-3.0.0-beta1.zip && cd ignite3-3.0.0-beta1
+----
+
+
+tab:Windows (PowerShell)[]
+[source,shell]
+----
+Expand-Archive ignite3-3.0.0-beta1.zip -DestinationPath . ; cd
ignite3-3.0.0-beta1
+----
+
+tab:Windows (CMD)[]
+[source,shell]
+----
+tar -xf ignite3-3.0.0-beta1.zip & cd ignite3-3.0.0-beta1
+----
+--
+
+. Add your installation directory to the PATH environment variable:
++
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+export IGNITE_HOME=$(pwd)
+----
+
+//tab:Windows (PowerShell)[]
+//[source,shell]
+//----
+//$ENV:PATH += ";."
+//----
+
+//tab:Windows (CMD)[]
+//[source,text]
+//----
+//set PATH=%cd%;%PATH%
+//----
+--
+
+//NOTE: On Windows, this latter change is not permanent and only affects the
current terminal session. If you want the
+//`ignite` command to be available after terminal or system restart, use the
`System Properties` dialog to
+//permanently update the `PATH` environment variable by adding a full path to
the Ignite installation directory.
+
diff --git a/docs/_docs/quick-start/getting-started-guide.adoc
b/docs/_docs/quick-start/getting-started-guide.adoc
index 656b999d2e..cddb4741ba 100644
--- a/docs/_docs/quick-start/getting-started-guide.adoc
+++ b/docs/_docs/quick-start/getting-started-guide.adoc
@@ -14,9 +14,8 @@
// limitations under the License.
= Getting Started Guide
-This guide provides essential details on how to start working with Ignite 3.0
Alpha 5 by using the Ignite CLI tool, including the following information:
+This guide provides essential details on how to start working with Ignite 3.0
Beta by using the Ignite CLI tool, including the following information:
-* How to download and install the tool.
* How to use the Ignite CLI tool to manage nodes.
* How to run built-in examples.
* Additional information regarding the use of the tool.
@@ -24,196 +23,74 @@ This guide provides essential details on how to start
working with Ignite 3.0 Al
== Prerequisites
-Ignite 3.0 Alpha 5 was officially tested on:
+Ignite 3.0 Beta was officially tested on:
include::../includes/prereqs.adoc[]
+== Starting Ignite Node
-== Installing Ignite CLI Tool
+In this guide we will use a link:../installation/installing-using-zip[zip]
archive installation. To start an Ignite node,
-To download and install the Ignite CLI Tool, follow the steps below:
-. Download the archive with the Ignite CLI tool:
-+
[tabs]
--
-tab:Unix[]
-[source,shell]
+tab:Linux[]
----
-curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha5/apache-ignite-3.0.0-alpha5.zip";
-o apache-ignite-3.0.0-alpha5.zip
+ignite3-db-3.0.0-beta1/bin/ignite3db start
----
-tab:Windows (PowerShell)[]
-[source,shell]
+tab:Windows[]
+NOTE: You need to install Java in Bash environment to run Ignite on Windows.
----
-include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0]
+bash ignite3-db-3.0.0-beta1/bin/ignite3db start
----
-
-tab:Windows (CMD)[]
-[source,shell]
-----
-include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0]
-----
---
-
-. Unpack the archive:
-+
-[tabs]
--
-tab:Unix[]
-[source,shell]
-----
-unzip apache-ignite-3.0.0-alpha5.zip && cd apache-ignite-3.0.0-alpha5
-----
-tab:Windows (PowerShell)[]
-[source,shell]
-----
-Expand-Archive apache-ignite-3.0.0-alpha5.zip -DestinationPath . ; cd
apache-ignite-3.0.0-alpha5
-----
-tab:Windows (CMD)[]
-[source,shell]
-----
-tar -xf apache-ignite-3.0.0-alpha5.zip & cd apache-ignite-3.0.0-alpha5
-----
---
-
-. Add your installation directory to the PATH environment variable:
-+
-[tabs]
---
-tab:Unix[]
-[source,shell]
-----
-echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source
~/.bash_profile && source ignite_completion.sh
-----
-
-tab:Windows (PowerShell)[]
-[source,shell]
-----
-$ENV:PATH += ";."
-----
-
-tab:Windows (CMD)[]
-[source,text]
-----
-set PATH=%cd%;%PATH%
-----
---
-
-NOTE: On Windows, this latter change is not permanent and only affects the
current terminal session. If you want the
-`ignite` command to be available after terminal or system restart, use the
`System Properties` dialog to
-permanently update the `PATH` environment variable by adding a full path to
the Ignite installation directory.
== Using Ignite CLI Tool
-Ignite CLI is a single entry point for all the Ignite operations. You can
perform the following actions with it:
-
-* Manage existing nodes.
-* Install new nodes.
-* Update old nodes to new versions.
-* Install or remove optional modules.
-
-Let's use some of the \<<Ignite CLI Tool Commands>>.
-
-. Use the command below to see the full list:
-+
-[source, shell]
-----
-ignite
-----
-
-. Pass the `--help` parameter to the previous command to get its detailed
description:
-+
-[source, shell]
-----
-ignite bootstrap --help
-----
-
-== Installing Ignite Artifacts and Dependencies
-
-Ignite CLI allows to install Ignite modules and 3rd party Maven dependencies.
-
-WARNING: 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.
-
-. To start an Ignite 3.0 Alpha 5 cluster, you need to install Ignite core
artifacts first:
-+
-[source, shell]
-----
-ignite init
-----
-
-. Use the `module add` command to download Guava from Maven and add it to the
Ignite classpath:
-+
-[source, shell]
-----
-ignite module add mvn:com.google.guava:guava:23.0
-----
-
-. Confirm the library is added to the Ignite dependencies list:
-+
-[source, shell]
-----
-ignite module list
-----
-
+Ignite CLI is a single entry point for all the Ignite operations. In this
guide we will use it to start a cluster on a node you started on the previous
step and execute a simple SQL query.
-== Starting a Node
+//* Manage existing nodes.
+//* Install new nodes.
+//* Update old nodes to new versions.
+//* Install or remove optional modules.
-This section explains how to start a node, how to stop, and perform other
basic operations with it.
-
-. Start a cluster node setting `my-first-node` as a node unique identifier:
-+
-[source, shell]
+[tabs]
+--
+tab:Linux[]
----
-ignite node start --config=examples/config/ignite-config.json my-first-node
+ignite3-cli-3.0.0-beta1\bin\ignite3
----
-. Confirm the node is started and running:
-+
-[source, shell]
+tab:Windows[]
+NOTE: You need to install Java in Bash environment to run Ignite 3 beta on
Windows.
----
-ignite node list
+bash ignite3-cli-3.0.0-beta1\bin\ignite3
----
-+
-This command also displays the path to the log file.
-
-. 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 `cat` command on a Unix operating system.
-
-== Built-in Examples
+--
-Ignite 3.0 Alpha 5 comes with examples that are configured as a separate Maven
project located in the `examples` folder.
+After you start the node, you can start working on it. For example, you can
perform sql requests from the command line, or use the thin client to perform
requests.
-The project includes the following examples:
-* `RecordViewExample` demonstrates the usage of the
`org.apache.ignite.table.RecordView` API to create a table. It also shows how
to get data from a table, or insert a line into a table.
-* `KeyValueViewExample` - demonstrates the usage of the
`org.apache.ignite.table.KeyValueView` API to insert a line into a table.
-* `SqlJdbcExample` - demonstrates the usage of the Apache Ignite JDBC driver.
+== Stopping the Cluster
-To run any example, perform the following steps:
+After you are done working on the cluster, you need to stop the node. Use the
command below:
-. Import the examples project into your IDE.
-. Start a server node using the CLI tool:
-+
-[source, shell script]
+[tabs]
+--
+tab:Linux[]
----
-ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json
my-first-node
+ignite3-db-3.0.0-beta1/bin/ignite3db stop
----
-. Run the preferred example in the IDE.
-
-
-== Stopping the Cluster
-
-To stop the node, use the command below passing `my-first-node` as a node
unique identifier:
-[source, shell]
+tab:Windows[]
----
-ignite node stop my-first-node
+bash ignite3-db-3.0.0-beta1/bin/ignite3db stop
----
-
+--
== Next Steps
diff --git a/docs/_docs/sql/calcite-based-sql-engine.adoc
b/docs/_docs/sql/calcite-based-sql-engine.adoc
index b1dc3b3bc2..19c94ebdd8 100644
--- a/docs/_docs/sql/calcite-based-sql-engine.adoc
+++ b/docs/_docs/sql/calcite-based-sql-engine.adoc
@@ -14,7 +14,7 @@
// limitations under the License.
= Introduction
-Apache Ignite 3.0 Alpha 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.
+Apache Ignite 3.0 Beta 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.
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
link:https://calcite.apache.org/docs/[product documentation,window=_blank].
diff --git a/docs/_docs/sql/jdbc-driver.adoc b/docs/_docs/sql/jdbc-driver.adoc
index 1d3a5d5610..2163dbbde9 100644
--- a/docs/_docs/sql/jdbc-driver.adoc
+++ b/docs/_docs/sql/jdbc-driver.adoc
@@ -18,7 +18,7 @@ Apache Ignite is shipped with JDBC driver that allows
processing of distributed
WARNING:
----
-This Alpha release implementation of JDBC driver does not support the
following functionality:
+This Beta release implementation of JDBC driver does not support the following
functionality:
* SSL/TLS connection;
* Multiple Endpoints;
diff --git a/docs/_docs/transactions/performing-transactions.adoc
b/docs/_docs/transactions/performing-transactions.adoc
index a69986e2a5..f2f52885cc 100644
--- a/docs/_docs/transactions/performing-transactions.adoc
+++ b/docs/_docs/transactions/performing-transactions.adoc
@@ -14,7 +14,7 @@
// limitations under the License.
= Performing Transactions
-This Alpha release introduces the key-value API that provides an interface for
starting and completing transactions.
+This Beta release introduces the key-value API that provides an interface for
starting and completing transactions.
=== Synchronous Transactions
