Add drop column

KodaiD · KodaiD · commit 18a48c86ad07 · 2025-08-07T21:38:48.000+09:00
diff --git a/core/src/main/java/com/scalar/db/api/Admin.java b/core/src/main/java/com/scalar/db/api/Admin.java
@@ -441,6 +441,18 @@ default void addNewColumnToTable(
     }
   }
 
+  /**
+   * Drops a column from an existing table. The column cannot be a partition or clustering key.
+   *
+   * @param namespace the table namespace
+   * @param table the table name
+   * @param columnName the name of the column to drop
+   * @throws IllegalArgumentException if the table does not exist or the column does not exist
+   * @throws ExecutionException if the operation fails
+   */
+  void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException;
+
   /**
    * Imports an existing table that is not managed by ScalarDB.
    *
diff --git a/core/src/main/java/com/scalar/db/common/CheckedDistributedStorageAdmin.java b/core/src/main/java/com/scalar/db/common/CheckedDistributedStorageAdmin.java
@@ -295,6 +295,39 @@ public void addNewColumnToTable(
     }
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    TableMetadata tableMetadata = getTableMetadata(namespace, table);
+    if (tableMetadata == null) {
+      throw new IllegalArgumentException(
+          CoreError.TABLE_NOT_FOUND.buildMessage(ScalarDbUtils.getFullTableName(namespace, table)));
+    }
+
+    if (!tableMetadata.getColumnNames().contains(columnName)) {
+      throw new IllegalArgumentException(
+          CoreError.COLUMN_NOT_FOUND2.buildMessage(
+              ScalarDbUtils.getFullTableName(namespace, table), columnName));
+    }
+
+    if (tableMetadata.getPartitionKeyNames().contains(columnName)
+        || tableMetadata.getClusteringKeyNames().contains(columnName)
+        || tableMetadata.getSecondaryIndexNames().contains(columnName)) {
+      throw new IllegalArgumentException(
+          CoreError.COLUMN_SPECIFIED_AS_PRIMARY_KEY_OR_INDEX_KEY.buildMessage(
+              ScalarDbUtils.getFullTableName(namespace, table), columnName));
+    }
+
+    try {
+      admin.dropColumnFromTable(namespace, table, columnName);
+    } catch (ExecutionException e) {
+      throw new ExecutionException(
+          CoreError.DROPPING_COLUMN_FROM_TABLE_FAILED.buildMessage(
+              ScalarDbUtils.getFullTableName(namespace, table), columnName),
+          e);
+    }
+  }
+
   @Override
   public Set<String> getNamespaceNames() throws ExecutionException {
     try {
diff --git a/core/src/main/java/com/scalar/db/common/CoreError.java b/core/src/main/java/com/scalar/db/common/CoreError.java
@@ -678,6 +678,12 @@ public enum CoreError implements ScalarDbError {
       "Mutations across multiple storages are not allowed. Mutations: %s",
       "",
       ""),
+  COLUMN_SPECIFIED_AS_PRIMARY_KEY_OR_INDEX_KEY(
+      Category.USER_ERROR,
+      "0216",
+      "The column %s is specified as a primary key or an index key",
+      "",
+      ""),
 
   //
   // Errors for the concurrency error category
@@ -960,6 +966,12 @@ public enum CoreError implements ScalarDbError {
       Category.INTERNAL_ERROR, "0057", "Recovering records failed. Details: %s", "", ""),
   CONSENSUS_COMMIT_COMMITTING_RECORDS_FAILED(
       Category.INTERNAL_ERROR, "0058", "Committing records failed. Details: %s", "", ""),
+  DROPPING_COLUMN_FROM_TABLE_FAILED(
+      Category.INTERNAL_ERROR,
+      "0059",
+      "Dropping a column from the table failed. Table: %s; Column: %s",
+      "",
+      ""),
 
   //
   // Errors for the unknown transaction status error category
diff --git a/core/src/main/java/com/scalar/db/common/DecoratedDistributedTransactionAdmin.java b/core/src/main/java/com/scalar/db/common/DecoratedDistributedTransactionAdmin.java
@@ -195,6 +195,12 @@ public void addNewColumnToTable(
         namespace, table, columnName, columnType, encrypted);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    distributedTransactionAdmin.dropColumnFromTable(namespace, table, columnName);
+  }
+
   @Override
   public void importTable(String namespace, String table, Map<String, String> options)
       throws ExecutionException {
diff --git a/core/src/main/java/com/scalar/db/service/AdminService.java b/core/src/main/java/com/scalar/db/service/AdminService.java
@@ -94,6 +94,12 @@ public void addNewColumnToTable(
     admin.addNewColumnToTable(namespace, table, columnName, columnType);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    admin.dropColumnFromTable(namespace, table, columnName);
+  }
+
   @Override
   public TableMetadata getImportTableMetadata(
       String namespace, String table, Map<String, DataType> overrideColumnsType)
diff --git a/core/src/main/java/com/scalar/db/storage/cassandra/CassandraAdmin.java b/core/src/main/java/com/scalar/db/storage/cassandra/CassandraAdmin.java
@@ -415,6 +415,27 @@ columnName, getFullTableName(namespace, table)),
     }
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    try {
+      String alterTableQuery =
+          SchemaBuilder.alterTable(quoteIfNecessary(namespace), quoteIfNecessary(table))
+              .dropColumn(columnName)
+              .getQueryString();
+
+      clusterManager.getSession().execute(alterTableQuery);
+    } catch (IllegalArgumentException e) {
+      throw e;
+    } catch (RuntimeException e) {
+      throw new ExecutionException(
+          String.format(
+              "Dropping the %s column from the %s table failed",
+              columnName, getFullTableName(namespace, table)),
+          e);
+    }
+  }
+
   @Override
   public Set<String> getNamespaceNames() throws ExecutionException {
     try {
diff --git a/core/src/main/java/com/scalar/db/storage/cosmos/CosmosAdmin.java b/core/src/main/java/com/scalar/db/storage/cosmos/CosmosAdmin.java
@@ -644,6 +644,23 @@ columnName, getFullTableName(namespace, table)),
     }
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    try {
+      TableMetadata currentTableMetadata = getTableMetadata(namespace, table);
+      TableMetadata updatedTableMetadata =
+          TableMetadata.newBuilder(currentTableMetadata).removeColumn(columnName).build();
+      upsertTableMetadata(namespace, table, updatedTableMetadata);
+    } catch (ExecutionException e) {
+      throw new ExecutionException(
+          String.format(
+              "Adding the new %s column to the %s container failed",
+              columnName, getFullTableName(namespace, table)),
+          e);
+    }
+  }
+
   @Override
   public TableMetadata getImportTableMetadata(
       String namespace, String table, Map<String, DataType> overrideColumnsType) {
diff --git a/core/src/main/java/com/scalar/db/storage/dynamo/DynamoAdmin.java b/core/src/main/java/com/scalar/db/storage/dynamo/DynamoAdmin.java
@@ -1440,6 +1440,25 @@ columnName, getFullTableName(namespace, table)),
     }
   }
 
+  @Override
+  public void dropColumnFromTable(String nonPrefixedNamespace, String table, String columnName)
+      throws ExecutionException {
+    Namespace namespace = Namespace.of(namespacePrefix, nonPrefixedNamespace);
+    try {
+      TableMetadata currentTableMetadata = getTableMetadata(nonPrefixedNamespace, table);
+      TableMetadata updatedTableMetadata =
+          TableMetadata.newBuilder(currentTableMetadata).removeColumn(columnName).build();
+
+      upsertTableMetadata(namespace, table, updatedTableMetadata);
+    } catch (ExecutionException e) {
+      throw new ExecutionException(
+          String.format(
+              "Dropping the %s column from the %s table failed",
+              columnName, getFullTableName(namespace, table)),
+          e);
+    }
+  }
+
   @Override
   public TableMetadata getImportTableMetadata(
       String namespace, String table, Map<String, DataType> overrideColumnsType) {
diff --git a/core/src/main/java/com/scalar/db/storage/jdbc/JdbcAdmin.java b/core/src/main/java/com/scalar/db/storage/jdbc/JdbcAdmin.java
@@ -861,6 +861,31 @@ columnName, getFullTableName(namespace, table)),
     }
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    try {
+      TableMetadata currentTableMetadata = getTableMetadata(namespace, table);
+      TableMetadata updatedTableMetadata =
+          TableMetadata.newBuilder(currentTableMetadata).removeColumn(columnName).build();
+      String addNewColumnStatement =
+          "ALTER TABLE "
+              + encloseFullTableName(namespace, table)
+              + " DROP COLUMN"
+              + enclose(columnName);
+      try (Connection connection = dataSource.getConnection()) {
+        execute(connection, addNewColumnStatement);
+        addTableMetadata(connection, namespace, table, updatedTableMetadata, false, true);
+      }
+    } catch (SQLException e) {
+      throw new ExecutionException(
+          String.format(
+              "Adding the new %s column to the %s table failed",
+              columnName, getFullTableName(namespace, table)),
+          e);
+    }
+  }
+
   @Override
   public void addRawColumnToTable(
       String namespace, String table, String columnName, DataType columnType)
diff --git a/core/src/main/java/com/scalar/db/storage/multistorage/MultiStorageAdmin.java b/core/src/main/java/com/scalar/db/storage/multistorage/MultiStorageAdmin.java
@@ -205,6 +205,12 @@ public void addNewColumnToTable(
     getAdmin(namespace, table).addNewColumnToTable(namespace, table, columnName, columnType);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    getAdmin(namespace, table).dropColumnFromTable(namespace, table, columnName);
+  }
+
   @Override
   public TableMetadata getImportTableMetadata(
       String namespace, String table, Map<String, DataType> overrideColumnsType)
diff --git a/core/src/main/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitAdmin.java b/core/src/main/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitAdmin.java
@@ -238,6 +238,22 @@ public void addNewColumnToTable(
     admin.addNewColumnToTable(namespace, table, beforeColumnName, columnType);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    checkNamespace(namespace);
+
+    TableMetadata tableMetadata = getTableMetadata(namespace, table);
+    if (tableMetadata == null) {
+      throw new IllegalArgumentException(
+          CoreError.TABLE_NOT_FOUND.buildMessage(ScalarDbUtils.getFullTableName(namespace, table)));
+    }
+    String beforeColumnName = getBeforeImageColumnName(columnName, tableMetadata);
+
+    admin.dropColumnFromTable(namespace, table, columnName);
+    admin.dropColumnFromTable(namespace, table, beforeColumnName);
+  }
+
   @Override
   public Set<String> getNamespaceNames() throws ExecutionException {
     return admin.getNamespaceNames().stream()
diff --git a/core/src/main/java/com/scalar/db/transaction/jdbc/JdbcTransactionAdmin.java b/core/src/main/java/com/scalar/db/transaction/jdbc/JdbcTransactionAdmin.java
@@ -160,6 +160,12 @@ public void addNewColumnToTable(
     jdbcAdmin.addNewColumnToTable(namespace, table, columnName, columnType);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    jdbcAdmin.dropColumnFromTable(namespace, table, columnName);
+  }
+
   @Override
   public Set<String> getNamespaceNames() throws ExecutionException {
     return jdbcAdmin.getNamespaceNames();
diff --git a/core/src/main/java/com/scalar/db/transaction/singlecrudoperation/SingleCrudOperationTransactionAdmin.java b/core/src/main/java/com/scalar/db/transaction/singlecrudoperation/SingleCrudOperationTransactionAdmin.java
@@ -109,6 +109,12 @@ public void addNewColumnToTable(
     distributedStorageAdmin.addNewColumnToTable(namespace, table, columnName, columnType);
   }
 
+  @Override
+  public void dropColumnFromTable(String namespace, String table, String columnName)
+      throws ExecutionException {
+    distributedStorageAdmin.dropColumnFromTable(namespace, table, columnName);
+  }
+
   @Override
   public Set<String> getNamespaceNames() throws ExecutionException {
     return distributedStorageAdmin.getNamespaceNames();
diff --git a/integration-test/src/main/java/com/scalar/db/api/DistributedStorageAdminIntegrationTestBase.java b/integration-test/src/main/java/com/scalar/db/api/DistributedStorageAdminIntegrationTestBase.java
@@ -969,6 +969,71 @@ public void addNewColumnToTable_AddColumnForEachExistingDataType_ShouldAddNewCol
     }
   }
 
+  @Test
+  public void dropColumnFromTable_DropColumnForEachExistingDataType_ShouldDropColumnsCorrectly()
+      throws ExecutionException {
+    try {
+      // Arrange
+      Map<String, String> options = getCreationOptions();
+      TableMetadata.Builder currentTableMetadataBuilder =
+          TableMetadata.newBuilder()
+              .addColumn(getColumnName1(), DataType.INT)
+              .addColumn(getColumnName2(), DataType.INT)
+              .addColumn(getColumnName3(), DataType.INT)
+              .addColumn(getColumnName4(), DataType.BIGINT)
+              .addColumn(getColumnName5(), DataType.FLOAT)
+              .addColumn(getColumnName6(), DataType.DOUBLE)
+              .addColumn(getColumnName7(), DataType.TEXT)
+              .addColumn(getColumnName8(), DataType.BLOB)
+              .addColumn(getColumnName9(), DataType.DATE)
+              .addColumn(getColumnName10(), DataType.TIME)
+              .addPartitionKey(getColumnName1())
+              .addClusteringKey(getColumnName2(), Scan.Ordering.Order.ASC);
+      if (isTimestampTypeSupported()) {
+        currentTableMetadataBuilder
+            .addColumn(getColumnName11(), DataType.TIMESTAMP)
+            .addColumn(getColumnName12(), DataType.TIMESTAMPTZ);
+      }
+      TableMetadata currentTableMetadata = currentTableMetadataBuilder.build();
+      admin.createTable(namespace1, getTable4(), currentTableMetadata, options);
+
+      // Act
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName3());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName4());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName5());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName6());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName7());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName8());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName9());
+      admin.dropColumnFromTable(namespace1, getTable4(), getColumnName10());
+      if (isTimestampTypeSupported()) {
+        admin.dropColumnFromTable(namespace1, getTable4(), getColumnName11());
+        admin.dropColumnFromTable(namespace1, getTable4(), getColumnName12());
+      }
+
+      // Assert
+      TableMetadata.Builder expectedTableMetadataBuilder =
+          TableMetadata.newBuilder(currentTableMetadata)
+              .removeColumn(getColumnName3())
+              .removeColumn(getColumnName4())
+              .removeColumn(getColumnName5())
+              .removeColumn(getColumnName6())
+              .removeColumn(getColumnName7())
+              .removeColumn(getColumnName8())
+              .removeColumn(getColumnName9())
+              .removeColumn(getColumnName10());
+      if (isTimestampTypeSupported()) {
+        expectedTableMetadataBuilder
+            .removeColumn(getColumnName11())
+            .removeColumn(getColumnName12());
+      }
+      TableMetadata expectedTableMetadata = expectedTableMetadataBuilder.build();
+      assertThat(admin.getTableMetadata(namespace1, getTable4())).isEqualTo(expectedTableMetadata);
+    } finally {
+      admin.dropTable(namespace1, getTable4(), true);
+    }
+  }
+
   @Test
   public void getNamespaceNames_ShouldReturnCreatedNamespaces() throws ExecutionException {
     // Arrange
@@ -1002,6 +1067,38 @@ public void addNewColumnToTable_ForAlreadyExistingColumn_ShouldThrowIllegalArgum
         .isInstanceOf(IllegalArgumentException.class);
   }
 
+  @Test
+  public void dropColumnFromTable_ForNonExistingTable_ShouldThrowIllegalArgumentException() {
+    // Arrange
+
+    // Act Assert
+    assertThatThrownBy(() -> admin.dropColumnFromTable(namespace1, getTable4(), getColumnName2()))
+        .isInstanceOf(IllegalArgumentException.class);
+  }
+
+  @Test
+  public void dropColumnFromTable_ForNonExistingColumn_ShouldThrowIllegalArgumentException() {
+    // Arrange
+
+    // Act Assert
+    assertThatThrownBy(
+            () -> admin.dropColumnFromTable(namespace1, getTable1(), "nonExistingColumn"))
+        .isInstanceOf(IllegalArgumentException.class);
+  }
+
+  @Test
+  public void dropColumnFromTable_ForPrimaryOrIndexKeyColumn_ShouldThrowIllegalArgumentException() {
+    // Arrange
+
+    // Act Assert
+    assertThatThrownBy(() -> admin.dropColumnFromTable(namespace1, getTable1(), getColumnName1()))
+        .isInstanceOf(IllegalArgumentException.class);
+    assertThatThrownBy(() -> admin.dropColumnFromTable(namespace1, getTable1(), getColumnName3()))
+        .isInstanceOf(IllegalArgumentException.class);
+    assertThatThrownBy(() -> admin.dropColumnFromTable(namespace1, getTable1(), getColumnName5()))
+        .isInstanceOf(IllegalArgumentException.class);
+  }
+
   @Test
   public void
       upgrade_WhenMetadataTableExistsButNotNamespacesTable_ShouldCreateNamespacesTableAndImportExistingNamespaces()
diff --git a/integration-test/src/main/java/com/scalar/db/api/DistributedTransactionAdminIntegrationTestBase.java b/integration-test/src/main/java/com/scalar/db/api/DistributedTransactionAdminIntegrationTestBase.java

Original file line number	Diff line number	Diff line change
`@@ -441,6 +441,18 @@ default void addNewColumnToTable(`
`441`	`441`	`}`
`442`	`442`	`}`
`443`	`443`
	`444`	`+ /**`
	`445`	`+ * Drops a column from an existing table. The column cannot be a partition or clustering key.`
	`446`	`+ *`
	`447`	`+ * @param namespace the table namespace`
	`448`	`+ * @param table the table name`
	`449`	`+ * @param columnName the name of the column to drop`
	`450`	`+ * @throws IllegalArgumentException if the table does not exist or the column does not exist`
	`451`	`+ * @throws ExecutionException if the operation fails`
	`452`	`+ */`
	`453`	`+ void dropColumnFromTable(String namespace, String table, String columnName)`
	`454`	`+ throws ExecutionException;`
	`455`	`+`
`444`	`456`	`/**`
`445`	`457`	`* Imports an existing table that is not managed by ScalarDB.`
`446`	`458`	`*`