update demo app to use Oracle Database 23ai

Author: omsn

graphviz-demo/README.md

@@ -2,7 +2,7 @@
 
 An example Java web application based on [Micronaut](https://docs.micronaut.io/) which embeds Oracle's Graph
 Visualization library. The server queries the graph data from an Oracle Database using 
-[PGQL](https://pgql-lang.org/).
+SQL.
 
 The key source files to look at are
 
@@ -14,13 +14,11 @@ The key source files to look at are
 ## Pre-requisites
 
 1. Oracle JDK 11 (or OpenJDK 11)
-2. A running Oracle Graph Server. Download [from oracle.com](https://www.oracle.com/database/technologies/spatialandgraph/property-graph-features/graph-server-and-client/graph-server-and-client-downloads.html) 
-   and install [as per documentation](https://docs.oracle.com/en/database/oracle/property-graph/22.4/spgdg/deploying-graph-visualization-application.html).
-3. A running Oracle Database (e.g. [Autonomous Database](https://www.oracle.com/autonomous-database/))
-4. Import the Human Resources dataset and create a PG View by running `./gradlew createHrDatasetAndPgView -Pjdbc_url=<jdbc_url> -Pusername=<username> -Ppassword=<password>`
+2. A running Oracle Database, version 23.4 or newer (e.g. [Autonomous Database](https://www.oracle.com/autonomous-database/))
+3. Import the Human Resources dataset and create a Property Graph by running `./gradlew createHrDatasetAndPropertyGraph -Pjdbc_url=<jdbc_url> -Pusername=<username> -Ppassword=<password>`
 
 * Note: The user must have `GRANT CREATE SESSION, CREATE TABLE, CREATE VIEW, CREATE SEQUENCE grants on the Database`
-* Note 2: You can drop the HR dataset and the created PG View by running the following command: `./gradlew dropHrDatasetAndPgView -Pjdbc_url=<jdbc_url> -Pusername=<username> -Ppassword=<password>`
+* Note 2: You can drop the HR dataset and the created Property Graph by running the following command: `./gradlew dropHrDatasetAndPropertyGraph -Pjdbc_url=<jdbc_url> -Pusername=<username> -Ppassword=<password>`
 
 ## Usage
 
@@ -29,31 +27,30 @@ The key source files to look at are
 3. Unzip the library into the `src/main/resources/public` directory. For example:
 
 ```
-unzip oracle-graph-visualization-library-23.1.0.zip -d src/main/resources/public/
+unzip oracle-graph-visualization-library-24.2.0.zip -d src/main/resources/public/
 ```
 
 4. Run the following command to start the example app locally:
 
 ```
-./gradlew run --args='-oracle.graph-server.url=<graph-server-url> -oracle.graph-server.jdbc-url=<jdbc-url> -oracle.graph-server.username=<username> -oracle.graph-server.password=<password>'
+./gradlew run --args='-oracle.jdbc-url=<jdbc-url> -oracle.username=<username> -oracle.password=<password>'
 ```
 
 with
 
-* `<graph-server-url>` being the URL of the Graph Server, e.g. `https://myhost:7007`
-* `<jdbc-url>` being the JDBC URL of the Oracle Database the Graph Server should connect to, e.g. `jdbc:oracle:thin:@myhost:1521/orcl` 
-* `<username>` being the Oracle Database username to authenticate the example application with the Graph Server, e.g. `scott`
-* `<password>` being the Oracle Database password to authenticate the example application with the Graph Server, e.g. `tiger`
+* `<jdbc-url>` being the JDBC URL of the Oracle Database should connect to, e.g. `jdbc:oracle:thin:@myhost:1521/orcl` 
+* `<username>` being the Oracle Database username to authenticate the example application, e.g. `scott`
+* `<password>` being the Oracle Database password to authenticate the example application, e.g. `tiger`
 
 Then open your browser at `http://localhost:8080`.
 
-When you click on the <em>Query</em> button, a request is made to `/hr/neighbors`, which fetches the direct reports of 
-the given employee (by default `SKING`) from the HR graph using a PGQL query. 
+When you click on the <em>Query</em> button, a request is made to `/hr/directs`, which fetches the direct reports of 
+the given employee (by default `SKING`) from the HR graph using a SQL query. 
 
 ![](screenshot.jpg)
 
-When you right-click on one of the resulting nodes and then select <em>Expand</em>, a request to `/hr/directs` is being 
-made, which fetches the neighbors of that node via another PGQL query.
+When you right-click on one of the resulting nodes and then select <em>Expand</em>, a request to `/hr/neighbors` is being 
+made, which fetches the neighbors of that node via another SQL query.
 
 ## Troubleshooting
 

graphviz-demo/build.gradle

@@ -49,7 +49,7 @@ micronaut {
     }
 }
 
-task createHrDataSetAndPgView(type: JavaExec) {
+task createHrDataSetAndPropertyGraph(type: JavaExec) {
     outputs.upToDateWhen { false }
 
     environment("JDBC_URL", jdbc_url)
@@ -59,7 +59,7 @@ task createHrDataSetAndPgView(type: JavaExec) {
     classpath = sourceSets.main.runtimeClasspath
 }
 
-task dropHrDataSetAndPgView(type: JavaExec) {
+task dropHrDataSetAndPropertyGraph(type: JavaExec) {
     outputs.upToDateWhen { false }
 
     environment("JDBC_URL", jdbc_url)

graphviz-demo/src/main/java/com/oracle/example/GraphClient.java

@@ -1,33 +1,19 @@
 package com.oracle.example;
 
-import javax.security.auth.login.LoginException;
-
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.nio.charset.StandardCharsets;
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
 
 import io.micronaut.context.annotation.Value;
-import io.micronaut.http.HttpResponse;
-import io.micronaut.http.HttpStatus;
-import io.micronaut.http.MediaType;
 import io.micronaut.http.client.HttpClient;
-import io.micronaut.http.client.annotation.Client;
-import io.micronaut.http.client.exceptions.HttpClientResponseException;
 import jakarta.inject.Singleton;
 
+import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.oracle.example.response.Response;
-import com.oracle.example.response.Result;
-import com.oracle.example.response.TokenResponse;
-
-import static io.micronaut.http.HttpRequest.POST;
-import static io.micronaut.http.HttpRequest.PUT;
-
 /**
  * Micronaut client wrapper around Oracle Graph Visualization REST endpoints.
  * See the Oracle Graph documentation
@@ -42,152 +28,44 @@ public class GraphClient {
 
   HttpClient httpClient;
 
-  @Value("${oracle.graph-server.jdbc-url}")
+  @Value("${oracle.jdbc-url}")
   String jdbcUrl;
 
-  @Value("${oracle.graph-server.username}")
+  @Value("${oracle.username}")
   String username;
 
-  @Value("${oracle.graph-server.password}")
+  @Value("${oracle.password}")
   String password;
 
-  // JSON parser
-  private final static ObjectMapper objectMapper = new ObjectMapper();
-
-  // Authentication token;
-  String token;
-
-  public GraphClient(@Client("${oracle.graph-server.url}") HttpClient httpClient) {
-    this.httpClient = httpClient;
-  }
-
-  public String query(String query) throws LoginException {
-    return query(query, false);
-  }
-
-  public String query(String query, boolean isRetry) throws LoginException {
-    if (token == null) {
-      login();
-    }
-
-    log.info("POST /v2/runQuery");
-    log.info("query {}", query);
-
-    List<String> statements = new ArrayList<>();
-    statements.add(query);
-
-    Map<String, Object> payload = new HashMap<>();
-    payload.put("driver", "PGQL_IN_DATABASE");
-    payload.put("formatter", "GVT");
-    payload.put("statements", statements);
-    log.info("payload: {}", payload);
-
-    CharSequence token = this.token;
+  private static final String anonymousFunction;
 
+  static {
     try {
-      HttpResponse<String> response = httpClient.toBlocking().exchange(
-          POST("/v2/runQuery", payload)
-              .contentType(MediaType.APPLICATION_JSON)
-              .accept(MediaType.APPLICATION_JSON)
-              .bearerAuth(token),
-          String.class);
-
-      log.info("received response - reading body");
-
-      String responseBody = response.getBody()
-          .orElseThrow(() -> new InternalError("response body could not be converted to string"));
-      log.info("response body: {}", responseBody);
-
-      Response json = objectMapper.readValue(responseBody, Response.class);
-      Result result = json.getResults().get(0);
-
-      boolean responseIsSuccess = (boolean) result.getSuccess();
-
-      if (!responseIsSuccess) {
-        String errorMsg = new StringBuilder("query failed. Response = ").append(result.getError())
-            .toString();
-        log.warn(errorMsg);
-        throw new InternalError("could not get response from server");
-      }
-
-      return (String) result.getResult();
-    } catch (HttpClientResponseException e) {
-      Object body = e.getResponse().body();
-      if (e.getStatus() == HttpStatus.FORBIDDEN || e.getStatus() == HttpStatus.UNAUTHORIZED) {
-        if (isRetry) {
-          log.warn("authentication failed while trying to run query. Response = {}", body);
-          throw new LoginException("authentication failed");
-        }
-        log.info("hit 401, refreshing token and retrying");
-        refreshToken();
-        return query(query, true);
-      }
-      if (e.getStatus() == HttpStatus.BAD_REQUEST) {
-        throw new IllegalArgumentException(body != null ? body.toString() : "bad request");
-      }
-      log.warn("query failed. Response = {}", body);
-      throw new InternalError("query failed");
-    } catch (JsonProcessingException e) {
-      log.warn("could not parse response", e);
-      throw new InternalError("failed to parse response");
-    }
-  }
-
-  private void login() throws LoginException {
-    log.info("POST /auth/token");
-    log.info("login {}", username);
-
-    Map<String, Object> payload = new HashMap<>();
-    payload.put("username", username);
-    payload.put("password", password);
-    payload.put("createSession", false);
-
-    try {
-      HttpResponse<String> response = httpClient.toBlocking().exchange(
-          POST("/auth/token", payload)
-              .contentType(MediaType.APPLICATION_JSON)
-              .accept(MediaType.APPLICATION_JSON),
-          String.class);
-
-      TokenResponse json = objectMapper.readValue(
-          response.getBody().orElseThrow(() -> new InternalError("response body could not be converted to string")),
-          TokenResponse.class);
-      token = json.getAccessToken();
-      log.info("obtained token: {}", token);
-    } catch (HttpClientResponseException e) {
-      log.warn("login failed with status {}", e.getStatus(), e);
-      throw new LoginException("login failed");
-    } catch (JsonProcessingException e) {
-      log.warn("could not parse server response", e);
-      throw new LoginException("token refresh failed");
+      anonymousFunction = IOUtils.toString(
+          GraphClient.class.getResourceAsStream("/my_sqlgraph_json.sql"),
+          StandardCharsets.UTF_8);
+    } catch (Exception e) {
+      log.error("Cannot locate anonymous function file");
+      throw new RuntimeException(e);     
     }
   }
 
-  private void refreshToken() throws LoginException {
-    log.info("refreshToken {}", username);
-
-    Map<String, Object> payload = new HashMap<>();
-    payload.put("token", token);
-    payload.put("createSession", false);
-
-    try {
-      HttpResponse<String> response = httpClient.toBlocking().exchange(
-          PUT("/auth/token", payload)
-              .contentType(MediaType.APPLICATION_JSON)
-              .accept(MediaType.APPLICATION_JSON),
-          String.class);
-
-      TokenResponse json = objectMapper.readValue(
-          response.getBody().orElseThrow(() -> new InternalError("response body could not be converted to string")),
-          TokenResponse.class);
-      token = json.getAccessToken();
-      log.info("obtained token: {}", token);
-    } catch (HttpClientResponseException e) {
-      log.warn("token refresh failed with status {}", e.getStatus(), e);
-      throw new LoginException("token refresh failed");
-    } catch (JsonProcessingException e) {
-      log.warn("could not parse server response", e);
-      throw new LoginException("token refresh failed");
+  public String query(String query, String parameter) throws Exception {
+
+    String wrapQuery = anonymousFunction + "SELECT MY_SQLGRAPH_JSON('" + query + "') as result from dual";
+    String resultString = null;
+    try (Connection conn = DriverManager.getConnection(jdbcUrl, username, password)) {
+      try (PreparedStatement ps = conn.prepareStatement(wrapQuery)) {
+        ps.setString(1, parameter);
+        log.info("running: {}", wrapQuery);
+        log.info("replaced parameter: {}", parameter);
+        try (ResultSet resultSet = ps.executeQuery()) {
+          if (resultSet.next()) {
+            resultString = resultSet.getString(1);
+          }
+        }
+      }
     }
+    return resultString;
   }
 }

graphviz-demo/src/main/java/com/oracle/example/HRController.java

@@ -1,7 +1,5 @@
 package com.oracle.example;
 
-import javax.security.auth.login.LoginException;
-
 import java.util.Arrays;
 import java.util.stream.Collectors;
 
@@ -32,19 +30,26 @@ public HRController(GraphClient graphClient) {
 
   @Get("/directs")
   @Produces(MediaType.APPLICATION_JSON)
-  public String getDirects(@QueryValue String email) throws LoginException {
-    String pgql = "select e from match ()-[e]->(x:employees) on MYHR where x.email = '" + email + "'";
-    log.info("running {}", pgql);
-    return graphClient.query(pgql);
+  public String getDirects(@QueryValue String email) throws Exception {
+    String query = "SELECT * FROM GRAPH_TABLE(\n"
+        + "MYHR\n"
+        + "MATCH (m)-[e]->(n IS employees WHERE n.email =''' || ? ||''')\n"
+        + "COLUMNS (vertex_id(m) as m_id, edge_id(e) as e_id, vertex_id(n) as n_id)\n"
+        + ")";
+    return graphClient.query(query, email);
   }
 
   @Get("/neighbors")
   @Produces(MediaType.APPLICATION_JSON)
-  public String getNeighbors(@QueryValue String ids) throws LoginException {
+  public String getNeighbors(@QueryValue String ids) throws Exception {
     ids = Arrays.stream(ids.split(",")).map(String::trim).collect(Collectors.joining("','"));
-    String pgql = "select e from match (x) -[e]-> () on MYHR where id(x) in ('" + ids + "')";
-    log.info("running {}", pgql);
-    return graphClient.query(pgql);
+    String query = "SELECT * FROM GRAPH_TABLE(\n"
+        + "MYHR\n"
+        + "MATCH (m)-[e]->(n)\n"
+        + "WHERE JSON_value(vertex_id(m), ''$.ELEM_TABLE'') || json_query(vertex_id(m), ''$.KEY_VALUE'' returning varchar2) in (''' || ? || ''') \n"
+        + "COLUMNS (vertex_id(m) as m_id, edge_id(e) as e_id, vertex_id(n) as n_id)\n"
+        + ")";
+    return graphClient.query(query, ids);
   }
 
   @Error(global = true)