docs: update api.md and radon_sql_support.md

[summary] Add some information. [test case] N/A [patch codecov] N/A
hustjieke · Mar 25, 2020 · d61e453 · d61e453
1 parent d08fd5e
commit d61e453
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -353,6 +353,7 @@ Request: {
 			"to-database":               "Destination database",                                              [required]
 			"to-table":                  "Destination table",                                                 [required]
 			"radonurl":                  "Radon RESTful api(default: http://peer-address)",
+			"rebalance":                 "Rebalance means a rebalance operation, which from table need cleanup after shifted(default false)",
 			"cleanup":                   "Cleanup the from table after shifted(defaults false)",
 			"mysqldump":                 "mysqldump path",
 			"threads":                   "shift threads num(defaults 16)",

diff --git a/docs/radon_sql_support.md b/docs/radon_sql_support.md
@@ -52,6 +52,7 @@ Contents
       * [RADON ATTACHLIST](#radon-attachlist)
       * [RADON DETACH](#radon-detach)
       * [RADON RESHARD](#radon-reshard) 
+      * [RADON CLEANUP](#radon-cleanup)
     * [Others](#others)
       * [Using AUTO_INCREMENT](#using-auto-increment)
 
@@ -1260,6 +1261,21 @@ mysql> select * from new_tb;
 2 rows in set (1.09 sec)
 ```
 
+### RADON CLEANUP
+
+`Syntax`
+```
+RADON CLEANUP
+```
+
+`Instructions`
+* RADON CLEANUP can clean up the old data after shifted.
+
+```
+mysql> radon cleanup;
+Query OK, 0 rows affected (0.13 sec)
+```
+
 ## Others
 ###  Using AUTO INCREMENT