JAVA-1651: Add NO_COMPACT startup option

tolbertam · olim7t · commit b4e444ec7a48 · 2018-01-04T13:43:47.000-08:00
diff --git a/changelog/README.md b/changelog/README.md
@@ -8,6 +8,7 @@
 - [improvement] JAVA-1679: Improve error message on batch log write timeout.
 - [improvement] JAVA-1672: Remove schema agreement check when repreparing on up.
 - [improvement] JAVA-1677: Warn if auth is configured on the client but not the server.
+- [new feature] JAVA-1651: Add NO_COMPACT startup option.
 
 Merged from 3.3.x:
 
diff --git a/driver-core/src/main/java/com/datastax/driver/core/Cluster.java b/driver-core/src/main/java/com/datastax/driver/core/Cluster.java
@@ -687,6 +687,7 @@ public static class Builder implements Initializer {
         private boolean metricsEnabled = true;
         private boolean jmxEnabled = true;
         private boolean allowBetaProtocolVersion = false;
+        private boolean noCompact = false;
 
         private Collection<Host.StateListener> listeners;
 
@@ -1295,6 +1296,24 @@ public Builder withNettyOptions(NettyOptions nettyOptions) {
             return this;
         }
 
+        /**
+         * Enables the <code>NO_COMPACT</code> startup option.
+         * <p>
+         * When this option is supplied, <code>SELECT</code>, <code>UPDATE</code>, <code>DELETE</code> and
+         * <code>BATCH</code> statements on <code>COMPACT STORAGE</code> tables function in "compatibility" mode which
+         * allows seeing these tables as if they were "regular" CQL tables.
+         * <p>
+         * This option only effects interactions with tables using <code>COMPACT STORAGE<code> and is only supported by
+         * C* 4.0+ and DSE 6.0+.
+         *
+         * @return this builder.
+         * @see <a href="https://issues.apache.org/jira/browse/CASSANDRA-10857">CASSANDRA-10857</a>
+         */
+        public Builder withNoCompact() {
+            this.noCompact = true;
+            return this;
+        }
+
         /**
          * The configuration that will be used for the new cluster.
          * <p/>
@@ -1306,7 +1325,7 @@ public Builder withNettyOptions(NettyOptions nettyOptions) {
          */
         @Override
         public Configuration getConfiguration() {
-            ProtocolOptions protocolOptions = new ProtocolOptions(port, protocolVersion, maxSchemaAgreementWaitSeconds, sslOptions, authProvider)
+            ProtocolOptions protocolOptions = new ProtocolOptions(port, protocolVersion, maxSchemaAgreementWaitSeconds, sslOptions, authProvider, noCompact)
                     .setCompression(compression);
 
             MetricsOptions metricsOptions = new MetricsOptions(metricsEnabled, jmxEnabled);
diff --git a/driver-core/src/main/java/com/datastax/driver/core/Connection.java b/driver-core/src/main/java/com/datastax/driver/core/Connection.java
@@ -232,8 +232,8 @@ private AsyncFunction<Void, Void> onChannelReady(final ProtocolVersion protocolV
         return new AsyncFunction<Void, Void>() {
             @Override
             public ListenableFuture<Void> apply(Void input) throws Exception {
-                ProtocolOptions.Compression compression = factory.configuration.getProtocolOptions().getCompression();
-                Future startupResponseFuture = write(new Requests.Startup(compression));
+                ProtocolOptions protocolOptions = factory.configuration.getProtocolOptions();
+                Future startupResponseFuture = write(new Requests.Startup(protocolOptions.getCompression(), protocolOptions.isNoCompact()));
                 return GuavaCompatibility.INSTANCE.transformAsync(startupResponseFuture,
                         onStartupResponse(protocolVersion, initExecutor), initExecutor);
             }
diff --git a/driver-core/src/main/java/com/datastax/driver/core/ProtocolOptions.java b/driver-core/src/main/java/com/datastax/driver/core/ProtocolOptions.java
@@ -99,6 +99,8 @@ public String toString() {
     private final SSLOptions sslOptions; // null if no SSL
     private final AuthProvider authProvider;
 
+    private final boolean noCompact;
+
     private volatile Compression compression = Compression.NONE;
 
     /**
@@ -118,7 +120,7 @@ public ProtocolOptions() {
      * @param port the port to use for the binary protocol.
      */
     public ProtocolOptions(int port) {
-        this(port, null, DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS, null, AuthProvider.NONE);
+        this(port, null, DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS, null, AuthProvider.NONE, false);
     }
 
     /**
@@ -135,11 +137,30 @@ public ProtocolOptions(int port) {
      *                        the Cassandra nodes.
      */
     public ProtocolOptions(int port, ProtocolVersion protocolVersion, int maxSchemaAgreementWaitSeconds, SSLOptions sslOptions, AuthProvider authProvider) {
+        this(port, protocolVersion, maxSchemaAgreementWaitSeconds, sslOptions, authProvider, false);
+    }
+
+    /**
+     * Creates a new {@code ProtocolOptions} instance using the provided port
+     * and SSL context.
+     *
+     * @param port            the port to use for the binary protocol.
+     * @param protocolVersion the protocol version to use. This can be {@code null}, in which case the
+     *                        version used will be the biggest version supported by the <em>first</em> node the driver connects to.
+     *                        See {@link Cluster.Builder#withProtocolVersion} for more details.
+     * @param sslOptions      the SSL options to use. Use {@code null} if SSL is not
+     *                        to be used.
+     * @param authProvider    the {@code AuthProvider} to use for authentication against
+     *                        the Cassandra nodes.
+     * @param noCompact       whether or not to include the NO_COMPACT startup option.
+     */
+    public ProtocolOptions(int port, ProtocolVersion protocolVersion, int maxSchemaAgreementWaitSeconds, SSLOptions sslOptions, AuthProvider authProvider, boolean noCompact) {
         this.port = port;
         this.initialProtocolVersion = protocolVersion;
         this.maxSchemaAgreementWaitSeconds = maxSchemaAgreementWaitSeconds;
         this.sslOptions = sslOptions;
         this.authProvider = authProvider;
+        this.noCompact = noCompact;
     }
 
     void register(Cluster.Manager manager) {
@@ -231,4 +252,10 @@ public AuthProvider getAuthProvider() {
         return authProvider;
     }
 
+    /**
+     * @return Whether or not to include the NO_COMPACT startup option.
+     */
+    public boolean isNoCompact() {
+        return noCompact;
+    }
 }
diff --git a/driver-core/src/main/java/com/datastax/driver/core/Requests.java b/driver-core/src/main/java/com/datastax/driver/core/Requests.java
@@ -35,6 +35,7 @@ static class Startup extends Message.Request {
         private static final String CQL_VERSION = "3.0.0";
 
         static final String COMPRESSION_OPTION = "COMPRESSION";
+        static final String NO_COMPACT_OPTION = "NO_COMPACT";
 
         static final Message.Coder<Startup> coder = new Message.Coder<Startup>() {
             @Override
@@ -50,21 +51,25 @@ public int encodedSize(Startup msg, ProtocolVersion version) {
 
         private final Map<String, String> options;
         private final ProtocolOptions.Compression compression;
+        private final boolean noCompact;
 
-        Startup(ProtocolOptions.Compression compression) {
+        Startup(ProtocolOptions.Compression compression, boolean noCompact) {
             super(Message.Request.Type.STARTUP);
             this.compression = compression;
+            this.noCompact = noCompact;
 
             ImmutableMap.Builder<String, String> map = new ImmutableMap.Builder<String, String>();
             map.put(CQL_VERSION_OPTION, CQL_VERSION);
             if (compression != ProtocolOptions.Compression.NONE)
                 map.put(COMPRESSION_OPTION, compression.toString());
+            if (noCompact)
+                map.put(NO_COMPACT_OPTION, "true");
             this.options = map.build();
         }
 
         @Override
         protected Request copyInternal() {
-            return new Startup(compression);
+            return new Startup(compression, noCompact);
         }
 
         @Override
