RubyGems - rroonga - Versions diffs - 2.0.2-x86-mingw32 → 2.0.3-x86-mingw32 - Mend

rroonga 2.0.2-x86-mingw32 → 2.0.3-x86-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 (398) hide show

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

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>4. Tutorial &mdash; groonga v2.0.0 documentation</title>
+    <title>4. Tutorial &mdash; groonga v2.0.2 documentation</title>
     <link rel="stylesheet" href="_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2.0.0',
+        VERSION:     '2.0.2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,7 +27,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 v2.0.0 documentation" href="index.html" />
+    <link rel="top" title="groonga v2.0.2 documentation" href="index.html" />
     <link rel="next" title="4.1. Basic operations" href="tutorial/introduction.html" />
     <link rel="prev" title="3. Community" href="community.html" />
   </head>
@@ -61,7 +61,7 @@
         <li class="right" >
           <a href="community.html" title="3. Community"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">groonga v2.0.0 documentation</a> &raquo;</li>
+        <li><a href="index.html">groonga v2.0.2 documentation</a> &raquo;</li>
       </ul>
     </div>
@@ -197,7 +197,7 @@
         <li class="right" >
           <a href="community.html" title="3. Community"
              >previous</a> |</li>
-        <li><a href="index.html">groonga v2.0.0 documentation</a> &raquo;</li>
+        <li><a href="index.html">groonga v2.0.2 documentation</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

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

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.4. データ型 &mdash; groonga v2.0.0 documentation</title>
+    <title>7.4. データ型 &mdash; groonga v2.0.2 documentation</title>
     <link rel="stylesheet" href="_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2.0.0',
+        VERSION:     '2.0.2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,7 +27,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 v2.0.0 documentation" href="index.html" />
+    <link rel="top" title="groonga v2.0.2 documentation" href="index.html" />
     <link rel="up" title="7. リファレンスマニュアル" href="reference.html" />
     <link rel="next" title="7.5. 疑似カラム (pseudo_column)" href="pseudo_column.html" />
     <link rel="prev" title="7.3.24. view_add" href="commands/view_add.html" />
@@ -62,7 +62,7 @@
         <li class="right" >
           <a href="commands/view_add.html" title="7.3.24. view_add"
              accesskey="P">previous</a> |</li>
-        <li><a href="index.html">groonga v2.0.0 documentation</a> &raquo;</li>
+        <li><a href="index.html">groonga v2.0.2 documentation</a> &raquo;</li>
           <li><a href="reference.html" accesskey="U">7. リファレンスマニュアル</a> &raquo;</li>
       </ul>
     </div>
@@ -235,7 +235,7 @@
         <li class="right" >
           <a href="commands/view_add.html" title="7.3.24. view_add"
              >previous</a> |</li>
-        <li><a href="index.html">groonga v2.0.0 documentation</a> &raquo;</li>
+        <li><a href="index.html">groonga v2.0.2 documentation</a> &raquo;</li>
           <li><a href="reference.html" >7. リファレンスマニュアル</a> &raquo;</li>
       </ul>
     </div>

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: f619d331026fc8e0738d40ea9d41e0f4
+config: 770c721fe4d86184fedd500e281f7258
 tags: fbb0d17656682115ca4d033fb2f83ba1

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

@@ -2,190 +2,438 @@
 .. highlightlang:: none
+.. groonga-command
+.. database: commands_select
 select
 ======
-名前
-----
+Summary
+-------
+``select`` searches records that are matched to specified conditions
+from a table and then outputs them.
+``select`` is the most important command in groonga. You need to
+understand ``select`` to use the full power of groonga.
+Syntax
+------
+``select`` has many parameters. The required parameter is only
+``table`` and others are optional::
+  select table
+         [match_columns=null]
+         [query=null]
+         [filter=null]
+         [scorer=null]
+         [sortby=null]
+         [output_columns="_id, _key, *"]
+         [offset=0]
+         [limit=10]
+         [drilldown=null]
+         [drilldown_sortby=null]
+         [drilldown_output_columns=null]
+         [drilldown_offset=0]
+         [drilldown_limit=10]
+         [cache=yes]
+         [match_escalation_threshold=0]
+         [query_expansion=null]
+Usage
+-----
+Let's learn about ``select`` usage with examples. This section shows
+many popular usages.
+Here are a schema definition and sample data to show usage.
+.. groonga-command
+.. include:: ../example/commands/select/usage_setup.log
+.. table_create Entries TABLE_HASH_KEY ShortText
+.. column_create Entries content COLUMN_SCALAR Text
+.. 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
+.. load --table Entries
+.. [
+.. {"_key": "The first post!", "content": "Welcome! This is my first post!"},
+.. {"_key": "Groonga", "content": "I started to use groonga. It's very fast!"}
+.. {"_key": "Mroonga", "content": "I also started to use mroonga. It's also very fast! Really fast!"}
+.. ]
+There is a table, ``Entries``, for blog entries. An entry has title
+and content. Title is key of ``Entries``. Content is value of
+``Entries.content`` column.
+``Entries._key`` column and ``Entries.content`` column are indexed
+using ``TokenBigram`` tokenizer. So both ``Entries._key`` and
+``Entries.content`` are fulltext search ready.
+OK. The schema and data for examples are ready.
+Simple usage
+^^^^^^^^^^^^
+Here is the most simple usage with the above shema and data. It outputs
+all records in ``Entries`` table.
+.. groonga-command
+.. include:: ../example/commands/select/simple_usage.log
+.. select Entries
+Why does the command output all records? There are two reasons. The
+first reason is that the command doesn't specify any search
+conditions. No search condition means all records are matched. The
+second reason is that the number of all records is 3. ``select``
+command outputs 10 records at a maximum by default. There are only 3
+records. It is less than 10. So the command outputs all records.
+Search conditions
+^^^^^^^^^^^^^^^^^
+Search conditions are specified by ``query`` or ``filter``. You can
+also specify both ``query`` and ``filter``. It means that selected
+records must be matched against both ``query`` and ``filter``.
+Search condition: ``query``
+"""""""""""""""""""""""""""
+``query`` is designed for search box in Web page. Imagine a search box
+in google.com. You specify search conditions for ``query`` as space
+separated keywords. For example, ``search engine`` means a matched
+record should contain two words, ``search`` and ``engine``.
+Normally, ``query`` parameter is used for specifying fulltext search
+conditions. It can be used for non fulltext search conditions but
+``filter`` is used for the propose.
+``query`` parameter is used with ``match_columns`` parameter when
+``query`` parameter is used for specifying fulltext search
+conditions. ``match_columns`` specifies which columnes and indexes are
+matched against ``query``.
+Here is a simple ``query`` usage example.
+.. groonga-command
+.. include:: ../example/commands/select/simple_query.log
+.. select Entries --match_columns content --query fast
+The ``select`` command searches records that contain a word ``fast``
+in ``content`` column value from ``Entries`` table.
+``query`` has query syntax but its deatils aren't described here. See
+:doc:`/spec/query_syntax` for datails.
+Search condition: ``filter``
+""""""""""""""""""""""""""""
+``filter`` is designed for complex search conditions. You specify
+search conditions for ``filter`` as ECMAScript like syntax.
+Here is a simple ``filter`` usage example.
+.. groonga-command
+.. include:: ../example/commands/select/simple_filter.log
+.. select Entries --filter 'content @ "fast" && _key == "Groonga"'
-select - テーブルの中から条件にマッチするレコードを検索して出力する
+The ``select`` command searches records that contain a word ``fast``
+in ``content`` column value and has ``Groonga`` as ``_key`` from
+``Entries`` table. There are three operators in the command, ``@``,
+``&&`` and ``==``. ``@`` is fulltext search operator. ``&&`` and
+``==`` are the same as ECMAScript. ``&&`` is logical AND operator and
+``==`` is equality operator.
-書式
-----
-::
+``filter`` has more operators and syntax like grouping by ``(...)``
+its deatils aren't described here. See :doc:`/spec/script_syntax` for
+datails.
- select table [match_columns [query [filter [scorer [sortby [output_columns
-              [offset [limit [drilldown [drilldown_sortby [drilldown_output_columns
-              [drilldown_offset [drilldown_limit [cache
-              [match_escalation_threshold [query_expansion]]]]]]]]]]]]]]]]
+Paging
+^^^^^^
-説明
-----
+You can specify range of outputted records by ``offset`` and ``limit``.
+Here is an example to output only the 2nd record.
-groonga組込コマンドの一つであるselectについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+.. groonga-command
+.. include:: ../example/commands/select/paging.log
+.. select Entries --offset 1 --limit 1
-selectは、使用しているデータベースのテーブルの中から条件にマッチするレコードを検索して出力します。
+``offset`` is zero-origin. ``--offset 1`` means output range is
+started from the 2nd record.
-引数
-----
+``limit`` specifies the max number of output records. ``--limit 1``
+means the number of output records is 1 at a maximium. If no records
+are matched, ``select`` command outputs no records.
-``table``
+The total number of records
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  検索対象のテーブルを指定します。存在しないテーブルを指定した場合はエラーになります。
+You can use ``--limit 0`` to retrieve the total number of recrods
+without any contents of records.
-``match_columns``
+.. groonga-command
+.. include:: ../example/commands/select/no_limit.log
+.. select Entries --limit 0
-  query引数に指定する検索条件文字列でデフォルトの検索対象となるカラムを指定します。
+``--limit 0`` is also useful for retrieving only the number of matched
+records.
-    カラム名
+Parameters
+----------
-  カラム名の後ろに'* 数値'を指定することによって、そのカラムにヒットした際のスコアに積算される重みを指定することができます。
+This section describes all parameters. Parameters are categorized.
-    カラム名 * 重み
+Required parameter
+^^^^^^^^^^^^^^^^^^
-  複数のカラムを'||'で結合して指定することもできます。
+There is a required parameter, ``table``.
-    カラム名1 * 重み1 || カラム名2 * 重み2
+``table``
+"""""""""
-  また、カラム名ではなく、検索に使用するインデックス名を指定することもできます。
+It specifies a table to be searched. ``table`` must be specified.
-``query``
+If nonexistent table is specified, an error is returned.
-  以下の形式の文字列によって検索条件を指定します。
+.. groonga-command
+.. include:: ../example/commands/select/table_nonexistent.log
+.. select Nonexistent
-条件式
-^^^^^^
+Search related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^
-以下の条件式が使用できます。
+There are search related parameters. Typically, ``match_columns`` and
+``query`` parameters are used for implementing a search
+box. ``filter`` parameters is used for implementing complex search
+feature.
-文字列
-  全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)
+If both ``query`` and ``filter`` are specified, selected records must
+be matched against both ``query`` and ``filter``. If both ``query``
+and ``filter`` aren't specified, all records are selected.
-\"文字列\"
-  フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)
+``match_columns``
+"""""""""""""""""
+It specifies the default target column for fulltext search by
+``query`` parameter value. A target column for fulltext search can be
+specified in ``query`` parameter. The difference between
+``match_columns`` and ``query`` is whether weight is supported or
+not. ``match_columns`` supports weight but ``query`` doesn't.
+Weight is relative importance of target column. A higher weight target
+column gets more hit score rather than a lower weight target column
+when a record is matched by fulltext search. The default weight is 1.
+Here is a simple ``match_columns`` usage example.
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_simple.log
+.. select Entries --match_columns content --query fast --output_columns '_key, _score'
+``--match_columns content`` means the default target column for
+fulltext search is ``content`` column and its weight
+is 1. ``--output_columns '_key, _score'`` means that the ``select``
+command outputs ``_key`` value and ``_score`` value for matched
+records.
+Pay attention to ``_score`` value. ``_score`` value is the number of
+matched counts against ``query`` parameter value. In the example,
+``query`` parameter value is ``fast``. The fact that ``_score`` value
+is 1 means that ``fast`` appers in ``content`` column only once.  The
+fact that ``_score`` value is 2 means that ``fast`` appears in
+``content`` column twice.
+To specify weight, ``column * weight`` syntax is used. Here is a
+weight usage example.
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_weight.log
+.. select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score'
+``--match_columns 'content * 2'`` means the default target column for
+fulltext search is ``content`` column and its weight is 2.
+Pay attention to ``_score`` value. ``_score`` value is doubled because
+weight is 2.
+You can specify one or more columns as the default target columns for
+fulltext search. If one or more columns are specified, fulltext search
+is done for all columns and scores are accumulated. If one of the
+columns is matched against ``query`` parameter value, the record is
+treated as matched.
+To specify one or more columns, ``column1 * weight1 || column2 *
+weight2 || ...`` syntax is used. ``* weight`` can be omitted. If it is
+omitted, 1 is used for weight. Here is a one or more columns usage
+example.
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_some_columns.log
+.. select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score'
+``--match_columns '_key * 10 || content'`` means the default target
+columns for fulltext search are ``_key`` and ``content`` columns and
+``_key`` column's weight is 10 and ``content`` column's weight
+is 1. This weight allocation means ``_key`` column value is more
+important rather than ``content`` column value. In this example, title
+of blog entry is more important rather thatn content of blog entry.
-カラム名:値
-  一致条件(カラム値 == 値)
+``query``
+"""""""""
-カラム名:!値
-  不一致条件(カラム値 != 値)
+TODO: write short description and add example.
-カラム名:<値
-  比較条件(カラム値 < 値)
+See :doc:`/spec/query_syntax`.
-カラム名:>値
-  比較条件(カラム値 > 値)
+``filter``
+""""""""""
-カラム名:<=値
-  比較条件(カラム値 <= 値)
+TODO: write short description and add example.
-カラム名:>=値
-  比較条件(カラム値 >= 値)
+See :doc:`/spec/script_syntax`.
-カラム名:@文字列
-  全文検索条件(カラム値が指定された文字列を含んでいる)
+Advanced search parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^
-結合演算子
-^^^^^^^^^^
+``match_escalation_threshold``
+""""""""""""""""""""""""""""""
-複数の条件式を結合するために以下の演算子が使用できます。
+TODO: add example.
-a OR b
-  論理和(aとbといずれかの条件がマッチする)
+It specifies threshold to determine whether search storategy
+escalation is used or not. The threshold is compared against the
+number of matched records. If the number of matched records is equal
+to or less than the threshold, search storategy escalation is
+used. See :doc:`/spec/search` about search storategy escalation.
-a + b
-  論理積(aとbの両方がマッチする)
+The default threshold is 0. It means that search storategy escalation
+is used only when no records are matched.
-a - b
-  aにマッチし、bにはマッチしない
+The default threshold can be customized by one of the followings.
-( )
-  複数の条件をまとめる
+  * ``--with-match-escalation-threshold`` option of configure
+  * ``--match-escalation-threshold`` option of groogna command
+  * ``match-escalation-threshold`` configuration item in configuration
+    file
+``query_expansion``
+"""""""""""""""""""
-``filter``
+TODO: write in English and add example.
-  絞り込み条件をscript形式のgrn_expr文字列によって指定します。
+It specifies a column that is used to expand (substitute) ``query``
+parameter value.
-  query引数とfilter引数をどちらも指定した場合は、両方の条件を満足するレコードのみがヒットします。どちらも指定しない場合は全件がヒットします。
+query_expansionパラメータには、queryパラメータに指定された文字列を置換(拡張)する条件となるテーブル・カラムを指定します。フォーマットは「${テーブル名}.${カラム名}」となります。指定するテーブルは文字列を主キーとするハッシュ型あるいはパトリシア木型のテーブルで、一つ以上の文字列型のカラムが定義されている必要があります。(ここでは置換テーブルと呼びます。)
-``scorer``
+queryパラメータに指定された文字列が、指定されたテーブルの主キーと完全一致する場合、その文字列を指定されたカラム値の文字列に置換します。queryパラメータが、空白、括弧、演算子などを含む場合は、その演算子によって区切られた文字列の単位で置換が実行されます。ダブルクォート("")で括られた範囲は、その内部に空白を含んでいても一つの置換される単位と見なされます。検索文字列と置換テーブルの主キー値との比較に際して大文字小文字等を区別したくない場合には、置換テーブルを定義する際にKEY_NORMALIZEを指定します。置換後の文字列となるカラムの値には、括弧や*, ORなど、queryパラメータで利用可能な全ての演算子を指定することができます。
-  検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。
+Output related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^
-  scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。
+``output_columns``
+""""""""""""""""""
-``sortby``
+TODO: write in English and add example.
+出力するカラム名のリストをカンマ(',')区切りで指定します。
-  ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。::
+アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id, _key, \*')
-    [-]カラム名1, [-]カラム名2, [-]カラム名3, ...
+``sortby``
+""""""""""
-  カラム名1の値でソートし、値が同一である場合はカラム名2でソート、と順次比較を行いソートします。カラム名の前に - を付加した場合は降順にソートします。付加しない場合には昇順にソートします。
+TODO: write in English and add example.
-  query引数またはfilter引数を指定した場合はカラム名に'_score'を使えます。'_score'を指定することでスコアでソートすることができます。query引数もfilter引数も指定していない状態で'_score'を指定するとエラーになります。
+ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。::
-``output_columns``
+  [-]カラム名1, [-]カラム名2, [-]カラム名3, ...
-  出力するカラム名のリストをカンマ(',')区切りで指定します。
+カラム名1の値でソートし、値が同一である場合はカラム名2でソート、と順次比較を行いソートします。カラム名の前に - を付加した場合は降順にソートします。付加しない場合には昇順にソートします。
-  アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id, _key, \*')
+query引数またはfilter引数を指定した場合はカラム名に'_score'を使えます。'_score'を指定することでスコアでソートすることができます。query引数もfilter引数も指定していない状態で'_score'を指定するとエラーになります。
 ``offset``
+""""""""""
+TODO: write in English and add example.
-  検索条件にマッチしたレコードのうち、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。offsetに負の値を指定した場合は、ヒットした件数 + offset によって算出される値が指定されたものとみなされます。
+検索条件にマッチしたレコードのうち、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。offsetに負の値を指定した場合は、ヒットした件数 + offset によって算出される値が指定されたものとみなされます。
 ``limit``
+"""""""""
-  検索条件にマッチしたレコードのうち、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、offset + limit がヒットした件数を超えない範囲でレコードが出力されます。limitに負の値を指定した場合は、ヒットした件数 + limit + 1 によって算出される値が指定されたものとみなされます。
+TODO: write in English and add example.
+検索条件にマッチしたレコードのうち、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、offset + limit がヒットした件数を超えない範囲でレコードが出力されます。limitに負の値を指定した場合は、ヒットした件数 + limit + 1 によって算出される値が指定されたものとみなされます。
+``scorer``
+""""""""""
+TODO: write in English and add example.
+検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。
+scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。
+Facet related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^
 ``drilldown``
+"""""""""""""
-  グループ化のキーとなるカラム名のリストをカンマ(',')区切りで指定します。検索条件にマッチした各レコードを出力したのちに、drilldownに指定されたカラムの値が同一であるレコードをとりまとめて、それぞれについて結果レコードを出力します。
+TODO: write in English and add example.
-``drilldown_sortby``
+グループ化のキーとなるカラム名のリストをカンマ(',')区切りで指定します。検索条件にマッチした各レコードを出力したのちに、drilldownに指定されたカラムの値が同一であるレコードをとりまとめて、それぞれについて結果レコードを出力します。
-  drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。sortbyパラメータと同様に昇降順を指定できます。
+``drilldown_sortby``
+""""""""""""""""""""
-``drilldown_output_columns``
+TODO: write in English and add example.
-  drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力するカラム名のリストをカンマ(',')区切りで指定します。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。sortbyパラメータと同様に昇降順を指定できます。
-``drilldown_offset``
+``drilldown_output_columns``
+""""""""""""""""""""""""""""
-  drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。drilldown_offsetに負の値を指定した場合は、ヒットした件数 + drilldown_offsetによって算出される値が指定されたものとみなされます。
+TODO: write in English and add example.
-``drilldown_limit``
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力するカラム名のリストをカンマ(',')区切りで指定します。
-  drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、drilldown_offset + drilldown_limit がヒットした件数を超えない範囲でレコードが出力されます。drilldown_limitに負の値を指定した場合は、ヒットした件数 + drilldown_limit + 1 によって算出される値が指定されたものとみなされます。
+``drilldown_offset``
+""""""""""""""""""""
-``cache``
+TODO: write in English and add example.
-  クエリキャッシュに関する動作を設定します。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。drilldown_offsetに負の値を指定した場合は、ヒットした件数 + drilldown_offsetによって算出される値が指定されたものとみなされます。
-    ``no``
+``drilldown_limit``
+"""""""""""""""""""
-      検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。
+TODO: write in English and add example.
-``match_escalation_threshold``
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、drilldown_offset + drilldown_limit がヒットした件数を超えない範囲でレコードが出力されます。drilldown_limitに負の値を指定した場合は、ヒットした件数 + drilldown_limit + 1 によって算出される値が指定されたものとみなされます。
-  検索の挙動をエスカレーションするかどうかの閾値を設定します。デフォルト値は0です。デフォルト値は以下のいずれかの方法で設定できます。
+Cache related parameter
+^^^^^^^^^^^^^^^^^^^^^^^
-    * configureの--with-match-escalation-thresholdオプション
-    * groongaコマンド起動時の--match-escalation-thresholdオプション
-    * 設定ファイル中のmatch-escalation-threshold設定項目
+``cache``
+"""""""""
-  クエリのヒット件数が閾値を越えない場合は :doc:`/spec/search` で説明している方法で検索方法をエスカレーションしてきます。
+TODO: write in English and add example.
-``query_expansion``
+クエリキャッシュに関する動作を設定します。
-  query_expansionパラメータには、queryパラメータに指定された文字列を置換(拡張)する条件となるテーブル・カラムを指定します。フォーマットは「${テーブル名}.${カラム名}」となります。指定するテーブルは文字列を主キーとするハッシュ型あるいはパトリシア木型のテーブルで、一つ以上の文字列型のカラムが定義されている必要があります。(ここでは置換テーブルと呼びます。)
+``no``
-  queryパラメータに指定された文字列が、指定されたテーブルの主キーと完全一致する場合、その文字列を指定されたカラム値の文字列に置換します。queryパラメータが、空白、括弧、演算子などを含む場合は、その演算子によって区切られた文字列の単位で置換が実行されます。ダブルクォート("")で括られた範囲は、その内部に空白を含んでいても一つの置換される単位と見なされます。検索文字列と置換テーブルの主キー値との比較に際して大文字小文字等を区別したくない場合には、置換テーブルを定義する際にKEY_NORMALIZEを指定します。置換後の文字列となるカラムの値には、括弧や*, ORなど、queryパラメータで利用可能な全ての演算子を指定することができます。
+  検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。
 返値
 ----
+TODO: write in English and add example.
 以下のようなjson形式で値が返却されます。
 ::
@@ -249,16 +497,8 @@ a - b
     drilldown_output_columns, drilldown_offset, drilldown_limitによって指定された条件に従って各レコードの値が出力されます。
-例
---
-テーブルEntryの全レコード・全カラムの値を出力します。::
- select Entry
- [[[2],[["_id", "UInt32"],["_key","ShortText"],["body","ShortText"]],[1,"abandon","放棄する"],[2,"abbreviate","短縮する"]]]
-関連項目
+See also
 --------
-:doc:`../expr`
+  * :doc:`/spec/query_syntax`
+  * :doc:`/spec/script_syntax`