rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/grn_expr.txt

@@ -0,0 +1,59 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+grn_expr
+========
+
+Grn_expr is an object that searches records with specified conditions
+and manipulates a database. It's pronounced as ``gurun expression``.
+
+Conditions for searching records from a database can be represented by
+conbining condition expressions such as ``equal condition expression``
+and ``less than condition expression`` with set operations such as
+``AND``, ``OR`` and ``NOT``. Grn_expr executes those conditions to
+search records. You can also use advanced searches such as similar
+search and near search by grn_expr. You can also use flexible full
+text search. For example, you can control hit scores for specified
+words and improve recall by re-searching with high-recall algolithm
+dinamically. To determine whether re-searching or not, the number of
+matched rescords is used.
+
+There are three ways to create grn_expr:
+
+  * Parsing :doc:`/reference/grn_expr/query_syntax` string.
+  * Parsing :doc:`/reference/grn_expr/script_syntax` string.
+  * Calling grn_expr related APIs.
+
+:doc:`/reference/grn_expr/query_syntax` is for common search form in
+Internet search site. It's simple and easy to use but it has a
+limitation. You can not use all condition expressions and set
+operations in :doc:`/reference/grn_expr/query_syntax`. You can use
+:doc:`/reference/grn_expr/query_syntax` with ``query`` option in
+:doc:`/reference/commands/select`.
+
+:doc:`/reference/grn_expr/script_syntax` is ECMAScript like
+syntax. You can use all condition expresssions and set operations in
+:doc:`/reference/grn_expr/script_syntax`. You can use
+:doc:`/reference/grn_expr/script_syntax` with ``filter`` option and
+``scorer`` option in :doc:`/reference/commands/select`.
+
+You can use groonga as a library and create a grn_expr by calling
+grn_expr related APIs. You can use full features with calling APIs
+like :doc:`/reference/grn_expr/script_syntax`. Calling APIs is useful
+creating a custom syntax to create grn_expr. They are used in `rroonga
+<http://groonga.rubyforge.org/#about-rroonga>`_ that is Ruby bindings
+of groonga. Rroonga can create a grn_expr by Ruby's syntax instead of
+parsing string.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   grn_expr/query_syntax
+   grn_expr/script_syntax
+
+See also
+--------
+
+  * :doc:`/reference/api/grn_expr`: grn_expr related APIs

data/vendor/local/share/doc/groonga/ja/html/_sources/{indexing.txt → reference/indexing.txt}

@@ -54,7 +54,7 @@ to a column that already has data.
 We define a schema:
 
 .. groonga-command
-.. include:: ../example/indexing-schema.log
+.. include:: ../example/reference/indexing-schema.log
 .. table_create Tweets TABLE_NO_KEY
 .. column_create Tweets content COLUMN_SCALAR ShortText
 .. table_create Lexicon TABLE_HASH_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
@@ -62,7 +62,7 @@ We define a schema:
 We register data:
 
 .. groonga-command
-.. include:: ../example/indexing-data.log
+.. include:: ../example/reference/indexing-data.log
 .. load --table Tweets
 .. [
 .. {"content":"Hello!"},
@@ -73,7 +73,7 @@ We register data:
 We search without index. We get no result:
 
 .. groonga-command
-.. include:: ../example/indexing-search-without-index.log
+.. include:: ../example/reference/indexing-search-without-index.log
 .. select Tweets --match_columns content --query 'good nice'
 
 We create index for ``Tweets.content``. Already registered
@@ -81,20 +81,20 @@ data in ``Tweets.content`` are indexed by offline index
 construction:
 
 .. groonga-command
-.. include:: ../example/indexing-offline-index-construction.log
+.. include:: ../example/reference/indexing-offline-index-construction.log
 .. column_create Lexicon tweet COLUMN_INDEX|WITH_POSITION Tweets content
 
 We search with index. We get a matched record:
 
 .. groonga-command
-.. include:: ../example/indexing-search-after-offline-index-construction.log
+.. include:: ../example/reference/indexing-search-after-offline-index-construction.log
 .. select Tweets --match_columns content --query 'good nice'
 
 We register data again. They are indexed by online index
 construction:
 
 .. groonga-command
-.. include:: ../example/indexing-online-index-construction.log
+.. include:: ../example/reference/indexing-online-index-construction.log
 .. load --table Tweets
 .. [
 .. {"content":"Good morning! Nice day."},
@@ -104,5 +104,5 @@ construction:
 We can also get newly registered records by searching:
 
 .. groonga-command
-.. include:: ../example/indexing-search-after-online-index-construction.log
+.. include:: ../example/reference/indexing-search-after-online-index-construction.log
 .. select Tweets --match_columns content --query 'good nice'

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/tokenizers.txt

@@ -0,0 +1,8 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Tokenizers
+==========
+
+TODO: Write me.

data/vendor/local/share/doc/groonga/{source → ja/html/_sources/reference}/type.txt

@@ -36,7 +36,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
 
   ブーリアン型やブール型などと呼ばれる型であり、真偽値を表します。取り得る値はtrueとfalseです。（デフォルト値: false）
 
-  :doc:`/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。
+  :doc:`/reference/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。
 
 ``Int8``
 
@@ -80,7 +80,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
 
   日時を表す型であり、1970年1月1日0時0分0秒からの経過時間を、マイクロ秒単位で64bit符号付き整数により表現します。（デフォルト値: 0）
 
-  :doc:`/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。
+  :doc:`/reference/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。
 
 ``ShortText``
 
@@ -99,7 +99,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
   旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
 
   度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。
-  :doc:`/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。
+  :doc:`/reference/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。
 
   測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。
 
@@ -107,7 +107,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
 
   世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
 
-  度分秒形式からミリ秒形式への変換方法や :doc:`/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。
+  度分秒形式からミリ秒形式への変換方法や :doc:`/reference/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。
 
 型に関する制限事項
 ------------------

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

@@ -8,12 +8,15 @@
 .. toctree::
    :maxdepth: 2
 
-   executables
-   output
-   commands
-   type
-   pseudo_column
-   expr
-   functions
-   indexing
-   log
+   reference/executables
+   reference/output
+   reference/command_version
+   reference/commands
+   reference/type
+   reference/tokenizers
+   reference/pseudo_column
+   reference/grn_expr
+   reference/functions
+   reference/indexing
+   reference/log
+   reference/api

data/vendor/local/share/doc/groonga/ja/html/_sources/server/gqtp.txt

@@ -0,0 +1,16 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+GQTP
+====
+
+TODO
+
+See :doc:`/reference/executables/groonga`.
+
+..
+   .. toctree::
+      :maxdepth: 2
+
+      gqtp/groonga

data/vendor/local/share/doc/groonga/ja/html/_sources/server/http/comparison.txt

@@ -0,0 +1,288 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Comparison
+==========
+
+There are many differences between :doc:`groonga` and
+:doc:`groonga-httpd`. Here is a comparison table.
+
++----------------------------+------------------------+----------------------+
+|                            |        groonga         |    groonga-httpd     |
++============================+========================+======================+
+|        Performance         | o                      | o                    |
++----------------------------+------------------------+----------------------+
+|   Using multi CPU cores    | o (by multi threading) | o (by multi process) |
++----------------------------+------------------------+----------------------+
+|     Configuration file     | optional               | required             |
++----------------------------+------------------------+----------------------+
+|     Custom prefix path     | x                      | o                    |
++----------------------------+------------------------+----------------------+
+|   Custom command version   | o                      | x (comming soon)     |
++----------------------------+------------------------+----------------------+
+|      Multi databases       | x                      | o                    |
++----------------------------+------------------------+----------------------+
+|       Authentication       | x                      | o                    |
++----------------------------+------------------------+----------------------+
+|      Gzip compression      | x                      | o                    |
++----------------------------+------------------------+----------------------+
+|            POST            | x                      | x (comming soon)     |
++----------------------------+------------------------+----------------------+
+|           HTTPS            | x                      | o                    |
++----------------------------+------------------------+----------------------+
+|         Access log         | x                      | o                    |
++----------------------------+------------------------+----------------------+
+| Upgrading without downtime | x                      | o                    |
++----------------------------+------------------------+----------------------+
+
+Performance
+-----------
+
+Both :doc:`groonga` and :doc:`groonga-httpd` are very fast. They can
+work with the same throughput.
+
+Using multi CPU cores
+---------------------
+
+Groonga scales on multi CPU cores. :doc:`groonga` scales by multi
+threading. :doc:`groonga-httpd` scales by multi processes.
+
+:doc:`groonga` uses the same number of threads as CPU cores by
+default. If you have 8 CPU cores, 8 threads are used by default.
+
+:doc:`groonga-httpd` uses 1 process by default. You need to set
+`worker_processes
+<http://nginx.org/en/docs/ngx_core_module.html#worker_processes>`_
+directive to use CPU cores. If you have 8 CPU cores, specify
+``worker_processes 8`` in configuration file like the following::
+
+  worker_processes 8;
+
+  http {
+    # ...
+  }
+
+Configuration file
+------------------
+
+:doc:`groonga` can work without configuration file. All configuration
+items such as port number and the max number of threads can be
+specified by command line. Configuration file is also used to specify
+configuration items.
+
+It's very easy to run groonga HTTP server because :doc:`groonga`
+requires just a few options to run. Here is the most simple command
+line to start HTTP server by :doc:`groonga`::
+
+  % groonga --protocol http -d /PATH/TO/DATABASE
+
+:doc:`groonga-httpd` requires configuration file to run. Here is the
+most simple configuration file to start HTTP server by
+:doc:`groonga-httpd`::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      location /d/ {
+        groonga on;
+        groonga_database /PATH/TO/DATABASE;
+      }
+    }
+  }
+
+Custom prefix path
+------------------
+
+:doc:`groonga` accepts a path that starts with ``/d/`` as command URL
+such as ``http://localhost:10041/d/status``. You cannot change the
+prefix path ``/d/``.
+
+:doc:`groonga-httpd` can custom prefix path. For example, you can use
+``http://localhost:10041/api/status`` as command URL. Here is a sample
+configuration to use ``/api/`` as prefix path::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      location /api/ { # <- change this
+        groonga on;
+        groonga_database /PATH/TO/DATABASE;
+      }
+    }
+  }
+
+Custom command version
+----------------------
+
+Groonga has :doc:`/reference/command_version` mechanism. It is for
+upgrading groonga commands with backward compatibility.
+
+:doc:`groonga` can change the default command veresion by
+``--default-command-version`` option. Here is a sample command line to
+use command version 2 as the default command version::
+
+  % groonga --protocol http --default-command-version 2 -d /PATH/TO/DATABASE
+
+:doc:`groonga-httpd` cannot custom the default command version
+yet. But it will be supported soon. If it is supported, you can
+provides different command version groonga commands in the same
+:doc:`groonga-httpd` process. Here is a sample configuration to
+provide command version 1 commands under ``/api/1/`` and command
+version 2 comamnds under ``/api/2/``::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      groonga_database /PATH/TO/DATABASE;
+
+      location /api/1/ {
+        groonga on;
+        groogna_default_command_version 1;
+      }
+
+      location /api/2/ {
+        groonga on;
+        groogna_default_command_version 2;
+      }
+    }
+  }
+
+Multi databases
+---------------
+
+:doc:`groonga` can use only one database in a process.
+
+:doc:`groonga-httpd` can use one or more databases in a process. Here
+is a sample configuration to provide ``/tmp/db1`` database under
+``/db1/`` path and ``/tmp/db2`` database under ``/db2/`` path::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      location /db1/ {
+        groonga on;
+        groonga_database /tmp/db1;
+      }
+
+      location /db2/ {
+        groonga on;
+        groonga_database /tmp/db2;
+      }
+    }
+  }
+
+Authentication
+--------------
+
+HTTP supports authentications such as basic authentication and digest
+authentication. It can be used for restricting use of danger command such
+as :doc:`/reference/commands/shutdown`.
+
+:doc:`groonga` doesn't support any authentications. To restrict use of
+danger command, other tools such as iptables and reverse proxy are
+needed.
+
+:doc:`groonga-httpd` supports basic authentication. Here is a sample
+configuration to restrict use of :doc:`/reference/commands/shutdown`
+command::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      groonga_database /PATH/TO/DATABASE;
+
+      location /d/shutdown {
+        groonga on;
+        auth_basic           "manager is required!";
+        auth_basic_user_file "/etc/managers.htpasswd";
+      }
+
+      location /d/ {
+        groonga on;
+      }
+    }
+  }
+
+Gzip compression
+----------------
+
+HTTP supports response compression by gzip with ``Content-Encoding:
+gzip`` response header. It can reduce network flow. It is useful
+for large search response.
+
+:doc:`groonga` doesn't support compression. To support compression,
+reverse proxy is needed.
+
+:doc:`groonga-httpd` supports gzip compression. Here is a sample
+configuration to compress response by gzip::
+
+  events {
+  }
+
+  http {
+    server {
+      listen 10041;
+
+      groonga_database /PATH/TO/DATABASE;
+
+      location /d/ {
+        groonga    on;
+        gzip       on;
+        gzip_types *;
+      }
+    }
+  }
+
+Note that `gzip_types *` is specified. It's one of the important
+configuration. `gzip_types` specifies gzip target data formats by MIME
+types. :doc:`groonga-httpd` returns one of JSON, XML or MessagePack
+format data. But those formats aren't included in the default value of
+`gzip_types`. The default value of `gzip_types` is `text/html`.
+
+To compress response data from :doc:`groonga-httpd` by gzip, you need
+to specify `gzip_types *` or `gzip_types application/json text/xml
+application/x-msgpack` explicitly. `gzip_types *` is recommended.
+There are two reasons for it. The first, groonga may support more
+formats in the future. The second, all requests for the `location` are
+processed by groonga. You don't need to consider about other modules.
+
+POST
+----
+
+TODO
+
+HTTPS
+-----
+
+TODO
+
+Access log
+----------
+
+TODO
+
+Upgrading without downtime
+--------------------------
+
+TODO

data/vendor/local/share/doc/groonga/ja/html/_sources/server/http/groonga-httpd.txt

@@ -0,0 +1,8 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+groonga-httpd
+=============
+
+TODO

data/vendor/local/share/doc/groonga/ja/html/_sources/server/http/groonga.txt

@@ -0,0 +1,8 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+groonga
+=======
+
+TODO

data/vendor/local/share/doc/groonga/ja/html/_sources/server/http.txt

@@ -0,0 +1,29 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+HTTP
+====
+
+Groonga provides two HTTP server implementations.
+
+* :doc:`http/groonga`
+* :doc:`http/groonga-httpd`
+
+:doc:`http/groonga` is a simple implemntation. It is fast but doesn't
+have many HTTP features. It is convenient to try groonga because it
+requires just a few command line options to run.
+
+:doc:`http/groonga-httpd` is a `nginx <http://nginx.org/>`_ based
+implementation. It is also fast and has many HTTP features.
+
+.. note::
+
+   :doc:`http/groonga-httpd` is still experimental.
+
+.. toctree::
+   :maxdepth: 2
+
+   http/comparison
+   http/groonga
+   http/groonga-httpd

data/vendor/local/share/doc/groonga/ja/html/_sources/server.txt

@@ -0,0 +1,12 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Server
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   server/gqtp
+   server/http

data/vendor/local/share/doc/groonga/ja/html/_sources/spec/search.txt

@@ -5,7 +5,7 @@
 検索
 ====
 
-:doc:`/commands/select` コマンドがqueryパラメータを使ってどのように検索するのかを説明します。
+:doc:`/reference/commands/select` コマンドがqueryパラメータを使ってどのように検索するのかを説明します。
 
 検索の挙動
 ----------

data/vendor/local/share/doc/groonga/ja/html/_sources/spec.txt

@@ -2,8 +2,8 @@
 
 .. highlightlang:: none
 
-仕様
-====
+Specification
+=============
 
 .. toctree::
    :maxdepth: 1

data/vendor/local/share/doc/groonga/ja/html/_sources/suggest/completion.txt

@@ -153,7 +153,7 @@ How to use
 .. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
 .. ]
 
-Groonga provides :doc:`/commands/suggest` command to use
+Groonga provides :doc:`/reference/commands/suggest` command to use
 completion. `--type complete` option requests completion.
 
 For example, here is an command to get completion results by

data/vendor/local/share/doc/groonga/ja/html/_sources/suggest/correction.txt

@@ -66,7 +66,7 @@ Similar search
 Similar search can find registered words that has one or
 more the same tokens as user input. TokenBigram tokenizer is
 used for tokenization because suggest dataset schema
-created by :doc:`/executables/groonga-suggest-create-dataset`
+created by :doc:`/reference/executables/groonga-suggest-create-dataset`
 uses TokenBigram tokenizer as the default tokenizer.
 
 For example, there is a registered query "search engine". An
@@ -101,7 +101,7 @@ How to use
 .. {"sequence": "1", "time": 1312950810.86057, "item": "search", "type": "submit"}
 .. ]
 
-Groonga provides :doc:`/commands/suggest` command to use
+Groonga provides :doc:`/reference/commands/suggest` command to use
 correction. `--type correct` option requests corrections.
 
 For example, here is an command to get correction results by

data/vendor/local/share/doc/groonga/ja/html/_sources/suggest/introduction.txt

@@ -47,7 +47,9 @@ For example, there are registered correction pairs:
 | wrong word | correct word |
 +============+==============+
 | grroonga   | groonga      |
++------------+--------------+
 | gronga     | groonga      |
++------------+--------------+
 | gronnga    | groonga      |
 +------------+--------------+
 

data/vendor/local/share/doc/groonga/ja/html/_sources/suggest/suggestion.txt

@@ -81,7 +81,7 @@ How to use
 .. {"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
 .. ]
 
-Groonga provides :doc:`/commands/suggest` command to use
+Groonga provides :doc:`/reference/commands/suggest` command to use
 suggestion. `--type suggest` option requests suggestion
 
 For example, here is an command to get suggestion results by

data/vendor/local/share/doc/groonga/ja/html/_sources/troubleshooting/different_results_with_the_same_keyword.txt

@@ -81,7 +81,7 @@ groongaは完全一致検索した結果のヒット件数が所定の閾値を
 
 TokenMecabトークナイザーは事前に準備した辞書を用いてトークナイズするため、再現率よりも適合率を重視したトークナイザーと言えます。一方、TokenBigramなど、N-gram系のトークナイザーは適合率を重視したトークナイザーと言えます。例えば、TokenMecabの場合「東京都」で「京都」に完全一致することはありませんが、TokenBigramでは完全一致します。一方、TokenMecabでは「東京都民」に完全一致しませんが、TokenBigramでは完全一致します。
 
-このようにN-gram系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには :doc:`/commands/select` のmatch_columnsで使用する索引毎に重み付けを指定します。
+このようにN-gram系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには :doc:`/reference/commands/select` のmatch_columnsで使用する索引毎に重み付けを指定します。
 
 ここでも、前述の例を使って具体例を示します。まず、TokenBigramを用いた索引を追加します。::