Skip to content

Commit 2c48be1

Browse files
authored
Update command-line-flags
1 parent 96d00d4 commit 2c48be1

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

doc/command-line-flags.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ This is somewhat similar to a Nagios `n`-times test, where `n` in our case is al
6969

7070
Optional. Default is `safe`. See more discussion in [`cut-over`](cut-over.md)
7171

72+
### cut-over-lock-timeout-seconds
73+
74+
Default `3`. Max number of seconds to hold locks on tables while attempting to cut-over (retry attempted when lock exceeds timeout).
75+
7276
### discard-foreign-keys
7377

7478
**Danger**: this flag will _silently_ discard any foreign keys existing on your table.
@@ -107,6 +111,10 @@ While the ongoing estimated number of rows is still heuristic, it's almost exact
107111

108112
Without this parameter, migration is a _noop_: testing table creation and validity of migration, but not touching data.
109113

114+
### force-table-names
115+
116+
Table name prefix to be used on the temporary tables.
117+
110118
### gcp
111119

112120
Add this flag when executing on a 1st generation Google Cloud Platform (GCP).
@@ -125,6 +133,10 @@ We think `gh-ost` should not take chances or make assumptions about the user's t
125133

126134
See [`initially-drop-ghost-table`](#initially-drop-ghost-table)
127135

136+
### initially-drop-socket-file
137+
138+
Default False. Should `gh-ost` forcibly delete an existing socket file. Be careful: this might drop the socket file of a running migration!
139+
128140
### max-lag-millis
129141

130142
On a replication topology, this is perhaps the most important migration throttling factor: the maximum lag allowed for migration to work. If lag exceeds this value, migration throttles.
@@ -169,6 +181,10 @@ See [`approve-renamed-columns`](#approve-renamed-columns)
169181

170182
Issue the migration on a replica; do not modify data on master. Useful for validating, testing and benchmarking. See [`testing-on-replica`](testing-on-replica.md)
171183

184+
### test-on-replica-skip-replica-stop
185+
186+
Default `False`. When `--test-on-replica` is enabled, do not issue commands stop replication (requires `--test-on-replica`).
187+
172188
### throttle-control-replicas
173189

174190
Provide a command delimited list of replicas; `gh-ost` will throttle when any of the given replicas lag beyond [`--max-lag-millis`](#max-lag-millis). The list can be queried and updated dynamically via [interactive commands](interactive-commands.md)

0 commit comments

Comments
 (0)