rroonga 3.0.7-x86-mingw32 → 3.0.8-x86-mingw32

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

@@ -0,0 +1,29 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_user_data``
+=================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_user_data
+
+   TODO...
+
+.. c:function:: grn_user_data *grn_obj_user_data(grn_ctx *ctx, grn_obj *obj)
+
+   objectに登録できるユーザデータへのポインタを返します。table, column, proc, exprのみ使用可能です。
+
+   :param obj: 対象objectを指定します。

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

@@ -2,53 +2,85 @@
 
 .. highlightlang:: none
 
-cache_limit
-===========
+.. groonga-command
+.. database: commands_cache_limit
 
-名前
-----
+``cache_limit``
+===============
 
-cache_limit - cacheサイズの設定・取得
+Summary
+-------
 
-書式
-----
-::
+``cache_limit`` gets or sets the max number of query cache
+entries. Query cache is used only by :doc:`select` command.
 
- cache_limit max
+If the max number of query cache entries is 100, the recent 100
+``select`` commands are only cached. The cache expire algorithm is LRU
+(least recently used).
 
-説明
-----
+Syntax
+------
 
-groonga組込コマンドの一つであるcache_limitについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+``cache_limit`` has one optional parameter::
 
-cache_limitは、クエリキャッシュの最大件数を取得したり設定したりします。
+  cache_limit [max=null]
 
-引数
-----
+Usage
+-----
+
+You can get the current max number of cache entries by executing
+``cache_limit`` without parameter.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/cache_limit/get.log
+.. cache_limit
+
+You can set the max number of cache entries by executing ``cache_limit``
+with ``max`` parameter.
+
+Here is an example that sets ``10`` as the max number of cache
+entries.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/cache_limit/set.log
+.. cache_limit 10
+.. cache_limit
+
+If ``max`` parameter is used, the return value is the max number of
+cache entries before ``max`` parameter is set.
+
+
+Parameters
+----------
+
+This section describes all parameters.
 
 ``max``
+"""""""
+
+It specifies the max number of query cache entries as a number.
+
+If ``max`` parameter isn't specified, the current max number of query
+cache entries isn't changed. ``cache_limit`` just returns the current
+max number of query cache entries.
 
-  クエリキャッシュの最大件数を整数で指定します。
-  maxが指定されなかった場合には、クエリキャッシュの最大件数は変更せず、
-  現在の設定値のみが返されます。
+Return value
+------------
 
-返値
-----
+``cache_limit`` returns the current max number of query cache entries::
 
-json
-^^^^
+  [[HEADER, n_entries]]
 
-::
+``HEADER``
 
- [以前の設定値]
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
-``以前の設定値``
+``n_entries``
 
-  すでに設定されていたクエリキャッシュの最大件数を返す。
+  ``n_entries`` is the current max number of query cache entries. It
+  is a number.
 
-例
---
-::
+See also
+--------
 
- cache_limit 4
- [100]
+* :doc:`select`

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

@@ -8,7 +8,7 @@ defrag
 名前
 ----
 
-defrag - オブジェクトにセットされたロックを解除する
+``defrag`` command resolves fragmentation of specified objects.
 
 書式
 ----

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

@@ -2,70 +2,121 @@
 
 .. highlightlang:: none
 
-delete
-======
+.. groonga-command
+.. database: commands_delete
 
-名前
-----
+``delete``
+==========
 
-delete - 一件のレコードの削除
+Summary
+-------
 
-書式
-----
-::
+``delete`` command deletes specified record of table.
 
- delete table [key [id [filter]]]
+.. _cascade-delete:
+
+Cascade delete
+^^^^^^^^^^^^^^
+
+There is a case that multiple table is associated. For example, the key of one table are referenced by other table's records. In such a case, if you delete the key of one table, other table's records are also removed.
 
-説明
-----
+Note that the type of other table's column is COLUMN_VECTOR, only the value of referencing key is removed from the vector value.
 
-groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Syntax
+------
+::
 
-deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。
+ delete table [key [id [filter]]]
 
-引数
-----
+Usage
+-----
+
+Here are a schema definition and sample data to show usage.
+
+.. groonga-command
+.. table_create Entry TABLE_HASH_KEY UInt32
+.. column_create Entry status --type ShortText
+.. load --table Entry
+.. [
+.. {"_key": 1, "status": "OK"}
+.. {"_key": 2, "status": "NG"}
+.. ] 
+
+Delete the record from Entry table which has "2" as the key.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/delete/status.log
+.. delete Entry 2
+.. select Entry
+
+Here is the example about cascaded delete.
+
+The country column of Users table associates with Country table.
+
+"Cascaded delete" removes the records which matches specified key and refers that key.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/delete/cascade.log
+.. table_create Country TABLE_HASH_KEY ShortText
+.. table_create Users TABLE_HASH_KEY UInt32
+.. column_create Users name COLUMN_SCALAR ShortText
+.. column_create Users country COLUMN_SCALAR Country
+.. load --table Users
+.. [
+.. {"_key": 1, "name": "John", country: "United States"}
+.. {"_key": 2, "name": "Mike", country: "United States"}
+.. {"_key": 3, "name": "Takashi", country: "Japan"}
+.. {"_key": 4, "name": "Hanako", country: "Japan"}
+.. ] 
+.. load --table Country
+.. [
+.. {"_key": "United States"}
+.. {"_key": "Japan"}
+.. ] 
+.. delete Country "United States"
+.. select Country
+.. select Users
+
+
+Parameters
+----------
 
 ``table``
 
-  レコードを削除しようとするテーブルの名前を指定します。
+  It specifies the name of table to delete the records.
 
 ``key``
 
-  削除するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。
+  It specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored.
+  (Use ``id`` parameter in such a case)
 
 ``id``
 
-  レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。
+  It specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter.
 
 ``filter``
 
-  script形式のgrn_expr文字列によってレコードを指定します。filterパラメータを指定する場合は、id及びkeyパラメータを指定してはいけません。
+  It specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter,
+  you must not specify ``key`` and ``id`` parameter.
 
-返値
----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
- [成功かどうかのフラグ]
-
-``成功かどうかのフラグ``
+ [HEADER, SUCCEEDED_OR_NOT]
 
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+``HEADER``
 
-例
---
+  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
+  See :doc:`/reference/command/output_format` about HEADER.
 
-テーブルEntryからレコードを削除します。::
+``SUCCEEDED_OR_NOT``
 
- delete Entry abandon
+  If command succeeded, it returns true, otherwise it returns false on error.
 
- [true]
 
-関連項目
+See also
 --------
 
 :doc:`load`

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

@@ -0,0 +1,77 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_ruby_eval
+
+``ruby_eval``
+=============
+
+Summary
+-------
+
+``ruby_eval`` command evaluates ruby script and returns the result.
+
+Syntax
+------
+
+``ruby_eval`` has one required parameter::
+
+  ruby_eval ruby_script
+
+Usage
+-----
+
+You can execute any scripts which mruby supports by calling ``ruby_eval``.
+
+Here is an example that just calculate ``1 + 2`` by mruby plugin.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/ruby_eval/calc.log
+.. register ruby/eval
+.. ruby_eval "1 + 2"
+
+Register ``ruby/eval`` plugin to use ``ruby_eval`` command in advance.
+
+Note that ``ruby_eval`` is implemented as an experimental plugin,
+and the specification may be changed in the future.
+
+Parameters
+----------
+
+This section describes all parameters.
+
+``ruby_script``
+"""""""""""""""
+
+It specifies the ruby script which you want to evaluate.
+
+Return value
+------------
+
+``ruby_eval`` returns the evaluated result which key is "value" as json format::
+
+  [[HEADER, EVALUATED]]
+
+``HEADER``
+
+  See :doc:`/reference/command/output_format` about ``HEADER``.
+
+``EVALUATED``
+
+  ``EVALUATED`` consists of pair of key and value in forms of {key:value}.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Name
+       - Description
+     * - ``key``
+       - reserved word 'value'.
+     * - ``value``
+       - the value of evaluated script. It must be a number.
+
+See also
+--------
+

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

@@ -645,6 +645,8 @@ is equal to or more than ``10`` from ``Entries`` table.
 Output related parameters
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. _output_columns:
+
 ``output_columns``
 """"""""""""""""""
 
@@ -860,11 +862,11 @@ TODO: write in English and add example.
 
   drilldown条件が実行される前の検索結果が以下のように出力されます。::
 
-    [[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]
+    [[ヒット数], [[カラム名1,カラム型1],..], 検索結果1,..]
 
-  ``検索件数``
+  ``ヒット数``
 
-    検索件数が出力されます。
+    検索条件にヒットしたレコードの数が出力されます。 ``--limit`` オプションで出力件数を制限した場合は出力するレコード数と一致しません。 ``ヒット数`` は ``--limit`` オプションに関係なく常にヒットしたレコードの数になります。
 
   ``カラム名n``
 

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

@@ -136,6 +136,11 @@ Context
 Specifies the path to a groonga database. This is the required
 directive.
 
+``groonga_database_auto_create``
+""""""""""""""""""""""""""""""""
+
+TODO
+
 ``groonga_base_path``
 """""""""""""""""""""
 
@@ -183,6 +188,101 @@ Here is an example configuration to add authorization to
     # Because location name is the base path.
   }
 
+.. _groonga-log-path:
+
+``groonga_log_path``
+"""""""""""""""""""""
+
+Synopsis::
+
+  groonga_log_path path | off;
+
+Default
+  ``/var/log/groonga/httpd/groonga.log``
+
+Context
+  ``http``, ``server``, ``location``
+
+Specifies groonga log path in the ``http``, ``server`` or ``location`` block. The
+default is ``/var/log/groonga/httpd/groonga.log``.
+You can disable logging to specify ``off``.
+
+Examples::
+
+  location /d/ {
+    groonga on;
+    # You can disable log for groonga.
+    groonga_log_path off;
+  }
+
+.. _groonga-log-level:
+
+``groonga_log_level``
+"""""""""""""""""""""
+
+Synopsis::
+
+  groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump;
+
+Default
+  ``notice``
+
+Context
+  ``http``, ``server``, ``location``
+
+Specifies groonga log level in the ``http``, ``server`` or ``location`` block. The
+default is ``notice``. You can disable logging by specifying ``none`` as log level.
+
+Examples::
+
+  location /d/ {
+    groonga on;
+    # You can customize log level for groonga.
+    groonga_log_level notice;
+  }
+
+.. _groonga-query-log-path:
+
+``groonga_query_log_path``
+""""""""""""""""""""""""""
+
+Synopsis::
+
+  groonga_query_log_path path | off;
+
+Default
+  ``/var/log/groonga/httpd/groonga-query.log``
+
+Context
+  ``http``, ``server``, ``location``
+
+Specifies groonga's query log path in the ``http``, ``server`` or
+``location`` block. The default is
+``/var/log/groonga/httpd/groonga-query.log``.  You can disable logging
+to specify ``off``.
+
+Examples::
+
+  location /d/ {
+    groonga on;
+    # You can disable query log for groonga.
+    groonga_query_log_path off;
+  }
+
+Query log is useful for the following cases:
+
+  * Detecting slow query.
+  * Debugging.
+
+You can analyze your query log by `groonga-query-log package
+<https://github.com/groonga/groonga-query-log>`_. The package provides
+useful tools.
+
+For example, there is a tool that analyzing your query log. It can
+detect slow queries from your query log. There is a tool that
+replaying same queries in your query log. It can test the new groonga
+before updating production environment.
+
 Performance related directives
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -200,10 +300,127 @@ see http://wiki.nginx.org/CoreModule#worker_processes.
 
 By default, this is set to 1. It is nginx's default.
 
+``proxy_cache``
+"""""""""""""""
+
+In short, you can use nginx's reverse proxy and cache mechanism
+instead of groonga's built-in query cache feature.
+
+Query cache
++++++++++++
+
+Groonga has query cache feature for :doc:`/reference/commands/select`
+command. The feature improves performance in many cases.
+
+Query cache feature works well on groonga-httpd except you use
+:doc:`/reference/commands/cache_limit` command on 2 or more
+workers. Normally, :doc:`/reference/commands/cache_limit` command
+isn't used. So there is no problem on many cases.
+
+Here is a description about a problem of using
+:doc:`/reference/commands/cache_limit` command on 2 or more workers.
+
+Groonga's query cache is available in the same process. It means that
+workers can't share the cache. If you don't change cache size, it
+isn't a big problem. If you want to change cache size by
+:doc:`/reference/commands/cache_limit` command, there is a problem.
+
+There is no portable ways to change cache size for all workers.
+
+For example, there are 3 workers::
+
+                                     +-- worker 1
+  client -- groonga-httpd (master) --+-- worker 2
+                                     +-- worker 3
+
+The client requests :doc:`/reference/commands/cache_limit` command and
+the worker 1 receives it::
+
+                                     +-> worker 1 (changed!)
+  client -> groonga-httpd (master) --+-- worker 2
+                                     +-- worker 3
+
+The client requests :doc:`/reference/commands/cache_limit` command
+again and the worker 1 receives it again::
+
+                                     +-> worker 1 (changed again!!!)
+  client -> groonga-httpd (master) --+-- worker 2
+                                     +-- worker 3
+
+In this case, the worker 2 and the worker 3 aren't received any
+requests. So they don't change cache size.
+
+You can't choose a worker. So you can't change cache sizes of all
+workers by :doc:`/reference/commands/cache_limit` command.
+
+Reverse proxy and cache
++++++++++++++++++++++++
+
+You can use nginx's reverse proxy and cache feature for query cache::
+
+                                                              +-- worker 1
+  client -- groonga-httpd (master) -- reverse proxy + cache --+-- worker 2
+                                                              +-- worker 3
+
+You can use the same cache configuration for all workers but you can't
+change cache configuration dynamically by HTTP.
+
+Here is a sample configuration::
+
+   ...
+   http {
+     proxy_cache_path /var/cache/groonga-httpd levels=1:2 keys_zone=groonga:10m;
+     proxy_cache_valid 10m;
+     ...
+     # Reverse proxy and cache
+     server {
+       listen 10041;
+       ...
+       # Only select command
+       location /d/select {
+         # Pass through groonga with cache
+         proxy_cache groonga;
+         proxy_pass http://localhost:20041;
+       }
+
+       location / {
+         # Pass through groonga
+         proxy_pass http://localhost:20041;
+       }
+     }
+
+     # groonga
+     server {
+       location 20041;
+       location /d/ {
+         groonga on;
+         groonga_database /var/lib/groonga/db/db;
+       }
+     }
+     ...
+   }
+
+See the following nginx documentations for parameter details:
+
+  * http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path
+  * http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid
+  * http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache
+  * http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass
+
+Note that you need to remove cache files created by nginx by hand
+after you load new data to groonga. For the above sample
+configuration, run the following command to remove cache files::
+
+  % groonga DB_PATH < load.grn
+  % rm -rf /var/cache/groonga-httpd/*
+
+If you use groonga's query cache feature, you don't need to expire
+cache by hand. It is done automatically.
+
 Available nginx modules
 -----------------------
 
-All standard HTTP modules is available. HttpRewriteModule is
+All standard HTTP modules are available. HttpRewriteModule is
 disabled when you don't have PCRE (Perl Compatible Regular
 Expressions). For the list of standard HTTP modules, see
 http://wiki.nginx.org/Modules.