Feature/joins (#133)

* simplified VirtualScan

* added PrepareQueryException

* reverted simplifications to VirtualScan in order to handle case of new driver with old proxy

* updated decrementQueryVersion() method

* added changelog entry for PrepareQueryException

Author: markoszah

CHANGELOG.md

@@ -25,6 +25,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
   (~/.oci/regions-config.json) or environment variable (OCI_REGION_METADATA)
 
 ### Added
+- Cloud only: added new OCI regions (RKT, SHJ, RUH, EBB, EBL)
+- PrepareQueryException. This exception is thrown if a prepared query is
+  executed after (a) the index used by the query has been dropped and then
+  re-created with a different schema, or (b) one or more of the referenced
+  tables has been altered (via the alter table statement).
 - Cloud only: added new OCI regions (RKT, SHJ, RUH, EBB, EBL, JJT, DLN, DTZ)
 - Cloud only: refactored how the Region class is managed, allowing dynamic
   addition of regions not yet known to the system

driver/src/main/java/oracle/nosql/driver/PrepareQueryException.java

@@ -0,0 +1,25 @@
+/*-
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ *  https://oss.oracle.com/licenses/upl/
+ */
+
+package oracle.nosql.driver;
+
+/**
+ * The query must be recompiled after DDL changes on the tables and/or
+ * indexes that are accessed by the query.
+ */
+public class PrepareQueryException extends NoSQLException {
+
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * @hidden
+     * @param msg the exception message
+     */
+    public PrepareQueryException(String msg) {
+        super(msg);
+    }
+}

driver/src/main/java/oracle/nosql/driver/http/Client.java

@@ -633,7 +633,7 @@ public Result execute(Request kvRequest) {
                  */
                 kvRequest.setTimeoutInternal(thisIterationTimeoutMs);
                 serialVersionUsed = writeContent(buffer, kvRequest,
-                    queryVersionUsed);
+                                                 queryVersionUsed);
                 kvRequest.setTimeoutInternal(timeoutMs);
 
                 /*
@@ -1628,14 +1628,17 @@ private synchronized boolean decrementSerialVersion(short versionUsed) {
      *         false: already at lowest version number.
      */
     private synchronized boolean decrementQueryVersion(short versionUsed) {
+
         if (queryVersion != versionUsed) {
             return true;
         }
-        if (queryVersion == QueryDriver.QUERY_V4) {
-            queryVersion = QueryDriver.QUERY_V3;
-            return true;
+
+        if (queryVersion == QueryDriver.QUERY_V3) {
+            return false;
         }
-        return false;
+
+        --queryVersion;
+        return true;
     }
 
     /**

driver/src/main/java/oracle/nosql/driver/ops/serde/BinaryProtocol.java

@@ -39,6 +39,7 @@
 import static oracle.nosql.driver.util.BinaryProtocol.OPERATION_NOT_SUPPORTED;
 import static oracle.nosql.driver.util.BinaryProtocol.PROVISIONED;
 import static oracle.nosql.driver.util.BinaryProtocol.READ_LIMIT_EXCEEDED;
+import static oracle.nosql.driver.util.BinaryProtocol.RECOMPILE_QUERY;
 import static oracle.nosql.driver.util.BinaryProtocol.REQUEST_SIZE_LIMIT;
 import static oracle.nosql.driver.util.BinaryProtocol.REQUEST_SIZE_LIMIT_EXCEEDED;
 import static oracle.nosql.driver.util.BinaryProtocol.REQUEST_TIMEOUT;
@@ -85,6 +86,7 @@
 import oracle.nosql.driver.Nson;
 import oracle.nosql.driver.OperationNotSupportedException;
 import oracle.nosql.driver.OperationThrottlingException;
+import oracle.nosql.driver.PrepareQueryException;
 import oracle.nosql.driver.ReadThrottlingException;
 import oracle.nosql.driver.RequestSizeLimitException;
 import oracle.nosql.driver.RequestTimeoutException;
@@ -492,6 +494,8 @@ public static RuntimeException mapException(int code, String msg) {
             return new TableNotReadyException(msg);
         case ETAG_MISMATCH:
             return new IllegalArgumentException(msg);
+        case RECOMPILE_QUERY:
+            return new PrepareQueryException(msg);
         default:
             return new NoSQLException("Unknown error code " + code + ": " +
                                       msg);

driver/src/main/java/oracle/nosql/driver/ops/serde/nson/NsonSerializerFactory.java

@@ -889,7 +889,7 @@ public void serialize(Request request,
                     writeMapField(ns, QUERY_NAME, rq.getQueryName());
                 }
                 if (rq.getVirtualScan() != null) {
-                    writeVirtualScan(ns, rq.getVirtualScan());
+                    writeVirtualScan(ns, rq.getVirtualScan(), queryVersion);
                 }
             }
 
@@ -898,13 +898,15 @@ public void serialize(Request request,
         }
 
         private static void writeVirtualScan(NsonSerializer ns,
-                                             VirtualScan vs)
+                                             VirtualScan vs,
+                                             short queryVersion)
             throws IOException {
+
             startMap(ns, VIRTUAL_SCAN);
             writeMapField(ns, VIRTUAL_SCAN_SID, vs.sid());
             writeMapField(ns, VIRTUAL_SCAN_PID, vs.pid());
 
-            if (vs.isFirstBatch()) {
+            if (queryVersion <= QueryDriver.QUERY_V4 && vs.isFirstBatch()) {
                 writeMapField(ns, VIRTUAL_SCAN_PRIM_KEY, vs.primKey());
                 writeMapField(ns, VIRTUAL_SCAN_SEC_KEY, vs.secKey());
                 writeMapField(ns, VIRTUAL_SCAN_MOVE_AFTER, vs.moveAfterResumeKey());
@@ -915,6 +917,7 @@ private static void writeVirtualScan(NsonSerializer ns,
                 writeMapField(ns, VIRTUAL_SCAN_JOIN_PATH_SEC_KEY, vs.joinPathSecKey());
                 writeMapField(ns, VIRTUAL_SCAN_JOIN_PATH_MATCHED, vs.joinPathMatched());
             }
+
             endMap(ns, VIRTUAL_SCAN);
         }
 

driver/src/main/java/oracle/nosql/driver/query/QueryDriver.java

@@ -35,7 +35,10 @@ public class QueryDriver {
     /* added query name in QueryRequest */
     public static short QUERY_V4 = 4;
 
-    public static short QUERY_VERSION = QUERY_V4;
+    /* Changed VirtualScan info exchanged between sdk and proxy */
+    public static final short QUERY_V5 = 5;
+
+    public static final short QUERY_VERSION = QUERY_V5;
 
     private static final int BATCH_SIZE = 100;
 

driver/src/main/java/oracle/nosql/driver/query/ReceiveIter.java

@@ -429,6 +429,8 @@ private void initPartitionSort(
             rcb.trace("ReceiveIter.initPartitionSort() : got result.\n" +
                       "reached limit = " + result.reachedLimit() +
                       " in phase 1 = " + result.isInPhase1());
+
+            origRequest.addQueryTraces(result.getQueryTraces());
         }
 
         /*

driver/src/main/java/oracle/nosql/driver/query/VirtualScan.java

@@ -11,7 +11,9 @@
 public class VirtualScan {
 
     final private int theSID;
+
     final private int thePID;
+
     final private byte[] thePrimResumeKey;        
     final private byte[] theSecResumeKey;
     final private boolean theMoveAfterResumeKey;
@@ -62,7 +64,7 @@ public byte[] secKey() {
     public byte[] primKey() {
         return thePrimResumeKey;
     }
-    
+
     public boolean moveAfterResumeKey() {
         return theMoveAfterResumeKey;
     }
@@ -99,51 +101,8 @@ public String toString() {
         sb.append("sid/pid = ").append(theSID).append("/").append(thePID);
         sb.append("\n");
 
-        if (thePrimResumeKey != null) {
-            sb.append("thePrimResumeKey = ");
-            sb.append(PlanIter.printByteArray(thePrimResumeKey));
-            sb.append("\n");
-        }
-
-        if (theSecResumeKey != null) {
-            sb.append("theSecResumeKey = ");
-            sb.append(PlanIter.printByteArray(theSecResumeKey));
-            sb.append("\n");
-        }
-
-        sb.append("theMoveAfterResumeKey = ").append(theMoveAfterResumeKey);
-        sb.append("\n");
-
-        if (theDescResumeKey != null) {
-            sb.append("theDescResumeKey = ");
-            sb.append(PlanIter.printByteArray(theDescResumeKey));
-            sb.append("\n");
-        }
-
-        if (theJoinPathTables != null) {
-            sb.append("theJoinPathTables = ");
-            sb.append(PlanIter.printIntArray(theJoinPathTables));
-            sb.append("\n");
-        }
-
-        if (theJoinPathKey != null) {
-            sb.append("theJoinPathKey = ");
-            sb.append(PlanIter.printByteArray(theJoinPathKey));
-            sb.append("\n");
-        }
-
-        if (theJoinPathSecKey != null) {
-            sb.append("theJoinPathSecKey = ");
-            sb.append(PlanIter.printByteArray(theJoinPathSecKey));
-            sb.append("\n");
-        }
-
-        sb.append("theJoinPathMatched = ").append(theJoinPathMatched);
-        sb.append("\n");
-
         sb.append("theFirstBatch = ").append(theFirstBatch);
         sb.append("\n");
-
         return sb.toString();
     }
 }

driver/src/main/java/oracle/nosql/driver/util/BinaryProtocol.java

@@ -187,6 +187,8 @@ public static boolean isTenantOperation(OpCode op) {
     /* added in V4 */
     public static final int TABLE_NOT_READY = 26;
     public static final int UNSUPPORTED_QUERY_VERSION = 27;
+    /* added in V5 */
+    public static final int RECOMPILE_QUERY = 28;
 
     /*
      * Error codes for user throttling, range from 50 to 100(exclusive).