Skip to content

docs: add GCP BigLake Metastore Catalog configuration example #2740

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
kevinjqliu merged 5 commits into from
Nov 13, 2025
Merged

docs: add GCP BigLake Metastore Catalog configuration example #2740

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9cfeeb1
docs: add GCP BigLake Metastore Catalog configuration example
Nov 11, 2025
73cb9b7
lint: fix
Nov 11, 2025
85ad88f
Merge branch 'apache:main' into docs/add-biglake-catalog-config
heathkh-recursion Nov 12, 2025
146c2e9
Update configuration.md
heathkh-recursion Nov 12, 2025
d8f8376
Update configuration.md
heathkh-recursion Nov 12, 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
22 changes: 22 additions & 0 deletions mkdocs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,28 @@ catalog:
type: noop
```

##### GCP BigLake Metastore Catalog REST

```yaml
catalog:
biglake_catalog:
type: rest
uri: https://biglake.googleapis.com/iceberg/v1/restcatalog
warehouse: gs://<bucket-name> # Use bq://projects/<gcp-project-id> for federation option (see docs)
auth:
type: google
header.x-goog-user-project: <gcp-project-id>
header.X-Iceberg-Access-Delegation: "" # For user-credentials authentication, set to empty string.
```

<!-- prettier-ignore-start -->

!!! Note "Metastore Authentication Models"
If your BigLake Metastore catalog is configured for "user credentials" authentication instead of "vendor credentials", set the `header.X-Iceberg-Access-Delegation` header to an empty string as shown above. Standard GCP Application Default Credentials (ADC) will be used to authenticate requests to the BigLake Metastore REST API.
You can retrieve the configuration details for your BigLake Iceberg catalog at the [GCP Console BigLake Metastore page](https://console.cloud.google.com/biglake/metastore/catalogs). Select your catalog, then find the necessary parameters such as `uri`, `warehouse`, and authentication method (e.g. user-creds or vendor).

<!-- prettier-ignore-end -->

### SQL Catalog

The SQL catalog requires a database for its backend. PyIceberg supports PostgreSQL and SQLite through psycopg2. The database connection has to be configured using the `uri` property. The init_catalog_tables is optional and defaults to True. If it is set to False, the catalog tables will not be created when the SQLCatalog is initialized. See SQLAlchemy's [documentation for URL format](https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls):
Expand Down