diff --git a/docs/3.0.0-alpha/binary-protocol.html b/docs/3.0.0-alpha/binary-protocol.html index bc89a23c8d1..e6be2eabeb5 100644 --- a/docs/3.0.0-alpha/binary-protocol.html +++ b/docs/3.0.0-alpha/binary-protocol.html @@ -85,12 +85,12 @@ Apache Ignite logo - - + + - + +
@@ -217,6 +218,19 @@ + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -394,11 +429,11 @@

    Binary Client Protocol

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/compute/compute.html b/docs/3.0.0-alpha/compute/compute.html new file mode 100644 index 00000000000..d03ddb174b9 --- /dev/null +++ b/docs/3.0.0-alpha/compute/compute.html @@ -0,0 +1,520 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Distributed Computing | Ignite Documentation + + + + + + + + + + + + + + + + +
    + +
    + +
    + + Apache Ignite logo + +
    + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + + + + + + + +
    + + +
    + Edit + +

    Distributed Computing

    + +
    +
    +
    +

    Apache Ignite 3 provides an API for distributing computations across cluster nodes in a balanced and fault-tolerant manner. You can submit individual tasks for execution from Java and .NET clients.

    +
    +
    +

    You can use Java or .NET client to execute compute jobs. Make sure the required classes are deployed to the cluster before executing code.

    +
    +
    +

    Here is how you can execute a simple compute job:

    +
    +
    +
    +
    private void example() {
+    IgniteClient client = client();
+    IgniteCompute compute = client.compute();
+    Set<ClusterNode> nodes = new HashSet<>(client.clusterNodes());
+
+    compute.execute(nodes, NodeNameJob.class, "Hello");
+}
+
+private static class NodeNameJob implements ComputeJob<String> {
+    @Override
+    public String execute(JobExecutionContext context, Object... args) {
+        return context.ignite().name() + "_" + args[0];
+    }
+}
    +
    +
    +
    + + + + + +
    +
    Note
    +    		 +Unlike Ignite 2, jobs are not serialized. Only the class name and arguments are sent to the node. +
    +
    +
    +
    IIgniteClient client = Client;
+ICompute compute = client.Compute;
+IList<IClusterNode> nodes = await Client.GetClusterNodesAsync();
+string res = await compute.ExecuteAsync<string>(nodes, jobClassName: "org.foo.bar.NodeNameJob", "Hello!");
    +
    +
     +
    +
    +
    +

    Colocated Computations

    +
    +
    +

    In Apache Ignite 3 you can execute colocated computation with executeColocated method. When you do it, the compute task is guaranteed to be executed on the nodes that hold the specified key. This can significantly reduce execution time if your tasks require data.

    +
    +
    +

    In this example we will need a table to colocate:

    +
    +
    +
    +
    executeSql("CREATE TABLE test (k int, v int, CONSTRAINT PK PRIMARY KEY (k))");
+executeSql("INSERT INTO test(k, v) VALUES (1, 101)");
    +
    +
    +
    +

    And we will execute a simple task:

    +
    +
    +
    +
    class GetNodeNameJob implements ComputeJob<String> {
+    @Override
+    public String execute(JobExecutionContext context, Object... args) {
+        return context.ignite().name();
+    }
+}
    +
    +
    +
    +
    +
    String actualNodeName = ignite.compute()
+        .executeColocated("PUBLIC.test", Tuple.create(Map.of("k", 1)), GetNodeNameJob.class)
+        .get(1, TimeUnit.SECONDS);
+
+System.out.println(actualNodeName);
    +
    +
    +
    +
    String actualNodeName = ignite.compute()
+        .executeColocated("PUBLIC.test", 1, Mapper.of(Integer.class), GetNodeNameJob.class)
+        .get(1, TimeUnit.SECONDS);
+
+System.out.println(actualNodeName);
    +
    +
     +
    +
    +
    + © 2022 The Apache Software Foundation.
    +Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation. + +
    + +
    + + +
    + + + + + + + + + + + + + + + + + + + diff --git a/docs/3.0.0-alpha/config/data-region.html b/docs/3.0.0-alpha/config/data-region.html new file mode 100644 index 00000000000..0d262d7a824 --- /dev/null +++ b/docs/3.0.0-alpha/config/data-region.html @@ -0,0 +1,523 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Data Region Configuration | Ignite Documentation + + + + + + + + + + + + + + + + +
    + +
    + +
    + + Apache Ignite logo + +
    + + + + + + + +
    + + +
    + + + + + + + + +
    +
    + + + +
    + + + + + + + +
    + + +
    + Edit + +

    Data Region Configuration

    + +
    +
    +
    +

    You can set configuration for data regions by using HOCON format. You can configure your data regions to run either RocksDB or B+Tree storage, and fine-tune their performance. A cluster can have several data regions, and you can select the preferred storage type for each.

    +
    +
    +

    We recommend to use B+ Tree storage for read-heavy workloads, and RocksDB for write-heavy workloads.

    +
    +
    +
    +
    +

    RocksDB Region Configuration

    +
    +

    Below is the list of properties for RocksDB data regions:

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDefaultDescription

    name

    The name of the data region.

    size

    256 * 1024 * 1024

    Size of the offheap cache.

    writeBufferSize

    64 * 1024 * 1024

    Size of the write buffer.

    cache

    lru

    The type of the cache to use. Currently only lru is supported.

    numShardBits

    -1

    The number of parts the cache is sharded to.

    +

    == Page Memory Region Configuration

    +

    Page memory keeps data in B+Tree format. You can set up the following configuration parameters:

    +

    [cols="1,1,3",opts="header", stripes=none]

    +
    +

    |name|| The name of the data region. +|persistent|false| Specifies if the data region is persistent. +|initSize|256 * 1024 * 1024| Sets the initial space allocated to the data region. +|maxSize|256 * 1024 * 1024| Sets the maximum space that can be allocated to the data region. +|evictionMode|DISABLED| Sets the eviction algorithm to use. +|replacementMode|CLOCK| Sets the page replacement algorithm. +|evictionThreshold|0.9| Configures when the eviction process starts. +|emptyPagesPoolSize|100| The maximum number of empty pages Ignite will try to keep. +|checkpointPageBufSize|0| Sets the size of the page buffer. +|lazyMemoryAllocation|true|If enabled, memory will not be allocated until necessary.

    +
    +
    +
    +

    Configuration Example

    +
    +
    +

    The example below configures two data regions, one using RocksDB storage, and another using page memory:

    +
    +
    +
    +
    ignite config set --type cluster \
+"{
+    rocksDb.regions: [{
+        name: lsm_region,
+        size: 256000000,
+        cache: lru
+    }],
+
+    pageMemory.regions: [{
+        name: btree_region,
+        persistent: false,
+        maxSize: 256000000,
+        lazyMemoryAllocation: true
+    }]
+}"
    +
    +
    +
    +
    +
    + © 2022 The Apache Software Foundation.
    +Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation. + +
    + +
    + + +
    + + + + + + + + + + + + + + + + + + + diff --git a/docs/3.0.0-alpha/ignite-cli-tool.html b/docs/3.0.0-alpha/ignite-cli-tool.html index e0dd36e9429..e3d813f0266 100644 --- a/docs/3.0.0-alpha/ignite-cli-tool.html +++ b/docs/3.0.0-alpha/ignite-cli-tool.html @@ -85,12 +85,12 @@ Apache Ignite logo - - + + - + +
    @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -323,80 +358,269 @@

    Ignite Cli Tool

    -
    -

    Ignite CLI Tool

    +

    The Ignite CLI tool uses REST API as a communication protocol between the node and the CLI, -allowing you to configure the node.

    +allowing you to configure the node. By default, the CLI tool runs in the REPL (Read Eval Print Loop) mode, but you can also execute commands without entering it.

    Below is a list of Ignite CLI tool commands with short descriptions:

    +
    +
    +
    +

    Installation and Usage

    +
    +
    +

    You can find detailed installation guide in the Getting Started tutorial. The tutorial also includes some basic usage examples.

    +
    +
    +
    +
    +

    Command Options

    +
    +
    +

    The following commands can be executed in REPL mode of the command line tool:

    +
    --+++ + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + + + - - + + + - + + + + + + + + + + +
    CommandParameters Description

    config

    Inspects and updates Ignite cluster configuration.

    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.

    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 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.

    config get

    Gets current Ignite cluster configuration values.

    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.

    config set

    Updates Ignite cluster configuration values.

    disconnect

    Disconnects from the cluster.

    init

    Installs Ignite core modules locally.

    exit

    Stops current interactive session.

    module

    Manages optional Ignite modules and external artifacts.

    help

    <command>

    Provides information on available commands, or for specific command if the command parameter is specified.

    module list

    Shows the list of available optional Ignite modules.

    node classpath

    Shows the current classpath used by Ignite nodes.

    module add

    Adds an optional Ignite module or an external artifact.

    node config show

    [--node-url][--selector]

    Gets the local node configuration.

    module remove

    Adds an optional Ignite module or an external artifact.

    node config update

    [--node-url] <config in HOCON format>

    Updates the local node configuration with the provided configuration in HOCON format.

    node

    Starts, stops, and manages locally running Ignite nodes.

    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 classpath

    Shows the current classpath used by the Ignite nodes.

    status

    --cluster-url

    Shows the status of the default cluster, or a different one if cluster-url is provided.

    node list

    sql

    [--cluster-url][--script-file] <query>

    Executes the specified SQL query.

    version

    Displays current CLI tool version.

    +
    +
    +
    +

    Non-interactive Mode

    +
    +
    +

    The following commands can be executed in non-REPL mode of the command-line tool:

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CommandParametersDescription

    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.
    @@ -411,7 +635,9 @@

    Ignite CLI Tool

    - - + + - + + @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -384,21 +419,27 @@

    Apache Ignite Documentation

    -

    New in Alpha 4

    +

    New in Alpha 5

    -

    Apache Ignite Alpha 4 comes with the following new features:

    +

    Apache Ignite Alpha 5 comes with the following new features:

    • -

      Transactions functionality;

      +

      New CLI tool;

      +
      • +
    • +

      Distributed Computing;

      +
      • +
    • +

      Java SQL API;

    • -

      Data Definition Language (DDL) commands;

      +

      Data colocation;

    • -

      Table views.

      +

      REST API.

    @@ -414,7 +455,7 @@

    New in Alpha 4

    - - + + - + + @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -443,11 +478,11 @@

    Installing Using Distributive

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/persistence.html b/docs/3.0.0-alpha/persistence.html index bcf194aebe8..cf1faf88ab7 100644 --- a/docs/3.0.0-alpha/persistence.html +++ b/docs/3.0.0-alpha/persistence.html @@ -85,12 +85,12 @@ Apache Ignite logo - - + + - + + @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -394,11 +429,11 @@

    Ignite Persistence

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/quick-start/getting-started-guide.html b/docs/3.0.0-alpha/quick-start/getting-started-guide.html index 2eabc0a22cf..8542a9ed96b 100644 --- a/docs/3.0.0-alpha/quick-start/getting-started-guide.html +++ b/docs/3.0.0-alpha/quick-start/getting-started-guide.html @@ -85,12 +85,12 @@ Apache Ignite logo - - + + - + + @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -326,7 +361,7 @@

    Getting Started Guide

    -

    This guide provides essential details on how to start working with Ignite 3.0 Alpha 4 by using the Ignite CLI tool, including the following information:

    +

    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:

      @@ -350,7 +385,7 @@

      Getting Started Guide

      Prerequisites

      -

      Ignite 3.0 Alpha 4 was officially tested on:

      +

      Ignite 3.0 Alpha 5 was officially tested on:

      @@ -382,15 +417,15 @@

      Installing Ignite CLI Tool

      Download the archive with the Ignite CLI tool:

      -
      curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha4/apache-ignite-3.0.0-alpha4.zip" -o apache-ignite-3.0.0-alpha4.zip
      +
      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
      -
      curl "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha4/apache-ignite-3.0.0-alpha4.zip" -o apache-ignite-3.0.0-alpha4.zip
      +
      curl "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
      -
      curl "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha4/apache-ignite-3.0.0-alpha4.zip" -o apache-ignite-3.0.0-alpha4.zip
      +
      curl "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
       @@ -398,15 +433,15 @@

      Installing Ignite CLI Tool

      Unpack the archive:

      -
      unzip apache-ignite-3.0.0-alpha4.zip && cd apache-ignite-3.0.0-alpha4
      +
      unzip apache-ignite-3.0.0-alpha5.zip && cd apache-ignite-3.0.0-alpha5
      -
      Expand-Archive apache-ignite-3.0.0-alpha4.zip -DestinationPath . ; cd apache-ignite-3.0.0-alpha4
      +
      Expand-Archive apache-ignite-3.0.0-alpha5.zip -DestinationPath . ; cd apache-ignite-3.0.0-alpha5
      -
      tar -xf apache-ignite-3.0.0-alpha4.zip & cd apache-ignite-3.0.0-alpha4
      +
      tar -xf apache-ignite-3.0.0-alpha5.zip & cd apache-ignite-3.0.0-alpha5
       @@ -414,7 +449,7 @@

      Installing Ignite CLI Tool

      Add your installation directory to the PATH environment variable:

      -
      echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source ~/.bash_profile
      +
      echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source ~/.bash_profile  && source ignite_completion.sh
      @@ -483,7 +518,7 @@

      Using Ignite CLI Tool

      Pass the --help parameter to the previous command to get its detailed description:

      -
      ignite init --help
      +
      ignite bootstrap --help
      @@ -512,7 +547,7 @@

      Installing Ignite Artifact
      1. -

        To start an Ignite 3.0 Alpha 4 cluster, you need to install Ignite core artifacts first:

        +

        To start an Ignite 3.0 Alpha 5 cluster, you need to install Ignite core artifacts first:

        ignite init
        @@ -578,7 +613,7 @@

        Starting a Node

        Built-in Examples

        -

        Ignite 3.0 Alpha 4 comes with examples that are configured as a separate Maven project located in the examples folder.

        +

        Ignite 3.0 Alpha 5 comes with examples that are configured as a separate Maven project located in the examples folder.

        The project includes the following examples:

        @@ -594,21 +629,15 @@

        Built-in Examples

      2. SqlJdbcExample - demonstrates the usage of the Apache Ignite JDBC driver.

        3. -
      3. -

        RebalanceExample - demonstrates the data rebalancing process.

        -
      -

      To run the RebalanceExample, refer to its JavaDoc for instructions.

      -
      -
      -

      To run any other example, perform the following steps:

      +

      To run any example, perform the following steps:

      1. -

        Import the examples project into you IDE.

        +

        Import the examples project into your IDE.

      2. Start a server node using the CLI tool:

        @@ -710,11 +739,11 @@

        Next Steps

        debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/rebalance.html b/docs/3.0.0-alpha/rebalance.html index 26c070f28d9..8648c941471 100644 --- a/docs/3.0.0-alpha/rebalance.html +++ b/docs/3.0.0-alpha/rebalance.html @@ -85,12 +85,12 @@ Apache Ignite logo
      - - + + - + + @@ -217,6 +218,19 @@ + + + + + +
    • + + Java API + +
      • + @@ -279,6 +293,27 @@ +
    • + + + REST API + +
      • + +
    • + + + Distributed Computing + +
      • + +
    • + + + Data Region Configuration + +
      • +
    • @@ -323,9 +358,7 @@

      Data Rebalancing

      -
      -
      -
      +

      When a new node joins the cluster, some of the partitions are relocated to the new node so that the data remains distributed equally in the cluster. This process is called data rebalancing. If an existing node permanently leaves the cluster and backups are not configured, you lose the partitions stored on this node. When backups are configured, one of the backup copies of the lost partitions becomes a primary partition and the rebalancing process is initiated.

      @@ -340,19 +373,6 @@

      Data Rebalancing

      • -
      -
    -
    -
    -

    Running an Example

    -
    -
    -

    Examples are shipped as a separate Maven project, which is located in the examples folder. RebalanceExample demonstrates the data rebalancing process.

    -
    -
    -

    To start running RebalanceExample, please refer to its JavaDoc for instructions.

    -
    -
    © 2022 The Apache Software Foundation.
    @@ -363,9 +383,7 @@

    Running an Example

    - - + + - + +
    @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -326,7 +361,7 @@

    Data Definition Language (DDL)

    -

    This section walks you through all data definition language (DDL) commands supported by Apache Ignite 3.0 Alpha 4.

    +

    This section walks you through all data definition language (DDL) commands supported by Apache Ignite 3.0 Alpha.

    @@ -339,6 +374,8 @@

    CREATE TABLE

    CREATE TABLE [IF NOT EXISTS] [simpleName | schemaName.simpleName] (tableColumn [, tableColumn]...)
+[COLOCATE [BY] (tableColumn [, tableColumn]...)]
+[ENGINE engineName]
 [WITH paramName=paramValue [,paramName=paramValue]...]
 tableColumn = columnName columnType [[NOT] NULL] [DEFAULT defaultValue] [PRIMARY KEY]
    @@ -361,6 +398,12 @@

    CREATE TABLE

    IF NOT EXISTS - create the table only if a table with the same name does not exist.

  • +

    ENGINE - selects the storage engine to use. Currently pagememory and rocksdb are available.

    +
    • +
  • +

    COLOCATED BY - colocation key. The key can be composite. Primary key must include colocation key. Was affinity_key in Ignite 2.x.

    +
    • +

  • WITH - accepts additional parameters not defined by ANSI-99 SQL:

    • @@ -377,59 +423,118 @@

    CREATE TABLE

    - + - + - + - - + + - - - - CREATE + + + + CREATE - - + + - - - - TABLE + + + + TABLE - + - - - + + + - + - - + + - - - - IF NOT EXISTS + + + + IF NOT EXISTS - + - + - - - - table_name + + + + table_name + + + + + + + ( + + + + + + + + + + + + + + + + + constraint + + + + + + + + + + columns_definition + + + + + + + + + + + , + + + + + + + + + + ) + + + + - +

    CREATE TABLE

    - + - + - + - - - - - - - ( - - - + + - - - + + + - - - - - - - - - constraint + + + + + + + + + + + + COLOCATE + + + + + + + + - - - - + + + + + + + BY + + + + + - - - - column_definition + + + + column_list - - - - - - - - , - - + - - - - - - - ) + + + + + + + + + + + + + + + + + ENGINE + + + + + + + + engine_name + + + - - - - + + + - + - - + + - - + + - - - - WITH + + + + WITH - - + + - - - + + + - - + + - - - - param_name + + + + param_name - - + + - - - - = + + + + = - - + + - - - - param_value + + + + param_value - - + + - - - - , + + + + , - + - + - - + +

    qualified_table_name

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/sql-reference/dml.html b/docs/3.0.0-alpha/sql-reference/dml.html index f1e76ad96a8..a3c8d788c06 100644 --- a/docs/3.0.0-alpha/sql-reference/dml.html +++ b/docs/3.0.0-alpha/sql-reference/dml.html @@ -85,12 +85,12 @@ Apache Ignite logo
    - - + + - + + @@ -217,6 +218,19 @@ + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -326,7 +361,7 @@

    Data Manipulation Language (DML)

    -

    This section walks you through all data manipulation language (DML) commands supported by Apache Ignite 3.0 Alpha 4.

    +

    This section walks you through all data manipulation language (DML) commands supported by Apache Ignite 3.0 Alpha.

    @@ -358,6 +393,14 @@

    SELECT

    [HAVINGbooleanExpression] +
    +

    JOINs

    +
    +

    Ignite supports colocated and non-colocated distributed SQL joins. Furthermore, if the data resides in different tables (caches), Ignite allows for cross-table joins as well. +Joins between partitioned and replicated data sets always work without any limitations. +However, if you join partitioned data sets, then you have to make sure that the keys you are joining on are either colocated or make sure you switched on the non-colocated joins parameter for a query.

    +
    +
    @@ -414,7 +457,11 @@

    DELETE

    @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -731,11 +766,11 @@

    TIMESTAMP

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html b/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html index 4c437cd1ed9..ee66d09e955 100644 --- a/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html +++ b/docs/3.0.0-alpha/sql/calcite-based-sql-engine.html @@ -85,12 +85,12 @@ Apache Ignite logo
    • - - + + - + + @@ -217,6 +218,19 @@ + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -394,11 +429,11 @@

    Introduction

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/sql/java.html b/docs/3.0.0-alpha/sql/java.html new file mode 100644 index 00000000000..e6c72bfa484 --- /dev/null +++ b/docs/3.0.0-alpha/sql/java.html @@ -0,0 +1,527 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Java SQL API | Ignite Documentation + + + + + + + + + + + + + + + + +
    + +
    + +
    + + Apache Ignite logo + +
    + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + + + + + + + +
    + + +
    + Edit + +

    Java SQL API

    + +
    +
    +
    +

    In your Java projects, you can use the Java SQL API to execute SQL statements and getting results. All operations are executed as a part of sql session. You can create a session with default parameters by using a sql.createSession() method, or use an sql.sessionBuilder to configure it for your environment. Sessions are usually long-lived objects that can be used in multiple threads and may hold data server-side. Session object is light-weight, and Ignite manages resources automatically in failover scenarios (for example, for disconnects). You have to close the session manually by using the close() method when the session is no longer needed to release server resources. Here is how you usually set up a session:

    +
    +
    +
    +
    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:

    +
    +
    +
    +
    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:

    +
    +
    +
    +
    try (ResultSet rs = ses.execute(null,
+        "CREATE TABLE SYNCH(ID INT PRIMARY KEY, VAL0 INT)")
+) {
+    // no-op
+}
    +
    +
    +
    +
    • + + + + +
    +
    Note
    +    		 +ResultSet is closable, but it is safe to skip close() method for DDL and DML queries, as they do not keep server cursor open. +
    +
    +
    +
    +
    +

    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:

    +
    +
    +
    +
    long rowsAdded = Arrays.stream(ses.executeBatch(null,
+    "INSERT INTO ACCOUNTS (ACCOUNT_ID, CITY_ID, FIRST_NAME, LAST_NAME, BALANCE) values (?, ?, ?, ?, ?)",
+    BatchedArguments.of(1, 1, "John", "Doe", 1000.0d)
+        .add(2, 1, "Jane", "Roe", 2000.0d)
+        .add(3, 1, "Mary", "Major", 1500.0d)
+        .add(4, 1, "Richard", "Miles", 1450.0d)))
+        .asLongStream().sum();
    +
    +
    +
    +
    +
    +

    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:

    +
    +
    +
    +
    try (ResultSet rs = ses.execute(null,
+        "SELECT a.FIRST_NAME, a.LAST_NAME FROM ACCOUNTS a")) {
+    while (rs.hasNext()) {
+        SqlRow row = rs.next();
+
+        result += row.stringValue(1) + ", " + row.stringValue("LAST_NAME") + "\n";
+    }
+}
    +
    +
    +
    + + + + + +
    +
    Note
    +    		 +ResultSet may hold server-side cursor open due to lazy query execution. It must be closed manually, or by using the try-with-resources statement. +
    +
    +
    +
    +
    + © 2022 The Apache Software Foundation.
    +Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation. + +
    + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/3.0.0-alpha/sql/jdbc-driver.html b/docs/3.0.0-alpha/sql/jdbc-driver.html index acae277a092..2bec044731e 100644 --- a/docs/3.0.0-alpha/sql/jdbc-driver.html +++ b/docs/3.0.0-alpha/sql/jdbc-driver.html @@ -85,12 +85,12 @@ Apache Ignite logo
    • - - + + - + +
    @@ -217,6 +218,19 @@ + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -410,7 +445,7 @@

    Running an Example

    1. -

      Import the examples project into you IDE;

      +

      Import the examples project into your IDE;

    2. Start a server node using the CLI tool:

      @@ -478,11 +513,11 @@

      Running an Example

      debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/table-views.html b/docs/3.0.0-alpha/table-views.html index 9271d8c3841..46a89ef0ef0 100644 --- a/docs/3.0.0-alpha/table-views.html +++ b/docs/3.0.0-alpha/table-views.html @@ -85,12 +85,12 @@ Apache Ignite logo
    - - + + - + + @@ -217,6 +218,19 @@
    • + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -506,11 +541,11 @@

    Record Binary View

    debug: false, }); - - + + - - + + diff --git a/docs/3.0.0-alpha/transactions/performing-transactions.html b/docs/3.0.0-alpha/transactions/performing-transactions.html index 86a7d1fc0db..dad3c3e4fd0 100644 --- a/docs/3.0.0-alpha/transactions/performing-transactions.html +++ b/docs/3.0.0-alpha/transactions/performing-transactions.html @@ -85,12 +85,12 @@ Apache Ignite logo
    • - - + + - + + @@ -217,6 +218,19 @@ + + + + + +
  • + + Java API + +
    • + @@ -279,6 +293,27 @@ +
  • + + + REST API + +
    • + +
  • + + + Distributed Computing + +
    • + +
  • + + + Data Region Configuration + +
    • +
  • @@ -424,11 +459,11 @@

    Asynchronous Transactions

    debug: false, }); - - + + - - + +