Update docs for -on_ddl flag

Signed-off-by: Jacques Grove <[email protected]>
vitessio · Oct 25, 2019 · e6c8011 · e6c8011
1 parent 2adeaf2
commit e6c8011
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/vreplgen/README.md b/vreplgen/README.md
@@ -2,7 +2,7 @@ A golang CLI utility to generate vtctlclient commands to add vreplication
 rules:
 
 ```
-Usage: ./vreplgen <tablet_id> <src_keyspace> <src_shard> <dest_keyspace> <dest_table1> 'filter1' [<dest_table2> 'filter2']...
+Usage: vreplgen [-on_ddl (ignore|stop|exec|exec_ignore)] <tablet_id> <src_keyspace> <src_shard> <dest_keyspace> <dest_table1> 'filter1' [<dest_table2> 'filter2']...
 ```
 
 E.g.:
@@ -30,3 +30,14 @@ you want `vreplgen` to generate, e.g.:
 ```
 export VTCTLCLIENT="vtctlclient -server vtctld:15999"
 ```
+
+Lastly, you can control the on_ddl flag using vreplgen. The default if you
+do not specify the `-on_ddl` option is `ignore`, but you can specify:
+
+  * `-on_ddl ignore`
+  * `-on_ddl stop`
+  * `-on_ddl exec`
+  * `-on_ddl exec_ignore`
+
+depending on how you want your DDL to be handled in your replication streams.
+See the main vreplication documentation for more details.
diff --git a/vreplgen/vreplgen.go b/vreplgen/vreplgen.go
@@ -46,7 +46,7 @@ func main() {
 	}
 
 	if (len(os.Args) < (7+argOffset)) {
-		fmt.Println("Usage: /vreplgen [-on_ddl (ignore|stop|exec|exec_ignore)] <tablet_id> <src_keyspace> <src_shard> <dest_keyspace> <dest_table1> 'filter1' [<dest_table2> 'filter2']...")
+		fmt.Println("Usage: vreplgen [-on_ddl (ignore|stop|exec|exec_ignore)] <tablet_id> <src_keyspace> <src_shard> <dest_keyspace> <dest_table1> 'filter1' [<dest_table2> 'filter2']...")
 		os.Exit(1)
 	}