rroonga 1.2.5-x86-mingw32 → 1.2.7-x86-mingw32

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

@@ -2,78 +2,250 @@
 
 .. highlightlang:: none
 
+.. groonga-command
+.. % groonga-suggest-create-dataset /tmp/groonga-databases/suggest query
+.. database: suggest
+
 suggest
 =======
 
-** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **
+.. note::
+
+   The suggest feature specification isn't stable. The
+   specification may be changed.
 
-名前
+NAME
 ----
 
-suggest - 指定したクエリに対する補完・修正・提案を行う。
+suggest - returns completion, correction and/or suggestion for a query.
 
-書式
-----
+SYNOPSIS
+--------
 ::
 
- suggest types table column query
+ suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]
 
-説明
-----
+DESCRIPTION
+-----------
 
-suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。
+The suggest command returns completion, correction and/or
+suggestion for a specified query.
 
-補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。
+See :doc:`/suggest/introduction` about completion,
+correction and suggestion.
 
-引数
-----
+OPTIONS
+-------
 
 ``types``
+  It specifies what types are returned by the suggest
+  command.
+
+  Here are available types:
 
-  補完・修正・提案のいずれを行うかを、パイプ('|')で組み合わせたシンボル名で指定します(例: correct|suggest)
+    ``complete``
+      The suggest command does completion.
 
-  ``complete``
+    ``correct``
+      The suggest command does correction.
 
-    補完を行います。
+    ``suggest``
+      The suggest command does suggestion.
 
-  ``correct``
+  You can specify one or more types separated by ``|``.
+  Here are examples:
 
-    修正を行います。
+    It returns correction::
 
-  ``suggest``
+      correct
 
-    提案を行います。
+    It returns correction and suggestion::
+
+      correct|suggest
+
+    It returns complete, correction and suggestion::
+
+      complete|correct|suggest
 
 ``table``
+  It specifies table name that has ``item_${DATA_SET_NAME}` format.
+  For example, ``item_query`` is a table name if you created
+  dataset by the following command::
 
-  基礎となるデータが格納されているテーブル名を指定します。
+    groonga-suggest-create-dataset /tmp/db-path query
 
 ``column``
-
-  基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。
+  It specifies a column name that has furigana in
+  Katakana in ``table`` table.
 
 ``query``
+  It specifies query for completion, correction and/or
+  suggestion.
 
-  補完・修正・提案の対象となるクエリを指定します。
+``sortby``
+  It specifies sort key.
 
-返値
-----
+  Default:
+    ``-_score``
 
-json形式
-^^^^^^^^
+``output_columns``
+  It specifies output columns.
 
-::
+  Default:
+    ``_key,_score``
+
+``offset``
+  It specifies returned records offset.
+
+  Default:
+    ``0``
+
+``limit``
+  It specifies number of returned records.
+
+  Default:
+    ``10``
+
+``frequency_threshold``
+  It specifies threshold for item frequency. Returned records must have
+  ``_score`` that is greater than or equal to ``frequency_threshold``.
+
+  Default:
+    ``100``
+
+``conditional_probability_threshold``
+
+  It specifies threshold for conditional
+  probability. Conditional probability is used for learned
+  data. It is probability of query submission when ``query``
+  is occurred. Returned records must have conditional
+  probability that is greater than or equal to
+  ``conditional_probability_threshold``.
+
+  Default:
+    ``0.2``
+
+``prefix_search``
+  It specifies whether optional prefix search is used or not
+  in completion.
+
+  Here are available values:
+
+    ``yes``
+      Prefix search is always used.
+
+    ``no``
+      Prefix search is never used.
+
+    ``auto``
+      Prefix search is used only when other search can't
+      find any records.
+
+  Default:
+    ``auto``
+
+RETURN VALUE
+------------
+
+JSON format
+^^^^^^^^^^^
+
+Here is a returned JSON format::
+
+ {"type1": [["candidate1", score of candidate1],
+            ["candidate2", score of candidate2],
+            ...],
+  "type2": [["candidate1", score of candidate1],
+            ["candidate2", score of candidate2],
+            ...],
+  ...}
+
+``type``
+
+  A type specified by ``types``.
+
+``candidate``
+
+  A candidate for completion, correction or suggestion.
+
+``score of candidate``
+
+  A score of corresponding ``candidate``. It means that
+  higher score candidate is more likely candidate for
+  completion, correction or suggestion. Returned candidates
+  are sorted by ``score of candidate`` descending by
+  default.
+
+EXAMPLE
+-------
+
+Here are learned data for completion.
+
+.. groonga-command
+.. include:: ../commands/suggest-learn-completion.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "1", "time": 1312950803.86057, "item": "e"},
+.. {"sequence": "1", "time": 1312950803.96857, "item": "en"},
+.. {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
+.. {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
+.. {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
+.. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
+.. ]
+
+Here are learned data for correction.
+
+.. groonga-command
+.. include:: ../commands/suggest-learn-correction.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "2", "time": 1312950803.86057, "item": "s"},
+.. {"sequence": "2", "time": 1312950803.96857, "item": "sa"},
+.. {"sequence": "2", "time": 1312950804.26057, "item": "sae"},
+.. {"sequence": "2", "time": 1312950804.56057, "item": "saer"},
+.. {"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
+.. {"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
+.. {"sequence": "2", "time": 1312950809.76057, "item": "serch"},
+.. {"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
+.. ]
+
+Here are learned data for suggestion.
+
+.. groonga-command
+.. include:: ../commands/suggest-learn-suggestion.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
+.. {"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
+.. ]
+
+Here is a completion example.
+
+.. groonga-command
+.. include:: ../commands/suggest-completion.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
+
+Here is a correction example.
+
+.. groonga-command
+.. include:: ../commands/suggest-correction.log
+.. suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
 
- {"タイプ1":[["候補1", 候補1のスコア], ["候補2", 候補2のスコア], ...], ...}
+Here is a suggestion example.
 
- ``タイプ``
+.. groonga-command
+.. include:: ../commands/suggest-suggestion.log
+.. suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
 
-   types引数に指定した値。
+Here is a mixed example.
 
- ``候補``
+.. groonga-command
+.. include:: ../commands/suggest-mixed.log
+.. suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
 
-   補完・修正・提案の候補。
 
- ``候補のスコア``
+SEE ALSO
+--------
 
-   補完・修正・提案として優れたものほど高くなる数値。結果は、スコア順にソートされている。
+* :doc:`/suggest`
+* :doc:`/executables/groonga-suggest-create-dataset`

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

@@ -134,7 +134,7 @@ grntest命令
 コマンドファイル
 ^^^^^^^^^^^^^^^^
 
-コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては :doc:`commands` を参照してください。
+コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては :doc:`/commands` を参照してください。
 
 サンプル
 ^^^^^^^^

data/vendor/local/share/doc/groonga/en/html/_sources/executables/{http.txt → groonga-http.txt}

@@ -48,7 +48,7 @@ GETメソッドのみが使用可能です。
 
 output_typeにはjson, tsv, xmlが指定可能です。
 
-command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`command_version` を参照してください。
+command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`/command_version` を参照してください。
 
 返値
 ----

data/vendor/local/share/doc/groonga/en/html/_sources/executables/groonga-suggest-create-dataset.txt

@@ -0,0 +1,50 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+groonga-suggest-create-dataset
+==============================
+
+NAME
+----
+
+groonga-suggest-create-dataset - Defines schema for a suggestion dataset
+
+SYNOPSTIS
+---------
+
+::
+
+ groonga-suggest-create-dataset [options] DATABASE DATASET
+
+DESCTIPION
+----------
+
+groonga-suggest-create-dataset creates a dataset for :doc:`/suggest`. A database has many datasets. This command just defines schea for a suggestion dataset.
+
+OPTIONS
+-------
+
+None.
+
+EXIT STATUS
+-----------
+
+TODO
+
+FILES
+-----
+
+TODO
+
+EXAMPLE
+-------
+
+TODO
+
+SEE ALSO
+--------
+
+:doc:`/suggest`
+.. : doc:`groonga-suggest-httpd`
+.. : doc:`groonga-suggest-learner`

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

@@ -18,6 +18,7 @@ groonga ドキュメント
    install
    community
    tutorial
+   suggest
    reference
    spec
    limitations

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

@@ -151,8 +151,19 @@ Install::
 
   % brew install groonga
 
-Windows
--------
+Windows (Installer)
+-------------------
+
+.. note::
+
+   We only distribute the package for x64.
+
+You just download installer (.exe file) from
+`packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
+and execute it.
+
+Windows (zip)
+-------------
 
 .. note::
 
@@ -160,7 +171,7 @@ Windows
 
 You just download zip-file from
 `packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
-and extract it. We doesn't distribute installer for now. Sorry.
+and extract it.
 
 Others
 ------

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

@@ -0,0 +1,214 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Log
+===
+
+Groonga has two log files. They are process log and query
+log. Process log is for all of :doc:`executables/groonga`
+works. Query log is just for query processing.
+
+Process log
+-----------
+
+Process log is enabled by default. Log path can be
+customized by :option:`--log-path` option.  Each log has its
+log level. If a log is smaller than groonga process' log
+level, it's not logged. Log level can be customized by
+:option:`-l` or :doc:`commands/log_level`.
+
+Format
+^^^^^^
+
+Process log uses the following format::
+
+  #{TIME_STAMP}|#{L}| #{MESSAGE}
+
+TIME_STAMP
+  It's time stamp uses the following format::
+
+    YYYY-MM-DD hh:mm:ss.SSSSSS
+
+  YYYY
+    Year with four digits.
+
+  MM
+    Month with two digits.
+
+  DD
+    Day with two digits.
+
+  hh
+    Hour with two digits.
+
+  mm
+    Minute with two digits.
+
+  ss
+    Second with two digits.
+
+  SSSSSS
+    Microsecond with six digits.
+
+  Example::
+
+    2011-07-05 06:25:18.345734
+
+L
+  Log level with a character. Here is a character and log
+  level map.
+
+  E
+    Emergency
+
+  A
+    Alert
+
+  C
+    Critical
+
+  e
+    Error
+
+  w
+    Warning
+
+  n
+    Notification
+
+  i
+    Information
+
+  d
+    Debug
+
+  \-
+    Dump
+
+  Example::
+
+    E
+
+MESSAGE
+  Details about the log with free format.
+
+  Example::
+
+    log opened.
+
+Example::
+
+  2011-07-05 08:35:09.276421|n| grn_init
+  2011-07-05 08:35:09.276553|n| RLIMIT_NOFILE(4096,4096)
+
+Query log
+---------
+
+Query log is disabled by default. It can be enabled by
+:option:`--query-log-path` option.
+
+Format
+^^^^^^
+
+Query log uses the following formats::
+
+  #{TIME_STAMP}|#{MESSAGE}
+  #{TIME_STAMP}|#{ID}|>#{QUERY}
+  #{TIME_STAMP}|#{ID}|:#{ELAPSED_TIME} #{PROGRESS}
+  #{TIME_STAMP}|#{ID}|<#{ELAPSED_TIME} #{RETURN_CODE}
+
+TIME_STAMP
+  It's time stamp uses the following format::
+
+    YYYY-MM-DD hh:mm:ss.SSSSSS
+
+  YYYY
+    Year with four digits.
+
+  MM
+    Month with two digits.
+
+  DD
+    Day with two digits.
+
+  hh
+    Hour with two digits.
+
+  mm
+    Minute with two digits.
+
+  ss
+    Second with two digits.
+
+  SSSSSS
+    Microsecond with six digits.
+
+  Example::
+
+    2011-07-05 06:25:18.345734
+
+ID
+  ID of a thread. Groonga process creates threads to process
+  requests concurrently. Each thread outputs some logs for a
+  request. This ID can be used to extract a log sequence by
+  a thread.
+
+  Example::
+
+    45ea3034
+
+>
+  A character that indicates query is started.
+
+:
+  A character that indicates query is processing.
+
+<
+  A character that indicates query is finished.
+
+MESSAGE
+  Details about the log with free format.
+
+  Example::
+
+    query log opened.
+
+QUERY
+  A query to be processed.
+
+  Example::
+
+    select users --match_columns hobby --query music
+
+ELAPSED_TIME
+  Elapsed time in nanoseconds since query is started.
+
+  Example::
+
+    000000000075770
+    (It means 75,770 nanoseconds.)
+
+PROGRESS
+  A processed work at the time.
+
+  Example::
+
+    select(313401)
+    (It means that 'select' is processed and 313,401 records are remained.)
+
+RETURN_CODE
+  A return code for the query.
+
+  Example::
+
+    rc=0
+    (It means return code is 0. 0 means GRN_SUCCESS.)
+
+Example::
+
+  2011-07-05 06:25:19.458756|45ea3034|>select Properties --limit 0
+  2011-07-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
+  2011-07-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
+  2011-07-05 06:25:19.458875|45ea3034|<000000000119062 rc=0
+  2011-07-05 06:25:19.458986|45ea3034|>quit

data/vendor/local/share/doc/groonga/en/html/_sources/news/1.0.x.txt

@@ -117,7 +117,7 @@
 * すべてのモジュールで同じ名前の関数をエクスポートするようにした。#624
 * 不正な名前を指定したときに指定された名前も報告するようにした。
 * :doc:`/commands/select` の--filter内での数値比較演算をサポート。 （@s3kiさんが報告）
-* :doc:`/grntest` の一行あたりの最大バイト数の制限を撤廃。 #608, #690
+* :doc:`/executables/grntest` の一行あたりの最大バイト数の制限を撤廃。 #608, #690
 * Int8/UInt8/Int16/UInt16の等値比較にC言語の比較演算子を使用。 #660
 * HTTP経由で存在しないパスにアクセスした時に存在しないパスを報告するように
   した。

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

@@ -5,6 +5,38 @@
 News
 ====
 
+.. _release-1-2-5:
+
+Release 1.2.5 - 2011/08/29
+--------------------------
+
+Improvements
+^^^^^^^^^^^^
+
+* Added experimental Windows installer support.
+* Accepted "#" and "-" as a valid name characters. #1043
+* Accepted all valid characters except "_" as the first character. #1043
+* Supported `--each` for `[...]` form :doc:`/commands/load`. #1044
+* Added documentation for :doc:`/suggest`.
+* Supported threshold as `--frequency_threshold` and
+  `--conditional_probability_threshold` options in all
+  :doc:`/commands/suggest` types. #1042
+* [groonga-suggest-httpd] Supported log reopen by SIGUSR1. #1048
+* Supported string input for reference vector column value. #1051
+* [groonga-suggest-httpd] Added `--n-lines-per-log-file`
+  option that changes log line limitation for a file.
+* [groonga-suggest-httpd] Added `p` parameter for
+  `--conditional_probability_threshold`.
+* Added GRN_CTX_PER_DB flag for grn_ctx_init() and grn_ctx_open(). #1053
+* Exported grn_ctx_close(). #1035
+
+Fixes
+^^^^^
+
+* Fixed a crash bug that invalid value is passed as match expression
+  argument in :doc:`/commands/select`. #1047
+* Fixed a bug that hash table cursor returns garbage records.
+
 .. _release-1-2-4:
 
 Release 1.2.4 - 2011/07/29
@@ -16,8 +48,8 @@ Improvements
 * Re-supported *BSD. (Reported by OBATA Akio)
 * Improved sed related portability. (Suggested by OBATA Akio)
 * Re-supported Visual C++ 2008.
-* Supported :doc:`commands/check` for hash table.
-* Ignored invalid _score in --sortby of :doc:`commands/select`
+* Supported :doc:`/commands/check` for hash table.
+* Ignored invalid _score in --sortby of :doc:`/commands/select`
   for convenience. #1030
 * Added document about :doc:`log`.
 * Supported ~/.editrc.
@@ -52,7 +84,7 @@ Improvements
 * Added groonga-query-log-analyzer that analyze query log.
 * groonga command shows failed command on error.
 * groonga command shows file name and line no on error.
-* Improved error message of :doc:`commands/column_create`. #952
+* Improved error message of :doc:`/commands/column_create`. #952
 * Added GRN_OBJ_TABLE_DAT_KEY, double array trie, table. (experimental)
 
 Fixes