refactor: leave existing methods in place for backward compatibility. Add Zstd as a built-in option.

Author: Michael Karsten

query-builder/src/main/java/com/datastax/oss/driver/api/querybuilder/schema/RelationOptions.java

@@ -19,12 +19,15 @@
 
 import static com.datastax.oss.driver.api.querybuilder.SchemaBuilder.RowsPerPartition;
 
+import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
 import com.datastax.oss.driver.api.querybuilder.SchemaBuilder;
 import com.datastax.oss.driver.api.querybuilder.schema.compaction.CompactionStrategy;
 import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
 import edu.umd.cs.findbugs.annotations.NonNull;
 
+import java.net.URL;
+
 public interface RelationOptions<SelfT extends RelationOptions<SelfT>>
     extends OptionProvider<SelfT> {
 
@@ -97,22 +100,32 @@ default SelfT withCompaction(@NonNull CompactionStrategy<?> compactionStrategy)
   }
 
   /**
-   * Configures compression using the LZ4 algorithm with the given chunk length and crc check
-   * chance.
-   *
-   * @see #withCompression(String, int, double)
+   * @deprecated This method only exists for backward compatibility. Use {@link
+   *     RelationOptions#withLZ4Compression(chunkLengthKB)} instead.
    */
+  @Deprecated
   @NonNull
   @CheckReturnValue
   default SelfT withLZ4Compression(int chunkLengthKB, double crcCheckChance) {
     return withCompression("LZ4Compressor", chunkLengthKB, crcCheckChance);
   }
 
+  /**
+   * Configures compression using the LZ4 algorithm with the given chunk length.
+   *
+   * @see #withCompression(String, int)
+   */
+  @NonNull
+  @CheckReturnValue
+  default SelfT withLZ4Compression(int chunkLengthKB) {
+    return withCompression("LZ4Compressor", chunkLengthKB);
+  }
+
   /**
    * Configures compression using the LZ4 algorithm using the default configuration (64kb
-   * chunk_length, and 1.0 crc_check_chance).
+   * chunk_length).
    *
-   * @see #withCompression(String, int, double)
+   * @see #withCompression(String, int)
    */
   @NonNull
   @CheckReturnValue
@@ -121,22 +134,55 @@ default SelfT withLZ4Compression() {
   }
 
   /**
-   * Configures compression using the Snappy algorithm with the given chunk length and crc check
-   * chance.
+   * Configures compression using the Zstd algorithm with the given chunk length.
+   *
+   * @see #withCompression(String, int)
+   */
+  @NonNull
+  @CheckReturnValue
+  default SelfT withZstdCompression(int chunkLengthKB) {
+    return withCompression("org.apache.cassandra.io.compress.ZstdCompressor", chunkLengthKB);
+  }
+
+  /**
+   * Configures compression using the Zstd algorithm using the default configuration (64kb
+   * chunk_length).
    *
-   * @see #withCompression(String, int, double)
+   * @see #withCompression(String, int)
+   */
+  @NonNull
+  @CheckReturnValue
+  default SelfT withZstdCompression() {
+    return withCompression("org.apache.cassandra.io.compress.ZstdCompressor");
+  }
+
+  /**
+   * @deprecated This method only exists for backward compatibility. Use {@link
+   *     RelationOptions#withSnappyCompression(chunkLengthKB)} instead.
    */
+  @Deprecated
   @NonNull
   @CheckReturnValue
   default SelfT withSnappyCompression(int chunkLengthKB, double crcCheckChance) {
     return withCompression("SnappyCompressor", chunkLengthKB, crcCheckChance);
   }
 
+  /**
+   * Configures compression using the Snappy algorithm with the given chunk length.
+   *
+   * @see #withCompression(String, int)
+   */
+  @NonNull
+  @CheckReturnValue
+  default SelfT withSnappyCompression(int chunkLengthKB) {
+    return withCompression("SnappyCompressor", chunkLengthKB);
+  }
+
   /**
    * Configures compression using the Snappy algorithm using the default configuration (64kb
-   * chunk_length, and 1.0 crc_check_chance).
+   * chunk_length).
    *
-   * @see #withCompression(String, int, double)
+   * @see #withCompression(String, int)
    */
   @NonNull
   @CheckReturnValue
@@ -145,22 +191,32 @@ default SelfT withSnappyCompression() {
   }
 
   /**
-   * Configures compression using the Deflate algorithm with the given chunk length and crc check
-   * chance.
-   *
-   * @see #withCompression(String, int, double)
+   * @deprecated This method only exists for backward compatibility. Use {@link
+   *     RelationOptions#withDeflateCompression(chunkLengthKB)} instead.
    */
+  @Deprecated
   @NonNull
   @CheckReturnValue
   default SelfT withDeflateCompression(int chunkLengthKB, double crcCheckChance) {
     return withCompression("DeflateCompressor", chunkLengthKB, crcCheckChance);
   }
 
+  /**
+   * Configures compression using the Deflate algorithm with the given chunk length.
+   *
+   * @see #withCompression(String, int)
+   */
+  @NonNull
+  @CheckReturnValue
+  default SelfT withDeflateCompression(int chunkLengthKB) {
+    return withCompression("DeflateCompressor", chunkLengthKB);
+  }
+
   /**
    * Configures compression using the Deflate algorithm using the default configuration (64kb
    * chunk_length, and 1.0 crc_check_chance).
    *
-   * @see #withCompression(String, int, double)
+   * @see #withCompression(String, int)
    */
   @NonNull
   @CheckReturnValue
@@ -170,13 +226,13 @@ default SelfT withDeflateCompression() {
 
   /**
    * Configures compression using the given algorithm using the default configuration (64kb
-   * chunk_length, and 1.0 crc_check_chance).
+   * chunk_length).
    *
    * <p>Unless specifying a custom compression algorithm implementation, it is recommended to use
    * {@link #withLZ4Compression()}, {@link #withSnappyCompression()}, or {@link
    * #withDeflateCompression()}.
    *
-   * @see #withCompression(String, int, double)
+   * @see #withCompression(String, int)
    */
   @NonNull
   @CheckReturnValue
@@ -185,27 +241,43 @@ default SelfT withCompression(@NonNull String compressionAlgorithmName) {
   }
 
   /**
-   * Configures compression using the given algorithm, chunk length and crc check chance.
+   * Configures compression using the given algorithm, chunk length.
    *
    * <p>Unless specifying a custom compression algorithm implementation, it is recommended to use
    * {@link #withLZ4Compression()}, {@link #withSnappyCompression()}, or {@link
    * #withDeflateCompression()}.
    *
    * @param compressionAlgorithmName The class name of the compression algorithm.
    * @param chunkLengthKB The chunk length in KB of compression blocks. Defaults to 64.
-   * @param crcCheckChance The probability (0.0 to 1.0) that checksum will be checked on each read.
-   *     Defaults to 1.0.
    */
   @NonNull
   @CheckReturnValue
+  default SelfT withCompression(
+          @NonNull String compressionAlgorithmName, int chunkLengthKB) {
+    return withOption(
+            "compression",
+            ImmutableMap.of(
+                    "class",
+                    compressionAlgorithmName,
+                    "chunk_length_in_kb",
+                    chunkLengthKB));
+  }
+
+  /**
+   * @deprecated This method only exists for backward compatibility. Use {@link
+   *     RelationOptions#withCompression(compressionAlgorithmName, chunkLengthKB)} instead.
+   */
+  @NonNull
+  @CheckReturnValue
+  @Deprecated
   default SelfT withCompression(
       @NonNull String compressionAlgorithmName, int chunkLengthKB, double crcCheckChance) {
     return withOption(
         "compression",
         ImmutableMap.of(
             "class",
             compressionAlgorithmName,
-            "chunk_length_in_kb",
+            "chunk_length_kb",
             chunkLengthKB,
             "crc_check_chance",
             crcCheckChance));

query-builder/src/test/java/com/datastax/dse/driver/api/querybuilder/schema/CreateDseTableTest.java

@@ -195,13 +195,46 @@ public void should_generate_create_table_lz4_compression() {
 
   @Test
   public void should_generate_create_table_lz4_compression_options() {
+    assertThat(
+            createDseTable("bar")
+                    .withPartitionKey("k", DataTypes.INT)
+                    .withColumn("v", DataTypes.TEXT)
+                    .withLZ4Compression(1024))
+            .hasCql(
+                    "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'LZ4Compressor','chunk_length_kb':1024}");
+  }
+
+  @Test
+  public void should_generate_create_table_lz4_compression_options_crc() {
     assertThat(
             createDseTable("bar")
                 .withPartitionKey("k", DataTypes.INT)
                 .withColumn("v", DataTypes.TEXT)
                 .withLZ4Compression(1024, .5))
         .hasCql(
-            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'LZ4Compressor','chunk_length_in_kb':1024,'crc_check_chance':0.5}");
+            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'LZ4Compressor','chunk_length_kb':1024,'crc_check_chance':0.5}");
+  }
+
+  @Test
+  public void should_generate_create_table_zstd_compression() {
+    assertThat(
+            createDseTable("bar")
+                    .withPartitionKey("k", DataTypes.INT)
+                    .withColumn("v", DataTypes.TEXT)
+                    .withZstdCompression())
+            .hasCql(
+                    "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'org.apache.cassandra.io.compress.ZstdCompressor'}");
+  }
+
+  @Test
+  public void should_generate_create_table_zstd_compression_options() {
+    assertThat(
+            createDseTable("bar")
+                    .withPartitionKey("k", DataTypes.INT)
+                    .withColumn("v", DataTypes.TEXT)
+                    .withZstdCompression(1024))
+            .hasCql(
+                    "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'org.apache.cassandra.io.compress.ZstdCompressor','chunk_length_in_kb':1024}");
   }
 
   @Test
@@ -217,13 +250,24 @@ public void should_generate_create_table_snappy_compression() {
 
   @Test
   public void should_generate_create_table_snappy_compression_options() {
+    assertThat(
+            createDseTable("bar")
+                    .withPartitionKey("k", DataTypes.INT)
+                    .withColumn("v", DataTypes.TEXT)
+                    .withSnappyCompression(2048))
+            .hasCql(
+                    "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'SnappyCompressor','chunk_length_in_kb':2048}");
+  }
+
+  @Test
+  public void should_generate_create_table_snappy_compression_options_crc() {
     assertThat(
             createDseTable("bar")
                 .withPartitionKey("k", DataTypes.INT)
                 .withColumn("v", DataTypes.TEXT)
                 .withSnappyCompression(2048, .25))
         .hasCql(
-            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'SnappyCompressor','chunk_length_in_kb':2048,'crc_check_chance':0.25}");
+            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'SnappyCompressor','chunk_length_kb':2048,'crc_check_chance':0.25}");
   }
 
   @Test
@@ -239,13 +283,24 @@ public void should_generate_create_table_deflate_compression() {
 
   @Test
   public void should_generate_create_table_deflate_compression_options() {
+    assertThat(
+            createDseTable("bar")
+                    .withPartitionKey("k", DataTypes.INT)
+                    .withColumn("v", DataTypes.TEXT)
+                    .withDeflateCompression(4096))
+            .hasCql(
+                    "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'DeflateCompressor','chunk_length_in_kb':4096}");
+  }
+
+  @Test
+  public void should_generate_create_table_deflate_compression_options_crc() {
     assertThat(
             createDseTable("bar")
                 .withPartitionKey("k", DataTypes.INT)
                 .withColumn("v", DataTypes.TEXT)
                 .withDeflateCompression(4096, .1))
         .hasCql(
-            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'DeflateCompressor','chunk_length_in_kb':4096,'crc_check_chance':0.1}");
+            "CREATE TABLE bar (k int PRIMARY KEY,v text) WITH compression={'class':'DeflateCompressor','chunk_length_kb':4096,'crc_check_chance':0.1}");
   }
 
   @Test