-
Notifications
You must be signed in to change notification settings - Fork 411
docs: Update pyiceberg CLI help docs #2793
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
Conversation
Hi folks, big fan of Iceberg! I noticed a tiny change in the cli docs. Correcting it here
Fokko
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was actually a joke from my end, xor referring to exclusive-or :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @el10savio,
Thanks for fixing this! It looks like this help message is out of date would you mind updating the output? We could also fix in a follow up
Options:
--catalog TEXT
--verbose BOOLEAN
--output [text|json]
--ugi TEXT
--uri TEXT
--credential TEXT
--help Show this message and exit.
Commands:
create Operation to create a namespace.
describe Describe a namespace or a table.
drop Operations to drop a namespace or table.
files List all the files of the table.
list List tables or namespaces.
list-refs List all the refs in the provided table.
location Return the location of the table.
properties Properties on tables/namespaces.
rename Rename a table.
schema Get the schema of the table.
spec Return the partition spec of the table.
uuid Return the UUID of the table.
version Print pyiceberg version.
|
Sure thing, I can update my PR to have the above output |
cli.md
geruh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! The CLI is super cool! It gives you a easy way to query a catalog and view table data.
kevinjqliu
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
thanks for updating the docs @el10savio and thanks for the review everyone :) |
|
also kicking off the release docs github action https://github.com/apache/iceberg-python/actions/runs/19945154037 |
|
anddddd its live! https://py.iceberg.apache.org/cli/ |

Hi folks, big fan of Iceberg! I noticed a tiny change in the cli docs. Correcting it here.
Rationale for this change
Fix docs.
Are these changes tested?
No tests against docs.
Are there any user-facing changes?
Should now reflect in https://py.iceberg.apache.org/cli/#python-cli