[Groonga-commit] groonga/groonga at 4b2d3cf [master] doc: document logical_parameters

Back to archive index

Masafumi Yokoyama null+****@clear*****
Tue Jul 28 12:16:28 JST 2015


Masafumi Yokoyama	2015-07-28 12:16:28 +0900 (Tue, 28 Jul 2015)

  New Revision: 4b2d3cfa243e842b725a1bec941d90931c600dfe
  https://github.com/groonga/groonga/commit/4b2d3cfa243e842b725a1bec941d90931c600dfe

  Message:
    doc: document logical_parameters
    
    TODO: Fill contents.

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

  Added: doc/source/reference/commands/logical_parameters.rst (+55 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/commands/logical_parameters.rst    2015-07-28 12:16:28 +0900 (6bfa79f)
@@ -0,0 +1,55 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: logical_parameters
+
+``logical_parameters``
+========================
+
+Summary
+-------
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.6
+
+TODO: Write summary
+
+Syntax
+------
+
+  logical_parameters [range_index]
+
+Usage
+-----
+
+Register ``sharding`` plugin to use ``logical_parameters`` command in advance.
+
+.. groonga-command
+.. plugin_register sharding
+
+Parameters
+----------
+
+This section describes parameters of ``logical_parameters``.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``range_index``
+"""""""""""""""""
+
+TODO
+
+Return value
+------------
+
+::
+
+  [HEADER, {"range_index":"PARAMETER_NAME"}]
-------------- next part --------------
HTML����������������������������...
Download 



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