rroonga 3.0.8-x86-mingw32 → 3.0.9-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga.txt

@@ -189,9 +189,6 @@ You can write command list with continuous line which is represented by '\\' cha
  ``column_remove``
    テーブルに定義されているカラムを削除します。
 
- ``view_add``
-   VIEW型のテーブルに要素となるテーブルを定義します。
-
  ``load``
    テーブルにレコードを挿入します。
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/tuning.txt

@@ -0,0 +1,176 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Tuning
+======
+
+Summary
+-------
+
+There are some tuning parameters for improving groonga performance or
+handling a large database.
+
+Parameters
+----------
+
+This section describes parameters.
+
+.. _tuning-max-n-open-files:
+
+The max number of open files per process
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This parameter is for handling a large database.
+
+Groonga creates one or more files per table and colum. If your
+database has many tables and columns, groonga process needs to open
+many files.
+
+System limits the max number of open files per process. So you need to
+relax the limitation.
+
+Here is an expression that compute how many files are opened by
+groonga::
+
+  3 (for DB) +
+    N tables +
+    N columns (except index clumns) +
+    (N index columns * 2) +
+    X (the number of plugins etc.)
+
+Here is an example schema::
+
+  table_create Entries TABLE_HASH_KEY ShortText
+  column_create Entries content COLUMN_SCALAR Text
+  column_create Entries n_likes COLUMN_SCALAR UInt32
+  table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+  column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
+  column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
+
+This example opens at least 11 files::
+
+  3 +
+    2 (Entries and Terms) +
+    2 (Entries.content and Entries.n_likes) +
+    4 (Terms.entries_key_index and Terms.entries_content_index) +
+    X = 11 + X
+
+.. _tuning-memory-usage:
+
+Memory usage
+^^^^^^^^^^^^
+
+This parameter is for handling a large database.
+
+Groonga maps database files onto memory and accesses to them. Groonga
+doesn't maps unnecessary files onto memory until they are nneded.
+
+If you access to all data in database, all database files are mapped
+onto memory.  If total size of your database files is 6GiB, your
+groonga process uses 6GiB memory.
+
+Normally, your all database files aren't mapped onto memry. But is may
+be occurred. It is an example case that you dump your database.
+
+You must have memory and swap that is larger than database.
+
+.. _tuning-linux:
+
+Linux
+-----
+
+This section describes how to configure parameters on Linux.
+
+.. _tuning-linux-nofile:
+
+nofile
+^^^^^^
+
+You can relax the :ref:`tuning-max-n-open-files` parameter by creating
+a configuration file ``/etc/security/limits.d/groonga.conf`` that has
+the following content::
+
+  ${USER} soft nofile ${MAX_VALUE}
+  ${USER} hard nofile ${MAX_VALUE}
+
+If you run ``groonga`` process by ``groonga`` user and your groonga
+process needs to open less than 10000 files, use the following
+configuration::
+
+  groonga soft nofile 10000
+  groonga hard nofile 10000
+
+The configuration is applied after your groonga service is restarted
+or re-login as your groonga user.
+
+.. _tuning-linux-overcommit-memory:
+
+vm.overcommit_memory
+^^^^^^^^^^^^^^^^^^^^
+
+This is :ref:`tuning-memory-usage` related parameter. You can handle a
+database that is larger than your memory and swap by setting
+``vm.overcommit_memory`` kernel parameter to 1. 1 means that groonga
+can always map database files onto memory. It is no problem until
+groonga touch mapped database files that their size is larger than
+memory and swap. Groonga recommends the configuration.
+
+See `Linux kernel documentaion about overcommit
+<https://www.kernel.org/doc/Documentation/vm/overcommit-accounting>`_
+about ``vm.overcommit_memory`` parameter details.
+
+You can set the configuration by putting a configuration file
+``/etc/sysctl.d/groonga.conf`` that has the following content::
+
+  vm.overcommit_memory = 1
+
+The configuration can be applied by restarting your system or run the
+following command::
+
+  % sudo sysctl -p
+
+
+.. _tuning-linux-max-map-count:
+
+vm.max_map_count
+^^^^^^^^^^^^^^^^
+
+This is :ref:`tuning-memory-usage` related parameter. You can handle a
+16GiB or more larger size database by increasing ``vm.max_map_count``
+kernel parameter. The parameter limits the max number of memory maps.
+
+The default value of the kernel parameter may be 65530 or 65536.
+Groonga maps 256KiB memory chunk at one time. If a database is larger
+than 16GiB, groonga reaches the limitation. (``256KiB * 65536 = 16GiB``)
+
+You needs to increase the value of the kernel parameter to handle
+16GiB or more larger size database. For example, you can handle almost
+32GiB size database by ``65536 * 2 = 131072``. You can set the
+configuration by putting a configuration file
+``/etc/sysctl.d/groonga.conf`` that has the following content::
+
+  vm.max_map_count = 131072
+
+Note that your real confiugration file will be the following because
+you already have ``vm.overcommit_memory`` configuration::
+
+  vm.overcommit_memory = 1
+  vm.max_map_count = 131072
+
+The configuration can be applied by restarting your system or run the
+following command::
+
+  % sudo sysctl -p
+
+FreeBSD
+-------
+
+This section describes how to configure parameters on FreeBSD.
+
+.. _tuning-freebsd-maxfilesperproc:
+
+kern.maxfileperproc
+^^^^^^^^^^^^^^^^^^^
+
+TODO

data/vendor/local/share/doc/groonga/en/html/_sources/suggest/completion.txt

@@ -37,6 +37,8 @@ For example, there is a registered word "日本". And "ニホン"
 (it must be katakana) is registered as its reading. An user
 can find "日本" by "ni", "二" or "に".
 
+If you create dataset which is named as example by :doc:`/reference/executables/groonga-suggest-create-dataset` command, you can update pairs of registered word and its reading by loading data to '_key' and 'kana' column of item_example table explicitly for prefix RK search.
+
 Cooccurrence search
 ^^^^^^^^^^^^^^^^^^^
 
@@ -193,3 +195,70 @@ following command::
   {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
   {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
   ]
+
+How to update RK reading data
+-----------------------------
+
+Groonga requires registered word and its reading for RK search, so load such data in the advance.
+
+
+Here is the example to register "日本" which means Japanese in english.
+
+.. groonga-command
+.. include:: ../example/suggest/complete/registered-word-japan.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
+.. ]
+
+
+Here is the example to update RK data to complete "日本".
+
+.. groonga-command
+.. include:: ../example/suggest/complete/update-rk-data.log
+.. load --table item_query
+.. [
+.. {"_key":"日本", "kana":["ニホン", "ニッポン"]}
+.. ]
+
+Then you can complete registered word "日本" by RK input - "nihon".
+
+.. groonga-command
+.. include:: ../example/suggest/complete/rk-search-nihon.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+
+Without loading above RK data, you can't complete registered word "日本" by query - "nihon".
+
+As the column type of item_query table is VECTOR_COLUMN, you can register multiple readings for registered word.
+
+This is the reason that you can also complete the registered word "日本" by query - "nippon".
+
+.. groonga-command
+.. include:: ../example/suggest/complete/rk-search-nippon.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
+
+This feature is very convenient because you can search registered word even though Japanese IM is disabled.
+
+If there are multiple candidates as completed result, you can customize priority to set the value of "boost" column in item_query table.
+
+Here is the example to customize priority for RK search.
+
+.. groonga-command
+.. include:: ../example/suggest/complete/registered-word-japanese.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
+.. {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
+.. ]
+.. load --table item_query
+.. [
+.. {"_key":"日本語", "kana":"ニホンゴ"}
+.. {"_key":"日本人", "kana":"ニホンジン"}
+.. ]
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+.. load --table item_query
+.. [
+.. {"_key":"日本人", "boost": 100},
+.. ]
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+

data/vendor/local/share/doc/groonga/en/html/_sources/troubleshooting/mmap_cannot_allocate_memory.txt

@@ -0,0 +1,45 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+How to avoid mmap Cannot allocate memory error
+==============================================
+
+Example
+-------
+
+There is a case following mmap error in log file:
+
+  2013-06-04 08:19:34.835218|A|4e86e700|mmap(4194304,551,432017408)=Cannot allocate memory <13036498944>
+
+Note that <13036498944> means total size of mmap (almost 12GB) in this case.
+
+Solution
+--------
+
+So you need to confirm following point of views.
+
+* Are there enough free memory?
+* Are maximum number of mappings exceeded?
+
+To check there are enough free memory, you can use vmstat command.
+
+To check whether maximum number of mappings are exceeded, you can investigate the value of vm.max_map_count.
+
+If this issue is fixed by modifying the value of vm.max_map_count, it's exactly the reason.
+
+As groonga allocates memory chunks each 256KB, you can estimate the size of database you can handle by following formula:
+
+  (database size) = vm.max_map_count * (memory chunks)
+
+If you want to handle over 16GB groonga database, you must specify at least 65536 as the value of vm.max_map_count:
+
+  database size (16GB) = vm.max_map_count (65536) * memory chunks (256KB)
+
+You can modify vm.max_map_count temporary by sudo sysctl -w vm.max_map_count=65536.
+
+Then save the configuration value to /etc/sysctl.conf or /etc/sysctl.d/*.conf.
+
+See :doc:`/reference/tuning` documentation about tuning related parameters.
+
+

data/vendor/local/share/doc/groonga/en/html/_static/basic.css

@@ -401,10 +401,6 @@ dl.glossary dt {
     margin: 0;
 }
 
-.refcount {
-    color: #060;
-}
-
 .optional {
     font-size: 1.3em;
 }

data/vendor/local/share/doc/groonga/en/html/characteristic.html

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>1. Characteristics of groonga &mdash; groonga v3.0.8 documentation</title>
+    <title>1. Characteristics of groonga &mdash; Groonga v3.0.9 documentation</title>
     
     <link rel="stylesheet" href="_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="index.html" />
     <link rel="next" title="2. Install" href="install.html" />
     <link rel="prev" title="groonga documentation" href="index.html" /> 
   </head>
@@ -59,7 +59,7 @@
         <li class="right" >
           <a href="index.html" title="groonga documentation"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -179,7 +179,7 @@
         <li class="right" >
           <a href="index.html" title="groonga documentation"
              >previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

data/vendor/local/share/doc/groonga/en/html/community.html

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>3. Community &mdash; groonga v3.0.8 documentation</title>
+    <title>3. Community &mdash; Groonga v3.0.9 documentation</title>
     
     <link rel="stylesheet" href="_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="index.html" />
     <link rel="next" title="4. Tutorial" href="tutorial.html" />
     <link rel="prev" title="2.8. Others" href="install/others.html" /> 
   </head>
@@ -59,7 +59,7 @@
         <li class="right" >
           <a href="install/others.html" title="2.8. Others"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -153,7 +153,7 @@ groonga related information.</p>
         <li class="right" >
           <a href="install/others.html" title="2.8. Others"
              >previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">

data/vendor/local/share/doc/groonga/en/html/contribution.html

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>13. How to contribute to groonga &mdash; groonga v3.0.8 documentation</title>
+    <title>13. How to contribute to groonga &mdash; Groonga v3.0.9 documentation</title>
     
     <link rel="stylesheet" href="_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="index.html" />
     <link rel="next" title="13.1. How to report a bug" href="contribution/report.html" />
     <link rel="prev" title="12.1. Travis CI" href="development/travis-ci.html" /> 
   </head>
@@ -59,7 +59,7 @@
         <li class="right" >
           <a href="development/travis-ci.html" title="12.1. Travis CI"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -228,7 +228,7 @@ its related projects.</p>
         <li class="right" >
           <a href="development/travis-ci.html" title="12.1. Travis CI"
              >previous</a> |</li>
-        <li><a href="index.html">groonga v3.0.8 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Groonga v3.0.9 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">