Skip to content
Permalink
Browse files
Updated READMEs for alpha3 + minor formatting
  • Loading branch information
vkulichenko committed Oct 12, 2021
1 parent 0083c45 commit 8858465518da32ffdea9b8098820078efc2cdf91
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 30 deletions.
@@ -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.
@@ -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.
@@ -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.
@@ -71,9 +71,9 @@ public static void main(String[] args) throws Exception {
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 static void main(String[] args) throws Exception {
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 static void main(String[] args) throws Exception {
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();

0 comments on commit 8858465

Please sign in to comment.