You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by vk...@apache.org on 2021/10/12 21:26:17 UTC

[ignite-3] branch ignite-3.0.0-alpha3 updated: Updated READMEs for alpha3 + minor formatting

This is an automated email from the ASF dual-hosted git repository.

vkulichenko pushed a commit to branch ignite-3.0.0-alpha3
in repository https://gitbox.apache.org/repos/asf/ignite-3.git


The following commit(s) were added to refs/heads/ignite-3.0.0-alpha3 by this push:
     new 5eb5dcb  Updated READMEs for alpha3 + minor formatting
5eb5dcb is described below

commit 5eb5dcb6050c7d945191748b00215be95a5fb52c
Author: Valentin Kulichenko <va...@gmail.com>
AuthorDate: Tue Oct 12 14:25:51 2021 -0700

    Updated READMEs for alpha3 + minor formatting
---
 RELEASE.md                                         | 14 +++++++++++
 assembly/README.md                                 | 23 ++++++++++--------
 examples/README.md                                 | 11 ++++-----
 .../ignite/example/rebalance/RebalanceExample.java | 28 +++++++++++-----------
 4 files changed, 46 insertions(+), 30 deletions(-)

diff --git a/RELEASE.md b/RELEASE.md
index 9085849..4779d6c 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -10,6 +10,20 @@ This document describes the current procedure for preparing an Ignite 3 release.
    svn checkout https://dist.apache.org/repos/dist/dev/ignite dist-dev
    svn checkout https://dist.apache.org/repos/dist/release/ignite dist-release
    ```
+3. Provide your Apache credentials to Maven (required for uploading to Apache Nexus):
+   ```xml
+   <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+             xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
+     <servers>
+       <server>
+         <id>apache.staging</id>
+         <username>USERNAME</username>
+         <password>PASSWORD</password>
+       </server>
+     </servers>
+   </settings>
+   ```
 
 For all the commands going forward:
 * Replace `{version}` with the version number being released.
diff --git a/assembly/README.md b/assembly/README.md
index a8f63fb..fea9c1a 100644
--- a/assembly/README.md
+++ b/assembly/README.md
@@ -1,4 +1,4 @@
-# Apache Ignite 3 Alpha 2
+# Apache Ignite 3 Alpha 3
 
 Apache Ignite is a distributed database for high-performance computing with in-memory speed.
 
@@ -11,16 +11,18 @@ The current alpha version includes the following features:
 * New schema management engine
 * Table API
 * Atomic storage implementation based on Raft
+* New SQL engine based on Apache Calcite and JDBC driver
+* New binary client protocol and its implementation in Java
 
 ## Installation
 
-1. Download Ignite 3 Alpha 2:
+1. Download Ignite 3 Alpha 3:
    ```
-   curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip" -o apache-ignite-3.0.0-alpha2.zip
+   curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha3/apache-ignite-3.0.0-alpha3.zip" -o apache-ignite-3.0.0-alpha3.zip
    ```
 2. Unzip the downloaded file:
    ```
-   unzip apache-ignite-3.0.0-alpha2.zip && cd apache-ignite-3.0.0-alpha2
+   unzip apache-ignite-3.0.0-alpha3.zip && cd apache-ignite-3.0.0-alpha3
    ```
 3. Add your installation directory to the PATH environment variable:
    ```
@@ -39,14 +41,15 @@ To start running you simply need to import provided `pom.xml` file into your fav
 The following examples are included:
 * `RecordViewExample` - demonstrates the usage of the `org.apache.ignite.table.RecordView` API
 * `KeyValueViewExample` - demonstrates the usage of the `org.apache.ignite.table.KeyValueView` API
+* `SqlJdbcExample` - demonstrates the usage of the Apache Ignite JDBC driver.
+* `RebalanceExample` - demonstrates the data rebalancing process.
 
-To run an example, do the following:
+To run the `RebalanceExample`, refer to its JavaDoc for instructions.
+
+To run any other example, do the following:
 1. Import the examples project into you IDE.
-2. (optional) Run one or more standalone nodes using the CLI tool:
+2. Start a server node using the CLI tool:
    ```
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-1
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-2
-   ...
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-n
+   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json my-first-node
    ```
 3. Run the preferred example in the IDE.
diff --git a/examples/README.md b/examples/README.md
index 42efd2c..ab460fc 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -11,13 +11,12 @@ The following examples are included:
 * `SqlJdbcExample` - demonstrates the usage of the Apache Ignite JDBC driver.
 * `RebalanceExample` - demonstrates the data rebalancing process.
 
-To run an example, do the following:
+To run the `RebalanceExample`, refer to its JavaDoc for instructions.
+
+To run any other example, do the following:
 1. Import the examples project into you IDE.
-2. (optional) Run one or more standalone nodes using the CLI tool:
+2. Start a server node using the CLI tool:
    ```
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-1
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-2
-   ...
-   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json node-n
+   ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json my-first-node
    ```
 3. Run the preferred example in the IDE.
diff --git a/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java b/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
index 501cacc..b590371 100644
--- a/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
+++ b/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
@@ -71,9 +71,9 @@ public class RebalanceExample {
         System.setProperty("java.util.logging.config.file", "config/java.util.logging.properties");
 
         try (Ignite server = IgnitionManager.start(
-                "example-node",
-                Files.readString(Path.of("config", "ignite-config.json")),
-                Path.of("work")
+            "example-node",
+            Files.readString(Path.of("config", "ignite-config.json")),
+            Path.of("work")
         )) {
             //--------------------------------------------------------------------------------------
             //
@@ -89,17 +89,17 @@ public class RebalanceExample {
             System.out.println("\nCreating a table...");
 
             TableDefinition tableDef = SchemaBuilders.tableBuilder("PUBLIC", "rebalance")
-                    .columns(
-                            SchemaBuilders.column("key", ColumnType.INT32).asNonNull().build(),
-                            SchemaBuilders.column("value", ColumnType.string()).asNullable().build()
-                    )
-                    .withPrimaryKey("key")
-                    .build();
+                .columns(
+                    SchemaBuilders.column("key", ColumnType.INT32).asNonNull().build(),
+                    SchemaBuilders.column("value", ColumnType.string()).asNullable().build()
+                )
+                .withPrimaryKey("key")
+                .build();
 
             server.tables().createTable(tableDef.canonicalName(), tableChange ->
-                    SchemaConfigurationConverter.convert(tableDef, tableChange)
-                            .changeReplicas(5)
-                            .changePartitions(1)
+                SchemaConfigurationConverter.convert(tableDef, tableChange)
+                    .changeReplicas(5)
+                    .changePartitions(1)
             );
 
             //--------------------------------------------------------------------------------------
@@ -111,8 +111,8 @@ public class RebalanceExample {
             System.out.println("\nConnecting to server...");
 
             try (IgniteClient client = IgniteClient.builder()
-                    .addresses("127.0.0.1:10800")
-                    .build()
+                .addresses("127.0.0.1:10800")
+                .build()
             ) {
                 KeyValueView<Tuple, Tuple> kvView = client.tables().table("PUBLIC.rebalance").keyValueView();