This is an automated email from the ASF dual-hosted git repository. vveider 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 108cfc3ce IGNITE-17142 Docs: Review the AI 3.0.0 Alpha 5 documentation (#870) 108cfc3ce is described below commit 108cfc3ce3208b423e8b5c6eb96d97bda20fd439 Author: Nikita Safonov <73828260+nikita-tech-wri...@users.noreply.github.com> AuthorDate: Mon Jun 20 16:47:31 2022 +0300 IGNITE-17142 Docs: Review the AI 3.0.0 Alpha 5 documentation (#870) --- docs/_docs/config/data-region.adoc | 4 ++-- docs/_docs/ignite-cli-tool.adoc | 6 ------ docs/_docs/index.adoc | 2 +- docs/_docs/rest/rest-api.adoc | 6 +++--- docs/_docs/sql-reference/ddl.adoc | 2 +- docs/_docs/sql-reference/dml.adoc | 2 +- docs/_docs/sql/java.adoc | 8 +++----- 7 files changed, 11 insertions(+), 19 deletions(-) diff --git a/docs/_docs/config/data-region.adoc b/docs/_docs/config/data-region.adoc index e4297816d..576e1ad01 100644 --- a/docs/_docs/config/data-region.adoc +++ b/docs/_docs/config/data-region.adoc @@ -21,7 +21,7 @@ We recommend to use B+ Tree storage for read-heavy workloads, and RocksDB for wr === RocksDB Region Configuration -Below is the list of properties for link:https://rocksdb.org/[RocksDB] data regions: +Below is the list of properties for link:https://rocksdb.org/[RocksDB,window=_blank] data regions: [cols="1,1,3",opts="header", stripes=none] |=== @@ -53,7 +53,7 @@ Page memory keeps data in B+Tree format. You can set up the following configurat == Configuration Example -The example below configures two data regions, one using RocksDB storage, and another using page memory: +The example below shows how to configure two data regions, one using RocksDB storage, and another using page memory: ---- ignite config set --type cluster \ diff --git a/docs/_docs/ignite-cli-tool.adoc b/docs/_docs/ignite-cli-tool.adoc index 9c7993a6b..a64c124dd 100644 --- a/docs/_docs/ignite-cli-tool.adoc +++ b/docs/_docs/ignite-cli-tool.adoc @@ -53,12 +53,6 @@ The following commands can be executed in REPL mode of the command line tool: | `status` | `--cluster-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. - - - - - - |=== == Non-interactive Mode diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc index 2fb5fdb05..56a9812cd 100644 --- a/docs/_docs/index.adoc +++ b/docs/_docs/index.adoc @@ -40,7 +40,7 @@ possesses the highest level of usability thanks to the following improvements: Apache Ignite Alpha 5 comes with the following new features: * New CLI tool; -* Distributed Computing; +* Distributed computing; * Java SQL API; * Data colocation; * REST API. diff --git a/docs/_docs/rest/rest-api.adoc b/docs/_docs/rest/rest-api.adoc index 6d0c61240..bd690c70a 100644 --- a/docs/_docs/rest/rest-api.adoc +++ b/docs/_docs/rest/rest-api.adoc @@ -15,13 +15,13 @@ = Ignite REST API -Apache Ignite 3 clusters provide an link:https://www.openapis.org/[OpenAPI] specification that can be used to work with Ignite 3 by standard REST methods. The link:https://github.com/apache/ignite-3/tree/main/modules/rest/openapi/openapi.yaml[openapi.yaml] specification file for the version is included with its release. +The Apache Ignite 3 clusters provide an link:https://www.openapis.org/[OpenAPI] specification that can be used to work with Ignite 3 by standard REST methods. The link:https://github.com/apache/ignite-3/tree/main/modules/rest/openapi/openapi.yaml[openapi.yaml,window=_blank] specification file for the version is included with its release. -We recommend that you generate client code in your project language by using an link:https://github.com/OpenAPITools/openapi-generator[OpenAPI code generator]. Below is the example of how you can do this for a Java project. +We recommend that you generate client code in your project language by using an link:https://github.com/OpenAPITools/openapi-generator[OpenAPI code generator,window=_blank]. Below is the example of how you can do this for a Java project. == Example Java Project Configuration -1. Add an link:https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin[open api generator] maven plugin to your project's pom.xml. +1. Add an link:https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin[open api generator,window=_blank] maven plugin to your project's pom.xml. + [source,xml] ---- diff --git a/docs/_docs/sql-reference/ddl.adoc b/docs/_docs/sql-reference/ddl.adoc index 5a7b485d7..7a310dccf 100644 --- a/docs/_docs/sql-reference/ddl.adoc +++ b/docs/_docs/sql-reference/ddl.adoc @@ -14,7 +14,7 @@ // limitations under the License. = Data Definition Language (DDL) -This section walks you through all data definition language (DDL) commands supported by Apache Ignite 3.0 Alpha. +This section walks you through all data definition language (DDL) commands supported by Apache Ignite 3.0 Alpha 5. == CREATE TABLE diff --git a/docs/_docs/sql-reference/dml.adoc b/docs/_docs/sql-reference/dml.adoc index 656062578..e08fc77f9 100644 --- a/docs/_docs/sql-reference/dml.adoc +++ b/docs/_docs/sql-reference/dml.adoc @@ -14,7 +14,7 @@ // limitations under the License. = Data Manipulation Language (DML) -This section walks you through all data manipulation language (DML) commands supported by Apache Ignite 3.0 Alpha. +This section walks you through all data manipulation language (DML) commands supported by Apache Ignite 3.0 Alpha 5. WARNING: Currently, `WITH` and `MERGE` commands are not supported. diff --git a/docs/_docs/sql/java.adoc b/docs/_docs/sql/java.adoc index c47b2c6d3..d609e1d30 100644 --- a/docs/_docs/sql/java.adoc +++ b/docs/_docs/sql/java.adoc @@ -22,7 +22,7 @@ Session ses = sql.createSession(); Session ses = sql.sessionBuilder().defaultSchema("PUBLIC").build(); ---- -The `execute` method accepts a query String, or a Statement object, that can be created by using `sql.createStatement()` and `sql.statementBuilder()` methods. Stetements are light-weight objects and can be reused in multiple threads or sessions. Setting set by using `statementBuilder` override session settings for this statement. Here is how you usually set up a statement: +The `execute` method accepts a query String, or a Statement object, that can be created by using `sql.createStatement()` and `sql.statementBuilder()` methods. Statements are light-weight objects and can be reused in multiple threads or sessions. Setting set by using `statementBuilder` override session settings for this statement. Here is how you usually set up a statement: [source, java] ---- @@ -30,7 +30,6 @@ Statement stmt = sql.createStatement(sqlQueryString)); Statement stmt = sql.statementBuilder().query(sqlQueryString)).build(); ---- - == Creating Tables Here is an example of how you can create a new table on a cluster: @@ -49,8 +48,7 @@ NOTE: ResultSet is closable, but it is safe to skip `close()` method for DDL and == Filling Tables -With Apache Ignite 3, you can fill the table by adding rows one by one, or in a batch. In both cases, you create an `INSERT` statement, and then exeute it: - +With Apache Ignite 3, you can fill the table by adding rows one by one, or in a batch. In both cases, you create an `INSERT` statement, and then exeсute it: [source, java] ---- @@ -65,7 +63,7 @@ long rowsAdded = Arrays.stream(ses.executeBatch(null, == Getting Data From Tables -To get data from a table, execute a `SELECT` statement to get a set of results. SqlRow can provide access to column values by column name or column index. You can then iterate through results to get data: +To get data from a table, execute the `SELECT` statement to get a set of results. SqlRow can provide access to column values by column name or column index. You can then iterate through results to get data: [source, java] ----