Google Git
Sign in
apache/ignite-3/HEAD/./examples/java
tree: 45ac1cdb8ceaa7617b7b10146c3a003822777e85
  1. config/
  2. src/
  3. .gitignore
  4. build.gradle
  5. README.md
examples/java/README.md

Apache Ignite 3 Examples

Overview

This project contains code examples for Apache Ignite 3.

Examples are shipped as a separate Gradle module, so to start running you simply need to import the provided build.gradle file into your favourite IDE.

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.
  • SqlApiExample - demonstrates the usage of the Java API for SQL.
  • VolatilePageMemoryStorageExample - demonstrates the usage of the PageMemory storage engine configured with an in-memory data region.
  • PersistentPageMemoryStorageExample - demonstrates the usage of the PageMemory storage engine configured with a persistent data region.
  • RocksDbStorageExample - demonstrates the usage of the RocksDB storage engine.
  • KeyValueViewDataStreamerExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, DataStreamerOptions) API with the KeyValueView.
  • KeyValueViewPojoDataStreamerExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, DataStreamerOptions) API with the KeyValueView and user-defined POJOs.
  • RecordViewDataStreamerExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, DataStreamerOptions) API with the RecordView.
  • RecordViewPojoDataStreamerExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, DataStreamerOptions) API with the RecordView and user-defined POJOs.
  • ReceiverStreamProcessingExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, Function, Function, ReceiverDescriptor, Subscriber, DataStreamerOptions, Object) API for stream processing of the trades data read from the file.
  • ReceiverStreamProcessingWithResultSubscriberExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, Function, Function, ReceiverDescriptor, Subscriber, DataStreamerOptions, Object) API for stream processing of the trade data and receiving processing results.
  • ReceiverStreamProcessingWithTableUpdateExample - demonstrates the usage of the DataStreamerTarget#streamData(Publisher, Function, Function, ReceiverDescriptor, Subscriber, DataStreamerOptions, Object) API for stream processing of the trade data and updating account data in the table.
  • ComputeAsyncExample - demonstrates the usage of the IgniteCompute#executeAsync(JobTarget, JobDescriptor, Object) API.
  • ComputeBroadcastExample - demonstrates the usage of the IgniteCompute#execute(BroadcastJobTarget, JobDescriptor, Object) API.
  • ComputeCancellationExample - demonstrates the usage of the IgniteCompute#executeAsync(JobTarget, JobDescriptor, Object, CancellationToken) API.
  • ComputeColocatedExample - demonstrates the usage of the IgniteCompute#execute(JobTarget, JobDescriptor, Object) API with colocated JobTarget.
  • ComputeExample - demonstrates the usage of the IgniteCompute#execute(JobTarget, JobDescriptor, Object) API.
  • ComputeJobPriorityExample - demonstrates the usage of the IgniteCompute#execute(JobTarget, JobDescriptor, Object) API with different job priorities.
  • ComputeMapReduceExample - demonstrates the usage of the IgniteCompute#executeMapReduce(TaskDescriptor, Object) API.
  • ComputeWithCustomResultMarshallerExample - demonstrates the usage of the IgniteCompute#execute(JobTarget, JobDescriptor, Object) API with a custom result marshaller.
  • ComputeWithResultExample - demonstrates the usage of the IgniteCompute#execute(JobTarget, JobDescriptor, Object)}` API with a result return.

Running examples with an Ignite node within a Docker container

  1. Pull the docker image

    docker pull apacheignite/ignite:3.1.0

  2. Prepare an environment variable:

    IGNITE_SOURCES=/path/to/ignite-sources-dir

  3. Start an Ignite node:

    docker run --name ignite3-node -d --rm -p 10300:10300 -p 10800:10800 \
  -v $IGNITE_SOURCES/examples/java/config/ignite-config.conf:/opt/ignite/etc/ignite-config.conf apacheignite/ignite:3.1.0

  4. Get the IP address of the node:

    NODE_IP_ADDRESS=$(docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' ignite3-node)

  5. Initialize the node:

    docker run --rm -it apacheignite/ignite:3.1.0 cli cluster init --url http://$NODE_IP_ADDRESS:10300 --name myCluster1 \
  --cluster-management-group defaultNode --metastorage-group defaultNode

  6. Run the example via IDE.

  7. Stop the Ignite node:

    docker stop ignite3-node

Running examples with an Ignite node started natively

  1. Open the Ignite project in your IDE of choice.

  2. Download the Ignite ZIP package including the database and CLI parts. Alternatively, build these parts from the Ignite sources (see DEVNOTES.md). Unpack.

  3. Prepare the environment variables. IGNITE_HOME is used in the Ignite startup. Therefore, you need to export it:

    export IGNITE_HOME=/path/to/ignite3-db-dir
IGNITE_CLI_HOME=/path/to/ignite3-cli-dir
IGNITE_SOURCES=/path/to/ignite3-sources-dir

  4. Override the default configuration file:

    echo "CONFIG_FILE=$IGNITE_SOURCES/examples/java/config/ignite-config.conf" >> $IGNITE_HOME/etc/vars.env

  5. Start an Ignite node using the startup script from the database part:

    $IGNITE_HOME/bin/ignite3db start

  6. Initialize the cluster using Ignite CLI from the CLI part:

    $IGNITE_CLI_HOME/bin/ignite3 cluster init --name myCluster1

  7. Run the example from the IDE.

  8. Stop the Ignite node using the startup script:

    $IGNITE_HOME/bin/ignite3db stop

Running Compute and Streaming Examples

Compute and streaming examples require deployment units to be deployed to the cluster. There are several ways to run these examples:

Automated Mode (Recommended)

From IDE (IDEA Gradle runner):

Simply run the example from your IDE. The deployment unit JAR (deploymentunit-example-1.0.0.jar) is automatically built before execution via the deploymentUnitJar Gradle task and deployed to the cluster if not already present.

Note: The automatic pre-build of the deployment unit JAR relies on the IDEA Gradle runner, which dynamically creates JavaExec tasks. If your IDE uses a different run configuration (e.g., Micronaut plugin, or runs java directly), the deployment unit JAR resource may not be built automatically. In that case, generate it manually first:

./gradlew :ignite-examples:processResources

and ensure your run configuration includes the Gradle output resources directory (for example, examples/java/build/resources/main) on the classpath.

From Command Line (Gradle):

./gradlew :ignite-examples:run -PmainClass=<ExampleMainClass>

From Command Line (java):

Build the project first (compiles classes and embeds the deployment unit JAR as a classpath resource), then run:

./gradlew :ignite-examples:build
java -cp "examples/java/build/classes/java/main:examples/java/build/resources/main:<runtime-jars>" <ExampleMainClass>

Where <runtime-jars> is a colon-separated (semicolon on Windows) list of all runtime dependency JARs. These are available in the Gradle cache after the build and can be obtained by inspecting the runtimeClasspath configuration.

Manual Mode

If you prefer to deploy the unit manually:

  1. Build the deployment unit JAR:

    ./gradlew :ignite-examples:deploymentUnitJar

  2. Deploy the JAR as a deployment unit using the CLI:

    cluster unit deploy <unitName> \
    --version 1.0.0 \
    --path=examples/java/build/libs/deploymentunit-example-1.0.0.jar

    Common unit names used by examples:

    • computeExampleUnit - used by compute examples
    • streamerReceiverExampleUnit - used by streaming examples

  3. Run the example from the IDE.