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 20b796031 [#5782][Improvement] Add extended help for schema in
Gravitino CLI (#5789)
20b796031 is described below
commit 20b796031caecf45351e2116b57bd696b93507b9
Author: Suvaid <81421914+suvaidk...@users.noreply.github.com>
AuthorDate: Mon Dec 9 03:09:54 2024 +0530
[#5782][Improvement] Add extended help for schema in Gravitino CLI (#5789)
What changes were proposed in this pull request?
Add extended help for schema in Gravitino CLI
Why are the changes needed?
To provide user with extra help.
Fix: https://github.com/apache/gravitino/issues/5782
Does this PR introduce any user-facing change?
No.
How was this patch tested?
N/A
---
clients/cli/src/main/resources/schema_help.txt | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/clients/cli/src/main/resources/schema_help.txt
b/clients/cli/src/main/resources/schema_help.txt
new file mode 100644
index 000000000..2f8fa3e8b
--- /dev/null
+++ b/clients/cli/src/main/resources/schema_help.txt
@@ -0,0 +1,21 @@
+gcli schema [list|details|create|properties]
+
+Please set the metalake in the Gravitino configuration file or the environment
variable before running any of these commands.
+Setting and removing schema properties is not currently supported by the Java
API or the Gravitino CLI.
+
+Example commands
+
+Show all schemas in a catalog
+gcli schema list --name catalog_postgres
+
+Show schema details
+gcli schema details --name catalog_postgres.hr
+
+Show schema audit information
+gcli schema details --name catalog_postgres.hr --audit
+
+Create a schema
+gcli schema create --name catalog_postgres.new_db
+
+Display schema properties
+gcli schema properties --name catalog_postgres.hr -i
\ No newline at end of file
