This is an automated email from the ASF dual-hosted git repository.
jshao 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 1fa31013a4 [Minor] Update command usage and add usage tracker in
Gravitino CLI (#6137)
1fa31013a4 is described below
commit 1fa31013a40b7a2d98988b29370e12a6b7abf94e
Author: Justin Mclean <[email protected]>
AuthorDate: Mon Jan 13 15:12:34 2025 +1100
[Minor] Update command usage and add usage tracker in Gravitino CLI (#6137)
### What changes were proposed in this pull request?
Update command usage and add usage tracker
### Why are the changes needed?
So everything is up to date and we can see many many people look up the
CLI docs.
Fix: # N/A
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Tested locally.
---
docs/cli.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/docs/cli.md b/docs/cli.md
index 0cc7dee4af..0598a36e03 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -30,13 +30,17 @@ The general structure for running commands with the
Gravitino CLI is `gcli entit
usage: gcli
[metalake|catalog|schema|model|table|column|user|group|tag|topic|fileset]
[list|details|create|delete|update|set|remove|properties|revoke|grant] [options]
Options
usage: gcli
- -a,--audit display audit information
+ -a,--audit display audit information
+ --alias <arg> model aliases
+ --all all operation for --enable
--auto <arg> column value auto-increments (true/false)
-c,--comment <arg> entity comment
--columnfile <arg> CSV file describing columns
-d,--distribution display distribution information
--datatype <arg> column data type
--default <arg> default column value
+ --disable disable entities
+ --enable enable entities
-f,--force force operation
-g,--group <arg> group name
-h,--help command help information
@@ -52,6 +56,7 @@ The general structure for running commands with the Gravitino
CLI is `gcli entit
-p,--properties <arg> property name/value pairs
--partition display partition information
--position <arg> position of column
+ --privilege <arg> privilege(s)
-r,--role <arg> role name
--rename <arg> new entity name
-s,--server Gravitino server version
@@ -59,6 +64,7 @@ The general structure for running commands with the Gravitino
CLI is `gcli entit
--sortorder display sortorder information
-t,--tag <arg> tag name
-u,--url <arg> Gravitino URL (default: http://localhost:8090)
+ --uri <arg> model version artifact
-v,--version Gravitino client version
-V,--value <arg> property value
-x,--index display index information
@@ -950,4 +956,6 @@ gcli <normal command> --simple
```bash
gcli <normal command> --simple --login userName
-```
\ No newline at end of file
+```
+
+<img
src="https://analytics.apache.org/matomo.php?idsite=62&rec=1&bots=1&action_name=CLI";
alt="" />
\ No newline at end of file
