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

data/vendor/local/share/doc/groonga/source/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/source/index.txt

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

data/vendor/local/share/doc/groonga/source/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/source/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/source/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/source/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

data/vendor/local/share/doc/groonga/source/suggest/completion.txt

@@ -0,0 +1,195 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. % groonga-suggest-create-dataset /tmp/groonga-databases/completion query
+.. database: completion
+
+Completion
+==========
+
+This section describes about the following completion
+features:
+
+* How it works
+* How to use
+* How to learn
+
+How it works
+------------
+
+The completion feature uses three searches to compute
+completed words:
+
+  1. Prefix RK search against registered words.
+  2. Cooccurrence search against learned data.
+  3. Prefix search against registered words. (optional)
+
+Prefix RK search
+^^^^^^^^^^^^^^^^
+
+RK means Romaji and Katakana. Prefix RK search can find
+registered words that start with user's input by romaji,
+katakana or hiragana. It's useful for searching in Japanese.
+
+For example, there is a registered word "日本". And "ニホン"
+(it must be katakana) is registered as its reading. An user
+can find "日本" by "ni", "二" or "に".
+
+Cooccurrence search
+^^^^^^^^^^^^^^^^^^^
+
+Cooccurrence search can find registered words from user's
+partial input. It uses user input sequences that will be
+learned from query logs, access logs and so on.
+
+For example, there is the following user input sequence:
+
++----------+----------+
+|  input   |  submit  |
++==========+==========+
+|s         |no        |
++----------+----------+
+|se        |no        |
++----------+----------+
+|sea       |no        |
++----------+----------+
+|sear      |no        |
++----------+----------+
+|searc     |no        |
++----------+----------+
+|search    |yes       |
++----------+----------+
+|e         |no        |
++----------+----------+
+|en        |no        |
++----------+----------+
+|eng       |no        |
++----------+----------+
+|engi      |no        |
++----------+----------+
+|engin     |no        |
++----------+----------+
+|engine    |no        |
++----------+----------+
+|enginen   |no (typo!)|
++----------+----------+
+|engine    |yes       |
++----------+----------+
+
+Groonga creates the following completion pairs:
+
++----------+--------------------+
+|  input   |   completed word   |
++==========+====================+
+|s         |search              |
++----------+--------------------+
+|se        |search              |
++----------+--------------------+
+|sea       |search              |
++----------+--------------------+
+|sear      |search              |
++----------+--------------------+
+|searc     |search              |
++----------+--------------------+
+|e         |engine              |
++----------+--------------------+
+|en        |engine              |
++----------+--------------------+
+|eng       |engine              |
++----------+--------------------+
+|engi      |engine              |
++----------+--------------------+
+|engin     |engine              |
++----------+--------------------+
+|engine    |engine              |
++----------+--------------------+
+|enginen   |engine              |
++----------+--------------------+
+
+All user not-submitted inputs (e.g. "s", "se" and so on)
+before each an user submission maps to the submitted input
+(e.g. "search").
+
+To be precise, this description isn't correct because it
+omits about time stamp. Groonga doesn't case about "all user
+not-submitted inputs before each an user
+submission". Groonga just case about "all user not-submitted
+inputs within a minute from an user submission before each
+an user submission". Groonga doesn't treat user inputs
+before a minute ago.
+
+If an user inputs "sea" and cooccurrence search returns
+"search" because "sea" is in input column and corresponding
+completed word column value is "search".
+
+Prefix search
+^^^^^^^^^^^^^
+
+Prefix search can find registered word that start with
+user's input. This search doesn't care about romaji,
+katakana and hiragana not like Prefix RK search.
+
+This search isn't always ran. It's just ran when it's
+requested explicitly or both prefix RK search and
+cooccurrence search return nothing.
+
+For example, there is a registered word "search". An user
+can find "search" by "s", "se", "sea", "sear", "searc" and
+"search".
+
+How to use
+----------
+
+.. groonga-command
+.. 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"}
+.. ]
+
+Groonga provides :doc:`/commands/suggest` command to use
+completion. `--type complete` option requests completion.
+
+For example, here is an command to get completion results by
+"en":
+
+.. groonga-command
+.. include:: ../example/completion-1.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
+
+How it learns
+-------------
+
+Cooccurrence search uses learned data. They are based on
+query logs, access logs and so on. To create learned data,
+groonga needs user input sequence with time stamp and user
+submit input with time stamp.
+
+For example, an user wants to search by "engine". The user
+inputs the query with the following sequence:
+
+  1. 2011-08-10T13:33:23+09:00: e
+  2. 2011-08-10T13:33:23+09:00: en
+  3. 2011-08-10T13:33:24+09:00: eng
+  4. 2011-08-10T13:33:24+09:00: engi
+  5. 2011-08-10T13:33:24+09:00: engin
+  6. 2011-08-10T13:33:25+09:00: engine (submit!)
+
+Groonga can be learned from the input sequence by the
+following command::
+
+  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"}
+  ]