documenting gh-ost-on-start-replication hook

Empia · Mar 7, 2017 · 7f72872 · 7f72872
1 parent 6fa32f6
commit 7f72872
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/doc/hooks.md b/doc/hooks.md
@@ -44,6 +44,7 @@ The full list of supported hooks is best found in code: [hooks.go](https://githu
 - `gh-ost-on-interactive-command`
 - `gh-ost-on-row-copy-complete`
 - `gh-ost-on-stop-replication`
+- `gh-ost-on-start-replication`
 - `gh-ost-on-begin-postponed`
 - `gh-ost-on-before-cut-over`
 - `gh-ost-on-success`

diff --git a/resources/hooks-sample/gh-ost-on-start-replication-hook b/resources/hooks-sample/gh-ost-on-start-replication-hook
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Sample hook file for gh-ost-on-start-replication
+# Useful for RDS/Aurora setups, see https://github.com/github/gh-ost/issues/163
+
+echo "$(date) gh-ost-on-start-replication $GH_OST_DATABASE_NAME.$GH_OST_TABLE_NAME $GH_OST_MIGRATED_HOST" >> /tmp/gh-ost.log
diff --git a/resources/hooks-sample/gh-ost-on-stop-replication-hook b/resources/hooks-sample/gh-ost-on-stop-replication-hook
@@ -1,5 +1,6 @@
 #!/bin/bash
 
 # Sample hook file for gh-ost-on-stop-replication
+# Useful for RDS/Aurora setups, see https://github.com/github/gh-ost/issues/163
 
 echo "$(date) gh-ost-on-stop-replication $GH_OST_DATABASE_NAME.$GH_OST_TABLE_NAME $GH_OST_MIGRATED_HOST" >> /tmp/gh-ost.log