This is an automated email from the ASF dual-hosted git repository.
jmclean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 4d187782b [#6145] improve(CLI): Refactor table commands in Gavitino
CLI (#6161)
4d187782b is described below
commit 4d187782b2cda668600b320167dd9692a3c5e2f9
Author: Lord of Abyss <[email protected]>
AuthorDate: Fri Jan 10 05:10:04 2025 +0800
[#6145] improve(CLI): Refactor table commands in Gavitino CLI (#6161)
### What changes were proposed in this pull request?
Refactor table commands in Gavitino CLI and Base class.
### Why are the changes needed?
Fix: #6145
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
local test
---
.../apache/gravitino/cli/GravitinoCommandLine.java | 103 +--------
.../apache/gravitino/cli/TableCommandHandler.java | 230 +++++++++++++++++++++
.../apache/gravitino/cli/TestableCommandLine.java | 4 +-
3 files changed, 233 insertions(+), 104 deletions(-)
diff --git
a/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
index 06b0c25e8..950274f07 100644
---
a/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
+++
b/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
@@ -131,7 +131,7 @@ public class GravitinoCommandLine extends
TestableCommandLine {
} else if (entity.equals(CommandEntities.COLUMN)) {
handleColumnCommand();
} else if (entity.equals(CommandEntities.TABLE)) {
- handleTableCommand();
+ new TableCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.SCHEMA)) {
handleSchemaCommand();
} else if (entity.equals(CommandEntities.CATALOG)) {
@@ -313,107 +313,6 @@ public class GravitinoCommandLine extends
TestableCommandLine {
}
}
- /**
- * Handles the command execution for Tables based on command type and the
command line options.
- */
- private void handleTableCommand() {
- String url = getUrl();
- String auth = getAuth();
- String userName = line.getOptionValue(GravitinoOptions.LOGIN);
- FullName name = new FullName(line);
- String metalake = name.getMetalakeName();
- String catalog = name.getCatalogName();
- String schema = name.getSchemaName();
-
- Command.setAuthenticationMode(auth, userName);
- List<String> missingEntities = Lists.newArrayList();
- if (catalog == null) missingEntities.add(CommandEntities.CATALOG);
- if (schema == null) missingEntities.add(CommandEntities.SCHEMA);
-
- // Handle CommandActions.LIST action separately as it doesn't require the
`table`
- if (CommandActions.LIST.equals(command)) {
- checkEntities(missingEntities);
- newListTables(url, ignore, metalake, catalog,
schema).validate().handle();
- return;
- }
-
- String table = name.getTableName();
- if (table == null) missingEntities.add(CommandEntities.TABLE);
- checkEntities(missingEntities);
-
- switch (command) {
- case CommandActions.DETAILS:
- if (line.hasOption(GravitinoOptions.AUDIT)) {
- newTableAudit(url, ignore, metalake, catalog, schema,
table).validate().handle();
- } else if (line.hasOption(GravitinoOptions.INDEX)) {
- newListIndexes(url, ignore, metalake, catalog, schema,
table).validate().handle();
- } else if (line.hasOption(GravitinoOptions.DISTRIBUTION)) {
- newTableDistribution(url, ignore, metalake, catalog, schema,
table).validate().handle();
- } else if (line.hasOption(GravitinoOptions.PARTITION)) {
- newTablePartition(url, ignore, metalake, catalog, schema,
table).validate().handle();
- } else if (line.hasOption(GravitinoOptions.SORTORDER)) {
- newTableSortOrder(url, ignore, metalake, catalog, schema,
table).validate().handle();
- } else {
- newTableDetails(url, ignore, metalake, catalog, schema,
table).validate().handle();
- }
- break;
-
- case CommandActions.CREATE:
- {
- String columnFile = line.getOptionValue(GravitinoOptions.COLUMNFILE);
- String comment = line.getOptionValue(GravitinoOptions.COMMENT);
- newCreateTable(url, ignore, metalake, catalog, schema, table,
columnFile, comment)
- .validate()
- .handle();
- break;
- }
- case CommandActions.DELETE:
- boolean force = line.hasOption(GravitinoOptions.FORCE);
- newDeleteTable(url, ignore, force, metalake, catalog, schema,
table).validate().handle();
- break;
-
- case CommandActions.SET:
- String property = line.getOptionValue(GravitinoOptions.PROPERTY);
- String value = line.getOptionValue(GravitinoOptions.VALUE);
- newSetTableProperty(url, ignore, metalake, catalog, schema, table,
property, value)
- .validate()
- .handle();
- break;
-
- case CommandActions.REMOVE:
- property = line.getOptionValue(GravitinoOptions.PROPERTY);
- newRemoveTableProperty(url, ignore, metalake, catalog, schema, table,
property)
- .validate()
- .handle();
- break;
-
- case CommandActions.PROPERTIES:
- newListTableProperties(url, ignore, metalake, catalog, schema,
table).validate().handle();
- break;
-
- case CommandActions.UPDATE:
- {
- if (line.hasOption(GravitinoOptions.COMMENT)) {
- String comment = line.getOptionValue(GravitinoOptions.COMMENT);
- newUpdateTableComment(url, ignore, metalake, catalog, schema,
table, comment)
- .validate()
- .handle();
- }
- if (line.hasOption(GravitinoOptions.RENAME)) {
- String newName = line.getOptionValue(GravitinoOptions.RENAME);
- newUpdateTableName(url, ignore, metalake, catalog, schema, table,
newName)
- .validate()
- .handle();
- }
- break;
- }
-
- default:
- System.err.println(ErrorMessages.UNSUPPORTED_COMMAND);
- break;
- }
- }
-
/** Handles the command execution for Users based on command type and the
command line options. */
protected void handleUserCommand() {
String url = getUrl();
diff --git
a/clients/cli/src/main/java/org/apache/gravitino/cli/TableCommandHandler.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/TableCommandHandler.java
new file mode 100644
index 000000000..b6d90ccd0
--- /dev/null
+++
b/clients/cli/src/main/java/org/apache/gravitino/cli/TableCommandHandler.java
@@ -0,0 +1,230 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.gravitino.cli;
+
+import com.google.common.collect.Lists;
+import java.util.List;
+import org.apache.commons.cli.CommandLine;
+import org.apache.gravitino.cli.commands.Command;
+
+/** Handles the command execution for Tables based on command type and the
command line options. */
+public class TableCommandHandler extends CommandHandler {
+ private final GravitinoCommandLine gravitinoCommandLine;
+ private final CommandLine line;
+ private final String command;
+ private final boolean ignore;
+ private final String url;
+ private final FullName name;
+ private final String metalake;
+ private final String catalog;
+ private final String schema;
+ private String table;
+
+ /**
+ * Constructs a {@link TableCommandHandler} instance.
+ *
+ * @param gravitinoCommandLine The Gravitino command line instance.
+ * @param line The command line arguments.
+ * @param command The command to execute.
+ * @param ignore Ignore server version mismatch.
+ */
+ public TableCommandHandler(
+ GravitinoCommandLine gravitinoCommandLine, CommandLine line, String
command, boolean ignore) {
+ this.gravitinoCommandLine = gravitinoCommandLine;
+ this.line = line;
+ this.command = command;
+ this.ignore = ignore;
+
+ this.url = getUrl(line);
+ this.name = new FullName(line);
+ this.metalake = name.getMetalakeName();
+ this.catalog = name.getCatalogName();
+ this.schema = name.getSchemaName();
+ }
+
+ /** Handles the command execution logic based on the provided command. */
+ @Override
+ protected void handle() {
+ String userName = line.getOptionValue(GravitinoOptions.LOGIN);
+ Command.setAuthenticationMode(getAuth(line), userName);
+
+ List<String> missingEntities = Lists.newArrayList();
+ if (catalog == null) missingEntities.add(CommandEntities.CATALOG);
+ if (schema == null) missingEntities.add(CommandEntities.SCHEMA);
+
+ if (CommandActions.LIST.equals(command)) {
+ checkEntities(missingEntities);
+ handleListCommand();
+ return;
+ }
+
+ this.table = name.getTableName();
+ if (table == null) missingEntities.add(CommandEntities.TABLE);
+ checkEntities(missingEntities);
+
+ if (!executeCommand()) {
+ System.err.println(ErrorMessages.UNSUPPORTED_COMMAND);
+ Main.exit(-1);
+ }
+ }
+
+ /**
+ * Executes the specific command based on the command type.
+ *
+ * @return true if the command is supported, false otherwise
+ */
+ private boolean executeCommand() {
+ switch (command) {
+ case CommandActions.DETAILS:
+ handleDetailsCommand();
+ return true;
+
+ case CommandActions.CREATE:
+ handleCreateCommand();
+ return true;
+
+ case CommandActions.DELETE:
+ handleDeleteCommand();
+ return true;
+
+ case CommandActions.SET:
+ handleSetCommand();
+ return true;
+
+ case CommandActions.REMOVE:
+ handleRemoveCommand();
+ return true;
+
+ case CommandActions.PROPERTIES:
+ handlePropertiesCommand();
+ return true;
+
+ case CommandActions.UPDATE:
+ handleUpdateCommand();
+ return true;
+
+ default:
+ return false;
+ }
+ }
+
+ /** Handles the "DETAILS" command. */
+ private void handleDetailsCommand() {
+ if (line.hasOption(GravitinoOptions.AUDIT)) {
+ gravitinoCommandLine
+ .newTableAudit(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ } else if (line.hasOption(GravitinoOptions.INDEX)) {
+ gravitinoCommandLine
+ .newListIndexes(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ } else if (line.hasOption(GravitinoOptions.DISTRIBUTION)) {
+ gravitinoCommandLine
+ .newTableDistribution(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ } else if (line.hasOption(GravitinoOptions.PARTITION)) {
+ gravitinoCommandLine
+ .newTablePartition(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ } else if (line.hasOption(GravitinoOptions.SORTORDER)) {
+ gravitinoCommandLine
+ .newTableSortOrder(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ } else {
+ gravitinoCommandLine
+ .newTableDetails(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ }
+ }
+
+ /** Handles the "CREATE" command. */
+ private void handleCreateCommand() {
+ String columnFile = line.getOptionValue(GravitinoOptions.COLUMNFILE);
+ String comment = line.getOptionValue(GravitinoOptions.COMMENT);
+ gravitinoCommandLine
+ .newCreateTable(url, ignore, metalake, catalog, schema, table,
columnFile, comment)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "DELETE" command. */
+ private void handleDeleteCommand() {
+ boolean force = line.hasOption(GravitinoOptions.FORCE);
+ gravitinoCommandLine
+ .newDeleteTable(url, ignore, force, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "SET" command. */
+ private void handleSetCommand() {
+ String property = line.getOptionValue(GravitinoOptions.PROPERTY);
+ String value = line.getOptionValue(GravitinoOptions.VALUE);
+ gravitinoCommandLine
+ .newSetTableProperty(url, ignore, metalake, catalog, schema, table,
property, value)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "REMOVE" command. */
+ private void handleRemoveCommand() {
+ String property = line.getOptionValue(GravitinoOptions.PROPERTY);
+ gravitinoCommandLine
+ .newRemoveTableProperty(url, ignore, metalake, catalog, schema, table,
property)
+ .validate()
+ .handle();
+ }
+ /** Handles the "PROPERTIES" command. */
+ private void handlePropertiesCommand() {
+ gravitinoCommandLine
+ .newListTableProperties(url, ignore, metalake, catalog, schema, table)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "LIST" command. */
+ private void handleListCommand() {
+ gravitinoCommandLine.newListTables(url, ignore, metalake, catalog,
schema).validate().handle();
+ }
+
+ /** Handles the "UPDATE" command. */
+ private void handleUpdateCommand() {
+ if (line.hasOption(GravitinoOptions.COMMENT)) {
+ String comment = line.getOptionValue(GravitinoOptions.COMMENT);
+ gravitinoCommandLine
+ .newUpdateTableComment(url, ignore, metalake, catalog, schema,
table, comment)
+ .validate()
+ .handle();
+ }
+ if (line.hasOption(GravitinoOptions.RENAME)) {
+ String newName = line.getOptionValue(GravitinoOptions.RENAME);
+ gravitinoCommandLine
+ .newUpdateTableName(url, ignore, metalake, catalog, schema, table,
newName)
+ .validate()
+ .handle();
+ }
+ }
+}
diff --git
a/clients/cli/src/main/java/org/apache/gravitino/cli/TestableCommandLine.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/TestableCommandLine.java
index c08a09505..d9e3b9288 100644
---
a/clients/cli/src/main/java/org/apache/gravitino/cli/TestableCommandLine.java
+++
b/clients/cli/src/main/java/org/apache/gravitino/cli/TestableCommandLine.java
@@ -315,8 +315,8 @@ public class TestableCommandLine {
}
protected ListTables newListTables(
- String url, boolean ignore, String metalake, String catalog, String
table) {
- return new ListTables(url, ignore, metalake, catalog, table);
+ String url, boolean ignore, String metalake, String catalog, String
schema) {
+ return new ListTables(url, ignore, metalake, catalog, schema);
}
protected DeleteTable newDeleteTable(
