docs/prefect integration #3037
Open
docs/prefect integration #3037
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
djudjuu
commented
Aug 26, 2025
djudjuu
commented
- prefect integration docs
- decomposition helper
- rewrite
- decomposition image
❌ Deploy Preview for dlt-hub-docs failed. Why did it fail? →
|
Closed
|
github-actions
bot
added
the
lfs-detected!
|
github-actions
bot
removed
the
lfs-detected!
djudjuu
force-pushed
the
docs/prefect-integration
branch
from
d566473 to
2ed2b15
Compare
djudjuu
commented
Aug 27, 2025
| For stability reasons, this actually runs one resource alone and then all others in parallel. | ||
| This is because otherwise, on the first run, all resources would try to create the same dlt-tables. | ||
| ::: | ||
| :::warning |
There was a problem hiding this comment.
@ShreyasGS read this (under this comment)
VioletM
requested changes
Aug 27, 2025
There was a problem hiding this comment.
Looks very exciting!
General comments:
-
I think in most of the cases dlt should be written without backticks (https://www.notion.so/dlthub/Documentation-Writing-Guide-87f4fcc32655460c83bcaf7787d11e67?source=copy_link#2288bedf0d7043e4bc1b4a0af7897b1f)
-
Sentence case for any headers
-
Please, put it through the grammar checker, I'm really bad with detecting grammar errors
|
|
||
| ## Key features | ||
|
|
||
| - **Prefect Collector:** a dedicated way to do real-time [progress monitoring] and summary reports after each pipeline stage |
There was a problem hiding this comment.
why [progress monitoring] is in braces?
There was a problem hiding this comment.
thx, i thought maybe this could be a link but removed it ultimately: https://dlthub.com/docs/general-usage/pipeline#monitor-the-loading-progress
|
|
||
| ### Schema Change Reports | ||
|
|
||
| The `PrefectCollector` will also create artifacts when schema changes are detected. |
There was a problem hiding this comment.
should we elaborate on the artifacts? what's inside?
| Prefect has built-in functionality to [include logs from other libraries](https://docs.prefect.io/v3/advanced/logging-customization#include-logs-from-other-libraries) and display them as part of their UI. | ||
|
|
||
| You can tell prefect to include `dlt`'s logs by setting the corresponding prefect environment variable, for example by adding this to your `.env` file: | ||
| ```sh |
There was a problem hiding this comment.
nit: Could you add the secrets.toml version as well?
There was a problem hiding this comment.
interesting. its actually a prefect configuration not dlt, but i can stress that
|
|
||
| ## Runner integration | ||
|
|
||
| The `PrefectCollector` integrates seamlessly with the [dlt+ runner](../production/pipeline-runner.md). |
There was a problem hiding this comment.
Suggested change
| The `PrefectCollector` integrates seamlessly with the [dlt+ runner](../production/pipeline-runner.md). | |
| The `PrefectCollector` integrates seamlessly with the [dlt+ Runner](../production/pipeline-runner.md). |
|
|
||
| ### Pipeline Retries | ||
|
|
||
| Prefect retry-mechanism is not a perfect fit for dlt pipelines. |
There was a problem hiding this comment.
I suggest first to mention that dlt+ Runner fixes the problem and then explain it :)
The dlt+ Runner provides a retry configuration that ensures pipeline state and intermediate results are preserved across retry attempts.
This is important because Prefect’s default retry mechanism is not optimized for dlt pipelines. During execution, dlt generates intermediate files in the pipeline’s working directory. If a run fails and Prefect retries it, those files may not be available anymore. For example, if the retry happens on a different worker node or inside an ephemeral Docker container.
To do so, ...
Co-authored-by: Violetta Mishechkina <[email protected]>
djudjuu
force-pushed
the
docs/prefect-integration
branch
from
b18cd50 to
413b953
Compare
VioletM
approved these changes
Sep 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.