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

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

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. _command-status:
+
 status
 ======
 
@@ -53,9 +55,6 @@ json形式
 例
 --
 
-::
-
- status
- {"alloc_count":104,
-  "starttime":1268213679,
-  "uptime":1}
+.. groonga-command
+.. include:: ../../example/reference/commands/status.log
+.. status

data/vendor/local/share/doc/groonga/{en/html/_sources → source/reference}/commands/suggest.txt

@@ -201,7 +201,7 @@ EXAMPLE
 Here are learned data for completion.
 
 .. groonga-command
-.. include:: ../commands/suggest-learn-completion.log
+.. include:: ../../example/reference/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"},
@@ -215,7 +215,7 @@ Here are learned data for completion.
 Here are learned data for correction.
 
 .. groonga-command
-.. include:: ../commands/suggest-learn-correction.log
+.. include:: ../../example/reference/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"},
@@ -231,7 +231,7 @@ Here are learned data for correction.
 Here are learned data for suggestion.
 
 .. groonga-command
-.. include:: ../commands/suggest-learn-suggestion.log
+.. include:: ../../example/reference/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"},
@@ -241,25 +241,25 @@ Here are learned data for suggestion.
 Here is a completion example.
 
 .. groonga-command
-.. include:: ../commands/suggest-completion.log
+.. include:: ../../example/reference/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
+.. include:: ../../example/reference/commands/suggest-correction.log
 .. suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
 
 Here is a suggestion example.
 
 .. groonga-command
-.. include:: ../commands/suggest-suggestion.log
+.. include:: ../../example/reference/commands/suggest-suggestion.log
 .. suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
 
 Here is a mixed example.
 
 .. groonga-command
-.. include:: ../commands/suggest-mixed.log
+.. include:: ../../example/reference/commands/suggest-mixed.log
 .. suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
 
 
@@ -267,4 +267,4 @@ SEE ALSO
 --------
 
 * :doc:`/suggest`
-* :doc:`/executables/groonga-suggest-create-dataset`
+* :doc:`/reference/executables/groonga-suggest-create-dataset`

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

@@ -76,29 +76,6 @@ json形式
   ``テーブル情報名n`` で示された情報の配列を出力します。
   情報の順序は ``テーブル情報名n`` の順序と同じです。
 
-例
---
-::
-
- table_list Entry
-
- [[["id", "UInt32"],
-   ["name","ShortText"],
-   ["path","ShortText"],
-   ["flags","ShortText"],
-   ["domain", "ShortText"],
-   ["range","ShortText"]],
-  [256,
-   "Entry",
-   "test.db.0000100",
-   "TABLE_HASH_KEY|PERSISTENT",
-   "ShortText",
-   "null"],
-  [257,
-   "Term",
-   "test.db.0000101",
-   "TABLE_PAT_KEY|KEY_NORMALIZE|PERSISTENT",
-   "ShortText",
-   "null"]]
-
-注: 実際は改行が入りません。
+.. groonga-command
+.. include:: ../../example/reference/commands/table_list.log
+.. table_list

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

@@ -14,7 +14,7 @@ table_remove - テーブルの削除
 ----
 ::
 
- table_remove table
+ table_remove name
 
 説明
 ----
@@ -26,7 +26,7 @@ table_removeはテーブルと定義されているカラムを削除します
 引数
 ----
 
-``table``
+``name``
   削除対象のカラムが定義されているテーブルの名前を指定します。
 
 返値
@@ -47,6 +47,6 @@ json形式
 --
 ::
 
- column_remove Entry body
+ table_remove Entry
 
  [true]

data/vendor/local/share/doc/groonga/source/reference/commands_not_implemented/add.txt

@@ -0,0 +1,104 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+add
+===
+
+名前
+----
+
+add - 一件のレコードの追加
+
+書式
+----
+::
+
+ add table [key [columns [values [output_columns]]]]
+
+説明
+----
+
+**未実装です**
+
+groonga組込コマンドの一つであるaddについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+addは、使用しているデータベースのテーブルに１件のレコードを登録し、カラムの値を更新し、更新したカラムの値を返却します。
+
+引数
+----
+
+``table``
+
+  レコードを追加しようとするテーブルの名前を指定します。
+
+``key``
+
+  登録するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定する必要はなく、指定された場合は無視されます。
+
+``columns``
+
+  テーブルに登録するレコードに値を設定するカラム名のリストを指定します。
+
+``values``
+
+  登録するレコードの値を表現した文字列を渡します。
+
+  以下のいずれかの形式が使用できます。
+
+  ``形式1``
+    [カラム値1, カラム値2,..]
+
+  ``形式2``
+    {カラム名1: カラム値1, カラム名2: カラム値2}
+
+  形式1の[カラム名1, カラム名2,..]の要素はcolumns引数が省略された場合のみ有効です。
+
+``output_columns``
+
+  出力するカラム名のリストをカンマ(',')区切りで指定します。
+
+返値
+---
+
+以下のようなjson形式で値が返却されます。
+
+::
+
+ [[リターンコード, 処理開始時間, 処理時間], 新規追加、[カラム値1, ...]]
+
+``リターンコード``
+
+  grn_rcに対応する数値が返されます。0(GRN_SUCCESS)以外の場合は、続いてエラー内容を示す
+  文字列が返されます。
+
+``処理開始時間``
+
+  処理を開始した時間について、1970年1月1日0時0分0秒を起点とした秒数を小数で返します。
+
+``処理時間``
+
+  処理にかかった秒数を返します。
+
+``新規追加``
+
+  レコードが追加されたかどうかを判定する。
+
+``カラム値n``
+
+  output_columnsで指定されたカラムの値。
+
+例
+--
+
+テーブルEntryにレコードを登録します。::
+
+ add Entry abandon body 放棄する
+
+ [[0,1268208665.67547,0.045],true,[]]
+
+関連項目
+--------
+
+:doc:`load`
+

data/vendor/local/share/doc/groonga/source/reference/commands_not_implemented/get.txt

@@ -0,0 +1,80 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+get
+===
+
+名前
+----
+
+get - 一件のレコードの値の取得
+
+書式
+----
+::
+
+ get table [key [output_columns [id]]]
+
+説明
+----
+
+groonga組込コマンドの一つであるgetについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+getは、使用しているデータベースのテーブルの中の１件のレコードを指定し、カラムの値を取得します。
+
+引数
+----
+
+``table``
+
+  値を取得するレコードを含むテーブルの名前を指定します。
+
+``key``
+
+  値を取得するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。
+
+``output_columns``
+
+  出力するカラム名のリストをカンマ(',')区切りで指定します。
+
+返値
+---
+
+以下のようなjson形式で値が返却されます。
+
+::
+
+ [[リターンコード, 処理開始時間, 処理時間], [カラム値1,..]]
+
+``リターンコード``
+
+  grn_rcに対応する数値が返されます。0(GRN_SUCCESS)以外の場合は、続いてエラー内容を示す
+  文字列が返されます。
+
+``処理開始時間``
+
+  処理を開始した時間について、1970年1月1日0時0分0秒を起点とした秒数を小数で返します。
+
+``処理時間``
+
+  処理にかかった秒数を返します。
+
+``カラム値n``
+
+  output_columnsで指定されたカラムの値。
+
+例
+--
+
+テーブルEntryから主キー値が"abandon"であるレコードのbodyカラムの値を取得します。::
+
+ get Entry abandon body
+
+ [[0,1268211658.00739,0.000361],["放棄する"]]
+
+
+関連項目
+--------
+
+:doc:`load`

data/vendor/local/share/doc/groonga/source/reference/commands_not_implemented/set.txt

@@ -0,0 +1,105 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+set
+===
+
+名前
+----
+
+set - 一件のレコードの値の更新
+
+書式
+----
+::
+
+ set table [key [columns [values [output_columns [id]]]]]
+
+説明
+----
+
+groonga組込コマンドの一つであるsetについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+setは、使用しているデータベースのテーブルの中の１件のレコードについて、カラムの値を更新し、更新したカラムの値を返却します。
+
+引数
+----
+
+``table``
+
+  値を更新しようとするレコードを含むテーブルの名前を指定します。
+
+``key``
+
+  値を変更するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。
+
+``columns``
+
+  テーブルに登録するレコードに値を設定するカラム名のリストを指定します。
+
+``values``
+
+  登録するレコードの値を表現した文字列を渡します。
+
+  以下のいずれかの形式が使用できます。
+
+  ``形式1``
+    [カラム値1, カラム値2,..]
+
+  ``形式2``
+    {カラム名1: カラム値1, カラム名2: カラム値2}
+
+  形式1の[カラム名1, カラム名2,..]の要素はcolumns引数が省略された場合のみ有効です。
+
+``output_columns``
+
+  出力するカラム名のリストをカンマ(',')区切りで指定します。
+
+``id``
+
+  レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。
+
+返値
+---
+
+以下のようなjson形式で値が返却されます。
+
+::
+
+ [[リターンコード, 処理開始時間, 処理時間], [新規追加, [カラム値1, ...]]]
+
+``リターンコード``
+
+  grn_rcに対応する数値が返されます。0(GRN_SUCCESS)以外の場合は、続いてエラー内容を示す
+  文字列が返されます。
+
+``処理開始時間``
+
+  処理を開始した時間について、1970年1月1日0時0分0秒を起点とした秒数を小数で返します。
+
+``処理時間``
+
+  処理にかかった秒数を返します。
+
+``新規追加``
+
+  レコードが追加されたかどうかを判定する。
+
+``カラム値n``
+
+  output_columnsで指定されたカラムの値。
+
+例
+--
+
+テーブルEntryにレコードを登録します。::
+
+ set Entry abandon body 放棄する
+
+ [[0,1268208665.67547,0.045],[]]
+
+関連項目
+--------
+
+:doc:`load`

data/vendor/local/share/doc/groonga/source/{executables → reference/executables}/grntest.txt

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

data/vendor/local/share/doc/groonga/source/reference/executables/groonga-httpd.txt

@@ -0,0 +1,209 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+groonga-httpd
+=============
+
+Summary
+-------
+
+groonga-httpd is a program to communicate with a groonga server using
+the HTTP protocol. It functions as same as
+:doc:`groonga-server-http`. Although :doc:`groonga-server-http` has
+limited support for HTTP with a minimal built-in HTTP server,
+groonga-httpd has full support for HTTP with an embedded `nginx
+<http://nginx.org/>`_. All standards-compliance and features provided
+by nginx is also available in groonga-httpd.
+
+groonga-httpd has an Web-based administration tool implemented with HTML and
+JavaScript. You can access to it from http://hostname:port/.
+
+Synopsis
+--------
+
+::
+
+  groonga-httpd [nginx options]
+
+Usage
+-----
+
+Set up
+^^^^^^
+
+First, you'll need to edit the groonga-httpd configuration file to specify a
+database. Edit /etc/groonga/httpd/groonga-httpd.conf to enable the
+``groonga_database`` directive like this::
+
+   # Match this to the file owner of groonga database files if groonga-httpd is
+   # run as root.
+   #user groonga;
+   ...
+   http {
+     ...
+     # Don't change the location; currently only /d/ is supported.
+     location /d/ {
+       groonga on; # <= This means to turn on groonga-httpd.
+
+       # Specify an actual database and enable this.
+       groonga_database /var/lib/groonga/db/db;
+     }
+     ...
+   }
+
+Then, run groonga-httpd. Note that the control immediately returns back to the
+console because groonga-httpd runs as a daemon process by default.::
+
+   % groonga-httpd
+
+Request queries
+^^^^^^^^^^^^^^^
+
+To check, request a simple query (:doc:`/reference/commands/status`).
+
+.. groonga-command
+.. database: groonga-httpd
+.. include:: ../../example/reference/executables/groonga-httpd.log
+.. /d/status
+
+Browse the administration tool
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Also, you can browse Web-based administration tool at http://localhost:10041/.
+
+Shut down
+^^^^^^^^^
+
+Finally, to terminate the running groonga-httpd daemon, run this::
+
+   % groonga-httpd -s stop
+
+Configuration directives
+------------------------
+
+This section decribes only important directives. They are
+groonga-httpd specific directives and performance related directives.
+
+The following directives can be used in the groonga-httpd configuration file.
+By default, it's located at /etc/groonga/httpd/groonga-httpd.conf.
+
+Groonga-httpd specific directives
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following directives aren't provided by nginx. They are provided
+by groonga-httpd to configure groonga-httpd specific configurations.
+
+``groonga``
+"""""""""""
+
+Synopsis::
+
+  groonga on | off;
+
+Default
+  ``groonga off;``
+
+Context
+  ``location``
+
+Specifies whether groonga is enabled in the ``location`` block. The
+default is ``off``. You need to specify ``on`` to enable groonga.
+
+Examples::
+
+  location /d/ {
+    groonga on;  # Enables groonga under /d/... path
+  }
+
+  location /d/ {
+    groonga off; # Disables groonga under /d/... path
+  }
+
+``groonga_database``
+""""""""""""""""""""
+
+Synopsis::
+
+  groonga_database /path/to/groonga/database;
+
+Default
+  ``groonga_database /usr/local/var/lib/groonga/db/db;``
+
+Context
+  ``http``, ``server``, ``location``
+
+Specifies the path to a groonga database. This is the required
+directive.
+
+``groonga_base_path``
+"""""""""""""""""""""
+
+Synopsis::
+
+  groonga_base_path /d/;
+
+Default
+  The same value as ``location`` name.
+
+Context
+  ``location``
+
+Specifies the base path in URI. groonga uses
+``/d/command?parameter1=value1&...`` path to run ``command``. The form
+of path in used in groonga-httpd but groonga-httpd also supports
+``/other-prefix/command?parameter1=value1&...`` form. To support the
+form, groonga-httpd removes the base path from the head of request URI
+and prepend ``/d/`` to the processed request URI. By the path
+conversion, users can use custom path prefix and groonga can always
+uses ``/d/command?parameter1=value1&...`` form.
+
+Nomally, this directive isn't needed. It is needed for per command
+configuration.
+
+Here is an example configuration to add authorization to
+:doc:`/reference/commands/shutdown` command::
+
+  groonga_database /var/lib/groonga/db/db;
+
+  location /d/shutdown {
+    groonga on;
+    # groonga_base_path is needed.
+    # Because /d/shutdown is handled as the base path.
+    # Without this configuration, /d/shutdown/shutdown path is required
+    # to run shutdown command.
+    groonga_base_path /d/;
+    auth_basic           "manager is required!";
+    auth_basic_user_file "/etc/managers.htpasswd";
+  }
+
+  location /d/ {
+    groonga on;
+    # groonga_base_path doesn't needed.
+    # Because location name is the base path.
+  }
+
+Performance related directives
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following directives are related to the performance of groonga-httpd.
+
+``worker_processes``
+""""""""""""""""""""
+
+For optimum performance, set this to be equal to the number of CPUs or cores. In
+many cases, groonga queries may be CPU-intensive work, so to fully utilize
+multi-CPU/core systems, it's essential to set this accordingly.
+
+This isn't a groonga-httpd specific directive, but an nginx's one. For details,
+see http://wiki.nginx.org/CoreModule#worker_processes.
+
+By default, this is set to 1. It is nginx's default.
+
+Available nginx modules
+-----------------------
+
+All standard HTTP modules is 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.

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

@@ -2,13 +2,13 @@
 
 .. highlightlang:: none
 
-groonga HTTPサービス
+groonga HTTPサーバー
 ====================
 
 名前
 ----
 
-groonga HTTPサービス
+groonga HTTPサーバー
 
 書式
 ----
@@ -48,7 +48,7 @@ GETメソッドのみが使用可能です。
 
 output_typeにはjson, tsv, xmlが指定可能です。
 
-command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`/command_version` を参照してください。
+command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`/reference/command_version` を参照してください。
 
 返値
 ----

data/vendor/local/share/doc/groonga/source/{executables → reference/executables}/groonga-suggest-create-dataset.txt

@@ -20,7 +20,7 @@ SYNOPSTIS
 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.
+groonga-suggest-create-dataset creates a dataset for :doc:`/suggest`. A database has many datasets. This command just defines schema for a suggestion dataset.
 
 OPTIONS
 -------