[#5057] Added first part of CLI code

clients/cli/bin/errors.sh

@@ -21,28 +21,29 @@
 
 # Some of these examples assume you have the Apache Gravitino playground running.
 
-alias gcli='java -jar clients/cli/build/libs/gravitino-cli-0.7.0-incubating-SNAPSHOT.jar'
+shopt -s expand_aliases
+alias gcli='java -jar ../../cli/build/libs/gravitino-cli-*-incubating-SNAPSHOT.jar'
 
 # No such command
 gcli unknown
 
 # unknown command and entiry
-gcli unknown --unknown
+gcli unknown unknown
 
 # unknown command 
-gcli metalake --unknown
+gcli metalake unknown
 
 # unknown entity 
-gcli unknown --list
+gcli unknown list
 
 # Name not specified 
-gcli metalake --details
+gcli metalake details
 
 # Unknown metalake name
-gcli metalake --details --name unknown
+gcli metalake details --name unknown
 
 # Unknown catalog name
-gcli catalog --details --name metalake_demo.unknown
+gcli catalog details --name metalake_demo.unknown
 
 # Missing catalog name
-gcli catalog --details --name metalake_demo
+gcli catalog details --name metalake_demo

clients/cli/bin/examples.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -17,12 +19,11 @@
 # under the License.
 #
 
-#!/bin/bash
-
 # These examples assume you have the Apache Gravitino playground running.
 
 unset GRAVITINO_METALAKE
-alias gcli='java -jar clients/cli/build/libs/gravitino-cli-0.7.0-incubating-SNAPSHOT.jar'
+shopt -s expand_aliases
+alias gcli='java -jar ../../cli/build/libs/gravitino-cli-*-incubating-SNAPSHOT.jar'
 
 # display help
 gcli --help
@@ -31,73 +32,75 @@ gcli --help
 gcli --version
 
 # metalake details
-gcli --details
+gcli details
 
 # metalake list
-gcli --list
+gcli list
 
 # list all catalogs in a metalake 
-gcli metalake --list --name metalake_demo
+gcli metalake list --metalake metalake_demo
 
 # list catalog schema
-gcli catalog --list --name metalake_demo.catalog_iceberg
-gcli catalog --list --name metalake_demo.catalog_mysql
-gcli catalog --list --name metalake_demo.catalog_postgres
-gcli catalog --list --name metalake_demo.catalog_hive
+gcli catalog list --metalake metalake_demo --name catalog_iceberg
+gcli catalog list --metalake metalake_demo --name catalog_mysql
+gcli catalog list --metalake metalake_demo --name catalog_postgres
+gcli catalog list --metalake metalake_demo --name catalog_hive
 
 # list catalog details
-gcli catalog --details --name metalake_demo.catalog_iceberg
-gcli catalog --details --name metalake_demo.catalog_mysql
-gcli catalog --details --name metalake_demo.catalog_postgres
-gcli catalog --details --name metalake_demo.catalog_hive
+gcli catalog details --metalake metalake_demo --name catalog_iceberg
+gcli catalog details --metalake metalake_demo --name catalog_mysql
+gcli catalog details --metalake metalake_demo --name catalog_postgres
+gcli catalog details --metalake metalake_demo --name catalog_hive
 
 # list schema tables
-gcli schema --list --name metalake_demo.catalog_postgres.hr
-gcli schema --list --name metalake_demo.catalog_mysql.db
-gcli schema --list --name metalake_demo.catalog_hive.sales
+gcli schema list --metalake metalake_demo --name catalog_postgres.hr
+gcli schema list --metalake metalake_demo --name catalog_mysql.db
+gcli schema list --metalake metalake_demo --name catalog_hive.sales
 
 # list schema details
-gcli schema --details --name metalake_demo.catalog_postgres.hr
-gcli schema --details --name metalake_demo.catalog_mysql.db
-gcli schema --details --name metalake_demo.catalog_hive.sales
+gcli schema details --metalake metalake_demo --name catalog_postgres.hr
+gcli schema details --metalake metalake_demo --name catalog_mysql.db
+gcli schema details --metalake metalake_demo --name catalog_hive.sales
 
 # list table details
-gcli table --list --name metalake_demo.catalog_postgres.hr.departments
-gcli table --list --name metalake_demo.catalog_mysql.db.iceberg_tables
-gcli table --list --name metalake_demo.catalog_hive.sales.products
+gcli table list --metalake metalake_demo --name catalog_postgres.hr.departments
+gcli table list --metalake metalake_demo --name catalog_mysql.db.iceberg_tables
+gcli table list --metalake metalake_demo --name catalog_hive.sales.products
 
 # Exmaples where metalake is set in an evironment variable
 export GRAVITINO_METALAKE=metalake_demo
 
 # metalake details
-gcli metalake --details
+gcli metalake details
 
 # list all catalogs in a metalake 
-gcli metalake --list
+gcli metalake list
 
 # list catalog schema
-gcli catalog --list --name catalog_iceberg
-gcli catalog --list --name catalog_mysql
-gcli catalog --list --name catalog_postgres
-gcli catalog --list --name catalog_hive
+gcli catalog list --name catalog_iceberg
+gcli catalog list --name catalog_mysql
+gcli catalog list --name catalog_postgres
+gcli catalog list --name catalog_hive
 
 # list catalog details
-gcli catalog --details --name catalog_iceberg
-gcli catalog --details --name catalog_mysql
-gcli catalog --details --name catalog_postgres
-gcli catalog --details --name catalog_hive
+gcli catalog details --name catalog_iceberg
+gcli catalog details --name catalog_mysql
+gcli catalog details --name catalog_postgres
+gcli catalog details --name catalog_hive
 
 # list schema tables
-gcli schema --list --name catalog_postgres.hr
-gcli schema --list --name catalog_mysql.db
-gcli schema --list --name catalog_hive.sales
+gcli schema list --name catalog_postgres.hr
+gcli schema list --name catalog_mysql.db
+gcli schema list --name catalog_hive.sales
 
 # list schema details
-gcli schema --details --name catalog_postgres.hr
-gcli schema --details --name catalog_mysql.db
-gcli schema --details --name catalog_hive.sales
+gcli schema details --name catalog_postgres.hr
+gcli schema details --name catalog_mysql.db
+gcli schema details --name catalog_hive.sales
 
 # list table details
-gcli table --list --name catalog_postgres.hr.departments
-gcli table --list --name catalog_mysql.db.iceberg_tables
-gcli table --list --name catalog_hive.sales.products
+gcli table list --name catalog_postgres.hr.departments
+gcli table list --name catalog_mysql.db.iceberg_tables
+gcli table list --name catalog_hive.sales.products
+
+unset GRAVITINO_METALAKE

clients/cli/docs/README.md

@@ -17,7 +17,7 @@
   under the License.
 -->
 
-# Apache Gravitino CLI
+# Apache Gravitino Command Line Interface
 
 Apache Gravitino CLI is a command-line tool that interacts with the Gravitino server to manage and query entities like metalakes, catalogs, schemas, and tables. The tool provides options for listing information about Gravitino entities and in future versions support creating, deleting, and updating these entities.
 
@@ -76,46 +76,60 @@ To run the Gravitino CLI, use the following command structure:
 ```bash
 usage: gcli [metalake|catalog|schema|table] [list|details|create|delete|update] [options]
 Options
- -C,--create       create an entity
- -D,--details      list details about an entity
  -f,--name <arg>   full entity name (dot separated)
  -h,--help         command help information
  -L,--list         list entity children
  -r,--server       Gravitino server version
- -R,--delete       delete an entity
  -u,--url <arg>    Gravitino URL (default: http://localhost:8090)
- -U,--update       update an entity
  -v,--version      Gravitino client version
 ```
 
 ## Commands
 The following commands are available for entity management:
 
---list: List available entities
---details: Show detailed information about an entity
---create: Create a new entity
---delete: Delete an existing entity
---update: Update an existing entity
+- list: List available entities
+- details: Show detailed information about an entity
+- create: Create a new entity
+- delete: Delete an existing entity
+- update: Update an existing entity
 
 ### Examples
 List All Metalakes
 
 ```bash
-gcli --list
+gcli list
 ```
 
 Get Details of a Specific Metalake
 
 ```bash
-gcli metalake --details -name my-metalake
+gcli metalake details --metalake my-metalake
 ```
 
 List Tables in a Catalog
 
 ```bash
-gcli metalake --list -name my-metalake
+gcli metalake list --metalake my-metalake
 ```
 
+### Setting the Metalake name
+
+As dealing with one Metalake is a typical scenario, you can set the Metalake name in several ways.
+
+1. Passed in on the command line via the `--metalake` parameter.
+2. Set via the 'GRAVITINO_METALAKE' environment variable.
+
+The command line option overrides the environment variable.
+
+### Setting the Gravitino URL
+
+As you need to set the Gravitino URL for every command, you can set the URL in several ways.
+
+1. Passed in on the command line via the `--url` parameter.
+2. Set via the 'GRAVITINO_URL' environment variable.
+
+The command line option overrides the environment variable.
+
 ## Running Tests
 
 This project includes a suite of unit tests to verify its functionality.

clients/cli/src/main/java/org/apache/gravitino/cli/FullName.java

@@ -39,12 +39,17 @@ public FullName(CommandLine line) {
   }
 
   /**
-   * Retrieves the metalake name from the command line options, environment variables, or the first
-   * part of the full name.
+   * Retrieves the metalake name from the command line options, the GRAVITINO_METALAKE environment
+   * variable.
    *
    * @return The metalake name, or null if not found.
    */
   public String getMetalakeName() {
+    // If specified on the command line use that
+    if (line.hasOption(GravitinoOptions.METALAKE)) {
+      return line.getOptionValue(GravitinoOptions.METALAKE);
+    }
+
     // Cache the metalake environment variable
     if (metalakeEnv == null) {
       metalakeEnv = System.getenv("GRAVITINO_METALAKE");
@@ -53,9 +58,6 @@ public String getMetalakeName() {
     // Check if the metalake name is set as an environment variable
     if (metalakeEnv != null) {
       return metalakeEnv;
-      // Extract the metalake name from the full name option
-    } else if (line.hasOption(GravitinoOptions.NAME)) {
-      return line.getOptionValue(GravitinoOptions.NAME).split("\\.")[0];
     }
 
     return null;
@@ -67,7 +69,7 @@ public String getMetalakeName() {
    * @return The catalog name, or null if not found.
    */
   public String getCatalogName() {
-    return getNamePart(1);
+    return getNamePart(0);
   }
 
   /**
@@ -76,7 +78,7 @@ public String getCatalogName() {
    * @return The schema name, or null if not found.
    */
   public String getSchemaName() {
-    return getNamePart(2);
+    return getNamePart(1);
   }
 
   /**
@@ -85,7 +87,7 @@ public String getSchemaName() {
    * @return The table name, or null if not found.
    */
   public String getTableName() {
-    return getNamePart(3);
+    return getNamePart(2);
   }
 
   /**
@@ -100,13 +102,7 @@ public String getNamePart(int position) {
     if (line.hasOption(GravitinoOptions.NAME)) {
       String[] names = line.getOptionValue(GravitinoOptions.NAME).split("\\.");
 
-      /* Adjust position if metalake is part of the full name. */
-      String metalakeEnv = System.getenv("GRAVITINO_METALAKE");
-      if (metalakeEnv != null) {
-        position = position - 1;
-      }
-
-      if (names.length < position) {
+      if (names.length <= position) {
         System.err.println(ErrorMessages.MALFORMED_NAME);
         return null;
       }

clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java

@@ -42,6 +42,7 @@ public class GravitinoCommandLine {
   private Options options;
   private String entity;
   private String command;
+  private String urlEnv;
 
   public static final String CMD = "gcli"; // recommended name
   public static final String DEFAULT_URL = "http://localhost:8090";
@@ -182,13 +183,28 @@ protected void handleGeneralCommand() {
   }
 
   /**
-   * Gets the Gravitino URL from the command line options, or returns the default URL.
+   * Retrieves the Gravitinno URL from the command line options or the GRAVITINO_URL environment
+   * variable.
    *
-   * @return The Gravitino URL to be used.
+   * @return The Gravitinno URL, or null if not found.
    */
-  protected String getUrl() {
-    return line.hasOption(GravitinoOptions.URL)
-        ? line.getOptionValue(GravitinoOptions.URL)
-        : DEFAULT_URL;
+  public String getUrl() {
+    // If specified on the command line use that
+    if (line.hasOption(GravitinoOptions.URL)) {
+      return line.getOptionValue(GravitinoOptions.URL);
+    }
+
+    // Cache the Gravitino URL environment variable
+    if (urlEnv == null) {
+      urlEnv = System.getenv("GRAVITINO_URL");
+    }
+
+    // If set return the Gravitino URL environment variable
+    if (urlEnv != null) {
+      return urlEnv;
+    }
+
+    // Return the default localhost URL
+    return DEFAULT_URL;
   }
 }

clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoOptions.java

@@ -29,11 +29,7 @@ public class GravitinoOptions {
   public static final String SERVER = "server";
   public static final String URL = "url";
   public static final String NAME = "name";
-  public static final String LIST = "list";
-  public static final String DETAILS = "details";
-  public static final String CREATE = "create";
-  public static final String UPDATE = "update";
-  public static final String DELETE = "delete";
+  public static final String METALAKE = "metalake";
 
   /**
    * Builds and returns the CLI options for Gravitino.
@@ -49,13 +45,7 @@ public Options options() {
     options.addOption(createSimpleOption("r", SERVER, "Gravitino server version"));
     options.addOption(createArgOption("u", URL, "Gravitino URL (default: http://localhost:8090)"));
     options.addOption(createArgOption("f", NAME, "full entity name (dot separated)"));
-
-    //  specifying the command
-    options.addOption(createSimpleOption("L", LIST, "list entity children"));
-    options.addOption(createSimpleOption("D", DETAILS, "list details about an entity"));
-    options.addOption(createSimpleOption("C", CREATE, "create an entity"));
-    options.addOption(createSimpleOption("U", UPDATE, "update an entity"));
-    options.addOption(createSimpleOption("R", DELETE, "delete an entity"));
+    options.addOption(createArgOption("m", METALAKE, "Metalake"));
 
     return options;
   }