Bring README up to date for 1.0.0 - #10
Merged
Merged
Conversation
The README described only statement_cost_limit as "the only criterion" and documented three of the four GUCs in loose, interleaved prose. Make it reflect the current module: - Rewrite the intro to name all three controls (statement and transaction cost limits, and the SELECT-only scope) - Add a Configuration section with a parameter table (type, default, who may set) covering all four GUCs - Document plan_filter.module_loaded and how a non-superuser can use it to detect that the filter is active - State that rejections raise SQLSTATE 54001, with the two message strings, for callers that map the error (e.g. to HTTP 429) - Note that at least one limit must be non-zero to activate the module, rather than singling out statement_cost_limit - Generalize the per-user override guidance to all plan_filter.* limits and add a transaction_cost_limit example - Note the EXPLAIN escape hatch requires superuser (the GUC is SUSET) - Group each limit's material under its own heading Also drop the docs/superpowers/ design-spec artifact (rationale lives in docs/adr/0004) and gitignore that path.
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.
Makes
README.mdreflect the current module before the 1.0.0 tag. Doc-only (plus removing one stray artifact); no code change.Why: master's README still opened by calling the per-statement cost "the only criterion currently supported" — stale now that
transaction_cost_limit(issue #4) andfilter_select_only(issue #2) exist — and it documented only three of the four GUCs. This also recovers the intro fix and artifact removal that were lost when a prior polish commit was pushed to an already-merged branch.Changes (all verified against the code, and the
module_loaded/SQLSTATE examples verified on a live PG 18.3 server):plan_filter.module_loadedand a non-superuser detection query.plan_filter.*limits, with atransaction_cost_limitexample.EXPLAINescape hatch needs superuser (the GUC isSUSET).docs/superpowers/design-spec process artifact (rationale is indocs/adr/0004) and gitignored the path.