docs: document table-level storage/encryption gap, drop from TODO#101
Merged
Conversation
Decision: don't implement. The TODO listed
ROW_FORMAT / KEY_BLOCK_SIZE / COMPRESSION / ENCRYPTION as
silent drops with a fix path ("add to model.Table,
applyTableOption, the catalog reader, and Table.SQL()"), but:
- All four require a full table rebuild on ALTER, so the
ergonomic case for managing them through myschema is weaker
than it looks.
- ENCRYPTION specifically needs a server-side keyring plugin
before `ENCRYPTION='Y'` is accepted; test environments
without the plugin can't exercise the round-trip end-to-end.
Rather than ship half-coverage (parser-only on ENCRYPTION),
mark the whole family out of scope. Users who need these
options manage them out-of-band — direct ALTER TABLE, or a
`-- myschema:execute` block that guards on
information_schema.TABLES.ROW_FORMAT / CREATE_OPTIONS for
idempotency.
CAVEATS.md gets a new "Table-level storage and encryption
options are not managed" section spelling out which options
are dropped, why, and the workaround. TODO.md drops the
corresponding entry.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #101 +/- ##
=======================================
Coverage 86.86% 86.86%
=======================================
Files 30 30
Lines 3357 3357
=======================================
Hits 2916 2916
Misses 270 270
Partials 171 171 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Documents an explicit out-of-scope area in myschema’s “contract”: table-level storage/encryption options that are parsed but not modeled, diffed, dumped, or applied. This formalizes the decision to not manage these options declaratively and removes the corresponding TODO entry.
Changes:
- Added a new CAVEATS section explaining that
ROW_FORMAT,KEY_BLOCK_SIZE,COMPRESSION, andENCRYPTIONare ignored (no round-trip), plus recommended workarounds. - Removed the related “table-level storage / encryption options” item from
TODO.mdnow that the limitation is documented.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| TODO.md | Removes the TODO item for table-level storage/encryption option round-trip support. |
| CAVEATS.md | Adds a dedicated caveat section documenting the non-managed table options and suggested operational workarounds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Decision: don't implement `ROW_FORMAT` / `KEY_BLOCK_SIZE` / `COMPRESSION` / `ENCRYPTION` round-trip. Document the gap and remove from TODO.
Why not implement
Rather than ship half-coverage (parser-only on `ENCRYPTION`, e2e on the other three), mark the whole family out of scope and document the workaround.
Changes
Test plan
🤖 Generated with Claude Code