rroonga 4.0.1-x64-mingw32 → 4.0.2-x64-mingw32

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

@@ -19,6 +19,7 @@ Here are data store columns:
 
   * :doc:`columns/scalar`
   * :doc:`columns/vector`
+  * :doc:`columns/pseudo`
 
 Here is an index column:
 

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

@@ -2,110 +2,208 @@
 
 .. highlightlang:: none
 
-column_list
-===========
+.. groonga-command
+.. database: commands_column_list
 
-名前
-----
+``column_list``
+===============
 
-column_list - テーブルに定義されているカラムのリスト表示
+Summary
+-------
 
-書式
-----
-::
+``column_list`` command lists columns in a table.
 
- column_list table
+Syntax
+------
 
-説明
-----
+``column_list`` command takes one required parameter::
 
-Groonga組込コマンドの一つであるcolumn_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+  column_list table
 
-column_listはテーブルに定義されているカラムをリスト表示します。
+Usage
+-----
 
-引数
-----
+Here is a simple example of ``column_list`` command.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/column_list/column_list.log
+.. table_create Users TABLE_PAT_KEY ShortText
+.. column_create Users age COLUMN_SCALAR UInt8
+.. column_create Users tags COLUMN_VECTOR ShortText
+.. column_list Users
+
+
+Parameters
+----------
+
+This section describes parameters of ``column_list``.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+All parameters are required.
 
 ``table``
-  カラム情報を出力するテーブルの名前を指定します。
+"""""""""
+
+It specifies the name of table to be listed columns.
+
+Return value
+------------
+
+``column_list`` returns the list of column information in the table::
+
+  [
+    HEADER,
+    [
+      COLUMN_LIST_HEADER,
+      COLUMN_INFORMATION1,
+      COLUMN_INFORMATION2,
+      ...
+    ]
+  ]
+
+``HEADER``
+
+  See :doc:`/reference/command/output_format` about ``HEADER``.
+
+``COLUMN_LIST_HEADER``
+
+  ``COLUMN_LIST_HEADER`` describes about content of each
+  ``COLUMN_INFORMATION``.
+
+  ``COLUMN_LIST_HEADER`` is the following format::
+
+    [
+      ["id",     "UInt32"],
+      ["name",   "ShortText"],
+      ["path",   "ShortText"],
+      ["type",   "ShortText"],
+      ["flags",  "ShortText"],
+      ["domain", "ShortText"],
+      ["range",  "ShortText"],
+      ["source", "ShortText"]
+    ]
+
+  It means the following:
+
+    * The first content in ``COLUMN_INFORMATION`` is ``id`` value and
+      the value type is ``UInt32``.
+    * The second content in ``COLUMN_INFORMATION`` is ``name`` value and
+      the value type is ``ShortText``.
+    * The third content ....
+
+  See the following ``COLUMN_INFORMATION`` description for details.
 
-返値
-----
+  This field provides meta-data of column information. So this field
+  will be useful for programs rather than humans.
 
-json形式
-^^^^^^^^
+``COLUMN_INFORMATION``
 
-カラム名一覧を以下の形式で返却します。::
+  Each ``COLUMN_INFORMATION`` is the following format::
 
-  [[[カラム情報名1,カラム情報型1],...], カラム情報1,...]
+    [
+      ID,
+      NAME,
+      PATH,
+      TYPE,
+      FLAGS,
+      DOMAIN,
+      RANGE,
+      SOURCES
+    ]
 
-``カラム情報名n``
+  ``ID``
 
-  ``カラム情報n`` には複数の情報が含まれますが、そこに入る情報がどんな内容かを示す名前を出力します。
-  情報名は以下の通りです。
+    The column ID in the Groonga database. Normally, you don't care
+    about it.
 
-  ``id``
+  ``NAME``
 
-    カラムオブジェクトに割り当てられたID
+    The column name.
 
-  ``name``
+  ``PATH``
 
-    カラム名
+    The path for storing column data.
 
-  ``path``
+  ``TYPE``
 
-    カラム値を格納するファイル名
+    The type of the column. It is one of the followings:
 
-  ``type``
+    .. list-table::
+       :header-rows: 1
 
-    スカラ型、ベクタ型、インデックス型の種別
+       * - Value
+         - Description
+       * - ``fix``
+         - The column is a fixed size column. Scalar column that its
+           type is fixed size type is fixed size column.
+       * - ``var``
+         - The column is a variable size column. Vector column or
+           scalar column that its type is variable size type are
+           variable size column.
+       * - ``index``
+         - The column is an index column.
 
-  ``flags``
+  ``FLAGS``
 
-    カラムのflags属性
+    The flags of the column. Each flag is separated by ``|`` like
+    ``COLUMN_VECTOR|WITH_WEIGHT``. ``FLAGS`` must include one of
+    ``COLUMN_SCALAR``, ``COLUMN_VECTOR`` or ``COLUMN_INDEX``. Other
+    flags are optional.
 
-  ``domain``
+    Here is the available flags:
 
-    カラムの値の属する型
+    .. list-table::
+       :header-rows: 1
 
-  ``range``
+       * - Flag
+         - Description
+       * - ``COLUMN_SCALAR``
+         - The column is a scalar column.
+       * - ``COLUMN_VECTOR``
+         - The column is a vector column.
+       * - ``COLUMN_INDEX``
+         - The column is an index column.
+       * - ``WITH_WEIGHT``
+         - The column can have weight. ``COLUMN_VECTOR`` and ``COLUMN_INDEX``
+           may have it. ``COLUMN_SCALAR`` doesn't have it.
+       * - ``WITH_SECTION``
+         - The column can have section information. ``COLUMN_INDEX``
+           may have it.  ``COLUMN_SCALAR`` and ``COLUMN_VECTOR`` don't
+           have it.
 
-    テーブルのkeyの型
+           Multiple column index has it.
+       * - ``WITH_POSITION``
+         - The column can have position information. ``COLUMN_INDEX``
+           may have it.  ``COLUMN_SCALAR`` and ``COLUMN_VECTOR`` don't
+           have it.
 
-  ``source``
+           Full text search index must has it.
+       * - ``PERSISTENT``
+         - The column is a persistent column. It means that the column
+           isn't a :doc:`/reference/columns/pseudo`.
 
-    インデックスカラムのとき、インデックス対象カラム名の配列
+  ``DOMAIN``
 
-``カラム情報型n``
+      The name of table that has the column.
 
-  カラム情報の型を出力します。
+  ``RANGE``
 
-``カラム情報n``
+      The value type name of the column. It is a type name or a table
+      name.
 
-  ``カラム情報名n`` で示された情報の配列を出力します。
-  情報の順序は ``カラム情報名n`` の順序と同じです。
+  ``SOURCES``
 
-例
---
-::
+      An array of the source column names of the index. If the index
+      column is multiple column index, the array has two or more
+      source column names.
 
- column_list Entry
+      It is always an empty array for ``COLUMN_SCALAR`` and
+      ``COLUMN_VECTOR``.
 
- [[["id", "UInt32"],
-   ["name","ShortText"],
-   ["path","ShortText"],
-   ["type","ShortText"],
-   ["flags","ShortText"],
-   ["domain", "ShortText"],
-   ["range", "ShortText"],
-   ["source","ShortText"]],
-  [258,
-   "Entry.body",
-   "test.db.0000102",
-   "var",
-   "COLUMN_SCALAR|COMPRESS_NONE|PERSISTENT",
-   "Entry",
-   "ShortText",
-   []]]
+See also
+--------
 
-注: 実際は改行が入りません。
+* :doc:`/reference/commands/column_create`
+* :doc:`/reference/column`

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

@@ -0,0 +1,65 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_normalizer_list
+
+``normalizer_list``
+===================
+
+Summary
+-------
+
+``normalizer_list`` command lists normalizers in a database.
+
+
+Syntax
+------
+
+``normalizer_list`` command takes no parameter.
+::
+
+  normalizer_list
+
+Usage
+-----
+
+Here is a simple example.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/normalizer_list/simple_example.log
+.. normalizer_list
+
+It returns normalizers in a database.
+
+Return value
+------------
+
+``normalizer_list`` command returns normalizers. Each normalizers has an attribute
+that contains the name. The attribute will be increased in the feature::
+
+  [HEADER, normalizer]
+
+``HEADER``
+
+  See :doc:`/reference/command/output_format` about ``HEADER``.
+
+``normalizer``
+
+  ``normalizer`` is an array of normalizer. Normalizer is an object that has the following
+  attributes.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Name
+       - Description
+     * - ``name``
+       - Normalizer name.
+
+See also
+--------
+
+* :doc:`/reference/normalizers`
+* :doc:`/reference/commands/normalize`

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

@@ -34,7 +34,7 @@ Syntax
          [limit=10]
          [drilldown=null]
          [drilldown_sortby=null]
-         [drilldown_output_columns=null]
+         [drilldown_output_columns="_key, _nsubrecs"]
          [drilldown_offset=0]
          [drilldown_limit=10]
          [cache=yes]
@@ -667,7 +667,7 @@ The ``select`` command just outputs ``_id`` and ``_key`` column
 values.
 
 ``*`` is a special value. It means that all columns that are not
-:doc:`/reference/pseudo_column`.
+:doc:`/reference/columns/pseudo`.
 
 Here is a ``*`` usage example.
 

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

@@ -0,0 +1,65 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_tokenizer_list
+
+``tokenizer_list``
+==================
+
+Summary
+-------
+
+``tokenizer_list`` command lists tokenizers in a database.
+
+
+Syntax
+------
+
+``tokenizer_list`` command takes no parameter.
+::
+
+  tokenizer_list
+
+Usage
+-----
+
+Here is a simple example.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/tokenizer_list/simple_example.log
+.. tokenizer_list
+
+It returns tokenizers in a database.
+
+Return value
+------------
+
+``tokenizer_list`` command returns tokenizers. Each tokenizers has an attribute
+that contains the name. The attribute will be increased in the feature::
+
+  [HEADER, tokenizer]
+
+``HEADER``
+
+  See :doc:`/reference/command/output_format` about ``HEADER``.
+
+``tokenizer``
+
+  ``tokenizer`` is an array of tokenizer. Tokenizer is an object that has the following
+  attributes.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Name
+       - Description
+     * - ``name``
+       - Tokenizer name.
+
+See also
+--------
+
+* :doc:`/reference/tokenizers`
+* :doc:`/reference/commands/tokenize`

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

@@ -45,10 +45,26 @@ Execute groonga-suggest-httpd command:
 
 After executing above command, groonga-suggest-httpd accepts HTTP request on 8080 port.
 
+If you just want to save requests into log file, use ``-l`` option.
+
+Here is the example to save log files under ``logs`` directory with ``log`` prefix for each file.::
+
+  % groonga-suggest-httpd -l logs/log /tmp/groonga-databases/groonga-suggest-httpd
+
+Under ``logs`` directory, log files such as ``logYYYYmmddHHMMSS-00`` are created.
+
 Request to groonga-suggest-httpd
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-TODO
+Here is the sample requests to learn ``groonga`` for ``query`` dataset::
+
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=92619&t=complete&q=g'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=93850&t=complete&q=gr'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94293&t=complete&q=gro'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94734&t=complete&q=groo'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95147&t=complete&q=grooon'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95553&t=complete&q=groonga'
+  % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95959&t=submit&q=groonga
 
 Options
 -------
@@ -60,6 +76,8 @@ Options
 .. cmdoption:: -t, --n-threads
 
    Specify number of threads. The default value is 8.
+   This option accepts 128 as the max value, but use the number of CPU cores for
+   performance.
 
 .. cmdoption:: -s, --send-endpoint
 
@@ -85,7 +103,7 @@ Options
 
    Specify this option to disable checking max fd on start.
 
-Command line Parameters
+Command line parameters
 -----------------------
 
 There is one required parameter - ``database_path``.
@@ -96,7 +114,7 @@ There is one required parameter - ``database_path``.
 Specifies the path to a Groonga database. This database must be created by :doc:`groonga-suggest-create-dataset` command because it executes required initialization for suggestion.
 
 
-GET Parameters
+GET parameters
 --------------
 
 groonga-suggest-httpd accepts following GET parameters.
@@ -116,7 +134,7 @@ Required parameters
      - UTF-8 encoded string which user fills in form
      - 
    * - t
-     - The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by '|'. Note that 'submit' is invalid value when you specify multiple type of query.
+     - The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by ``|``. Note that ``submit`` is invalid value when you specify multiple type of query.
      - 
 
 Required parameters for learning
@@ -130,13 +148,13 @@ Required parameters for learning
      - Note
    * - s
      - Elapsed time from 0:00 January 1, 1970
-     - Note that you need specify the value of 's' in milliseconds
+     - Note that you need specify the value of ``s`` in milliseconds
    * - i
      - Unique ID to distinct user
      - Use session ID or IP address for example
    * - l
-     - Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by '|'
-     - Note that dataset name must be matched to following regular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'
+     - Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by ``|``
+     - Note that dataset name must be matched to following regular expression ``[A-Za-z ][A-Za-z0-9 ]{0,15}``
 
 Required parameters for suggestion
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -162,7 +180,7 @@ Optional parameter
      - Note
    * - callback
      - Specify the name of function if you prefer JSONP as response format
-     - The name of function must be matched to reqular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'
+     - The name of function must be matched to reqular expression ``[A-Za-z ][A-Za-z0-9 ]{0,15}``
 
 Return value
 ------------
@@ -180,7 +198,7 @@ In JSONP format::
 
 ``TYPE``
 
-  'complete', 'correct' or 'suggest'.
+  One of ``complete``, ``correct`` and ``suggest``.
 
 ``CANDIDATE_N``
 
@@ -188,5 +206,5 @@ In JSONP format::
 
 ``SCORE_N``
 
-  The number of score.
+  The score.