This is an automated email from the ASF dual-hosted git repository. vkulichenko pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/ignite-3.git
commit 7140111feda0a5b82f772812d59e670d820c4f70 Author: Valentin Kulichenko <[email protected]> AuthorDate: Fri Jun 25 10:16:20 2021 -0700 IGNITE-15005 - Binary distribution README --- assembly/README | 0 assembly/README.md | 52 ++++++++++++++++++++++ assembly/assembly.xml | 3 +- examples/README.md | 12 ++--- .../example/table/KeyValueBinaryViewExample.java | 6 +-- .../apache/ignite/example/table/TableExample.java | 6 +-- 6 files changed, 66 insertions(+), 13 deletions(-) diff --git a/assembly/README b/assembly/README deleted file mode 100644 index e69de29..0000000 diff --git a/assembly/README.md b/assembly/README.md new file mode 100644 index 0000000..b67644c --- /dev/null +++ b/assembly/README.md @@ -0,0 +1,52 @@ +# Apache Ignite 3 Alpha 2 + +Apache Ignite is a distributed database for high-performance computing with in-memory speed. + +Ignite 3 is the next generation of the platform that will support a modernized modular architecture, +along with improved usability and developer experience. + +The current alpha version includes the following features: +* Unified CLI tool +* New configuration engine +* New schema management engine +* Table API +* Atomic storage implementation based on Raft + +## Installation + +1. Download Ignite 3 Alpha 2: + ``` + 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 + ``` +2. Unzip the downloaded file: + ``` + unzip apache-ignite-3.0.0-alpha2.zip && cd apache-ignite-3.0.0-alpha2 + ``` +3. Add your installation directory to the PATH environment variable: + ``` + echo 'export IGNITE_HOME="'`pwd`'"' >> ~/.bash_profile && echo 'export PATH="$IGNITE_HOME:$PATH"' >> ~/.bash_profile && source ~/.bash_profile + ``` +4. (optional) If you will start the cluster locally, install the core artifacts: + ``` + ignite init + ``` + +## Running Examples + +Examples are shipped as a separate Maven project, which is located in the `examples` folder. +To start running you simply need to import provided `pom.xml` file into your favourite IDE. + +The following examples are included: +* `TableExample` - demonstrates the usage of the `org.apache.ignite.table.Table` API +* `KeyValueBinaryViewExample` - demonstrates the usage of the `org.apache.ignite.table.KeyValueBinaryView` API + +To run an example, do the following: +1. Import the examples project into you IDE. +2. (optional) Run one or more standalone nodes 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 + ``` +3. Run the preferred example in the IDE. diff --git a/assembly/assembly.xml b/assembly/assembly.xml index 4923473..8a8ed05 100644 --- a/assembly/assembly.xml +++ b/assembly/assembly.xml @@ -38,7 +38,7 @@ </file> <file> - <source>assembly/README</source> + <source>assembly/README.md</source> <outputDirectory/> </file> @@ -66,6 +66,7 @@ <includes> <include>config/**</include> <include>src/**</include> + <include>README.md</include> </includes> </fileSet> </fileSets> diff --git a/examples/README.md b/examples/README.md index 8e1b30b..98934bc 100644 --- a/examples/README.md +++ b/examples/README.md @@ -12,10 +12,10 @@ The following examples are included: To run an example, do the following: 1. Import the examples project into you IDE. 2. (optional) Run one or more standalone nodes 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 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 + ``` 3. Run the preferred example in the IDE. diff --git a/examples/src/main/java/org/apache/ignite/example/table/KeyValueBinaryViewExample.java b/examples/src/main/java/org/apache/ignite/example/table/KeyValueBinaryViewExample.java index 28f6888..d4eb536 100644 --- a/examples/src/main/java/org/apache/ignite/example/table/KeyValueBinaryViewExample.java +++ b/examples/src/main/java/org/apache/ignite/example/table/KeyValueBinaryViewExample.java @@ -106,8 +106,8 @@ public class KeyValueBinaryViewExample { System.out.println( "Retrieved using Key-Value API\n" + - " Account Number: " + key.intValue("accountNumber") + '\n' + - " Owner: " + value.stringValue("firstName") + " " + value.stringValue("lastName") + '\n' + - " Balance: $" + value.doubleValue("balance")); + " Account Number: " + key.intValue("accountNumber") + '\n' + + " Owner: " + value.stringValue("firstName") + " " + value.stringValue("lastName") + '\n' + + " Balance: $" + value.doubleValue("balance")); } } diff --git a/examples/src/main/java/org/apache/ignite/example/table/TableExample.java b/examples/src/main/java/org/apache/ignite/example/table/TableExample.java index e97c5fe..800dae7 100644 --- a/examples/src/main/java/org/apache/ignite/example/table/TableExample.java +++ b/examples/src/main/java/org/apache/ignite/example/table/TableExample.java @@ -102,8 +102,8 @@ public class TableExample { System.out.println( "Retrieved using Tuple API\n" + - " Account Number: " + accountTuple.intValue("accountNumber") + '\n' + - " Owner: " + accountTuple.stringValue("firstName") + " " + accountTuple.stringValue("lastName") + '\n' + - " Balance: $" + accountTuple.doubleValue("balance")); + " Account Number: " + accountTuple.intValue("accountNumber") + '\n' + + " Owner: " + accountTuple.stringValue("firstName") + " " + accountTuple.stringValue("lastName") + '\n' + + " Balance: $" + accountTuple.doubleValue("balance")); } }
