-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add template file for table_copy command
- Loading branch information
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. -*- rst -*- | ||
.. highlightlang:: none | ||
|
||
|
||
``table_copy`` | ||
============== | ||
|
||
Summary | ||
------- | ||
|
||
.. versionadded:: 6.0.8 | ||
|
||
TOOD: Write me | ||
|
||
Syntax | ||
------ | ||
|
||
This command takes two parameters. | ||
|
||
All parameters are required:: | ||
|
||
table_copy from_name | ||
to_name | ||
|
||
Usage | ||
----- | ||
|
||
|
||
Parameters | ||
---------- | ||
|
||
This section describes parameters. | ||
|
||
Required parameters | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
All parameters are required. | ||
|
||
``from_name`` | ||
""""""""""""" | ||
|
||
Specifies the table name of source table. | ||
|
||
``to_name`` | ||
""""""""""" | ||
|
||
Specifies the destination table name. | ||
|
||
Optional parameters | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
There is no optional parameter. | ||
|
||
Return value | ||
------------ | ||
|
||
The command returns ``true`` as body on success such as:: | ||
|
||
[HEADER, true] | ||
|
||
If the command fails, error details are in ``HEADER``. | ||
|
||
See :doc:`/reference/command/output_format` for ``HEADER``. |