[Groonga-commit] groonga/groonga at bdf467b [master] doc: add template file for table_copy command

Back to archive index

Kentaro Hayashi null+****@clear*****
Mon Aug 29 02:35:56 JST 2016


Kentaro Hayashi	2016-08-29 02:35:56 +0900 (Mon, 29 Aug 2016)

  New Revision: bdf467b46a9ea33e6430f2cfaf67d1eabc1c0a40
  https://github.com/groonga/groonga/commit/bdf467b46a9ea33e6430f2cfaf67d1eabc1c0a40

  Message:
    doc: add template file for table_copy command

  Added files:
    doc/source/reference/commands/table_copy.rst

  Added: doc/source/reference/commands/table_copy.rst (+64 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/commands/table_copy.rst    2016-08-29 02:35:56 +0900 (9b0f8c6)
@@ -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``.
-------------- next part --------------
HTML����������������������������...
下載 



More information about the Groonga-commit mailing list
Back to archive index