docs: correct the default materialization maxTxnDuration - #3347
Merged
Conversation
The default was raised from 5m to 20m in d09cb56 (June 2025), but three descriptions of it were left behind: the ShardTemplate doc comment, its generated entry in flow.schema.json, and the hand-written table in the Configuring Task Shards page. No behavior change. The 20 minute default in assemble is intentional and unchanged; only the text describing it is corrected. flow.schema.json is edited in place rather than regenerated, because the released flowctl predates syncSchedule and regenerating with it would drop valid schema. The edited string is byte-identical to what an in-tree regeneration emits.
|
🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-3347/ 📄 Changed pages: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description:
Three places describe the default
maxTxnDurationfor materializations as five minutes. The actual default has been twenty minutes since d09cb56 (June 2025), which raised it deliberately. This corrects the text in all three; no behavior changes.crates/models/src/shards.rs:35flow.schema.json:1284site/docs/features/configuring-task-shards.md:18crates/assemble/src/lib.rs:411is the authority and is unchanged:Workflow steps:
No change to how the field is used. A reader of the docs page or the JSON schema now sees the default the runtime actually applies.
Documentation links affected:
maxTxnDurationrow of the properties table.Notes for reviewers:
Two things worth a look.
flow.schema.jsonis edited in place rather than regenerated. The releasedflowctl v0.6.12predates thesyncSchedulemodel, soflowctl raw json-schemawith it drops 102 lines of valid schema. The string I edited is the verbatim serialization of the doc comment, so this is byte-identical to what an in-tree regeneration emits, and the CI check added in d4583de should confirm that.