Skip to content

Commit

Permalink
doc: add template file for table_copy command
Browse files Browse the repository at this point in the history
  • Loading branch information
kenhys committed Aug 28, 2016
1 parent ca9d75b commit bdf467b
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions doc/source/reference/commands/table_copy.rst
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``.

0 comments on commit bdf467b

Please sign in to comment.