Skip to content

docs: add example for microsoft onelake iceberg rest catalog #2796

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 4 commits into from
Dec 8, 2025
Merged

docs: add example for microsoft onelake iceberg rest catalog #2796

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a43d102
update configuration for microsoft fabric onelake
NNSatyaKarthik Dec 8, 2025
84db771
fix comments
NNSatyaKarthik Dec 8, 2025
cafb846
fix comments
NNSatyaKarthik Dec 8, 2025
0a72eab
fix comments
NNSatyaKarthik Dec 8, 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 @@ -573,6 +573,28 @@ catalog:

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

##### Microsoft OneLake Iceberg REST Catalog

See [OneLake table APIs for Iceberg](https://aka.ms/onelakeircdocs) for detailed documentation.

```yaml
catalog:
onelake_catalog:
type: rest
uri: https://onelake.table.fabric.microsoft.com/iceberg
warehouse: <fabric_workspace_id>/<fabric_data_item_id> # Example : DB0CE1EE-B014-47D3-8F0C-9D64C39C0FC2/F470A1D2-6D6D-4C9D-8796-46286C80B7C0
token: <token>,
adls.account-name: onelake,
adls.account-host: onelake.blob.fabric.microsoft.com,
adls.credential: <credential>
```

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

!!! Note "OneLake Authentication Models"
For Authentication: You can use DefautlAzureCredential from `azure.identity` package or refer to other [authentication flows](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-flows-app-scenarios) for detailed documentation.
<!-- 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