rroonga 2.1.3-x86-mingw32 → 3.0.0-x86-mingw32

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

@@ -98,9 +98,9 @@ json形式
 
  [成功かどうかのフラグ]
 
- ``成功かどうかのフラグ``
+``成功かどうかのフラグ``
 
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
 例
 --

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

@@ -40,9 +40,9 @@ json形式
 
  [フラグメンテーション解消を実行したセグメントの数]
 
- ``フラグメンテーション解消を実行したセグメントの数``
+``フラグメンテーション解消を実行したセグメントの数``
 
-   フラグメンテーション解消を実行したセグメントの数を返す。
+  フラグメンテーション解消を実行したセグメントの数を返す。
 
 例
 --

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

@@ -52,9 +52,9 @@ json形式
 
  [成功かどうかのフラグ]
 
- ``成功かどうかのフラグ``
+``成功かどうかのフラグ``
 
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
 例
 --

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

@@ -2,99 +2,99 @@
 
 .. highlightlang:: none
 
-load
-====
+.. groonga-command
+.. database: commands_load
 
-名前
-----
+``load``
+========
 
-load - データのロード
+Summary
+-------
 
-書式
-----
-::
 
- load values table [columns [ifexists [input_type]]]
+``load`` loads data as records in the current database and updates values of each columns.
 
-説明
-----
+Syntax
+------
+::
 
-groonga組込コマンドの一つであるloadについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+ load values table [columns [ifexists [input_type]]]
 
-loadは、使用しているデータベースのテーブルにレコードを登録し、カラムの値を更新します。
+Parameters
+----------
 
-引数
-----
+This section describes all parameters.
 
 ``values``
 
-  input_typeに指定する形式で登録するレコードの値を表現した文字列を渡します。
+  It specifies values loaded to records.
+  Values should satisfy ``input_type`` format.
+  If you specify "json" as ``input_type``, you can choose a format from below:
 
-  input_typeがjsonである場合には、以下のいずれかの形式が使用できます。
+  ``Format 1:``
+    [[COLUMN_NAME1, COLUMN_NAME2,..], [VALUE1, VALUE2,..], [VALUE1, VALUE2,..],..]
 
-  ``形式1``
-    [[カラム名1, カラム名2,..], [カラム値1, カラム値2,..], [カラム値1, カラム値2,..],..]
+  ``Format 2:``
+    [{COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2}, {COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2},..]
 
-  ``形式2``
-    [{カラム名1: カラム値1, カラム名2: カラム値2}, {カラム名1: カラム値1, カラム名2: カラム値2},..]
+  ``[COLUMN_NAME1, COLUMN_NAME2,..]`` format in ``Format 1`` is effective only when ``column`` parameter isn't specified.
 
-  形式1の[カラム名1, カラム名2,..]の要素はcolumns引数が省略された場合のみ有効です。
+  When a target table contains primary key, you must specify ``_key`` column (pseudo column associated primary key) as the one of ``COLUMN_NAME``.
 
-  対象のテーブルが主キーを持つテーブルであった場合は、カラム名の中に'_key'(主キーを示す疑似カラム名)が含まれていなければなりません。
+  If ``values`` isn't specified any values, they are read from the standard input until all opened parenthes match their closed ones.
+  You don't have to enclose them with single-quotes or double-quotes, but if you specified values with ``values`` parameter, you should do.
 
-  values引数が省略された場合には、括弧の対応が取れるまで標準入力からvaluesの値を読み取ります。引数として値を指定する場合は、文字列のエスケープが必要ですが、標準入力から与える文字列はエスケープする必要がありません。
-
-  続きの文字列については、空白文字(' ')をエスケープする必要はありません。
+  In following values, you also don't have to enclose any spaces (' ') with single-quotes or double-quotes.
 
 ``table``
 
-  レコードを追加しようとするテーブルの名前を指定します。
+  It specifies a table name you want to add records.
 
 ``columns``
 
-  テーブルに登録するレコードに値を設定するカラム名のリストを、カンマ区切りで指定します。
+  It specifies column names in added records with comma separations.
 
 ``ifexists``
 
-  指定した主キーに対応するレコードが既にテーブルに登録済みであった場合に実行するscript形式のgrn_expr文字列を指定します。ifexistsにgrn_exprが指定された場合は、式の値が真である場合に限り、その他のカラムの値が更新されます。(デフォルトはtrue)
+  It specifies executed ``grn_expr`` string when the same primary key
+  as added records already exists in your table.
+  If ``ifexists`` specifies ``grn_expr`` string (default: true) and
+  its value is true, values in other (all columns excluding ``_key``
+  column) columns is updated.
 
 ``input_type``
 
-  入力形式を指定します。JSONのみに対応しています。
-
-返値
-----
-
-JSON形式
-^^^^^^^^
-
-::
-
- [登録件数]
-
-``登録件数``
-
-  テーブルに登録されたレコードの件数が返されます。
+  It specifies an input format for ``values``. It supports JSON only.
 
-例
---
+Usage
+-----
 
-テーブルEntryにレコードを登録します。::
+Here is an example to add records to "Entry" table. ::
 
- load --table Entry --input_type json --values [{\"_key\":\"abandon\",\"body\":\"放棄する\"}]
+ load --table Entry --input_type json --values [{\"_key\":\"Groonga\",\"body\":\"It's very fast!!\"}]
 
  [1]
 
-標準入力からvaluesの値を与えます。::
+This example shows how to add values from standard input. ::
 
  load --table Entry --input_type json
  [
- {"_key": "abbreviate", "body": "短縮する"}
+ {"_key": "Groonga", "body": "It's very fast!!"}
  ]
 
  [1]
 
-関連項目
+Return value
+------------
+
+JSON format
+^^^^^^^^^^^
+
+ ``load`` returns the number of added records such as ::
+
+   [NUMBER]
+
+See also
 --------
 
 :doc:`/reference/grn_expr`

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

@@ -49,9 +49,9 @@ json形式
 
  [成功かどうかのフラグ]
 
- ``成功かどうかのフラグ``
+``成功かどうかのフラグ``
 
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
 例
 --

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

@@ -53,9 +53,9 @@ json形式
 
  [成功かどうかのフラグ]
 
- ``成功かどうかのフラグ``
+``成功かどうかのフラグ``
 
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
 例
 --

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

@@ -40,9 +40,9 @@ json形式
 
  [成功かどうかのフラグ]
 
- ``成功かどうかのフラグ``
+``成功かどうかのフラグ``
 
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
 例
 --

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

@@ -0,0 +1,85 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_normalize
+
+``normalize``
+=============
+
+.. Caution::
+
+  ``normalize`` command is the experimental feature.
+  This command may be changed in the future.
+
+Summary
+-------
+
+``normalize`` command normalizes text by the specified normalizer.
+
+There is no need to create table to use ``normalize`` command.
+It is usefull for you to check the results of normalizer.
+
+Syntax
+--------
+
+``normalize`` commands takes two parameters - ``normalizer`` and ``string``.
+Both of them are required.
+
+::
+
+ normalize normalizer string
+
+
+Usage
+-----
+
+Here is a simple example of ``normalize`` command.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/normalize/normalizer_auto_ascii.log
+.. normalize NormalizerAuto "aBcDe 123"
+
+Parameters
+----------
+
+This section describes parameters of ``normalizer``.
+
+Required parameter
+^^^^^^^^^^^^^^^^^^
+
+There are required parameters, ``normalizer`` and ``string``.
+
+``normalizer``
+""""""""""""""
+
+It specifies the name of normalizer.
+Currently, ``normalize`` command accepts ``NormalizerAuto`` or ``NormalizerNFKC51`` as built-in normalizer.
+If you want to try another normalizer, you need to register additional normalizer plugin by ``register`` command.
+
+``string``
+""""""""""
+
+It specifies any string which you want to normalize.
+
+Return value
+------------
+
+::
+
+ [HEADER, normalized]
+
+``HEADER``
+
+  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
+  See :doc:`/reference/command/output_format` about HEADER.
+
+``normalized``
+
+  normalized is the normalized text by the specified normalizer.
+
+See also
+--------
+
+* :doc:`/reference/normalizers`

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

@@ -41,6 +41,7 @@ Syntax
          [match_escalation_threshold=0]
          [query_expansion=null]
          [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN|ALLOW_UPDATE|ALLOW_LEADING_NOT|NONE]
+         [query_expander=null]
 
 Usage
 -----
@@ -451,95 +452,7 @@ more searches aren't executed. And no records are matched.
 ``query_expansion``
 """""""""""""""""""
 
-It's for query expansion. Query expansion substitutes specific words
-to another words in query. Nomally, it's used for synonym search.
-
-It specifies a column that is used to substitute ``query`` parameter
-value. The format of this parameter value is
-"``${TABLE}.${COLUMN}``". For example, "``Terms.synonym``" specifies
-``synonym`` column in ``Terms`` table.
-
-Table for query expansion is called "substitution table". Substitution
-table's key must be ``ShortText``. So array table (``TABLE_NO_KEY``)
-can't be used for query expansion. Because array table doesn't have
-key.
-
-Column for query expansion is called "substitution
-column". Substitution column's value type must be
-``ShortText``. Column type must be vector (``COLUMN_VECTOR``).
-
-Query expansion substitutes key of substitution table in query with
-values in substitution column. If a word in ``query`` is a key of
-substitution table, the word is substituted with substitution column
-value that is associated with the key. Substition isn't performed
-recursively. It means that substitution target words in substituted
-query aren't substituted.
-
-Here is a sample substitution table to show a simple
-``query_expansion`` usage example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/select/query_expansion_substitution_table.log
-.. table_create Thesaurus TABLE_PAT_KEY|KEY_NORMALIZE ShortText
-.. column_create Thesaurus synonym COLUMN_VECTOR ShortText
-.. load --table Thesaurus
-.. [
-.. {"_key": "mroonga", "synonym": ["mroonga", "tritonn", "groonga mysql"]},
-.. {"_key": "groonga", "synonym": ["groonga", "senna"]}
-.. ]
-
-``Thesaurus`` substitution table has two synonyms, ``"mroonga"`` and
-``"groonga"``. If an user searches with ``"mroonga"``, groonga
-searches with ``"((mroonga) OR (tritonn) OR (groonga mysql))"``. If an
-user searches with ``"groonga"``, groonga searchs with ``"((groonga)
-OR (senna))"``. Nomrally, it's good idea that substitution table has
-``KEY_NORMALIZE`` flag. If the flag is used, substitute target word is
-matched in case insensitive manner.
-
-Note that those synonym values include the key value such as
-``"mroonga"`` and ``"groonga"``. It's recommended that you include the
-key value. If you don't include key value, substituted value doesn't
-include the original substitute target value. Normally, including the
-original value is better search result. If you have a word that you
-don't want to be searched, you should not include the original
-word. For example, you can implement "stop words" by an empty vector
-value.
-
-Here is a simple ``query_expansion`` usage example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/select/query_expansion_substitute.log
-.. select Entries --match_columns content --query "mroonga"
-.. select Entries --match_columns content --query "mroonga" --query_expansion Thesaurus.synonym
-.. select Entries --match_columns content --query "((mroonga) OR (tritonn) OR (groonga mysql))"
-
-The first ``select`` command doesn't use query expansion. So a record
-that has ``"tritonn"`` isn't found. The second ``select`` command uses
-query expansion. So a record that has ``"tritonn"`` is found. The
-third ``select`` command doesn't use query expansion but it is same as
-the second ``select`` command. The third one uses expanded query.
-
-Each substitute value can contain any :doc:`/reference/grn_expr/query_syntax` syntax
-such as ``(...)`` and ``OR``. You can use complex substitution by
-using those syntax.
-
-Here is a complex substitution usage example that uses query syntax.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/select/query_expansion_complex.log
-.. load --table Thesaurus
-.. [
-.. {"_key": "popular", "synonym": ["popular", "n_likes:>=10"]}
-.. ]
-.. select Entries --match_columns content --query "popular" --query_expansion Thesaurus.synonym
-
-The ``load`` command registers a new synonym ``"popular"``. It is
-substituted with ``((popular) OR (n_likes:>=10))``. The substituted
-query means that "popular" is containing the word "popular" or 10 or
-more liked entries.
-
-The ``select`` command outputs records that ``n_likes`` column value
-is equal to or more than ``10`` from ``Entries`` table.
+Deprecated. Use :ref:`query-expander` instead.
 
 .. _query-flags:
 
@@ -633,6 +546,102 @@ specified.
 
 See also :doc:`/reference/grn_expr/query_syntax`.
 
+.. _query-expander:
+
+``query_expander``
+""""""""""""""""""
+
+It's for query expansion. Query expansion substitutes specific words
+to another words in query. Nomally, it's used for synonym search.
+
+It specifies a column that is used to substitute ``query`` parameter
+value. The format of this parameter value is
+"``${TABLE}.${COLUMN}``". For example, "``Terms.synonym``" specifies
+``synonym`` column in ``Terms`` table.
+
+Table for query expansion is called "substitution table". Substitution
+table's key must be ``ShortText``. So array table (``TABLE_NO_KEY``)
+can't be used for query expansion. Because array table doesn't have
+key.
+
+Column for query expansion is called "substitution
+column". Substitution column's value type must be
+``ShortText``. Column type must be vector (``COLUMN_VECTOR``).
+
+Query expansion substitutes key of substitution table in query with
+values in substitution column. If a word in ``query`` is a key of
+substitution table, the word is substituted with substitution column
+value that is associated with the key. Substition isn't performed
+recursively. It means that substitution target words in substituted
+query aren't substituted.
+
+Here is a sample substitution table to show a simple
+``query_expander`` usage example.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/query_expander_substitution_table.log
+.. table_create Thesaurus TABLE_PAT_KEY|KEY_NORMALIZE ShortText
+.. column_create Thesaurus synonym COLUMN_VECTOR ShortText
+.. load --table Thesaurus
+.. [
+.. {"_key": "mroonga", "synonym": ["mroonga", "tritonn", "groonga mysql"]},
+.. {"_key": "groonga", "synonym": ["groonga", "senna"]}
+.. ]
+
+``Thesaurus`` substitution table has two synonyms, ``"mroonga"`` and
+``"groonga"``. If an user searches with ``"mroonga"``, groonga
+searches with ``"((mroonga) OR (tritonn) OR (groonga mysql))"``. If an
+user searches with ``"groonga"``, groonga searchs with ``"((groonga)
+OR (senna))"``. Nomrally, it's good idea that substitution table has
+``KEY_NORMALIZE`` flag. If the flag is used, substitute target word is
+matched in case insensitive manner.
+
+Note that those synonym values include the key value such as
+``"mroonga"`` and ``"groonga"``. It's recommended that you include the
+key value. If you don't include key value, substituted value doesn't
+include the original substitute target value. Normally, including the
+original value is better search result. If you have a word that you
+don't want to be searched, you should not include the original
+word. For example, you can implement "stop words" by an empty vector
+value.
+
+Here is a simple ``query_expander`` usage example.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/query_expander_substitute.log
+.. select Entries --match_columns content --query "mroonga"
+.. select Entries --match_columns content --query "mroonga" --query_expander Thesaurus.synonym
+.. select Entries --match_columns content --query "((mroonga) OR (tritonn) OR (groonga mysql))"
+
+The first ``select`` command doesn't use query expansion. So a record
+that has ``"tritonn"`` isn't found. The second ``select`` command uses
+query expansion. So a record that has ``"tritonn"`` is found. The
+third ``select`` command doesn't use query expansion but it is same as
+the second ``select`` command. The third one uses expanded query.
+
+Each substitute value can contain any :doc:`/reference/grn_expr/query_syntax` syntax
+such as ``(...)`` and ``OR``. You can use complex substitution by
+using those syntax.
+
+Here is a complex substitution usage example that uses query syntax.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/query_expander_complex.log
+.. load --table Thesaurus
+.. [
+.. {"_key": "popular", "synonym": ["popular", "n_likes:>=10"]}
+.. ]
+.. select Entries --match_columns content --query "popular" --query_expander Thesaurus.synonym
+
+The ``load`` command registers a new synonym ``"popular"``. It is
+substituted with ``((popular) OR (n_likes:>=10))``. The substituted
+query means that "popular" is containing the word "popular" or 10 or
+more liked entries.
+
+The ``select`` command outputs records that ``n_likes`` column value
+is equal to or more than ``10`` from ``Entries`` table.
+
+
 Output related parameters
 ^^^^^^^^^^^^^^^^^^^^^^^^^