Skip to content

[#5822] Print Help information when the help option is passed#5852

Merged
shaofengshi merged 9 commits intoapache:mainfrom
Abyss-lord:improvement-help
Dec 17, 2024
Merged

[#5822] Print Help information when the help option is passed#5852
shaofengshi merged 9 commits intoapache:mainfrom
Abyss-lord:improvement-help

Conversation

@Abyss-lord
Copy link
Contributor

What changes were proposed in this pull request?

This is a small improvement, previously, typing entity help will displays the help information for that entity. Now, the entity --help command will have the same effect.

Why are the changes needed?

Fix: #5822

Does this PR introduce any user-facing change?

No

How was this patch tested?

bin/gcli.sh metalake [--help|help]
# metalake help information

bin/gcli.sh catalog [--help|help]
# catalog help information

bin/gcli.sh schema [--help|help]
# schema help information

bin/gcli.sh table [--help|help]
# table help information

bin/gcli.sh column [--help|help]
# column help information

bin/gcli.sh fileset [--help|help]
# fileset help information

bin/gcli.sh group [--help|help]
# group help information

bin/gcli.sh role [--help|help]
# role help information

bin/gcli.sh topic [--help|help]
# topic help information

bin/gcli.sh user [--help|help]
# user help information

bin/gcli.sh catalog -m demo_metalake --name Hive_catalog
# correct details output

@Abyss-lord
Copy link
Contributor Author

Hi @justinmclean @xunliu, would you mind reviewing my code when you have a moment?

@Abyss-lord Abyss-lord changed the title Print Help information when the help option is passed [#5822] Print Help information when the help option is passed Dec 15, 2024
@justinmclean
Copy link
Member

The help files have already been added in PR #5809

@Abyss-lord
Copy link
Contributor Author

The help files have already been added in PR #5809

ok @justinmclean , than I just change the code and delete the help file

@Abyss-lord
Copy link
Contributor Author

Hi @justinmclean, I just remove those help files

…option is passed

Previously, typing "entity help" displays the help information for that entity. Now, the "entity -help" command will have the same effect.
Add help files for multiple entities(column, fileset, group, role, table, tag, topic, user)
…option is passed

move help option check to resolveCommand
…option is passed

add test to entity + --help option.
Copy link
Member

@justinmclean justinmclean left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for your contribution

Copy link
Contributor

@shaofengshi shaofengshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shaofengshi shaofengshi merged commit 4a3e717 into apache:main Dec 17, 2024
@Abyss-lord Abyss-lord deleted the improvement-help branch December 17, 2024 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Improvement] In the Gravitino CLI have "gcli metalake --help" and "gcli metalake help" produce the help output

4 participants