Repository navigation
Document --move-tables mode - #1809
Merged
Merged
Conversation
Remove internal task numbers, section markers, and private design links from move-tables comments and point to doc/move-tables-design.md instead.
Log target host, database, tables, and drain GTID in the before-cut-over and success sample hooks when GH_OST_MOVE_TABLES is set.
ericyan
force-pushed
the
move-tables-docs
branch
2 times, most recently
from
November 12, 2026 10:04
7ea2327 to
89a8fe3
Compare
Add the move-tables operator guide and technical reference, and update the README, flag reference, hook docs, resume docs, throttling docs, and output docs.
ericyan
force-pushed
the
move-tables-docs
branch
from
November 12, 2026 11:11
89a8fe3 to
9c3b253
Compare
ericyan
marked this pull request as ready for review
November 12, 2026 11:16
ericyan
added
the
feature/move-tables
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation omits resume data-completeness warnings, checkpoint-table cleanup steps, and accepted cut-over timeout ranges, risking skipped row changes and failed retries or cut-overs.
3 open issues
What changed in this PR
Documents --move-tables for cross-cluster migrations, covering MySQL/MariaDB setup, operator-managed traffic switching, and recovery.
Changes:
- Adds user and design guides for copying, cut-over, cleanup, resume, and rollback.
- Updates related documentation and sample hook logging for move-tables mode.
- Cleans up internal references in code/test comments and a panic message without changing migration flow.
| File | Description |
|---|---|
resources/hooks-sample/gh-ost-on-success-hook |
Logs moved tables, target details, and drain GTID. |
resources/hooks-sample/gh-ost-on-before-cut-over-hook |
Logs move-tables source and target details. |
README.md |
Links the new user and design guides. |
localtests/move-tables/multiple-two/create.sql |
Removes an internal section reference from a comment. |
localtests/move-tables/multiple-three/create.sql |
Removes an internal section reference from a comment. |
go/logic/migrator.go |
Replaces internal references and clarifies lifecycle comments. |
go/logic/migrator_move_tables_cutover_test.go |
Clarifies test comments and removes internal task references. |
go/logic/hooks.go |
Removes an internal marker from a hook-variable comment. |
go/logic/applier.go |
Updates design references and bookkeeping comments. |
go/logic/applier_test.go |
Cleans up internal references in test comments. |
go/base/context.go |
Removes an internal section marker from panic text. |
doc/understanding-output.md |
Explains per-table progress and writer lag. |
doc/throttle.md |
Documents target-side throttling and source-monitoring responsibilities. |
doc/resume.md |
Adds move-tables resume guidance and fixes shell continuations. |
doc/move-tables.md |
Adds the operational setup, cut-over, and recovery guide. |
doc/move-tables-design.md |
Describes architecture, cut-over phases, and correctness boundaries. |
doc/hooks.md |
Documents move-tables hook variables and recovery precautions. |
doc/command-line-flags.md |
Documents move-tables options and mode-specific flag behavior. |
Review effort: Max (auto)
- Document cut-over-lock-timeout-seconds ranges and the fallback to 3s - Warn that --resume can skip part of a transaction (#1781) - Include the checkpoint table when abandoning a move
danieljoos
previously approved these changes
Nov 12, 2026
ericyan
dismissed
danieljoos’s stale review
November 12, 2026 13:14
The merge-base changed after approval.
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.
Description
Adds public documentation for
--move-tablesmode and cleans up internal design references in comments:doc/move-tables.md) covering setup, read/write cut-over, cleanup, resume, and rollback.doc/move-tables-design.md) covering architecture, theT0–T6cut-over sequence, and correctness/failure boundaries.README.md,doc/command-line-flags.md,doc/hooks.md,doc/resume.md,doc/throttle.md,doc/understanding-output.md, and the sample hooks inresources/hooks-sample/.doc/move-tables-design.md.Stacked on #1756.