[#6493] feat(CLI): Support table format output for Schema and Table c…

…ommand (#6495) ### What changes were proposed in this pull request? Support table format output for Schema and Table command. ### Why are the changes needed? Fix: #6493 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? local test. ```bash gcli schema list -m demo_metalake --name Hive_catalog --output table -i +---------------------------+ | Schema | +---------------------------+ | convert_example | | default | | hive_best_performance | | test_hive_convert_example | | test_multiple_data_source | +---------------------------+ gcli schema details -m demo_metalake --name Hive_catalog.default --output table -i +---------+-----------------------+ | Schema | Comment | +---------+-----------------------+ | default | Default Hive database | +---------+-----------------------+ gcli table list -m demo_metalake --name Hive_catalog.default -i --output table +---------------------------------------+ | Table | +---------------------------------------+ | test_create_txt_tbl_without_delimited | | test_jinjia_tbl1 | | test_jinjia_tbl2 | | test | | test1 | | example_table | | example_table2 | +---------------------------------------+ gcli table details -m demo_metalake --name Hive_catalog.default.test1 -i --output table +----------+---------+---------------+----------+---------+ | Name | Type | AutoIncrement | Nullable | Comment | +----------+---------+---------------+----------+---------+ | id | integer | false | true | N/A | | name | string | false | true | N/A | | standard | long | false | true | N/A | | dt | string | false | true | N/A | +----------+---------+---------------+----------+---------+ ```
apache · Feb 24, 2025 · fb3d900 · fb3d900
1 parent ee296fa
commit fb3d900
Show file tree

Hide file tree

Showing 7 changed files with 290 additions and 26 deletions.
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/commands/Command.java b/clients/cli/src/main/java/org/apache/gravitino/cli/commands/Command.java
@@ -235,7 +235,7 @@ protected <T extends GravitinoClientBase> Builder<T> constructClient(Builder<T>
    * @param entity The entity to output.
    * @param <T> The type of entity.
    */
-  protected <T> void output(T entity) {
+  private <T> void output(T entity) {
     if (outputFormat == null) {
       PlainFormat.output(entity, context);
       return;

diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/commands/ListSchema.java b/clients/cli/src/main/java/org/apache/gravitino/cli/commands/ListSchema.java
@@ -19,7 +19,8 @@
 
 package org.apache.gravitino.cli.commands;
 
-import com.google.common.base.Joiner;
+import org.apache.gravitino.Audit;
+import org.apache.gravitino.Schema;
 import org.apache.gravitino.cli.CommandContext;
 import org.apache.gravitino.cli.ErrorMessages;
 import org.apache.gravitino.client.GravitinoClient;
@@ -49,8 +50,10 @@ public ListSchema(CommandContext context, String metalake, String catalog) {
   @Override
   public void handle() {
     String[] schemas = new String[0];
+    GravitinoClient client;
+
     try {
-      GravitinoClient client = buildClient(metalake);
+      client = buildClient(metalake);
       schemas = client.loadCatalog(catalog).asSchemas().listSchemas();
     } catch (NoSuchMetalakeException err) {
       exitWithError(ErrorMessages.UNKNOWN_METALAKE);
@@ -60,8 +63,29 @@ public void handle() {
       exitWithError(exp.getMessage());
     }
 
-    String all = schemas.length == 0 ? "No schemas exist." : Joiner.on(",").join(schemas);
+    if (schemas.length == 0) {
+      printInformation("No schemas exist.");
+      return;
+    }
+
+    Schema[] schemaObjects = new Schema[schemas.length];
+    for (int i = 0; i < schemas.length; i++) {
+      String schemaName = schemas[i];
+      Schema gSchema =
+          new Schema() {
+            @Override
+            public String name() {
+              return schemaName;
+            }
+
+            @Override
+            public Audit auditInfo() {
+              return null;
+            }
+          };
+      schemaObjects[i] = gSchema;
+    }
 
-    printInformation(all);
+    printResults(schemaObjects);
   }
 }
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/commands/ListTables.java b/clients/cli/src/main/java/org/apache/gravitino/cli/commands/ListTables.java
@@ -19,12 +19,12 @@
 
 package org.apache.gravitino.cli.commands;
 
-import com.google.common.base.Joiner;
-import java.util.ArrayList;
-import java.util.List;
+import org.apache.gravitino.Audit;
 import org.apache.gravitino.NameIdentifier;
 import org.apache.gravitino.Namespace;
 import org.apache.gravitino.cli.CommandContext;
+import org.apache.gravitino.rel.Column;
+import org.apache.gravitino.rel.Table;
 
 /** List the names of all tables in a schema. */
 public class ListTables extends TableCommand {
@@ -49,22 +49,41 @@ public ListTables(CommandContext context, String metalake, String catalog, Strin
   public void handle() {
     NameIdentifier[] tables = null;
     Namespace name = Namespace.of(schema);
+
     try {
       tables = tableCatalog().listTables(name);
     } catch (Exception exp) {
       exitWithError(exp.getMessage());
     }
 
-    List<String> tableNames = new ArrayList<>();
-    for (int i = 0; i < tables.length; i++) {
-      tableNames.add(tables[i].name());
+    if (tables.length == 0) {
+      printInformation("No tables exist.");
+      return;
     }
 
-    String all =
-        tableNames.isEmpty()
-            ? "No tables exist."
-            : Joiner.on(System.lineSeparator()).join(tableNames);
+    Table[] gTables = new Table[tables.length];
+    for (int i = 0; i < tables.length; i++) {
+      String tableName = tables[i].name();
+      gTables[i] =
+          new Table() {
+
+            @Override
+            public String name() {
+              return tableName;
+            }
+
+            @Override
+            public Column[] columns() {
+              return new Column[0];
+            }
+
+            @Override
+            public Audit auditInfo() {
+              return null;
+            }
+          };
+    }
 
-    printResults(all);
+    printResults(gTables);
   }
 }
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/commands/SchemaDetails.java b/clients/cli/src/main/java/org/apache/gravitino/cli/commands/SchemaDetails.java
@@ -68,7 +68,7 @@ public void handle() {
     }
 
     if (result != null) {
-      printInformation(result.name() + "," + result.comment());
+      printResults(result);
     }
   }
 }
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/commands/TableDetails.java b/clients/cli/src/main/java/org/apache/gravitino/cli/commands/TableDetails.java
@@ -57,6 +57,8 @@ public void handle() {
       exitWithError(exp.getMessage());
     }
 
-    printInformation(gTable.name() + "," + gTable.comment());
+    if (gTable != null) {
+      printResults(gTable);
+    }
   }
 }
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/TableFormat.java b/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/TableFormat.java
@@ -47,7 +47,9 @@
 import java.util.Objects;
 import org.apache.gravitino.Catalog;
 import org.apache.gravitino.Metalake;
+import org.apache.gravitino.Schema;
 import org.apache.gravitino.cli.CommandContext;
+import org.apache.gravitino.rel.Table;
 
 /**
  * Abstract base class for formatting entity information into ASCII-art tables. Provides
@@ -75,6 +77,14 @@ public static void output(Object entity, CommandContext context) {
       new CatalogTableFormat(context).output((Catalog) entity);
     } else if (entity instanceof Catalog[]) {
       new CatalogListTableFormat(context).output((Catalog[]) entity);
+    } else if (entity instanceof Schema) {
+      new SchemaTableFormat(context).output((Schema) entity);
+    } else if (entity instanceof Schema[]) {
+      new SchemaListTableFormat(context).output((Schema[]) entity);
+    } else if (entity instanceof Table) {
+      new TableDetailsTableFormat(context).output((Table) entity);
+    } else if (entity instanceof Table[]) {
+      new TableListTableFormat(context).output((Table[]) entity);
     } else {
       throw new IllegalArgumentException("Unsupported object type");
     }
@@ -540,4 +550,97 @@ public String getOutput(Catalog[] catalogs) {
       return getTableFormat(columnName);
     }
   }
+
+  /**
+   * Formats a single {@link Schema} instance into a two-column table display. Displays catalog
+   * details including name and comment information.
+   */
+  static final class SchemaTableFormat extends TableFormat<Schema> {
+    public SchemaTableFormat(CommandContext context) {
+      super(context);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getOutput(Schema schema) {
+      Column columnName = new Column(context, "schema");
+      Column columnComment = new Column(context, "comment");
+
+      columnName.addCell(schema.name());
+      columnComment.addCell(schema.comment());
+
+      return getTableFormat(columnName, columnComment);
+    }
+  }
+
+  /**
+   * Formats an array of Schemas into a single-column table display. Lists all schema names in a
+   * vertical format.
+   */
+  static final class SchemaListTableFormat extends TableFormat<Schema[]> {
+    public SchemaListTableFormat(CommandContext context) {
+      super(context);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getOutput(Schema[] schemas) {
+      Column column = new Column(context, "schema");
+      Arrays.stream(schemas).forEach(schema -> column.addCell(schema.name()));
+
+      return getTableFormat(column);
+    }
+  }
+
+  /**
+   * Formats a single {@link Table} instance into a two-column table display. Displays table details
+   * including name and comment information.
+   */
+  static final class TableDetailsTableFormat extends TableFormat<Table> {
+    public TableDetailsTableFormat(CommandContext context) {
+      super(context);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getOutput(Table table) {
+      Column columnName = new Column(context, "name");
+      Column columnType = new Column(context, "type");
+      Column columnAutoIncrement = new Column(context, "AutoIncrement");
+      Column columnNullable = new Column(context, "nullable");
+      Column columnComment = new Column(context, "comment");
+
+      org.apache.gravitino.rel.Column[] columns = table.columns();
+      for (org.apache.gravitino.rel.Column column : columns) {
+        columnName.addCell(column.name());
+        columnType.addCell(column.dataType().simpleString());
+        columnAutoIncrement.addCell(column.autoIncrement());
+        columnNullable.addCell(column.nullable());
+        columnComment.addCell(
+            column.comment() == null || column.comment().isEmpty() ? "N/A" : column.comment());
+      }
+
+      return getTableFormat(
+          columnName, columnType, columnAutoIncrement, columnNullable, columnComment);
+    }
+  }
+
+  /**
+   * Formats an array of {@link Table} into a single-column table display. Lists all table names in
+   * a vertical format.
+   */
+  static final class TableListTableFormat extends TableFormat<Table[]> {
+    public TableListTableFormat(CommandContext context) {
+      super(context);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getOutput(Table[] tables) {
+      Column column = new Column(context, "table");
+      Arrays.stream(tables).forEach(table -> column.addCell(table.name()));
+
+      return getTableFormat(column);
+    }
+  }
 }