Skip to content

Commit 4e6e454

Browse files
author
Shlomi Noach
committed
documenting --postpone-cut-over-flag-file
1 parent 087a6cc commit 4e6e454

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/command-line-flags.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,12 @@ See also: [Sub-second replication lag throttling](subsecond-lag.md)
119119

120120
Typically `gh-ost` is used to migrate tables on a master. If you wish to only perform the migration in full on a replica, connect `gh-ost` to said replica and pass `--migrate-on-replica`. `gh-ost` will briefly connect to the master but other issue no changes on the master. Migration will be fully executed on the replica, while making sure to maintain a small replication lag.
121121

122+
### postpone-cut-over-flag-file
123+
124+
Indicate a file name, such that the final [cut-over](cut-over.md) step does not take place as long as the file exists.
125+
When this flag is set, `gh-ost` expects the file to exist on startup, or else tries to create it. `gh-ost` exits with error if the file does not exist and `gh-ost` is unable to create it.
126+
With this flag set, the migration will cut-over upon deletion of the file or upon `cut-over` [interactive command](interactive-commands.md).
127+
122128
### skip-foreign-key-checks
123129

124130
By default `gh-ost` verifies no foreign keys exist on the migrated table. On servers with large number of tables this check can take a long time. If you're absolutely certain no foreign keys exist (table does not referenece other table nor is referenced by other tables) and wish to save the check time, provide with `--skip-foreign-key-checks`.

0 commit comments

Comments
 (0)