Skip to content

[doc]: Doc fix for CLI usage #3215

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
MonkeyCanCode merged 2 commits into from
Dec 16, 2025
Merged

[doc]: Doc fix for CLI usage #3215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d47632
Doc fix for CLI usage
MonkeyCanCode Dec 5, 2025
ab9a08f
Change catalog connection type for iceberg to iceberg-rest
MonkeyCanCode Dec 16, 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
2 changes: 1 addition & 1 deletion client/python/apache_polaris/cli/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ class Update:

class External:
CATALOG_CONNECTION_TYPE = (
"The type of external catalog in [ICEBERG, HADOOP, HIVE]."
"The type of external catalog in [ICEBERG-REST, HADOOP, HIVE]."
)
CATALOG_AUTHENTICATION_TYPE = (
"The type of authentication in [OAUTH, BEARER, SIGV4, IMPLICIT]"
Expand Down
4 changes: 3 additions & 1 deletion 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 @@ -40,6 +40,7 @@ options:
--header
--profile
--proxy
--debug
```

`COMMAND` must be one of the following:
Expand Down Expand Up @@ -146,6 +147,7 @@ options:
--endpoint (Only for S3) The S3 endpoint to use when connecting to S3
--endpoint-internal (Only for S3) The S3 endpoint used by Polaris to use when connecting to S3, if different from the one that clients use
--sts-endpoint (Only for S3) The STS endpoint to use when connecting to STS
--no-sts (Only for S3) Indicates that Polaris should not use STS (e.g. if STS is not available)
--path-style-access (Only for S3) Whether to use path-style-access for S3
--allowed-location An allowed location for files tracked by the catalog. Multiple locations can be provided by specifying this option more than once.
--role-arn (Only for AWS S3) A role ARN to use when connecting to S3
Expand All @@ -156,7 +158,7 @@ options:
--consent-url (Only for Azure) A consent URL granting permissions for the Azure Storage location
--service-account (Only for GCS) The service account to use when connecting to GCS
--property A key/value pair such as: tag=value. Multiple can be provided by specifying this option more than once
--catalog-connection-type The type of external catalog in [iceberg-rest, hadoop, hive].
--catalog-connection-type The type of external catalog in [ICEBERG-REST, HADOOP, HIVE].
--iceberg-remote-catalog-name The remote catalog name when federating to an Iceberg REST catalog
--hadoop-warehouse The warehouse to use when federating to a HADOOP catalog
--hive-warehouse The warehouse to use when federating to a HIVE catalog
Expand Down
Loading