Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#5057] Added first part of CLI code #5058

Merged
merged 51 commits into from
Oct 24, 2024
Merged

[#5057] Added first part of CLI code #5058

merged 51 commits into from
Oct 24, 2024

Conversation

justinmclean
Copy link
Member

What changes were proposed in this pull request?

Added initial CLI to list information about metalakes, catalogs, schema and tables.

Why are the changes needed?

For a CLI.

Fix: #5057

Does this PR introduce any user-facing change?

No, but it add a new API.

How was this patch tested?

Unit test pass locally.

clients/cli/examples.sh Outdated Show resolved Hide resolved
clients/cli/README.md Outdated Show resolved Hide resolved
clients/cli/README.md Outdated Show resolved Hide resolved
clients/cli/build.gradle.kts Outdated Show resolved Hide resolved
clients/cli/examples.sh Outdated Show resolved Hide resolved
@justinmclean
Copy link
Member Author

@shaofengshi @diqiu50 @yuqi1129 @mchades if you could review agian that would be appreciated

@justinmclean justinmclean self-assigned this Oct 14, 2024
@shaofengshi
Copy link
Contributor

Hi Justin, my comments are all resolved now, thank you!

I see you have replied Jerry's comments; I think he suggests to move the document to gravitino project's "docs" folder (not in cli module) and make its style consistent with others; besides, the error.sh and example.sh are sample commands, not for execution, which can be a part of documentation? You'd better double confirm with him.

@jerryshao
Copy link
Contributor

jerryshao commented Oct 22, 2024

Hi Justin, my comments are all resolved now, thank you!

I see you have replied Jerry's comments; I think he suggests to move the document to gravitino project's "docs" folder (not in cli module) and make its style consistent with others; besides, the error.sh and example.sh are sample commands, not for execution, which can be a part of documentation? You'd better double confirm with him.

Yes, docs should be in the "docs" folder, and it is user-facing doc, so any other content like test/contribute is not necessary to add.

Besides, these two shell scripts are just for demo purposes, it is not so useful and can be covered by doc, I suggest that you remove these two scripts here. You can add a script for running cli easily, like "gravitino.sh", for example "gcli.sh", this can be done in the later PR, but it should be in the "bin" folder.

@justinmclean
Copy link
Member Author

All requested changes have been done, @jerryshao if you could please review, that would be appreciated.

@jerryshao jerryshao merged commit 3cd03fe into apache:main Oct 24, 2024
26 checks passed
mplmoknijb pushed a commit to mplmoknijb/gravitino that referenced this pull request Nov 6, 2024
### What changes were proposed in this pull request?

Added initial CLI to list information about metalakes, catalogs, schema
and tables.

### Why are the changes needed?

For a CLI.

Fix: apache#5057

### Does this PR introduce _any_ user-facing change?

No, but it add a new API.

### How was this patch tested?

Unit test pass locally.
@justinmclean justinmclean deleted the CLI branch December 9, 2024 01:03
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.

Add basic commands to Gravitino CLI
6 participants