Kouhei Sutou
null+****@clear*****
Fri Aug 14 14:29:51 JST 2015
Kouhei Sutou 2015-08-14 14:29:51 +0900 (Fri, 14 Aug 2015) New Revision: f895e02812f493c97de911048ab77c12af31cd5d https://github.com/groonga/groonga/commit/f895e02812f493c97de911048ab77c12af31cd5d Message: doc: document database_unmap Added files: doc/source/reference/commands/database_unmap.rst Added: doc/source/reference/commands/database_unmap.rst (+84 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/database_unmap.rst 2015-08-14 14:29:51 +0900 (96bbe12) @@ -0,0 +1,84 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: commands_database_unmap + +.. groonga-command +.. thread_count 2 + +``database_unmap`` +================== + +Summary +------- + +.. versionadded:: 5.0.7 + +``database_unmap`` unmaps already mapped tables and columns in the +database. It releases memory to map tables and columns. + +.. note:: + + Normally, you don't need to use ``database_unmap`` because OS + manages memory cleverly. If remained system memory is reduced, OS + moves memory used by Groonga to disk until Groonga needs the + memory. OS moves unused memory preferentially. + +.. caution:: + + You ca use this command only when :doc:`thread_count` returns + ``1``. It means that this command doesn't work with multithreading. + +Syntax +------ + +``database_unmap`` has no parameters:: + + database_unmap + +Usage +----- + +You can unmap database after you change the max number of threads to +``1``: + +.. groonga-command +.. include:: ../../example/reference/commands/database_unmap/usage_success.log +.. thread_count --new_count 1 +.. database_unmap + +If the max number of threads is larger than ``1``, ``database_unmap`` +fails: + +.. groonga-command +.. include:: ../../example/reference/commands/database_unmap/usage_failure.log +.. thread_count --new_count 2 +.. database_unmap + +Parameters +---------- + +This section describes all parameters. + +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is no required parameters. + +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +There is no optional parameters. + +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����������������������������...Télécharger
