diff --git a/README.md b/README.md index 0531326..74b92fb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # gh-ost -#### GitHub's online schema migration for MySQL +#### GitHub's online schema migration for MySQL -`gh-ost` is a triggerless online schema migration solution for MySQL. It is testable and provides with pausability, dynamic control/reconfiguration, auditing, and many operational perks. + `gh-ost` is a triggerless online schema migration solution for MySQL. It is testable and provides with pausability, dynamic control/reconfiguration, auditing, and many operational perks. `gh-ost` produces a light workload on the master throughout the migration, decoupled from the existing workload on the migrated table. It has been designed based on years of experience with existing solutions, and changes the paradigm of table migrations. -![gh-ost logo](doc/images/gh-ost-logo-light-160.png) + ## How? @@ -44,7 +44,7 @@ The [cheatsheet](doc/cheatsheet.md) has it all. You may be interested in invokin Our tips: -- [Testing above all](testing-on-replica.md), try out `--test-on-replica` first few times. Better yet, make it continuous. We have multiple replicas where we iterate our entire fleet of production tables, migrating them one by one, checksumming the results, verifying migration is good. +- [Testing above all](doc/testing-on-replica.md), try out `--test-on-replica` first few times. Better yet, make it continuous. We have multiple replicas where we iterate our entire fleet of production tables, migrating them one by one, checksumming the results, verifying migration is good. - For each master migration, first issue a _noop_ - Then issue the real thing via `--execute`. @@ -63,8 +63,6 @@ Originally this was named `gh-osc`: GitHub Online Schema Change, in the likes of But then a rare genetic mutation happened, and the `s` transformed into `t`. And that sent us down the path of trying to figure out a new acronym. Right now, `gh-ost` (pronounce: _Ghost_), stands for: - GitHub Online Schema Transmogrifier/Translator/Transformer/Transfigurator -Pronounce: _ghost_ - ## License `gh-ost` is licensed under the [MIT license](https://github.com/github/gh-ost/blob/documentation/LICENSE) diff --git a/doc/interactive-commands.md b/doc/interactive-commands.md index 1579e01..1d96250 100644 --- a/doc/interactive-commands.md +++ b/doc/interactive-commands.md @@ -24,7 +24,7 @@ replication lag on to determine throttling - `critical-load=`: change critical load setting (exceeding given thresholds causes panic and abort) - `nice-ratio=`: change _nice_ ratio: 0 for aggressive, positive integer `n`: for any unit of time spent copying rows, spend `n` units of time sleeping. - `throttle-query`: change throttle query -- `throttle-control-replicas`: change list of throttle-control replicas, these are replicas `gh-ost` will cehck +- `throttle-control-replicas`: change list of throttle-control replicas, these are replicas `gh-ost` will check - `throttle`: force migration suspend - `no-throttle`: cancel forced suspension (though other throttling reasons may still apply) - `unpostpone`: at a time where `gh-ost` is postponing the [cut-over](cut-over.md) phase, instruct `gh-ost` to stop postponing and proceed immediately to cut-over.