Don't write compression to index metadata if index compression disabled

datastax · Jan 31, 2025 · 71a3a1e · 71a3a1e
1 parent b0691a2
commit 71a3a1e
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/src/java/org/apache/cassandra/config/CassandraRelevantProperties.java b/src/java/org/apache/cassandra/config/CassandraRelevantProperties.java
@@ -347,6 +347,9 @@ public enum CassandraRelevantProperties
     /** Watcher used when opening sstables to discover extra components, eg. archive component */
     CUSTOM_SSTABLE_WATCHER("cassandra.custom_sstable_watcher"),
 
+    /** When enabled, a user can set compression options in the index schema */
+    INDEX_COMPRESSION("cassandra.index.compression_enabled", "false"),
+
     /** Controls the maximum top-k limit for vector search */
     SAI_VECTOR_SEARCH_MAX_TOP_K("cassandra.sai.vector_search.max_top_k", "1000"),
 

diff --git a/src/java/org/apache/cassandra/cql3/statements/schema/CreateIndexStatement.java b/src/java/org/apache/cassandra/cql3/statements/schema/CreateIndexStatement.java
@@ -28,6 +28,7 @@
 import org.apache.cassandra.audit.AuditLogContext;
 import org.apache.cassandra.audit.AuditLogEntryType;
 import org.apache.cassandra.auth.Permission;
+import org.apache.cassandra.config.CassandraRelevantProperties;
 import org.apache.cassandra.config.DatabaseDescriptor;
 import org.apache.cassandra.config.ParameterizedClass;
 import org.apache.cassandra.cql3.ColumnIdentifier;
@@ -172,6 +173,10 @@ public Keyspaces apply(Keyspaces schema)
                                            ? CompressionParams.fromMap(valueCompressionOptions)
                                            : CompressionParams.noCompression();
 
+        if ((keyCompression.isEnabled() || valueCompression.isEnabled()) && !CassandraRelevantProperties.INDEX_COMPRESSION.getBoolean())
+            throw ire("Cannot create a compressed index, because index compression is disabled. " +
+                      "Please set " + CassandraRelevantProperties.INDEX_COMPRESSION.getKey() + " property to enable it.");
+
         IndexMetadata index = IndexMetadata.fromIndexTargets(indexTargets, name, kind, options, keyCompression, valueCompression);
 
         String className = index.getIndexClassName();

diff --git a/src/java/org/apache/cassandra/schema/SchemaKeyspace.java b/src/java/org/apache/cassandra/schema/SchemaKeyspace.java
@@ -822,8 +822,11 @@ private static void addIndexToSchemaMutation(TableMetadata table, IndexMetadata
                .add("kind", index.kind.toString())
                .add("options", index.options);
 
-        rowBuilder.add("key_compression", index.keyCompression.asMap());
-        rowBuilder.add("value_compression", index.valueCompression.asMap());
+        if (CassandraRelevantProperties.INDEX_COMPRESSION.getBoolean())
+        {
+            rowBuilder.add("key_compression", index.keyCompression.asMap());
+            rowBuilder.add("value_compression", index.valueCompression.asMap());
+        }
     }
 
     private static void dropIndexFromSchemaMutation(TableMetadata table, IndexMetadata index, Mutation.SimpleBuilder builder)

diff --git a/test/unit/org/apache/cassandra/index/sai/cql/IndexCompressionTest.java b/test/unit/org/apache/cassandra/index/sai/cql/IndexCompressionTest.java
@@ -20,8 +20,10 @@
 
 import java.util.Set;
 
+import org.junit.BeforeClass;
 import org.junit.Test;
 
+import org.apache.cassandra.config.CassandraRelevantProperties;
 import org.apache.cassandra.db.ColumnFamilyStore;
 import org.apache.cassandra.index.sai.IndexContext;
 import org.apache.cassandra.index.sai.SAITester;
@@ -38,6 +40,11 @@
 
 public class IndexCompressionTest extends SAITester
 {
+    @BeforeClass
+    public static void setup()
+    {
+        CassandraRelevantProperties.INDEX_COMPRESSION.setBoolean(true);
+    }
 
     @Test
     public void testKeyCompression()