Skip to content

Commit abae20f

Browse files
authored
docs: Update pyiceberg CLI help docs (#2793)
Hi folks, big fan of Iceberg! I noticed a tiny change in the cli docs. Correcting it here. <!-- Thanks for opening a pull request! --> <!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. --> <!-- Closes #${GITHUB_ISSUE_ID} --> # 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 <!-- In the case of user-facing changes, please add the changelog label. -->
1 parent 8ed913b commit abae20f

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

mkdocs/docs/cli.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,28 @@ You can pass the path to the Catalog using the `--uri` and `--credential` argume
3333
Usage: pyiceberg [OPTIONS] COMMAND [ARGS]...
3434

3535
Options:
36-
--catalog TEXT
37-
--verbose BOOLEAN
38-
--output [text|json]
39-
--ugi TEXT
40-
--uri TEXT
41-
--credential TEXT
42-
--help Show this message and exit.
36+
--catalog TEXT
37+
--verbose BOOLEAN
38+
--output [text|json]
39+
--ugi TEXT
40+
--uri TEXT
41+
--credential TEXT
42+
--help Show this message and exit.
4343

4444
Commands:
45-
describe Describes a namespace xor table
46-
drop Operations to drop a namespace or table
47-
list Lists tables or namespaces
48-
location Returns the location of the table
49-
properties Properties on tables/namespaces
50-
rename Renames a table
51-
schema Gets the schema of the table
52-
spec Returns the partition spec of the table
53-
uuid Returns the UUID of the table
45+
create Operation to create a namespace.
46+
describe Describe a namespace or a table.
47+
drop Operations to drop a namespace or table.
48+
files List all the files of the table.
49+
list List tables or namespaces.
50+
list-refs List all the refs in the provided table.
51+
location Return the location of the table.
52+
properties Properties on tables/namespaces.
53+
rename Rename a table.
54+
schema Get the schema of the table.
55+
spec Return the partition spec of the table.
56+
uuid Return the UUID of the table.
57+
version Print pyiceberg version.
5458
```
5559

5660
This example assumes that you have a default catalog set. If you want to load another catalog, for example, the rest example above. Then you need to set `--catalog rest`.

0 commit comments

Comments
 (0)