Skip to content

docs(fdw): correct relationships table caveat columns#3228

Closed
capybara-alt wants to merge 2 commits into
authzed:mainfrom
capybara-alt:docs/fix-fdw-relationships-columns
Closed

docs(fdw): correct relationships table caveat columns#3228
capybara-alt wants to merge 2 commits into
authzed:mainfrom
capybara-alt:docs/fix-fdw-relationships-columns

Conversation

@capybara-alt

@capybara-alt capybara-alt commented Jul 13, 2026

Copy link
Copy Markdown

Description

Fixes incorrect caveat column names and types in internal/fdw/README.md.

The documentation currently describes:

  • optional_caveat_name (text)
  • optional_caveat_context (jsonb)

However, the implementation and the example configuration use:

  • caveat_name (text)
  • caveat_context (text)

This PR updates the documentation to match the current implementation.

Testing

Verified that the documentation matches:

  • internal/fdw/tables/relationships.go
  • internal/fdw/configuration.sql

Documentation change only. No functional changes.

References

Closes #3227

@capybara-alt capybara-alt requested a review from a team as a code owner July 13, 2026 14:44
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


0 out of 2 committers have signed the CLA.
@Capybara
@capybara-alt
capybara seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request

@capybara-alt capybara-alt force-pushed the docs/fix-fdw-relationships-columns branch from ef0afcd to d09e3bf Compare July 13, 2026 15:15
@capybara-alt capybara-alt force-pushed the docs/fix-fdw-relationships-columns branch from d09e3bf to ed4d622 Compare July 13, 2026 15:20
@capybara-alt capybara-alt deleted the docs/fix-fdw-relationships-columns branch July 13, 2026 15:21
@github-actions github-actions Bot added area/datastore Affects the storage system area/tooling Affects the dev or user toolchain (e.g. tests, ci, build tools) labels Jul 13, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 13, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area/datastore Affects the storage system area/tooling Affects the dev or user toolchain (e.g. tests, ci, build tools)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Incorrect caveat column names and types in internal/fdw/README.md

2 participants