Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support encrypted columns in Schema Loader #1975

Merged
merged 2 commits into from
Jun 25, 2024
Merged

Support encrypted columns in Schema Loader #1975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d110cf
Support encrypted columns in Schema Loader
brfrn169 Jun 21, 2024
565e5e5
Merge branch 'master' into support-encrypted-columns-in-schema-loader
feeblefakie Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions core/src/main/java/com/scalar/db/api/TableMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.scalar.db.api;

import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.scalar.db.api.Scan.Ordering.Order;
Expand Down Expand Up @@ -162,7 +163,8 @@ public boolean equals(Object o) {
&& Objects.equals(partitionKeyNames, metadata.partitionKeyNames)
&& Objects.equals(clusteringKeyNames, metadata.clusteringKeyNames)
&& Objects.equals(clusteringOrders, metadata.clusteringOrders)
&& Objects.equals(secondaryIndexNames, metadata.secondaryIndexNames);
&& Objects.equals(secondaryIndexNames, metadata.secondaryIndexNames)
&& Objects.equals(encryptedColumnNames, metadata.encryptedColumnNames);
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot to add encryptedColumnNames to equals() and hashCode() in the previous PR...

}

@Override
Expand All @@ -173,7 +175,21 @@ public int hashCode() {
partitionKeyNames,
clusteringKeyNames,
clusteringOrders,
secondaryIndexNames);
secondaryIndexNames,
encryptedColumnNames);
}

@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("columnNames", columnNames)
.add("columnDataTypes", columnDataTypes)
.add("partitionKeyNames", partitionKeyNames)
.add("clusteringKeyNames", clusteringKeyNames)
.add("clusteringOrders", clusteringOrders)
.add("secondaryIndexNames", secondaryIndexNames)
.add("encryptedColumnNames", encryptedColumnNames)
.toString();
}

/** A builder class that creates a TableMetadata instance. */
Expand Down
16 changes: 12 additions & 4 deletions schema-loader/src/main/java/com/scalar/db/schemaloader/TableSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ protected TableMetadata buildTableMetadata(String tableFullName, JsonObject tabl
for (JsonElement clusteringKeyRaw : clusteringKeys) {
String clusteringKey;
String order;
String[] clusteringKeyFull = clusteringKeyRaw.getAsString().split(" ", -1);
String[] clusteringKeyFull = clusteringKeyRaw.getAsString().split("\\s+", -1);
if (clusteringKeyFull.length < 2) {
clusteringKey = clusteringKeyFull[0];
tableBuilder.addClusteringKey(clusteringKey);
Expand Down Expand Up @@ -128,13 +128,21 @@ protected TableMetadata buildTableMetadata(String tableFullName, JsonObject tabl
traveledKeys.add(COLUMNS);
for (Entry<String, JsonElement> column : columns.entrySet()) {
String columnName = column.getKey();
DataType columnDataType = DATA_MAP_TYPE.get(column.getValue().getAsString().toUpperCase());
if (columnDataType == null) {

String[] columnDataTypeAndEncrypted = column.getValue().getAsString().split("\\s+", -1);
String columnDataType = columnDataTypeAndEncrypted[0];
boolean encrypted =
columnDataTypeAndEncrypted.length > 1
&& columnDataTypeAndEncrypted[1].equalsIgnoreCase("ENCRYPTED");

DataType dataType = DATA_MAP_TYPE.get(columnDataType.toUpperCase());
if (dataType == null) {
throw new IllegalArgumentException(
CoreError.SCHEMA_LOADER_PARSE_ERROR_INVALID_COLUMN_TYPE.buildMessage(
tableFullName, columnName, column.getValue().getAsString()));
}
tableBuilder.addColumn(columnName, columnDataType);

tableBuilder.addColumn(columnName, dataType, encrypted);
}

// Add secondary indexes
Expand Down
50 changes: 44 additions & 6 deletions schema-loader/src/test/java/com/scalar/db/schemaloader/TableSchemaTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,12 @@ public void buildOptions_OptionsMapFromTableDefinitionAndOptionsGiven_ShouldRetu
}

@Test
public void buildTableMetadata_ProperFormatTableDefinitionGiven_ShouldReturnProperTableMetadata()
throws SchemaLoaderException {
public void
buildTableMetadata_ProperFormatTableDefinitionGiven_ShouldReturnProperTableMetadata() {
String tableDefinitionJson =
"{\"transaction\": false,"
+ "\"partition-key\": [\"c1\"],"
+ "\"clustering-key\": [\"c3\",\"c4 ASC\",\"c6 DESC\"],"
+ "\"clustering-key\": [\"c3\",\"c4 ASC\",\"c6 DESC\"],"
+ "\"columns\": {"
+ " \"c1\": \"INT\","
+ " \"c2\": \"TEXT\","
Expand Down Expand Up @@ -182,6 +182,44 @@ public void buildTableMetadata_ProperFormatTableDefinitionGiven_ShouldReturnProp
Assertions.assertThat(tableMetadata).isEqualTo(expectedTableMetadata);
}

@Test
public void
buildTableMetadata_ProperFormatTableDefinitionWithEncryptedColumnsGiven_ShouldReturnProperTableMetadata() {
String tableDefinitionJson =
"{\"transaction\": false,"
+ "\"partition-key\": [\"c1\"],"
+ "\"clustering-key\": [\"c3\",\"c4 ASC\",\"c6 DESC\"],"
+ "\"columns\": {"
+ " \"c1\": \"INT\","
+ " \"c2\": \"TEXT ENCRYPTED\","
+ " \"c3\": \"BLOB\","
+ " \"c4\": \"INT\","
+ " \"c5\": \"BOOLEAN ENCRYPTED\","
+ " \"c6\": \"INT\""
+ "}}";
JsonObject tableDefinition = JsonParser.parseString(tableDefinitionJson).getAsJsonObject();

TableMetadata.Builder tableBuilder = TableMetadata.newBuilder();
tableBuilder.addPartitionKey("c1");
tableBuilder.addClusteringKey("c3");
tableBuilder.addClusteringKey("c4");
tableBuilder.addClusteringKey("c6", Order.DESC);
tableBuilder.addColumn("c1", DataType.INT);
tableBuilder.addColumn("c2", DataType.TEXT, true);
tableBuilder.addColumn("c3", DataType.BLOB);
tableBuilder.addColumn("c4", DataType.INT);
tableBuilder.addColumn("c5", DataType.BOOLEAN, true);
tableBuilder.addColumn("c6", DataType.INT);
TableMetadata expectedTableMetadata = tableBuilder.build();

// Act
TableMetadata tableMetadata =
new TableSchema("ns.tb", tableDefinition, Collections.emptyMap()).getTableMetadata();

// Assert
Assertions.assertThat(tableMetadata).isEqualTo(expectedTableMetadata);
}

@Test
public void Table_WrongFormatTableFullNameGiven_ShouldThrowIllegalArgumentException() {
// Arrange
Expand All @@ -194,11 +232,11 @@ public void Table_WrongFormatTableFullNameGiven_ShouldThrowIllegalArgumentExcept
}

@Test
public void constructor_TableDefinitionWithoutTransactionGiven_ShouldConstructProperTableSchema()
throws SchemaLoaderException {
public void
constructor_TableDefinitionWithoutTransactionGiven_ShouldConstructProperTableSchema() {
String tableDefinitionJson =
"{\"partition-key\": [\"c1\"],"
+ "\"clustering-key\": [\"c3\",\"c4 ASC\",\"c6 DESC\"],"
+ "\"clustering-key\": [\"c3\",\"c4 ASC\",\"c6 DESC\"],"
+ "\"columns\": {"
+ " \"c1\": \"INT\","
+ " \"c2\": \"TEXT\","
Expand Down
Loading