Skip to content

Commit aae3210

Browse files
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. -->
1 parent 65ba595 commit aae3210

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

mkdocs/docs/configuration.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,28 @@ catalog:
573573

574574
<!-- prettier-ignore-end -->
575575

576+
##### Microsoft OneLake Iceberg REST Catalog
577+
578+
See [OneLake table APIs for Iceberg](https://aka.ms/onelakeircdocs) for detailed documentation.
579+
580+
```yaml
581+
catalog:
582+
onelake_catalog:
583+
type: rest
584+
uri: https://onelake.table.fabric.microsoft.com/iceberg
585+
warehouse: <fabric_workspace_id>/<fabric_data_item_id> # Example : DB0CE1EE-B014-47D3-8F0C-9D64C39C0FC2/F470A1D2-6D6D-4C9D-8796-46286C80B7C0
586+
token: <token>,
587+
adls.account-name: onelake,
588+
adls.account-host: onelake.blob.fabric.microsoft.com,
589+
adls.credential: <credential>
590+
```
591+
592+
<!-- prettier-ignore-start -->
593+
594+
!!! Note "OneLake Authentication Models"
595+
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.
596+
<!-- prettier-ignore-end -->
597+
576598
### SQL Catalog
577599

578600
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):

0 commit comments

Comments
 (0)