Skip to content

Commit 58f1595

Browse files
seungh0seungh0
committed
Allow use of table options not registered in TableOption
see #1584 Signed-off-by: seungh0 <[email protected]>
1 parent 0444035 commit 58f1595

File tree

6 files changed

+265
-2
lines changed

6 files changed

+265
-2
lines changed

‎spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/CassandraAdminTemplate.java‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
* @author John Blum
4545
* @author Vagif Zeynalov
4646
* @author Mikhail Polivakha
47+
* @author Seungho Kang
4748
*/
4849
public class CassandraAdminTemplate extends CassandraTemplate implements CassandraAdminOperations {
4950

@@ -115,8 +116,10 @@ public void createTable(boolean ifNotExists, CqlIdentifier tableName, Class<?> e
115116

116117
if (!CollectionUtils.isEmpty(optionsByName)) {
117118
optionsByName.forEach((key, value) -> {
118-
TableOption tableOption = TableOption.valueOfIgnoreCase(key);
119-
if (tableOption.requiresValue()) {
119+
TableOption tableOption = TableOption.findByNameIgnoreCase(key);
120+
if (tableOption == null) {
121+
addRawTableOption(key, value, createTableSpecification);
122+
} else if (tableOption.requiresValue()) {
120123
createTableSpecification.with(tableOption, value);
121124
} else {
122125
createTableSpecification.with(tableOption);
@@ -127,6 +130,14 @@ public void createTable(boolean ifNotExists, CqlIdentifier tableName, Class<?> e
127130
getCqlOperations().execute(CqlGenerator.toCql(createTableSpecification));
128131
}
129132

133+
private void addRawTableOption(String key, Object value, CreateTableSpecification createTableSpecification) {
134+
if (value instanceof String) {
135+
createTableSpecification.with(key, value, true, true);
136+
return;
137+
}
138+
createTableSpecification.with(key, value, false, false);
139+
}
140+
130141
@Override
131142
public void dropTable(Class<?> entityClass) {
132143
dropTable(getTableName(entityClass));

‎spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/keyspace/TableOption.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,23 @@ public static TableOption valueOfIgnoreCase(String optionName) {
135135
throw new IllegalArgumentException(String.format("Unable to recognize specified Table option '%s'", optionName));
136136
}
137137

138+
/**
139+
* Look up {@link TableOption} by name using case-insensitive lookups.
140+
*
141+
* @param optionName name of the option.
142+
* @return the matching {@link TableOption}, or {@code null} if no match is found
143+
* @since 4.5.2
144+
*/
145+
@Nullable
146+
public static TableOption findByNameIgnoreCase(String optionName) {
147+
for (TableOption value : values()) {
148+
if (value.getName().equalsIgnoreCase(optionName)) {
149+
return value;
150+
}
151+
}
152+
return null;
153+
}
154+
138155
@Override
139156
public Class<?> getType() {
140157
return this.delegate.getType();

‎spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/CassandraAdminTemplateIntegrationTests.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,46 @@ void shouldApplyTableOptions() {
107107
.isEqualTo("BLOCKING");
108108
}
109109

110+
@Test // GH-359, GH-1584
111+
void shouldApplyTableOptions_with_raw() {
112+
113+
Map<String, Object> options = Map.of(TableOption.COMMENT.getName(), "This is comment for table", //
114+
"bloom_filter_fp_chance", "0.3", //
115+
"default_time_to_live", "864000", //
116+
"cdc", true, //
117+
"speculative_retry", "90percentile", //
118+
"memtable_flush_period_in_ms", "1000", //
119+
"crc_check_chance", "0.9", //
120+
"min_index_interval", "128", //
121+
"max_index_interval", "2048", //
122+
"read_repair", "BLOCKING");
123+
124+
CqlIdentifier tableName = CqlIdentifier.fromCql("someTable");
125+
cassandraAdminTemplate.createTable(true, tableName, SomeTable.class, options);
126+
127+
TableMetadata someTable = getKeyspaceMetadata().getTables().get(tableName);
128+
129+
assertThat(someTable).isNotNull();
130+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.COMMENT.getName()))) //
131+
.isEqualTo("This is comment for table");
132+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.BLOOM_FILTER_FP_CHANCE.getName()))) //
133+
.isEqualTo(0.3);
134+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.DEFAULT_TIME_TO_LIVE.getName()))) //
135+
.isEqualTo(864_000);
136+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.SPECULATIVE_RETRY.getName()))) //
137+
.isEqualTo("90p");
138+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.MEMTABLE_FLUSH_PERIOD_IN_MS.getName()))) //
139+
.isEqualTo(1000);
140+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.CRC_CHECK_CHANCE.getName()))) //
141+
.isEqualTo(0.9);
142+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.MIN_INDEX_INTERVAL.getName()))) //
143+
.isEqualTo(128);
144+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.MAX_INDEX_INTERVAL.getName()))) //
145+
.isEqualTo(2048);
146+
assertThat(someTable.getOptions().get(CqlIdentifier.fromCql(TableOption.READ_REPAIR.getName()))) //
147+
.isEqualTo("BLOCKING");
148+
}
149+
110150
@Test // GH-1388
111151
void shouldCreateTableWithNameDerivedFromEntityClass() {
112152

‎spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/cql/generator/CreateTableCqlGeneratorUnitTests.java‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,71 @@ void shouldGenerateMultipleOptions() {
181181
assertStringOption(TableOption.READ_REPAIR.getName(), "BLOCKING", cql);
182182
}
183183

184+
@Test // GH-1584
185+
void shouldGenerateMultipleOptions_usingRawStringKeys() {
186+
187+
CqlIdentifier name = CqlIdentifier.fromCql("timeseries_table");
188+
DataType partitionKeyType0 = DataTypes.TIMEUUID;
189+
CqlIdentifier partitionKey0 = CqlIdentifier.fromCql("tid");
190+
DataType partitionKeyType1 = DataTypes.TIMESTAMP;
191+
CqlIdentifier partitionKey1 = CqlIdentifier.fromCql("create_timestamp");
192+
DataType columnType1 = DataTypes.TEXT;
193+
CqlIdentifier column1 = CqlIdentifier.fromCql("data_point");
194+
Double readRepairChance = 0.5;
195+
Double dcLocalReadRepairChance = 0.7;
196+
Double bloomFilterFpChance = 0.001;
197+
Long gcGraceSeconds = 600l;
198+
Long defaultTimeToLive = 864_00L;
199+
Boolean cdc = Boolean.TRUE;
200+
String speculative_retry = "99percentile";
201+
Long memtableFlushPeriodInMs = 600L;
202+
Double crcCheckChance = 0.9;
203+
Long maxIndexInterval = 2048L;
204+
Long minIndexInterval = 128L;
205+
206+
String comment = "This is My Table";
207+
Map<Option, Object> compactionMap = new LinkedHashMap<>();
208+
Map<Option, Object> compressionMap = new LinkedHashMap<>();
209+
Map<Option, Object> cachingMap = new LinkedHashMap<>();
210+
211+
// Compaction
212+
compactionMap.put(CompactionOption.CLASS, "SizeTieredCompactionStrategy");
213+
compactionMap.put(CompactionOption.MIN_THRESHOLD, "4");
214+
// Compression
215+
compressionMap.put(CompressionOption.SSTABLE_COMPRESSION, "SnappyCompressor");
216+
compressionMap.put(CompressionOption.CHUNK_LENGTH_KB, 128);
217+
compressionMap.put(CompressionOption.CRC_CHECK_CHANCE, 0.75);
218+
// Caching
219+
cachingMap.put(CachingOption.KEYS, KeyCachingOption.ALL);
220+
cachingMap.put(CachingOption.ROWS_PER_PARTITION, "NONE");
221+
222+
CreateTableSpecification table = CreateTableSpecification.createTable(name)
223+
.partitionKeyColumn(partitionKey0, partitionKeyType0).partitionKeyColumn(partitionKey1, partitionKeyType1)
224+
.column(column1, columnType1).with("compact_storage", null, false, false)
225+
.with("read_repair_chance", readRepairChance, false, false).with("compaction", compactionMap, false, false)
226+
.with("compression", compressionMap, false, false)
227+
.with("bloom_filter_fp_chance", bloomFilterFpChance, false, false).with("caching", cachingMap, false, false)
228+
.with("comment", comment, true, true).with("dclocal_read_repair_chance", dcLocalReadRepairChance, false, false)
229+
.with("gc_grace_seconds", gcGraceSeconds, false, false)
230+
.with("default_time_to_live", defaultTimeToLive, false, false).with("cdc", cdc, false, false)
231+
.with("speculative_retry", speculative_retry, true, true)
232+
.with("memtable_flush_period_in_ms", memtableFlushPeriodInMs, false, false)
233+
.with("crc_check_chance", crcCheckChance, false, false)
234+
.with("max_index_interval", maxIndexInterval, false, false)
235+
.with("min_index_interval", minIndexInterval, false, false).with("read_repair", "BLOCKING", true, true);
236+
237+
String cql = CqlGenerator.toCql(table);
238+
239+
assertPreamble(name, cql);
240+
assertColumns("tid timeuuid, create_timestamp timestamp, data_point text", cql);
241+
assertPrimaryKey(String.format("(%s, %s)", partitionKey0, partitionKey1), cql);
242+
assertDoubleOption(TableOption.READ_REPAIR_CHANCE.getName(), readRepairChance, cql);
243+
assertDoubleOption(TableOption.DCLOCAL_READ_REPAIR_CHANCE.getName(), dcLocalReadRepairChance, cql);
244+
assertDoubleOption(TableOption.BLOOM_FILTER_FP_CHANCE.getName(), bloomFilterFpChance, cql);
245+
assertStringOption(TableOption.COMMENT.getName(), comment, cql);
246+
assertLongOption(TableOption.GC_GRACE_SECONDS.getName(), gcGraceSeconds, cql);
247+
}
248+
184249
@Test // DATACASS-518
185250
void createTableWithOrderedClustering() {
186251

‎spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/cql/keyspace/CreateTableSpecificationTest.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2016-2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.data.cassandra.core.cql.keyspace;
17+
18+
import static org.assertj.core.api.Assertions.*;
19+
import com.datastax.oss.driver.api.core.CqlIdentifier;
20+
import org.junit.jupiter.api.Test;
21+
22+
/**
23+
* Unit tests for {@link CreateTableSpecification}.
24+
*
25+
* @author Seungho Kang
26+
*/
27+
class CreateTableSpecificationTest {
28+
29+
@Test // GH-1584
30+
void shouldSupportStandardTableOptions() {
31+
32+
CreateTableSpecification specification = CreateTableSpecification.createTable(CqlIdentifier.fromCql("person"))
33+
.with(TableOption.COMPACT_STORAGE)
34+
.with(TableOption.CDC, true)
35+
.with(TableOption.READ_REPAIR, "BLOCKING");
36+
37+
assertThat(specification.getOptions()).containsEntry("COMPACT STORAGE", null)
38+
.containsEntry("cdc", true)
39+
.containsEntry("read_repair", "'BLOCKING'");
40+
}
41+
42+
@Test // GH-1584
43+
void shouldUseRawValueWhenEscapingIsDisabled() {
44+
45+
CreateTableSpecification specification = CreateTableSpecification.createTable(CqlIdentifier.fromCql("person"))
46+
.with("max_index_interval", 128, false, false);
47+
48+
assertThat(specification.getOptions()).containsEntry("max_index_interval", 128);
49+
}
50+
51+
@Test // GH-1584
52+
void shouldEscapeStringValueWhenEscapeIsEnabled() {
53+
54+
CreateTableSpecification specification = CreateTableSpecification.createTable(CqlIdentifier.fromCql("person"))
55+
.with("read_repair", "BLOCKING", true, true);
56+
57+
assertThat(specification.getOptions()).containsEntry("read_repair", "'BLOCKING'");
58+
}
59+
60+
@Test // GH-1584
61+
void shouldPreserveEscapedStringWhenProvidedByCaller() {
62+
63+
CreateTableSpecification specification = CreateTableSpecification.createTable(CqlIdentifier.fromCql("person"))
64+
.with("read_repair", "'BLOCKING'", false, false);
65+
66+
assertThat(specification.getOptions()).containsEntry("read_repair", "'BLOCKING'");
67+
}
68+
69+
}

‎spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/cql/keyspace/TableOptionTest.java‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/*
2+
* Copyright 2016-2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.data.cassandra.core.cql.keyspace;
17+
18+
import static org.assertj.core.api.Assertions.*;
19+
20+
import org.junit.jupiter.api.Test;
21+
22+
/**
23+
* Unit tests for {@link TableOption}.
24+
*
25+
* @author Seungho Kang
26+
*/
27+
class TableOptionTest {
28+
29+
@Test // GH-1584
30+
void shouldResolveTableOptionUsingValueOfIgnoreCase() {
31+
32+
TableOption option = TableOption.valueOfIgnoreCase("bloom_filter_fp_chance");
33+
34+
assertThat(option).isEqualTo(TableOption.BLOOM_FILTER_FP_CHANCE);
35+
}
36+
37+
@Test // GH-1584
38+
void shouldThrowExceptionWhenTableOptionNotFoundInValueOfIgnoreCase() {
39+
40+
assertThatThrownBy(() -> TableOption.valueOfIgnoreCase("unknown_option"))
41+
.isInstanceOf(IllegalArgumentException.class)
42+
.hasMessageContaining("Unable to recognize specified Table option");
43+
}
44+
45+
@Test // GH-1584
46+
void shouldResolveKnownTableOptionByName() {
47+
48+
TableOption tableOption = TableOption.findByNameIgnoreCase("bloom_filter_fp_chance");
49+
50+
assertThat(tableOption).isEqualTo(TableOption.BLOOM_FILTER_FP_CHANCE);
51+
}
52+
53+
@Test // GH-1584
54+
void shouldReturnNullForUnknownTableOption() {
55+
56+
TableOption tableOption = TableOption.findByNameIgnoreCase("unknown_option");
57+
58+
assertThat(tableOption).isNull();
59+
}
60+
61+
}

0 commit comments

Comments
 (0)