ducklink: update to v4.1.1#2201
Closed
zacharywhitley wants to merge 1 commit into
Closed
Conversation
Additive follow-up to v4.1.0 (currently open as duckdb#2199). v4.1.1 lands the wasm custom-section docs bridge: components can ship their own summary / description / example / tags inside the `.wasm` binary via a `duckdb.docs` custom section, and ducklink merges them with the catalog docs at query time. Merge semantics per field: component `summary` / `description` / `example` REPLACE the catalog values; `tags` UNION with the catalog set. Modules without a section render pure catalog data — no behaviour change for existing components. Non-fatal at every step (missing / malformed / invalid all silently skip), so a broken section can never break `LOAD WASM 'name'`. Third-party components can keep their docs authoritative without a catalog PR. This PR supersedes duckdb#2199. If either is merged the other's noop against a v4.1.1 CDN; closing duckdb#2199 with a supersedes comment.
This was referenced Jul 8, 2026
Contributor
Author
|
Superseded by #2207 (v4.2.0). |
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
1 participant
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.
Additive follow-up to v4.1.0 (currently open as #2199). v4.1.1 lands the wasm custom-section docs bridge: components can ship their own
summary/description/example/tagsinside the.wasmbinary via aduckdb.docscustom section, and ducklink merges them with the catalog docs at query time.Merge semantics
Per-function, per-field:
summary/description/examplereplace the catalog value when present.tagsunion with the catalog set (catalog order preserved, component-only tags appended).Why it exists
Catalog authoring lag is a real thing. This lets third-party component authors keep their own docs authoritative without waiting on a catalog PR to land, while still respecting the catalog as source-of-truth for anything the component doesn't override.
Safety
Non-fatal at every step: missing file / malformed envelope / missing section / invalid JSON / wrong shape all return silently. A broken section can never break
LOAD WASM 'name'. Diagnostics go throughverbose_log!; no user-facing noise on the happy path.Implementation
src/docs_section.rs(~260 lines, unit-tested).Engine2::load+build_doc_rows, so the override flows throughducklink.docs,ducklink_search, andducklink_helpuniformly.PR history
Supersedes:
Closing #2199 alongside this PR with a supersedes comment.