Make Driver Level Queries API GA

Author: injectives

bundle/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.neo4j.driver</groupId>
     <artifactId>neo4j-java-driver-parent</artifactId>
-    <version>5.7-SNAPSHOT</version>
+    <version>5.8-SNAPSHOT</version>
     <relativePath>..</relativePath>
   </parent>
 

driver/clirr-ignored-differences.xml

@@ -503,4 +503,16 @@
         <method>org.neo4j.driver.BookmarkManager executableQueryBookmarkManager()</method>
     </difference>
 
+    <difference>
+        <className>org/neo4j/driver/RoutingControl</className>
+        <differenceType>6001</differenceType>
+        <field>WRITERS</field>
+    </difference>
+
+    <difference>
+        <className>org/neo4j/driver/RoutingControl</className>
+        <differenceType>6001</differenceType>
+        <field>READERS</field>
+    </difference>
+
 </differences>

driver/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.neo4j.driver</groupId>
     <artifactId>neo4j-java-driver-parent</artifactId>
-    <version>5.7-SNAPSHOT</version>
+    <version>5.8-SNAPSHOT</version>
   </parent>
 
   <artifactId>neo4j-java-driver</artifactId>

driver/src/main/java/org/neo4j/driver/Driver.java

@@ -25,7 +25,6 @@
 import org.neo4j.driver.reactive.RxSession;
 import org.neo4j.driver.types.TypeSystem;
 import org.neo4j.driver.util.Experimental;
-import org.neo4j.driver.util.Preview;
 
 /**
  * Accessor for a specific Neo4j graph database.
@@ -72,7 +71,6 @@ public interface Driver extends AutoCloseable {
      * @return new executable query instance
      * @since 5.7
      */
-    @Preview(name = "Driver Level Queries")
     ExecutableQuery executableQuery(String query);
 
     /**
@@ -81,7 +79,6 @@ public interface Driver extends AutoCloseable {
      * @return bookmark manager, must not be {@code null}
      * @since 5.7
      */
-    @Preview(name = "Driver Level Queries")
     BookmarkManager executableQueryBookmarkManager();
 
     /**

driver/src/main/java/org/neo4j/driver/EagerResult.java

@@ -20,13 +20,11 @@
 
 import java.util.List;
 import org.neo4j.driver.summary.ResultSummary;
-import org.neo4j.driver.util.Preview;
 
 /**
  * An in-memory result of executing a Cypher query that has been consumed in full.
  * @since 5.5
  */
-@Preview(name = "Driver Level Queries")
 public interface EagerResult {
     /**
      * Returns the keys of the records this result contains.

driver/src/main/java/org/neo4j/driver/ExecutableQuery.java

@@ -26,7 +26,6 @@
 import java.util.stream.Collectors;
 import org.neo4j.driver.internal.EagerResultValue;
 import org.neo4j.driver.summary.ResultSummary;
-import org.neo4j.driver.util.Preview;
 
 /**
  * An executable query that executes a query in a managed transaction with automatic retries on retryable errors.
@@ -96,7 +95,6 @@
  *
  * @since 5.7
  */
-@Preview(name = "Driver Level Queries")
 public interface ExecutableQuery {
     /**
      * Sets query parameters.
@@ -166,7 +164,6 @@ default <T> T execute(Collector<Record, ?, T> recordCollector) {
      * @param <T> the final value type
      * @since 5.5
      */
-    @Preview(name = "Driver Level Queries")
     @FunctionalInterface
     interface ResultFinisher<S, T> {
         /**

driver/src/main/java/org/neo4j/driver/QueryConfig.java

@@ -24,13 +24,11 @@
 import java.io.Serializable;
 import java.util.Objects;
 import java.util.Optional;
-import org.neo4j.driver.util.Preview;
 
 /**
  * Query configuration used by {@link Driver#executableQuery(String)} and its variants.
  * @since 5.5
  */
-@Preview(name = "Driver Level Queries")
 public final class QueryConfig implements Serializable {
     @Serial
     private static final long serialVersionUID = -2632780731598141754L;
@@ -154,7 +152,7 @@ public String toString() {
      * Builder used to configure {@link QueryConfig} which will be used to execute a query.
      */
     public static final class Builder {
-        private RoutingControl routing = RoutingControl.WRITERS;
+        private RoutingControl routing = RoutingControl.WRITE;
         private String database;
         private String impersonatedUser;
         private BookmarkManager bookmarkManager;

driver/src/main/java/org/neo4j/driver/RoutingControl.java

@@ -18,20 +18,19 @@
  */
 package org.neo4j.driver;
 
-import org.neo4j.driver.util.Preview;
-
 /**
  * Defines routing mode for query.
  * @since 5.5
  */
-@Preview(name = "Driver Level Queries")
 public enum RoutingControl {
     /**
      * Routes to the leader of the cluster.
+     * @since 5.8
      */
-    WRITERS,
+    WRITE,
     /**
      * Routes to the followers in the cluster.
+     * @since 5.8
      */
-    READERS
+    READ
 }

driver/src/main/java/org/neo4j/driver/internal/InternalExecutableQuery.java

@@ -78,8 +78,8 @@ public <A, R, T> T execute(Collector<Record, A, R> recordCollector, ResultFinish
                 return resultFinisher.finish(result.keys(), finishedValue, summary);
             };
             return switch (config.routing()) {
-                case WRITERS -> session.executeWrite(txCallback);
-                case READERS -> session.executeRead(txCallback);
+                case WRITE -> session.executeWrite(txCallback);
+                case READ -> session.executeRead(txCallback);
             };
         }
     }

driver/src/test/java/org/neo4j/driver/QueryConfigTest.java

@@ -36,7 +36,7 @@ void shouldReturnDefaultValues() {
         var config = QueryConfig.defaultConfig();
         var manager = Mockito.mock(BookmarkManager.class);
 
-        assertEquals(RoutingControl.WRITERS, config.routing());
+        assertEquals(RoutingControl.WRITE, config.routing());
         assertTrue(config.database().isEmpty());
         assertTrue(config.impersonatedUser().isEmpty());
         assertEquals(manager, config.bookmarkManager(manager).get());

driver/src/test/java/org/neo4j/driver/internal/InternalExecutableQueryTest.java

@@ -127,8 +127,8 @@ void shouldExecuteAndReturnResult(RoutingControl routingControl) {
         var txContext = mock(TransactionContext.class);
         BiFunction<Session, TransactionCallback<Object>, Object> executeMethod =
                 switch (routingControl) {
-                    case WRITERS -> Session::executeWrite;
-                    case READERS -> Session::executeRead;
+                    case WRITE -> Session::executeWrite;
+                    case READ -> Session::executeRead;
                 };
         given(executeMethod.apply(session, any())).willAnswer(answer -> {
             TransactionCallback<?> txCallback = answer.getArgument(0);

examples/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.neo4j.driver</groupId>
     <artifactId>neo4j-java-driver-parent</artifactId>
-    <version>5.7-SNAPSHOT</version>
+    <version>5.8-SNAPSHOT</version>
   </parent>
 
   <groupId>org.neo4j.doc.driver</groupId>

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>org.neo4j.driver</groupId>
   <artifactId>neo4j-java-driver-parent</artifactId>
-  <version>5.7-SNAPSHOT</version>
+  <version>5.8-SNAPSHOT</version>
 
   <packaging>pom</packaging>
   <name>Neo4j Java Driver Project</name>

testkit-backend/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>neo4j-java-driver-parent</artifactId>
         <groupId>org.neo4j.driver</groupId>
-        <version>5.7-SNAPSHOT</version>
+        <version>5.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>testkit-backend</artifactId>

testkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/ExecuteQuery.java

@@ -45,8 +45,8 @@ public TestkitResponse process(TestkitState testkitState) {
         var routing = data.getConfig().getRouting();
         if (data.getConfig().getRouting() != null) {
             switch (routing) {
-                case "w" -> configBuilder.withRouting(RoutingControl.WRITERS);
-                case "r" -> configBuilder.withRouting(RoutingControl.READERS);
+                case "w" -> configBuilder.withRouting(RoutingControl.WRITE);
+                case "r" -> configBuilder.withRouting(RoutingControl.READ);
                 default -> throw new IllegalArgumentException();
             }
         }

testkit-tests/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.neo4j.driver</groupId>
         <artifactId>neo4j-java-driver-parent</artifactId>
-        <version>5.7-SNAPSHOT</version>
+        <version>5.8-SNAPSHOT</version>
         <relativePath>..</relativePath>
     </parent>