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

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

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

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

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

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

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

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

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

@@ -40,15 +40,15 @@ json形式
 
   下記の項目がハッシュ形式で出力されます。
 
-  ``alloc_count``
+``alloc_count``
 
-    groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を示します。groongaをbuildする際に、configureオプションで --enable-exact-alloc-countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を返す場合があります。
+  groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を示します。groongaをbuildする際に、configureオプションで --enable-exact-alloc-countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を返す場合があります。
 
-  ``starttime``
+``starttime``
 
-    groongaプロセスが起動した時刻のtvsec値を返します。
+  groongaプロセスが起動した時刻のtvsec値を返します。
 
-  ``uptime``
+``uptime``
 
     groongaプロセスが起動してから経過した秒数を返します。
 

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

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

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

@@ -0,0 +1,73 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_truncate
+
+``truncate``
+============
+
+Summary
+-------
+
+``truncate`` command deletes all records from specified table.
+
+Syntax
+------
+
+``truncate`` command takes only one parameter.
+
+The required parameter is only ``table``::
+
+  truncate table
+
+Usage
+-----
+
+Here is a simple example of ``truncate`` command.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/truncate/truncate.log
+.. table_create Users TABLE_PAT_KEY ShortText
+.. load --table Users
+.. [
+.. {"_key": "Alice",  "score": 2},
+.. {"_key": "Bob",    "score": 0},
+.. {"_key": "Carlos", "score": -1}
+.. ]
+.. select Users
+.. truncate Users
+.. select Users
+
+Parameters
+----------
+
+This section describes parameters of ``truncate``.
+
+Required parameter
+^^^^^^^^^^^^^^^^^^
+
+There is required parameter, ``table_name``.
+
+``table_name``
+""""""""""""""
+
+It specifies the name of table.
+
+Return value
+------------
+
+::
+
+ [HEADER, SUCCEEDED_OR_NOT]
+
+``HEADER``
+
+  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
+  See :doc:`/reference/command/output_format` about HEADER.
+
+``SUCCEEDED_OR_NOT``
+
+  If command succeeded, it returns true, otherwise it returns false on error.
+

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

@@ -0,0 +1,124 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_sub_filter
+
+sub_filter
+==========
+
+Summary
+-------
+
+``sub_filter`` evaluates ``query_string`` in ``match_column`` context.
+
+``sub_filter`` can be used in only ``--filter`` in :doc:`/reference/commands/select`.
+
+Syntax
+------
+
+``sub_filter`` requires two arguments - ``match_column`` and ``query_string``.
+
+::
+
+  sub_filter(match_column, query_string)
+
+
+Usage
+-----
+
+Here are a schema definition and sample data to show usage.
+
+Sample schema:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/sub_filter/usage_setup_schema.log
+.. table_create Comment TABLE_PAT_KEY UInt32
+.. column_create Comment name COLUMN_SCALAR ShortText
+.. column_create Comment content COLUMN_SCALAR ShortText
+.. table_create Blog TABLE_PAT_KEY ShortText
+.. column_create Blog title COLUMN_SCALAR ShortText
+.. column_create Blog content COLUMN_SCALAR ShortText
+.. column_create Blog comments COLUMN_VECTOR Comment
+.. column_create Comment blog_comment_index COLUMN_INDEX Blog comments
+.. table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram
+.. column_create Lexicon comment_content COLUMN_INDEX|WITH_POSITION Comment content
+.. column_create Lexicon comment_name COLUMN_INDEX|WITH_POSITION Comment name
+.. column_create Lexicon blog_content COLUMN_INDEX|WITH_POSITION Blog content
+
+Sample data:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/sub_filter/usage_setup_data.log
+.. load --table Comment
+.. [
+.. {"_key": 1, "name": "A", "content": "groonga"},
+.. {"_key": 2, "name": "B", "content": "groonga"},
+.. {"_key": 3, "name": "C", "content": "rroonga"},
+.. {"_key": 4, "name": "A", "content": "mroonga"},
+.. ]
+.. load --table Blog
+.. [
+.. {"_key": "groonga's blog", "content": "content of groonga's blog", comments: [1, 2, 3]},
+.. {"_key": "mroonga's blog", "content": "content of mroonga's blog", comments: [2, 3, 4]},
+.. {"_key": "rroonga's blog", "content": "content of rroonga's blog", comments: [3]},
+.. ]
+
+Here is the simple usage of ``sub_filter`` function which extracts the blog entry
+ user 'A' commented out.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/sub_filter/usage_without_sub_filter.log
+.. select Blog --output_columns _key \
+..   --filter "comments.name @ \"A\" && comments.content @ \"groonga\""
+
+When executing above query, not only "groonga's blog", but also "mroonga's blog".
+This is not what you want because user "A" does not mention "groonga" to "mroonga's blog".
+
+Without sub_filter, it means that following conditions are met.
+
+* There is at least one record that user "A" commented out.
+* There is at least one record that mentioned about "groonga".
+
+.. groonga-command
+.. include:: ../../example/reference/functions/sub_filter/usage_with_sub_filter.log
+.. select Blog --output_columns _key \
+..   --filter 'sub_filter(comments, "name @ \\"A\\" && content @ \\"groonga\\"")'
+
+On the other hand, executing above query returns the intended result.
+Because the arguments of sub_filter is evaluated in comments column's context.
+
+It means that sub_filter requires following condition is met.
+
+* There are the records that user "A" mentions about "groonga".
+
+
+Parameters
+----------
+
+There are two required parameter, ``match_column`` and ``query_string``.
+
+``match_column``
+^^^^^^^^^^^^^^^^
+
+  It specifies ``match_column`` equivalent parameter.
+
+See :ref:`select-match-columns` about match_column.
+
+``query_string``
+^^^^^^^^^^^^^^^^
+
+  It specifies ``query`` equivalent parameter.
+
+See :ref:`select-query` about query string.
+
+Return value
+------------
+
+``sub_filter`` returns a value of boolean (true or false).
+
+See also
+--------
+
+* :doc:`/reference/commands/select`