diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 5219010279..e42ea1da80 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -573,6 +573,28 @@ catalog: +##### 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: / # Example : DB0CE1EE-B014-47D3-8F0C-9D64C39C0FC2/F470A1D2-6D6D-4C9D-8796-46286C80B7C0 + token: , + adls.account-name: onelake, + adls.account-host: onelake.blob.fabric.microsoft.com, + adls.credential: +``` + + + +!!! 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. + + ### 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):