online-schema-change 0.0.1.post0

copy mode

Say we have an existing table named my_table under database test:

CREATE TABLE `my_table` (
  `id` int(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

Now if we want to run ALTER TABLE ``my_table add column data varchar(10);`` against it. Instead of feed the ALTER TABLE statement to OSC, we just need to put a CREATE TABLE statement representing the desired schema into a file /tmp/foo.sql like below:

CREATE TABLE `my_table` (
  `id` int(11) NOT NULL,
  `data` varchar(10) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

Then run the following command:

osc_cli copy --ddl-file-list=foo.sql --socket=/tmp/mysql.socket --database=test

cleanup mode

To cleanup the table left behind by last run of OSC

osc_cli cleanup --socket=/tmp/mysql.socket --database=test

To terminate a currently running OSC process on certain MySQL Instance:

osc_cli cleanup

direct mode

This mode is reserved for utilizing MySQL’s native online ddl for schema change, and help DBA manage all the schema related operation into this one tool. For now, if you plan to use OSC for all your schema management, this mode is here for you to create a empty new table. Following command will create an empty table into database test

osc_cli direct --ddl-file-list=foo.sql --socket=/tmp/mysql.socket --database=test