Create and Connect a Micronaut Application to the Oracle Cloud Infrastructure MySQL HeatWave Service

This guide describes how to create a database application using the Graal Development Kit for Micronaut (GDK). The application presents REST endpoints and stores data in an Oracle Cloud Infrastructure MySQL database using Micronaut® Data.

MySQL HeatWave is a fully-managed Oracle Cloud Infrastructure database service developed and supported by the MySQL team in Oracle.

Micronaut Data is a database access toolkit that uses ahead-of-time compilation to precompute queries for repository interfaces that are then executed by a thin, lightweight runtime layer. Micronaut Data supports the following back ends: JPA (Hibernate and Hibernate Reactive); SQL (JDBC, R2DBC); and MongoDB.

Prerequisites #

Follow the steps below to create the application from scratch. However, you can also download the completed example:

A note regarding your development environment

Consider using Visual Studio Code, which provides native support for developing applications with the Graal Development Kit extension.

Note: If you use IntelliJ IDEA, enable annotation processing.

Windows platform: The GDK guides are compatible with Gradle only. Maven support is coming soon.

1. Create the Application #

Create an application using the GDK Launcher.

  1. Open the GDK Launcher in advanced mode.

  2. Create a new project using the following selections.
    • Project Type: Application (Default)
    • Project Name: oci-db-demo
    • Base Package: com.example (Default)
    • Clouds: OCI
    • Language: Java (Default)
    • Build Tool: Gradle (Groovy) or Maven
    • Test Framework: JUnit (Default)
    • Java Version: 17 (Default)
    • Micronaut Version: (Default)
    • Cloud Services: Database
    • Features: GraalVM Native Image and MySQL
    • Sample Code: Yes (Default)
  3. Click Generate Project, then click Download Zip. The GDK Launcher creates a Java project with the default package com.example in a directory named oci-db-demo. The application ZIP file will be downloaded to your default downloads directory.

Alternatively, use the GDK CLI as follows:

gdk create-app com.example.oci-db-demo \
    --clouds=oci \
    --services=database \
    --features=graalvm,mysql \
    --build=gradle \
    --jdk=17 \
gdk create-app com.example.oci-db-demo \
    --clouds=oci \
    --services=database \
    --features=graalvm,mysql \
    --build=maven \
    --jdk=17 \

The GDK Launcher creates a multimodule project with two subprojects: oci for Oracle Cloud Infrastructure, and lib for common code and configuration shared across cloud platforms. You develop the application logic in the lib subproject, and keep the Oracle Cloud Infrastructure-specific configurations in the oci subproject. If you enable sample code generation, the GDK Launcher creates the main controller, repository interface, entity, service classes, and tests for you. Consider checking this guide where each sample class is closely examined.

2. Set Up Oracle Cloud Infrastructure #

This guide requires the following Oracle Cloud Infrastructure resources (known as a “stack”):

  • A MySQL DB System
  • A Compute instance to host your application (because there is no direct way to externally connect to a MySQL DB System)
  • A Virtual Cloud Network
    • A private subnet allowing traffic between the MySQL DB System and Compute instance
    • A public subnet open to the internet

Instead of creating the stack manually, use the following steps to provision it using Oracle Cloud Infrastructure Resource Manager:

  1. Download the Terraform configuration GDK MySQLDownload Terraform Configuration to your default downloads directory.

  2. Follow the steps in Creating a Stack from a Zip File.
    • In the “ssh_public_key” field of the Configure variables panel, paste the contents of your public key.
    • In the Review panel, select Run apply.
  3. Click Create. (It can take up to 20 minutes to provision the stack. The Log provides details of progress.)

    Note: These resources must not already exist in your Oracle Cloud Infrastructure tenancy, otherwise the Resource Manager will fail to provision the stack—in the Log you will see a message similar to Error: 409-NAMESPACE_CONFLICT, Repository already exists. Delete the conflicting resources before re-attempting to provision the stack.

  4. When the job completes, click Outputs in the list of the job’s resources and make note of the IP addresses:
    • compute_instance_private_ip (the private IP address of the Compute instance)
    • compute_instance_public_ip (the public IP address of the Compute instance)
    • mysql_db_private_ip (the private IP address of the MySQL DB System)
  5. In a local terminal, create an environment variable for the public IP address of the Compute instance, as follows:
    export COMPUTE_INSTANCE_PUBLIC_IP=<compute_instance_public_ip>
    set COMPUTE_INSTANCE_PUBLIC_IP=<compute_instance_public_ip>
    $COMPUTE_INSTANCE_PUBLIC_IP = "<compute_instance_public_ip>"

    Replacing <compute_instance_public_ip> with its value.

3. Configure a MySQL Database #

The GDK Launcher defined default datasources in the oci/src/main/resources/ file. The GDK Launcher also included and enabled Flyway to perform migrations on the default datasources. It uses the Micronaut integration with Flyway to automate schema changes and significantly simplify schema management tasks, such as migrating, rolling back, and reproducing in multiple environments.

Flyway will create the database tables the first time the application starts, but you must first create the database and a database user.

3.1. Start MySQL Shell #

  1. Using your existing local terminal, use ssh to connect to your newly created Compute instance, providing the instance’s Public IP address:
     ssh -i /path/to/ssh-key opc@$COMPUTE_INSTANCE_PUBLIC_IP

    For more information, see Connecting to Your Linux Instance Using SSH.

  2. Start the MySQL shell using the admin username (“admin”) and password (“Welcome_1”), and the private IP address of the MySQL DB System:
     mysqlsh --host <mysql_db_private_ip> -u admin -p
  3. Switch to “SQL mode” in the shell, as follows:

3.2. Create a Database and User #

  1. From the MySQL shell, create the database (use any valid database name, for example, “gdkDB”):
  2. Create a database user. Use any valid MySQL username, for example, “guide_user”, and a valid password (at least eight characters long, with at least one numeric character, one lowercase character, one uppercase character, and one non-alphanumeric character):
     CREATE USER 'guide_user'@'<compute_instance_private_ip>' IDENTIFIED BY '<password>';

    Where <compute_instance_private_ip> is the private IP address of your Compute instance as noted earlier.

  3. Grant access to the database for the new user:
     GRANT ALL ON gdkDB.* TO 'guide_user'@'<compute_instance_private_ip>';
  4. Exit the MySQL shell by entering “\quit”.

  5. Close the ssh session by entering “exit”.

4. Run the Java Application #

With almost everything in place, you can run the application.

  1. From your existing local terminal, copy the ZIP file to the Compute instance using scp:

    scp -i /path/to/ssh-key \
           /path/to/downloads/ \
    scp -i /path/to/ssh-key \
           /path/to/downloads/ \
  2. Use ssh to reconnect to your Compute instance (ssh -i /path/to/ssh-key opc@$COMPUTE_INSTANCE_PUBLIC_IP) and unzip the ZIP file using unzip, then cd into the newly created directory.

  3. Set values for additional datasources named datasources.default.url, datasources.default.username, and datasources.default.password by exporting them as environment variables as follows:

    export DATASOURCES_DEFAULT_URL=jdbc:mysql://<mysql_db_private_ip>:3306/gdkDB # 1
    export DATASOURCES_DEFAULT_USERNAME=<username> # 2
    export DATASOURCES_DEFAULT_PASSWORD=<password> # 3
    set DATASOURCES_DEFAULT_URL=jdbc:mysql://<mysql_db_private_ip>:3306/gdkDB # 1
    $ENV:DATASOURCES_DEFAULT_URL = "jdbc:mysql://<mysql_db_private_ip>:3306/gdkDB" # 1

    1 Set the value of the datasources.default.url property as the private IP address of the MySQL DB System combined with the name of the database.

    2 Set the value of the datasources.default.username property as the username of the user you created, for example, “guide_user”.

    3 Set the value of the datasources.default.password property as the password of the user you created.

  4. To run the Java application on the Compute instance, use the following command from within the ssh session (which starts the application on port 8080):

    ./gradlew :oci:run
    ./mvnw install -pl lib -am
    ./mvnw mn:run -pl oci
  5. Open a new local terminal, then run this command to test that you can create and store a new Genre in the database:

     curl -X "POST" "http://<compute_instance_public_ip>:8080/genres" \
          -H 'Content-Type: application/json; charset=utf-8' \
          -d $'{ "name": "music" }'

    Replacing <compute_instance_public_ip> with its value.

    Then list the genres:

     curl http://<compute_instance_public_ip>:8080/genres/list

You have successfully shown that the Java application presents REST endpoints and stores data in the Oracle MySQL database.

5. Package with GraalVM Native Image #

The GDK supports compiling a Java application ahead-of-time into a native executable using GraalVM Native Image. You can use the Gradle plugin for GraalVM Native Image building/Maven plugin for GraalVM Native Image building. Packaged as a native executable, it significantly reduces application startup time and memory footprint.

To generate a native executable on the Compute instance, run the following command in your existing ssh session:

./gradlew :oci:nativeCompile

The native executable is created in the oci/build/native/nativeCompile/ directory and can be run with the following command:

./mvnw install -pl lib -am
./mvnw clean package -pl oci -Dpackaging=native-image

The native executable is created in the oci/target/ directory and can be run with the following command:


6. Run and Test the Native Executable #

  1. In the ssh session, run the native executable.

  2. Perform the same tests as in step 4.

7. Clean Up Cloud Resources #

After you have finished this guide, clean up the resources you created:

  1. Destroy the resources associated with a stack by following the steps in Creating a Destroy Job.

  2. Follow the instructions in Deleting a Stack to delete the stack.

Summary #

This guide demonstrated how to use the GDK to create a database application that stores data in an Oracle MySQL Database. You also learned how to package this application into a native executable.