github / github/gh-ost

Document --alter

Open
#989 1 comment 2 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
13.6k
Forks
1.4k
Avg merge
2h 31m
Merged PRs (30d)
4

Description

It seems to me that nowhere in the documentation do you explain how to provide the actual migration/`ALTER TABLE` statement to `gh-ost`. A few places use `--alter="engine=innodb"` in examples, but it is far from obvious that `"engine=innodb"` is supposed to be the migration (as in `ALTER TABLE my_table engine=innodb`), rather than some configuration option.

Not even the [`command-line-flags.md`](https://github.com/github/gh-ost/blob/master/doc/command-line-flags.md) mention `--alter`. Nor does the [announcement blog post](https://github.blog/2016-08-01-gh-ost-github-s-online-migration-tool-for-mysql/). Seem you need to look at third party blog posts, or be familiar with for example [pt-online-schema-change](https://www.percona.com/doc/percona-toolkit/2.1/pt-online-schema-change.html), to know that `--alter` is used to pass the migration itself.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.