Repository navigation
docs: simplify the partitioned-index notes for dump, ignore, and plan - #658
Merged
Merged
Conversation
The notes added in #643 ran to several paragraphs each, with worked examples and repeated explanations of constraint-backed indexes. Trim each to a short paragraph in the same style as the circular-foreign-key note from #642, keeping the behavior a reader needs: creation order, the indexes/ output directory, the dump error for ignored attached children, and when plan falls back to recursive index creation. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-only, with one non-blocking scope clarification remaining.
1 open finding
What changed in this PR
Simplifies partitioned-index documentation across dump, ignore, and plan without changing runtime behavior.
Changes:
- Condenses creation-order and ignore guidance.
- Removes worked examples and repeated explanations.
| File | Description |
|---|---|
| docs/cli/plan.mdx | Shortens preservation and recursive-creation guidance. |
| docs/cli/ignore.mdx | Condenses attached-child ignore restrictions. |
| docs/cli/dump.mdx | Summarizes index creation order and multi-file placement. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
 [Low impact] Simplifies documentation for partitioned index behavior. The PR is safe to merge, with a non-blocking clarification needed in the Findings
SummaryShortens the partitioned-index notes in three CLI guides without changing code.
Reviews (1) · Last reviewed commit: "docs: simplify the partitioned-index not..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
The explicit ON ONLY plus ATTACH PARTITION schedule only covers standalone indexes; indexes backing PRIMARY KEY and UNIQUE constraints are still created through their constraints. Restore the qualifier and the caveat that the simplification dropped. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
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.
Summary
Trims the partitioned-index documentation added in #643 (
docs/cli/dump.mdx,docs/cli/ignore.mdx,docs/cli/plan.mdx) from 48 lines to 22. Each note is now one or two short paragraphs in the same style as the circular-foreign-key note from #642.What changed
ON ONLY,ATTACH PARTITION) and theindexes/output directory for multi-file dumps.dumperror when an attached child index is ignored while its parent is retained, plus a line noting[indexes]patterns do not match constraint-backed indexes.planpreserves index names and attachments (new hierarchy from scratch) and one on when it falls back to recursive index creation.Dropped the worked
event_unique/early_custom_uniqueexamples, the repeated constraint-backed-index explanations, and the "plan and apply retain their existing ignore behavior" line. No behavior described was changed; wording was checked againstinternal/diff/partition_index.goandinternal/dump/formatter.go.Test plan
🤖 Generated with Claude Code