docs(transformations): add external data sources guide - #2734
Conversation
Walks through registering a Fabric OneLake data source, checking that it is usable, reading its tables from transformation SQL with ext_onelake(), rotating the client secret and deleting the data source. The page is reached from the Transformations page and cross-references the API and data class reference there instead of repeating the autosummary and automodule directives.
30aa933 to
9d04c3a
Compare
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for the new External Data Sources API, specifically focusing on Microsoft Fabric OneLake integration. It adds a new documentation file, transformations_external_data_sources.rst, which covers key concepts, permissions, and Python/SQL code examples for registering, verifying, reading, listing, rotating credentials, and deleting external data sources. Additionally, the main transformations documentation is updated to include this new section in its table of contents. No review comments were provided, so there is no feedback to address.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2734 +/- ##
==========================================
- Coverage 93.77% 93.76% -0.02%
==========================================
Files 513 513
Lines 52445 52445
==========================================
- Hits 49181 49173 -8
- Misses 3264 3272 +8 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation file, transformations_external_data_sources.rst, which provides comprehensive guides and examples for configuring and using Microsoft Fabric OneLake as an external data source in Cognite Data Fusion transformations. It also updates transformations.rst to include this new document in the table of contents. There are no review comments, so I have no feedback to provide.
|
🦄 |
2 participants
Third and last PR in the stack: #2729 (data classes) → #2732 (client API) → this one. Review #2732 first; this diff is docs only.
Adds
docs/source/transformations_external_data_sources.rst, reached from a nested toctree on the Transformations page — the feature is one sub-API of transformations, not a family of its own, so it belongs under that page rather than as a peer entry inindex.rst.Contents
Concepts (format, credentials, location, data set scoping), a per-operation permission table, then task-oriented sections: register a data source, verify it is usable, read its tables from transformation SQL, list data sources, rotate the client secret, delete a data source.