Skip to content

docs: rewrite 'Encode metadata, not a handle to a live object' section - #1785

Open
Awesome06 wants to merge 1 commit into
apache:mainfrom
Awesome06:docs/1726-rewrite-metadata
Open

Awesome06 wants to merge 1 commit into
apache:mainfrom
Awesome06:docs/1726-rewrite-metadata

Conversation

@Awesome06

Copy link
Copy Markdown

Which issue does this PR close?

Closes #1726

Rationale for this change

With recent PRs (such as #1723) modifying the examples to encode durable metadata, the "Encode metadata, not a handle to a live object" section in the extension guide needed a structural rewrite to reflect the current state of the codebase. It now correctly leads with positive examples and clarifies that the token registry used in the ForeignExecutionPlan arm is a marked workaround, not a pattern to emulate.

What changes are included in this PR?

  • docs/source/extension-guide/codecs.md: Rewrites the section to point to datafusion-ffi-example (logical codec) and examples/distributed/storage-library as the primary, positive examples of encoding durable metadata.
  • docs/source/extension-guide/codecs.md: Explains that a token registry is a consequence of an upstream defect ([Umbrella] FFI planner boundary: foreign-wrapped nodes, lost plan properties, and severed dynamic filters datafusion#25152) and isolates it to the ForeignExecutionPlan arm. Adds a bidirectional link to extension_codec_order.
  • docs/source/extension-guide/checklist.md: Updates the checklist to clarify that the token workaround is now limited to "one arm of one codec" rather than a general practice in the repository's examples.

Are there any user-facing changes?

No (documentation improvements only).

Copilot AI balanced review requested due to automatic review settings October 6, 2026 09:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite the "Encode metadata, not a handle to a live object" section

2 participants