RubyGems - rroonga - Versions diffs - 6.0.9-x64-mingw32 → 6.1.0-x64-mingw32 - Mend

rroonga 6.0.9-x64-mingw32 → 6.1.0-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (688) hide show

data/vendor/local/share/doc/groonga/en/html/tutorial/patricia_trie.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>4.8. Prefix search with patricia trie &mdash; Groonga v6.0.9 documentation</title>
+    <title>4.8. Prefix search with patricia trie &#8212; Groonga v6.1.0 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:     '6.0.9',
+        VERSION:     '6.1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,9 @@
     <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 v6.0.9 documentation" href="../index.html" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="top" title="Groonga v6.1.0 documentation" href="../index.html" />
     <link rel="up" title="4. Tutorial" href="../tutorial.html" />
     <link rel="next" title="4.9. Additional information about lexicon for full text search" href="lexicon.html" />
     <link rel="prev" title="4.7. match_columns parameter" href="match_columns.html" />
@@ -60,8 +62,8 @@
         <li class="right" >
           <a href="match_columns.html" title="4.7. match_columns parameter"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &#187;</li>
       </ul>
     </div>
@@ -292,12 +294,12 @@ select --table PatSuffix --filter &#39;_key @$ &quot;ゆき&quot; &amp;&amp; ori
         <li class="right" >
           <a href="match_columns.html" title="4.7. match_columns parameter"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2009-2016, Brazil, Inc.
+        &#169; Copyright 2009-2016, Brazil, Inc.
     </div>
   </body>
 </html>

data/vendor/local/share/doc/groonga/en/html/tutorial/query_expansion.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>4.11. Query expansion &mdash; Groonga v6.0.9 documentation</title>
+    <title>4.11. Query expansion &#8212; Groonga v6.1.0 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:     '6.0.9',
+        VERSION:     '6.1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,9 @@
     <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 v6.0.9 documentation" href="../index.html" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="top" title="Groonga v6.1.0 documentation" href="../index.html" />
     <link rel="up" title="4. Tutorial" href="../tutorial.html" />
     <link rel="next" title="5. Server" href="../server.html" />
     <link rel="prev" title="4.10. Let&#39;s create micro-blog" href="micro_blog.html" />
@@ -60,8 +62,8 @@
         <li class="right" >
           <a href="micro_blog.html" title="4.10. Let&#39;s create micro-blog"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &#187;</li>
       </ul>
     </div>
@@ -327,12 +329,12 @@ select Doc --match_columns body --query &quot;theatre&quot; --query_expander Syn
         <li class="right" >
           <a href="micro_blog.html" title="4.10. Let&#39;s create micro-blog"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2009-2016, Brazil, Inc.
+        &#169; Copyright 2009-2016, Brazil, Inc.
     </div>
   </body>
 </html>

data/vendor/local/share/doc/groonga/en/html/tutorial/search.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>4.4. Various search conditions &mdash; Groonga v6.0.9 documentation</title>
+    <title>4.4. Various search conditions &#8212; Groonga v6.1.0 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:     '6.0.9',
+        VERSION:     '6.1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,9 @@
     <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 v6.0.9 documentation" href="../index.html" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="top" title="Groonga v6.1.0 documentation" href="../index.html" />
     <link rel="up" title="4. Tutorial" href="../tutorial.html" />
     <link rel="next" title="4.5. Drilldown" href="drilldown.html" />
     <link rel="prev" title="4.3. Various data types" href="data.html" />
@@ -60,8 +62,8 @@
         <li class="right" >
           <a href="data.html" title="4.3. Various data types"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U">4. Tutorial</a> &#187;</li>
       </ul>
     </div>
@@ -610,12 +612,12 @@ select --table Site --query &quot;_id:1 OR _id:2&quot; --output_columns _key,loc
         <li class="right" >
           <a href="data.html" title="4.3. Various data types"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.9 documentation</a> &raquo;</li>
-          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.1.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../tutorial.html" >4. Tutorial</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &copy; Copyright 2009-2016, Brazil, Inc.
+        &#169; Copyright 2009-2016, Brazil, Inc.
     </div>
   </body>
 </html>

data/vendor/local/share/doc/groonga/ja/html/.buildinfo CHANGED Viewed

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c8e2534bdc6ad13b63655529e3cc8c38
+config: d5c1fd8c3142b8fd2aea1035a6f407c4
 tags: 645f666f9bcd5a90fca523b33c5a78b7

data/vendor/local/share/doc/groonga/ja/html/_sources/install/centos.txt CHANGED Viewed

@@ -169,9 +169,9 @@ Install required packages to build Groonga::
 Download source::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure (see :ref:`source-configure` about ``configure`` options)::

data/vendor/local/share/doc/groonga/ja/html/_sources/install/debian.txt CHANGED Viewed

@@ -89,9 +89,9 @@ Install required packages to build Groonga::
 Download source::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure (see :ref:`source-configure` about ``configure`` options)::

data/vendor/local/share/doc/groonga/ja/html/_sources/install/fedora.txt CHANGED Viewed

@@ -80,9 +80,9 @@ Install required packages to build Groonga::
 Download source::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure (see :ref:`source-configure` about ``configure`` options)::

data/vendor/local/share/doc/groonga/ja/html/_sources/install/mac_os_x.txt CHANGED Viewed

@@ -49,9 +49,9 @@ Install `Xcode <https://developer.apple.com/xcode/>`_.
 Download source::
-  % curl -O http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % curl -O http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure (see :ref:`source-configure` about ``configure`` options)::

data/vendor/local/share/doc/groonga/ja/html/_sources/install/others.txt CHANGED Viewed

@@ -74,9 +74,9 @@ Build from source
 Groonga uses GNU build system. So the following is the simplest build
 steps::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
   % ./configure
   % make
   % sudo make install

data/vendor/local/share/doc/groonga/ja/html/_sources/install/solaris.txt CHANGED Viewed

@@ -17,9 +17,9 @@ Install required packages to build Groonga::
 Download source::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % gtar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % gtar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure with ``CFLAGS="-m64" CXXFLAGS="-m64"`` variables. They are
 needed for building 64-bit version. To build 32-bit version, just

data/vendor/local/share/doc/groonga/ja/html/_sources/install/ubuntu.txt CHANGED Viewed

@@ -82,9 +82,9 @@ Install required packages to build Groonga::
 Download source::
-  % wget http://packages.groonga.org/source/groonga/groonga-6.0.9.tar.gz
-  % tar xvzf groonga-6.0.9.tar.gz
-  % cd groonga-6.0.9
+  % wget http://packages.groonga.org/source/groonga/groonga-6.1.0.tar.gz
+  % tar xvzf groonga-6.1.0.tar.gz
+  % cd groonga-6.1.0
 Configure (see :ref:`source-configure` about ``configure`` options)::

data/vendor/local/share/doc/groonga/ja/html/_sources/install/windows.txt CHANGED Viewed

@@ -21,14 +21,14 @@ Installer
 For 32-bit environment, download x86 executable binary from
 packages.groonga.org:
-  * http://packages.groonga.org/windows/groonga/groonga-6.0.9-x86.exe
+  * http://packages.groonga.org/windows/groonga/groonga-6.1.0-x86.exe
 Then run it.
 For 64-bit environment, download x64 executable binary from
 packages.goronga.org:
-  * http://packages.groonga.org/windows/groonga/groonga-6.0.9-x64.exe
+  * http://packages.groonga.org/windows/groonga/groonga-6.1.0-x64.exe
 Then run it.
@@ -41,14 +41,14 @@ zip
 For 32-bit environment, download x86 zip archive from
 packages.groonga.org:
-  * http://packages.groonga.org/windows/groonga/groonga-6.0.9-x86.zip
+  * http://packages.groonga.org/windows/groonga/groonga-6.1.0-x86.zip
 Then extract it.
 For 64-bit environment, download x64 zip archive from
 packages.groonga.org:
-  * http://packages.groonga.org/windows/groonga/groonga-6.0.9-x64.zip
+  * http://packages.groonga.org/windows/groonga/groonga-6.1.0-x64.zip
 Then extract it.
@@ -66,27 +66,27 @@ Windows. Here are required tools:
 Download zipped source from packages.groonga.org:
-  * http://packages.groonga.org/source/groonga/groonga-6.0.9.zip
+  * http://packages.groonga.org/source/groonga/groonga-6.1.0.zip
 Then extract it.
 Move to the Groonga's source folder::
-  > cd c:\Users\%USERNAME%\Downloads\groonga-6.0.9
+  > cd c:\Users\%USERNAME%\Downloads\groonga-6.1.0
 Configure by ``cmake``. The following commnad line is for 64-bit
 version. To build 32-bit version, use ``-G "Visual Studio 12 2013"``
 parameter instead::
-  groonga-6.0.9> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga
+  groonga-6.1.0> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga
 Build::
-  groonga-6.0.9> cmake --build . --config Release
+  groonga-6.1.0> cmake --build . --config Release
 Install::
-  groonga-6.0.9> cmake --build . --config Release --target Install
+  groonga-6.1.0> cmake --build . --config Release --target Install
 After the above steps, :doc:`/reference/executables/groonga` is found at
 ``c:\Groonga\bin\groonga.exe``.

data/vendor/local/share/doc/groonga/ja/html/_sources/news.txt CHANGED Viewed

@@ -7,6 +7,65 @@
 News
 ====
+.. _release-6-1-0:
+Release 6.1.0 - 2016-10-29
+--------------------------
+Improvements
+^^^^^^^^^^^^
+* [:doc:`/reference/commands/dump`] Supported to sort load table names by key instead of ID to make output stable. This is incompatible change but it makes easy to compare result of dump command.
+* [:doc:`/reference/commands/table_create`][:doc:`/reference/commands/column_create`]
+  Revised outdated descriptions with execution examples. English
+  documentation is also published and section about small/medium index
+  column is also added.
+* [experimental][httpd] Supported mruby to customize configuration
+  settings in groonga-httpd.conf.
+* [windows] Updated bundled Groonga Admin to 0.9.5. It is recommended
+  to upgrade because amount of memory usage is drastically
+  reduced. Note that this version drops Groonga 5.0.8 or earlier
+  support.
+* Added log token and token ID on error. [Gitter:groonga/ja:58043f77614116a2568d529c]
+  [Suggested by torinky]
+* [:doc:`/reference/tables`] Updated description about the max record ID.
+* [mruby] Suppported to convert time of ``mrb_value`` to ``grn_bulk``.
+  [GitHub:#607] [Patch by Naoya Murakami]
+* [ubuntu] Supported Ubuntu 16.10 (Yakkety Yak)
+* [httpd] Updated bundled nginx to 1.11.5.
+Fixes
+^^^^^
+* Fixed a bug that table of index column was reported in log instead of
+  correct index column.
+* Fixed a bug that unexpected "invalid cursor error" is recorded in
+  log file. [Gitter:groonga/ja:57f2ff87d45d7f0f525e2216] [Reported by
+  torinky]
+* Fixed a memory leak on static index construction.
+* [hash] Fixed a memory leak for many token filters are set case.
+* [:doc:`/reference/commands/select`] Fixed a bug that wrong column
+  name that starts with number in output_columns is not ignored. It
+  caused a syntax error.
+Thanks
+^^^^^^
+* torinky
+* Naoya Murakami
 .. _release-6-0-9:
 Release 6.0.9 - 2016-09-29
@@ -50,7 +109,7 @@ Fixes
 * [doc] Fixed a missing entry in Groonga 6.0.2 news that sequential
   search is also executed as a fallback for :doc:`/reference/functions/geo_in_circle` [Reported by Gurunavi,
-  Inc]
+  Inc.]
 * [:doc:`/reference/commands/table_create`] Fixed a bug that
   ``table_create`` command accepts no key type for ``TABLE_PAT_KEY``,
@@ -68,7 +127,7 @@ Thanks
 * Brad Smith
 * Kazuhiko
-* Gurunavi, Inc
+* Gurunavi, Inc.
 .. _release-6-0-8:

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/column_create.txt CHANGED Viewed

@@ -2,100 +2,799 @@
 .. highlightlang:: none
+.. groonga-command
+.. database: commands_column_create
 ``column_create``
 =================
 Summary
 -------
-column_create - カラムの追加
+``column_create`` creates a new column in a table.
-Groonga組込コマンドの一つであるcolumn_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+You need to create one or more columns to store multiple data in one
+record.
-column_createは、使用しているデータベースのテーブルに対してカラムを追加します。
+Groonga provides an index as a column. It's different from other
+systems. An index is just an index in other systems. Implementing an
+index as a column provides flexibility. For example, you can add
+metadata to each token.
+See :doc:`/reference/column` for column details.
 Syntax
 ------
-::
- column_create table name flags type [source]
+This command takes many parameters.
+Most parameters are required::
+  column_create table
+                name
+                flags
+                type
+                [source=null]
 Usage
 -----
-テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。::
+This section describes about the followings:
+  * :ref:`column-create-scalar`
+  * :ref:`column-create-vector`
+  * :ref:`column-create-vector-weight`
+  * :ref:`column-create-reference`
+  * :ref:`column-create-index`
+  * :ref:`column-create-index-full-text-search`
+  * :ref:`column-create-index-multiple-columns`
+  * :ref:`column-create-index-small`
+  * :ref:`column-create-index-medium`
+Here is the ``People`` table definition. The ``People`` table is used
+in examples:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_table.log
+.. table_create \
+..   --name People \
+..   --flags TABLE_HASH_KEY \
+..   --key_type ShortText
+.. _column-create-scalar:
+Create a scalar column
+^^^^^^^^^^^^^^^^^^^^^^
+Groonga provides scalar column to store one value. For example, scalar
+column should be used for storing age into a person record. Because a
+person record must have only one age.
+If you want to store multiple values into a record, scalar column
+isn't suitable. Use :ref:`column-create-vector` instead.
+You must specify ``COLUMN_SCALAR`` to the ``flags`` parameter to
+create a scalar column.
+Here is an example to create the ``age`` column to the ``People``
+table. ``age`` column is a scalar column. It can store one ``UInt8``
+(``0-255``) value as its value:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_scalar_create.log
+.. column_create \
+..   --table People \
+..   --name age \
+..   --flags COLUMN_SCALAR \
+..   --type UInt8
+You can store one value (``7``) by the following :doc:`load` command:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_scalar_load.log
+.. load --table People
+.. [
+.. {"_key": "alice", "age": 7}
+.. ]
+You can confirm the stored one value (``7``) by the following
+:doc:`select` command:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_scalar_select.log
+.. select --table People
+.. _column-create-vector:
+Create a vector column
+^^^^^^^^^^^^^^^^^^^^^^
+Groonga provides vector column to store multiple values. For example,
+vector column may be used for storing roles into a person
+record. Because a person record may have multiple roles.
+If you want to store only one value into a record, vector column isn't
+suitable. Use :ref:`column-create-scalar` instead.
+You must specify ``COLUMN_VECTOR`` to the ``flags`` parameter to
+create a vector column.
+Here is an example to create the ``roles`` column to the ``People``
+table. ``roles`` column is a vector column. It can store zero or more
+``ShortText`` values as its value:
-  column_create Entry body --type ShortText
-  [true]
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_vector_create.log
+.. column_create \
+..   --table People \
+..   --name roles \
+..   --flags COLUMN_VECTOR \
+..   --type ShortText
-テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。::
+You can store multiple values (``["adventurer", "younger-sister"]``)
+by the following :doc:`load` command:
-  column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body
-  [true]
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_scalar_load.log
+.. load --table People
+.. [
+.. {"_key": "alice", "roles": ["adventurer", "younger-sister"]}
+.. ]
+You can confirm the stored multiple values (``["adventurer",
+"younger-sister"]``) by the following :doc:`select` command:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_vector_select.log
+.. select --table People
+.. _column-create-vector-weight:
+Create a weight vector column
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+TODO: See also :ref:`weight-vector-column` and :ref:`select-adjuster`.
+.. _column-create-reference:
+Create a column that refers a table's record
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Both scalar column and vector column can store reference to record of
+an existing table as column value. It's useful to store relationship
+between records.
+For example, using a column that refers a person record is better for
+storing a character into a book record. Because one person may be
+appeared in some books.
+You must specify table name to be referenced to the ``type`` parameter
+to create a column that refers a table's record.
+Here is an example to create the ``character`` column to the ``Books``
+table. The ``character`` column refers the ``People`` table. It can
+store one ``People`` table's record.
+Here is the ``Books`` table definition:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_reference_create_table.log
+.. table_create \
+..   --name Books \
+..   --flags TABLE_HASH_KEY \
+..   --key_type ShortText
+Here is the ``character`` column definition in the ``Books``
+table. ``--type People`` is important:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_reference_create_column.log
+.. column_create \
+..   --table Books \
+..   --name character \
+..   --flags COLUMN_SCALAR \
+..   --type People
+You can store one reference (``"alice"``) by the following :doc:`load`
+command. You can use key value (``People._key`` value) for referring a
+record:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_reference_load.log
+.. load --table Books
+.. [
+.. {"_key": "Alice's Adventure in Wonderland", "character": "alice"}
+.. ]
+You can confirm the stored reference (``"alice"`` record) by the
+following :doc:`select` command. It retrieves the ``age`` column and
+the ``roles`` column values:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_reference_select.log
+.. select \
+..  --table Books \
+..  --output_columns _key,character._key,character.age,character.roles
+.. _column-create-index:
+Create an index column
+^^^^^^^^^^^^^^^^^^^^^^
+Groonga provides index column for fast search. It doesn't store your
+data. It stores data for fast search.
+You don't need to update index column by yourself. Index column is
+updated automatically when you store data into a data column (scalar
+column or vector column) that is marked as index target column. You
+can set multiple columns as index target columns to one index column.
+If Groonga has an index column for the ``age`` column of the
+``People`` table, Groonga can do fast equal search, fast comparison
+search and fast range search against ``age`` column values.
+You must specify the following parameters to create an index column:
+  * The ``flags`` parameter: ``COLUMN_INDEX``
+  * The ``type`` parameter: The table name of index target column such
+    as ``People``
+  * The ``source`` parameter: The index target column name such as
+    ``age``
+You don't need additional flags to the ``flags`` parameter for equal
+search, comparison search and range search index column. You need
+additional flags to the ``flags`` parameter for full text search index
+column or multiple column index column. See
+:ref:`column-create-index-full-text-search` and
+:ref:`column-create-index-multiple-columns` for details.
+Here is an example to create an index column for the ``age`` column of
+the ``People`` table.
+First, you need to create a table for range index column. See
+:ref:`table-create-range-index-table` for details. This example
+creates the ``Ages`` table as :ref:`table-pat-key`:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_index_create_table.log
+.. table_create \
+..   --name Ages \
+..   --flags TABLE_PAT_KEY \
+..   --key_type UInt8
+Now, you can create an index column for the ``age`` column of the
+``People`` table. ``COLUMN_INDEX`` in the ``flags`` parameter,
+``People`` in the ``type`` parameter and ``age`` in the ``source``
+parameter are important:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_index_create_column.log
+.. column_create \
+..   --table Ages \
+..   --name people_age_index \
+..   --flags COLUMN_INDEX \
+..   --type People \
+..   --source age
+You can confirm that ``age > 5`` is evaluated by the
+``Ages.people_age_index`` newly created index column from log. Groonga
+reports used index columns in ``info`` log level. You can change log
+level dynamically by :doc:`log_level` command.
+.. groonga-command
+.. log: true
+.. include:: ../../example/reference/commands/column_create/usage_index_select.log
+.. log_level --level info
+.. select \
+..   --table People \
+..   --filter 'age > 5'
+.. log_level --level notice
+.. log: false
+You can confirm that the ``Ages.people_age_index`` is used from the
+following log::
+  [table][select][index][range] <Ages.people_age_index>
+The log says ``Ages.people_age_index`` index column is used for range
+search.
+.. _column-create-index-full-text-search:
+Create an index column for full text search
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+There is a difference between for non full text search (equal search,
+comparison search or range search) index column and for full text
+search index column. You need to add ``WITH_POSITION`` to the
+``flags`` parameter. It means that you need to specify
+``COLUMN_INDEX|WITH_POSITION`` to the ``flags`` parameter. It's the
+difference.
+Here is an example to create a full text search index column for the
+``roles`` column of the ``People`` table.
+First, you need to create a table for full text search index
+column. See :ref:`table-create-lexicon` for details. This example
+creates the ``Terms`` table as :ref:`table-pat-key` with
+:ref:`token-bigram` tokenizer and :ref:`normalizer-auto` normalizer:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_full_text_search_index_create_table.log
+.. table_create \
+..   --name Terms \
+..   --flags TABLE_PAT_KEY \
+..   --key_type ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto
+Now, you can create a full text search index column for the ``roles``
+column of the ``People`` table. ``COLUMN_INDEX|WITH_POSITION`` in the
+``flags`` parameter, ``People`` in the ``type`` parameter and
+``roles`` in the ``source`` parameter are important:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_full_text_search_index_create_column.log
+.. column_create \
+..   --table Terms \
+..   --name people_roles_index \
+..   --flags COLUMN_INDEX|WITH_POSITION \
+..   --type People \
+..   --source roles
+You can confirm that ``--match_columns roles`` and ``--query Sister``
+are evaluated by the ``Terms.people_roles_index`` newly created full
+text search index column from log. Groonga reports used index columns
+in ``info`` log level. You can change log level dynamically by
+:doc:`log_level` command.
+.. groonga-command
+.. log: true
+.. include:: ../../example/reference/commands/column_create/usage_full_text_search_index_select.log
+.. log_level --level info
+.. select \
+..   --table People \
+..   --match_columns roles \
+..   --query Sister
+.. log_level --level notice
+.. log: false
+You can confirm that the ``Terms.people_roles_index`` is used from the
+following log::
+  [object][search][index][key][exact] <Terms.people_roles_index>
+The log says ``Terms.people_roles_index`` index column is used for
+full text search. (To be precise, the index column is used for exact
+term search by inverted index.)
+.. _column-create-index-multiple-columns:
+Create a multiple columns index column
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You can create an index column for multiple columns. It means that you
+can do fast search for multiple columns with one index
+column. Multiple columns index column has better space efficiency than
+single column index column only when multiple columns have many same
+tokens. Multiple columns index column may be slower than single column
+index column. Because multiple columns index column will be a bigger
+index column.
+You can't use multiples columns in different tables as index target
+columns in the same multiple columns index column. You must specify
+columns in the same tables as index target columns to one multiple
+columns index column. For example, you can't create a multiple columns
+index for ``People._key`` and ``Books._key`` because they are columns
+of different tables. You can create a multiple columns index column
+for ``People._key`` and ``People.roles`` because they are columns of
+the same table.
+There is a difference between for single column index column and for
+multiple columns index column. You need to add ``WITH_SECTION`` to the
+``flags`` parameter. It means that you need to specify
+``COLUMN_INDEX|WITH_SECTION`` to the ``flags`` parameter. It's the
+difference.
+If you want to create a multiple columns index column for full text
+search, you need to specify
+``COLUMN_INDEX|WITH_POSITION|WITH_SECTION`` to the ``flags``
+parameter. See :ref:`column-create-index-full-text-search` for full
+text search index column details.
+Here is an example to create a multiple columns full text search index
+column for the key of the ``People`` table and the ``roles`` column of
+the ``People`` table.
+There is no difference between index table for single column index
+column and multiple columns index column. In this example, the
+``Terms`` table created at :ref:`column-create-index-full-text-search`
+is used.
+You can create a multiple columns full text search index column for
+the key of the ``People`` table and ``roles`` column of the ``People``
+table. ``COLUMN_INDEX|WITH_POSITION|WITH_SECTION`` in the ``flags``
+parameter, ``People`` in the ``type`` parameter and ``_key,roles`` in
+the ``source`` parameter are important:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_multiple_columns_index_create_column.log
+.. column_create \
+..   --table Terms \
+..   --name people_key_roles_index \
+..   --flags COLUMN_INDEX|WITH_POSITION|WITH_SECTION \
+..   --type People \
+..   --source _key,roles
+You can confirm that ``--match_columns _key`` and ``--query
+Alice`` are evaluated by the ``Terms.people_key_roles_index`` newly
+created multiple columns full text search index column from log. Groonga
+reports used index columns in ``info`` log level. You can change log level
+dynamically by :doc:`log_level` command.
+.. groonga-command
+.. log: true
+.. include:: ../../example/reference/commands/column_create/usage_multiple_columns_index_select.log
+.. log_level --level info
+.. select \
+..   --table People \
+..   --match_columns _key,roles \
+..   --query Alice
+.. log_level --level notice
+.. log: false
+You can confirm that the ``Terms.people_roles_index`` is used from the
+following log::
+  [object][search][index][key][exact] <Terms.people_key_roles_index>
+The log says ``Terms.people_roles_index`` index column is used for
+full text search. (To be precise, the index column is used for exact
+term search by inverted index.)
+.. _column-create-index-small:
+Create a small index column
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you know index target data are small, you can reduce memory usage
+for the index column. Memory usage is ``1/256`` of the default index
+column.
+How many data are small? It depends on data. Small index column can't
+handle 1 billion records at least. If index target is only one
+scalar column with no text family type (``ShortText``, ``Text`` or
+``LongText``), the maximum handleable records are depends of the
+number of kinds of index target data. If index target column has
+``1``, ``1``, ``2`` and ``3``, the number of kinds of them are ``3``
+(``1`` and ``2`` and ``3``). The following table shows the
+relationship between the number of kinds of index target data and the
+number of handleable records:
+.. list-table:: The number of kinds of index target data and the number of handleable records in a small index column
+   :header-rows: 1
+   * - The number of kinds of index target data
+     - The number of hanleable records
+   * - 1
+     - 16779234
+   * - 2
+     - 4648070
+   * - 4
+     - 7238996
+   * - 8
+     - 8308622
+   * - 16
+     - 11068624
+   * - 32
+     - 12670817
+   * - 64
+     - 18524211
+   * - 128
+     - 38095511
+   * - 256
+     - 51265384
+You need to add ``INDEX_SMALL`` to the ``flags`` parameter such as
+``COLUMN_INDEX|INDEX_SMALL`` to create a small index column.
+If the ``People`` table has only 1 million records, you can use a
+small index column for the ``age`` column:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_small_index_create_column.log
+.. column_create \
+..   --table Ages \
+..   --name people_age_small_index \
+..   --flags COLUMN_INDEX|INDEX_SMALL \
+..   --type People \
+..   --source age
+.. _column-create-index-medium:
+Create a medium index column
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you know index target data are medium, you can reduce memory usage
+for the index column. Memory usage is ``5/24`` of the default index
+column.
+How many data are medium? It depends on data.
+If index target is only one scalar column, a medium index column
+can handle all records.
+A medium index column may not handle all records at the following
+cases:
+  * Index target is one text family (``ShortText``, ``Text`` or
+    ``LongText``) scalar column
+  * Index target is one vector column
+  * Index targets are multiple columns
+  * Index table has tokenizer
+You need to add ``INDEX_MEDIUM`` to the ``flags`` parameter such as
+``COLUMN_INDEX|INDEX_MEDIUM`` to create a medium index column.
+You can use a medium index column for an index column of the ``age``
+column of the ``People`` table safely. Because it's one scalar column
+with ``UInt8`` type.
+Here is an example to create a medium index column:
+.. groonga-command
+.. include:: ../../example/reference/commands/column_create/usage_medium_index_create_column.log
+.. column_create \
+..   --table Ages \
+..   --name people_age_medium_index \
+..   --flags COLUMN_INDEX|INDEX_MEDIUM \
+..   --type People \
+..   --source age
 Parameters
 ----------
+This section describes all parameters.
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+There are some required parameters.
+.. _column-create-table:
 ``table``
+"""""""""
+Specifies an existing table name for the new column.
-  カラムを追加するテーブルの名前を指定します。
+.. _column-create-name:
 ``name``
+""""""""
+Specifies the column name to be created.
+The column name must be unique in the same table.
+Here are available characters:
+* ``0`` .. ``9`` (digit)
+* ``a`` .. ``z`` (alphabet, lower case)
+* ``A`` .. ``Z`` (alphabet, upper case)
+* ``#`` (hash)
+* ``@`` (at mark)
+* ``-`` (hyphen)
+* ``_`` (underscore) (NOTE: Underscore can't be used as the first
+  character.)
+You need to create a name with one or more the above characters. Note
+that you can't use ``_`` as the first character such as ``_name``.
-  作成するカラムの名前を指定します。カラム名は、テーブルの中で一意でなければなりません。
-  ピリオド('.'), コロン(':')を含む名前のカラムは作成できません。また、アンダースコア('_')で始まる名前は予約済みであり、使用できません。
+.. _column-create-flags:
 ``flags``
+"""""""""
-  カラムの属性を表す以下の数値か、パイプ('|')で組み合わせたシンボル名を指定します。
+Specifies the column type and column customize options.
-  0, ``COLUMN_SCALAR``
-    単一の値が格納できるカラムを作成します。
-  1, ``COLUMN_VECTOR``
-    複数の値の配列を格納できるカラムを作成します。
-  2, ``COLUMN_INDEX``
-    インデックス型のカラムを作成します。
+Here are available flags:
-  There are two flags to compress the value of column, but you can't specify these flags for now because there are memory leaks issue `GitHub#6 <https://github.com/groonga/groonga/issues/6>`_ when refers the value of column. This issue occurs both of them (zlib and lzo).
+.. list-table::
+   :header-rows: 1
-  16, ``COMPRESS_ZLIB``
-    Compress the value of column by using zlib. This flag is enabled when you build Groonga with ``--with-zlib``.
-  32, ``COMPRESS_LZO``
-    Compress the value of column by using lzo. This flag is enabled when you build Groonga with ``--with-lzo``.
+   * - Flag
+     - Description
-  インデックス型のカラムについては、flagsの値に以下の値を加えることによって、追加の属
-  性を指定することができます。
+   * - ``COLUMN_SCALAR``
+     - Scalar column. It can store one value. See also
+       :doc:`/reference/columns/scalar` or
+       :ref:`column-create-scalar`.
-  128, ``WITH_SECTION``
-    段落情報を格納するインデックスを作成します。
+   * - ``COLUMN_VECTOR``
+     - Vector column. It can store multiple values. See also
+       :doc:`/reference/columns/vector` or
+       :ref:`column-create-vector`.
-  256, ``WITH_WEIGHT``
-    ウェイト情報を格納するインデックスを作成します。
+   * - ``COLUMN_INDEX``
+     - Index column. It stores data for fast search. See also
+       :doc:`/reference/columns/index` or
+       :ref:`column-create-index`.
-  512, ``WITH_POSITION``
-    位置情報を格納するインデックス(完全転置インデックス)を作成します。
+   * - ``COMPRESS_ZLIB``
+     - It enables column value compression by zlib. You need Groonga
+       that enables zlib support.
+       Compression by zlib is higher space efficiency than compression
+       by LZ4. But compression by zlib is slower than compression by
+       LZ4.
+       This flag is available only for ``COLUMN_SCALAR`` and
+       ``COLUMN_VECTOR``.
+   * - ``COMPRESS_LZ4``
+     - It enables column value compression by LZ4. You need Groonga
+       that enables LZ4 support.
+       Compression by LZ4 is faster than compression by zlib. But
+       compression by LZ4 is lower space efficiency than compression
+       by zlib.
+       This flag is available only for ``COLUMN_SCALAR`` and
+       ``COLUMN_VECTOR``.
+   * - ``WITH_SECTION``
+     - It enables section support to index column.
+       If section support is enabled, you can support multiple
+       documents in the same index column.
+       You must specify this flag to create a multiple columns index
+       column. See also :ref:`column-create-index-multiple-columns` for
+       details.
+       Section support requires additional spaces. If you don't need
+       section support, you should not enable section support.
+       This flag is available only for ``COLUMN_INDEX``.
+   * - ``WITH_WEIGHT``
+     - It enables weight support to vector column or index column.
+       If weight support is enabled for vector column, you can add
+       weight for each element. If weight support is enabled for index
+       column, you can add weight for each posting. They are useful to
+       compute suitable search score.
+       You must specify this flag to use :ref:`select-adjuster`. See
+       also :ref:`column-create-vector-weight` for details.
+       Weight support requires additional spaces. If you don't need
+       weight support, you should not enable weight support.
+       This flag is available only for ``COLUMN_VECTOR`` or
+       ``COLUMN_INDEX``.
+   * - ``WITH_POSITION``
+     - It enables position support to index column. It means that the
+       index column is full inverted index. (Index column is
+       implemented as inverted index.)
+       If position support is enabled, you can add position in the
+       document for each posting. It's required for phrase search. It
+       means that index column for full text search must enable
+       position support because most full text search uses phrase
+       search.
+       You must specify this flag to create a full text search index
+       column. See also :ref:`column-create-index-full-text-search` for
+       details.
+       Position support requires additional spaces. If you don't need
+       position support, you should not enable position support.
+       This flag is available only for ``COLUMN_INDEX``.
+   * - ``INDEX_SMALL``
+     - .. versionadded:: 6.0.8
+       It requires to create a small index column.
+       If index target data are small, small index column is enough.
+       Small index column uses fewer memory than a normal index column
+       or a medium index column. See also
+       :ref:`column-create-index-small` for knowing what are "small
+       data" and how to use this flag.
+       This flag is available only for ``COLUMN_INDEX``.
+   * - ``INDEX_MEDIUM``
+     - .. versionadded:: 6.0.8
+       It requires to create a medium index column.
+       If index target data are medium, medium index column is enough.
+       Medium index column uses fewer memory than a normal index
+       column. See also :ref:`column-create-index-medium` for knowing
+       what are "medium data" and how to use this flag.
+       This flag is available only for ``COLUMN_INDEX``.
+You must specify one of ``COLUMN_${TYPE}`` flags. You can't specify
+two or more ``COLUMN_${TYPE}`` flags. For example,
+``COLUMN_SCALAR|COLUMN_VECTOR`` is invalid.
+You can combine flags with ``|`` (vertical bar) such as
+``COLUMN_INDEX|WITH_SECTION|WITH_POSITION``.
+.. _column-create-type:
 ``type``
+""""""""
+Specifies type of the column value.
+If the column is scalar column or vector column, here are available
+types:
+  * Builtin types described in :doc:`/reference/types`
+  * Tables defined by users
-  値の型を指定します。Groongaの組込型か、同一データベースに定義済みのユーザ定義型、定義済みのテーブルを指定することができます。
+If the column is index column, here are available types:
+  * Tables defined by users
+See also the followings:
+  * :ref:`column-create-scalar`
+  * :ref:`column-create-vector`
+  * :ref:`column-create-reference`
+  * :ref:`column-create-index`
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+There is an optional parameter.
+.. _column-create-source:
 ``source``
+""""""""""
-  インデックス型のカラムを作成した場合は、インデックス対象となるカラムをsource引数に指定します。
+Specifies index target columns. You can specify one or more columns to
+the ``source`` parameter.
+This parameter is only available for index column.
+You can only specify columns of the table specified as
+:ref:`column-create-type`. You can also use the ``_key`` pseudo column
+for specifying the table key as index target.
+If you specify multiple columns to the ``source`` parameter, separate
+columns with ``,`` (comma) such as ``_key,roles``.
 Return value
 ------------
-::
+``column_create`` returns ``true`` as body on success such as::
+  [HEADER, true]
+If ``column_create`` fails, ``column_create`` returns ``false`` as
+body::
- [HEADER, SUCCEEDED]
+  [HEADER, false]
-``HEADER``
+Error details are in ``HEADER``.
-  See :doc:`/reference/command/output_format` about ``HEADER``.
+See :doc:`/reference/command/output_format` for ``HEADER``.
-``SUCCEEDED``
+See also
+--------
-  If command is succeeded, it returns true on success, false otherwise.
+  * :doc:`/reference/column`
+  * :doc:`/reference/commands/table_create`
+  * :doc:`/reference/command/output_format`