Skip to content

Conversation

@heathkh-recursion
Copy link
Contributor

@heathkh-recursion heathkh-recursion commented Nov 11, 2025

  • Adds documentation example for configuring Google BigLake Metastore as a REST catalog
  • Includes configuration example with proper authentication setup

Rationale for this change

GCP had the GA release of the BigLake Metastore Catalog Iceberg REST api Nov 30 (see release notes). There are few GCP docs available how to set this up in general, and with pyiceberg specifically. Ray Data and probably many other tools use pyiceberg under the hood, so documenting this would make it much easier for folks in the GCP cloud to use pyiceberg at scale.

Are these changes tested?

Yes, using the following test plan:

  • Configuration tested to work with pyiceberg 0.10.0 and Google BigLake Metastore (Nov 11, 2025)
  • Documentation builds successfully
  • Configuration example follows existing format and style
  • Added links are valid

Are there any user-facing changes?

Would add a new section in the docs when docs are published.

Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

Can the warehouse be of type bq://projects/PROJECT_ID? As shown here:
https://docs.cloud.google.com/biglake/docs/blms-rest-catalog#configure-catalog

If applicable, should we add a note?

Copy link
Contributor

@rambleraptor rambleraptor left a comment

Choose a reason for hiding this comment

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

This looks awesome! Thanks for doing this.

Add note about warehouse uri format for the federation option (bq:// ).
@heathkh-recursion
Copy link
Contributor Author

Can the warehouse be of type bq://projects/PROJECT_ID? As shown here: https://docs.cloud.google.com/biglake/docs/blms-rest-catalog#configure-catalog

If applicable, should we add a note?

Added a comment about the bq:// alternative

Add extend bq uri example
Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

Thanks!

@heathkh-recursion
Copy link
Contributor Author

Is there a process for requesting review by someone with write permissions?

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

I ran make docs-serve locally
Image

@kevinjqliu
Copy link
Contributor

"BigLake Metastore Catalog Iceberg REST" is a mouthful 😅

@kevinjqliu kevinjqliu merged commit f2131e6 into apache:main Nov 13, 2025
2 checks passed
@kevinjqliu
Copy link
Contributor

Thanks for the PR @heathkh-recursion and thanks for the review @rambleraptor @raulcd

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.

4 participants