Skip to content

feat: support listing known catalogs #2088

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

Merged
merged 1 commit into from
Jun 14, 2025

Conversation

Anton-Tarazi
Copy link
Contributor

Adds a new function pyiceberg.catalog.list_catalogs() -> List[str] to list all known catalogs.

Rationale for this change

In creating a pyiceberg-backed API, one must either duplicate the config-parsing logic or access private data in order to know what catalogs are available in the env. I believe that this logic should be part of the library.

Are these changes tested?

Yes

Are there any user-facing changes?

Yes, knew public function in pyiceberg.catalog

Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM this is a great addition!

@kevinjqliu kevinjqliu merged commit 93931e4 into apache:main Jun 14, 2025
10 checks passed
Fokko pushed a commit that referenced this pull request Jun 24, 2025
<!--
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
`make test` fails locally since `Config().get_known_catalogs()` also
reads my local `~/.pyiceberg.yaml`

Follow up to #2088

# Are these changes tested?

# Are there any user-facing changes?

<!-- In the case of user-facing changes, please add the changelog label.
-->
amitgilad3 pushed a commit to amitgilad3/iceberg-python that referenced this pull request Jul 7, 2025
<!--
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} -->

Adds a new function `pyiceberg.catalog.list_catalogs() -> List[str]` to
list all known catalogs.

# Rationale for this change
In creating a pyiceberg-backed API, one must either duplicate the
config-parsing logic or access private data in order to know what
catalogs are available in the env. I believe that this logic should be
part of the library.

# Are these changes tested?
Yes

# Are there any user-facing changes?
Yes, knew public function in `pyiceberg.catalog`

<!-- In the case of user-facing changes, please add the changelog label.
-->
amitgilad3 pushed a commit to amitgilad3/iceberg-python that referenced this pull request Jul 7, 2025
<!--
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
`make test` fails locally since `Config().get_known_catalogs()` also
reads my local `~/.pyiceberg.yaml`

Follow up to apache#2088

# Are these changes tested?

# Are there any user-facing changes?

<!-- In the case of user-facing changes, please add the changelog label.
-->
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.

2 participants