Skip to content

Fix doc for CLI update #1994

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.

Sign up for GitHub

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

Merged
eric-maynard merged 2 commits into from
Jul 2, 2025
Merged

Fix doc for CLI update #1994

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d91f0a
Fix doc for catalog update
MonkeyCanCode Jul 2, 2025
7631d51
Fix doc for update
MonkeyCanCode Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions site/content/in-dev/unreleased/command-line-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,9 +251,11 @@ input: polaris catalogs update --help
options:
update
Named arguments:
--default-base-location (Required) Default base location of the catalog
--default-base-location A new default base location for the catalog
--allowed-location An allowed location for files tracked by the catalog. Multiple locations can be provided by specifying this option more than once.
--property A key/value pair such as: tag=value. Multiple can be provided by specifying this option more than once
--region (Only for S3) The region to use when connecting to S3
--set-property A key/value pair such as: tag=value. Merges the specified key/value into an existing properties map by updating the value if the key already exists or creating a new entry if not. Multiple can be provided by specifying this option more than once
--remove-property A key to remove from a properties map. If the key already does not exist then no action is takn for the specified key. If properties are also being set in the same update command then the list of removals is applied last. Multiple can be provided by specifying this option more than once
Positional arguments:
catalog
```
Expand Down Expand Up @@ -382,7 +384,8 @@ input: polaris principals update --help
options:
update
Named arguments:
--property A key/value pair such as: tag=value. Multiple can be provided by specifying this option more than once
--set-property A key/value pair such as: tag=value. Merges the specified key/value into an existing properties map by updating the value if the key already exists or creating a new entry if not. Multiple can be provided by specifying this option more than once
--remove-property A key to remove from a properties map. If the key already does not exist then no action is takn for the specified key. If properties are also being set in the same update command then the list of removals is applied last. Multiple can be provided by specifying this option more than once
Positional arguments:
principal
```
Expand Down Expand Up @@ -521,7 +524,8 @@ input: polaris principal-roles update --help
options:
update
Named arguments:
--property A key/value pair such as: tag=value. Multiple can be provided by specifying this option more than once
--set-property A key/value pair such as: tag=value. Merges the specified key/value into an existing properties map by updating the value if the key already exists or creating a new entry if not. Multiple can be provided by specifying this option more than once
--remove-property A key to remove from a properties map. If the key already does not exist then no action is takn for the specified key. If properties are also being set in the same update command then the list of removals is applied last. Multiple can be provided by specifying this option more than once
Positional arguments:
principal_role
```
Expand Down Expand Up @@ -691,7 +695,8 @@ options:
update
Named arguments:
--catalog The name of an existing catalog
--property A key/value pair such as: tag=value. Multiple can be provided by specifying this option more than once
--set-property A key/value pair such as: tag=value. Merges the specified key/value into an existing properties map by updating the value if the key already exists or creating a new entry if not. Multiple can be provided by specifying this option more than once
--remove-property A key to remove from a properties map. If the key already does not exist then no action is takn for the specified key. If properties are also being set in the same update command then the list of removals is applied last. Multiple can be provided by specifying this option more than once
Positional arguments:
catalog_role
```
Expand Down
Loading