Documented warmer and cache:clear commands

Author: Martynas Sudintas

Resources/doc/commands.rst

@@ -156,4 +156,93 @@ Type update
    | ``es:type:update --manager shop --type article --force``   | Updates mapping for ``shop`` *manager* type ``article``.      |
    +------------------------------------------------------------+---------------------------------------------------------------+
 
+Cache clear
+-----------
+
+- Command name: ``es:cache:clear``.
+- Description: Clears elasticsearch client cache.
+- Options:
+
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+   | Full name       | Short name    | Value            | What it does                                                                                  |
+   +=================+===============+==================+===============================================================================================+
+   | ``--manager``   | *undefined*   | Manager name.    | Used to select *manager* to update types for. If not specified, default manager is used.      |
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+
+-  Examples:
+
+   +------------------------------------------------------------+---------------------------------------------------------------+
+   | Input                                                      | What it does                                                  |
+   +============================================================+===============================================================+
+   | ``es:cache:clear``                                         | Clears client which *manager* is using cache.                 |
+   +------------------------------------------------------------+---------------------------------------------------------------+
+   | ``es:type:update --manager shop``                          | Clears client which ``shop`` *manager* is using cache.        |
+   +------------------------------------------------------------+---------------------------------------------------------------+
+
+Warmer put
+----------
+
+- Command name: ``es:warmer:put``.
+- Description: Puts warmers into elasticsearch.
+- Arguments:
+
+   +--------------+-----------------------------------------------------------------------------------------------------+
+   | Value        | What it specifies                                                                                   |
+   +==============+=====================================================================================================+
+   | Warmer name  | Array of tagged warmer names.                                                                       |
+   +--------------+-----------------------------------------------------------------------------------------------------+
+
+- Options:
+
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+   | Full name       | Short name    | Value            | What it does                                                                                  |
+   +=================+===============+==================+===============================================================================================+
+   | ``--manager``   | *undefined*   | Manager name.    | Used to select *manager* to update types for. If not specified, default manager is used.      |
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+
+-  Examples:
+
+   +------------------------------------------------------------+------------------------------------------------------------------------------------+
+   | Input                                                      | What it does                                                                       |
+   +============================================================+====================================================================================+
+   | ``es:warmer:put``                                          | Puts all warmers into client which *default* manager is using.                     |
+   +------------------------------------------------------------+------------------------------------------------------------------------------------+
+   | ``es:warmer:put --manager shop``                           | Puts all warmers into client which ``shop`` manager is using.                      |
+   +------------------------------------------------------------+------------------------------------------------------------------------------------+
+   | ``es:warmer:put foo baz --manager tuna``                   | Puts ``foo`` and ``baz`` named warmers into client which ``tuna`` manager is using |
+   +------------------------------------------------------------+------------------------------------------------------------------------------------+
+
+Warmer delete
+-------------
+
+- Command name: ``es:warmer:delete``.
+- Description: Removes warmers from elasticsearch.
+- Arguments:
+
+   +--------------+-----------------------------------------------------------------------------------------------------+
+   | Value        | What it specifies                                                                                   |
+   +==============+=====================================================================================================+
+   | Warmer name  | Array of tagged warmer names.                                                                       |
+   +--------------+-----------------------------------------------------------------------------------------------------+
+
+- Options:
+
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+   | Full name       | Short name    | Value            | What it does                                                                                  |
+   +=================+===============+==================+===============================================================================================+
+   | ``--manager``   | *undefined*   | Manager name.    | Used to select *manager* to update types for. If not specified, default manager is used.      |
+   +-----------------+---------------+------------------+-----------------------------------------------------------------------------------------------+
+
+-  Examples:
+
+   +------------------------------------------------------------+----------------------------------------------------------------------------------------+
+   | Input                                                      | What it does                                                                           |
+   +============================================================+========================================================================================+
+   | ``es:warmer:delete``                                       | Deletes all warmers from client which *default* manager is using.                      |
+   +------------------------------------------------------------+----------------------------------------------------------------------------------------+
+   | ``es:warmer:delete --manager shop``                        | Deletes all warmers from client which ``shop`` manager is using.                       |
+   +------------------------------------------------------------+----------------------------------------------------------------------------------------+
+   | ``es:warmer:delete foo baz --manager tuna``                | Deletes ``foo`` and ``baz`` named warmers from client which ``tuna`` manager is using. |
+   +------------------------------------------------------------+----------------------------------------------------------------------------------------+
+
 .. _manager: setup.html

Resources/doc/warmers.rst

@@ -50,7 +50,7 @@ quotations marks.
 Putting warmers into index.
 ---------------------------
 
-The easiet way to load warmers are through `commands <commands.html>`_.
+The easiet way to load warmers are through `commands <commands.html#warmer-put>`_.
 
 Also we can load them manually. f.e.