This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
The following commit(s) were added to refs/heads/main by this push:
new aae32108 docs: add example for microsoft onelake iceberg rest catalog
(#2796)
aae32108 is described below
commit aae32108593331dab16987f7e26d234a5df204cb
Author: NNSatyaKarthik <[email protected]>
AuthorDate: Mon Dec 8 15:08:08 2025 -0800
docs: add example for microsoft onelake iceberg rest catalog (#2796)
<!--
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
Adding a configuration for Microsoft Fabric OneLake catalog in [Common
Integrations &
Examples](https://py.iceberg.apache.org/configuration/#common-integrations-examples)
<img width="859" height="329" alt="image"
src="https://github.com/user-attachments/assets/5ccb3b0f-e42f-46ed-aecf-0303a6139aa2";
/>
## Are these changes tested?
Not needed - only documentation change.
## Are there any user-facing changes?
Yes - only documentation chnages.
<!-- In the case of user-facing changes, please add the changelog label.
-->
---
mkdocs/docs/configuration.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md
index 52190102..e42ea1da 100644
--- a/mkdocs/docs/configuration.md
+++ b/mkdocs/docs/configuration.md
@@ -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):
