rroonga 5.0.0-x86-mingw32 → 5.0.1-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/highlight_html.txt

@@ -85,7 +85,7 @@ There is only one parameter ``column`` .
 ``column``
 ^^^^^^^^^^
 
-It specifies a column of the table.
+Specifies a column of the table.
 
 Return value
 ------------

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/html_untag.txt

@@ -72,7 +72,7 @@ There is one required parameter, ``html``.
 ``html``
 ^^^^^^^^
 
-It specifies HTML text to be untagged.
+Specifies HTML text to be untagged.
 
 Return value
 ------------

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/in_values.txt

@@ -11,20 +11,72 @@ in_values
 Summary
 -------
 
-TODO
+.. versionadded:: 4.0.7
+
+``in_values`` enables you to simplify the query which uses multiple ``OR`` or ``==``. It is recommended to use this function in point of view about performance improvements in such a case.
 
 Syntax
 ------
 
-TODO
+``in_values`` requires two or more arguments - ``target_value`` and multiple ``value``.
+
+::
+
+  in_values(target_value, value1, ..., valueN)
 
 Usage
 -----
 
+Here is a schema definition and sample data.
+
+Sample schema:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_values/usage_setup_schema.log
+.. table_create Tags TABLE_PAT_KEY ShortText
+.. table_create Memos TABLE_HASH_KEY ShortText
+.. column_create Memos tag COLUMN_SCALAR ShortText
+.. column_create Tags memos_tag COLUMN_INDEX Memos tag
+
+Sample data:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_values/usage_setup_data.log
+.. load --table Memos
+.. [
+.. {"_key": "Groonga is fast",          "tag": "groonga"},
+.. {"_key": "Mroonga is fast",          "tag": "mroonga"},
+.. {"_key": "Rroonga is fast",          "tag": "rroonga"},
+.. {"_key": "Droonga is fast",          "tag": "droonga"},
+.. {"_key": "Groonga is a HTTP server", "tag": "groonga"}
+.. ]
+
+Here is the simple usage of ``in_values`` function which selects the records - the value of ``tag`` column is "groonga" or "mroonga" or "droonga".
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_values/usage_only.log
+.. select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sortby _id
+
+When executing the above query, you can get the records except "rroonga" because "rroonga" is not specified as value in ``in_values``.
+
 Parameters
 ----------
 
+There are two or more required parameter, ``target_value`` and multiple ``value``.
+
+``target_value``
+^^^^^^^^^^^^^^^^
+
+Specifies a column of the table that is specified by ``table`` parameter in ``select``.
+
+``value``
+^^^^^^^^^
+
+Specifies a value of the column which you want to select.
+
 Return value
 ------------
 
+``in_values`` returns whether the value of column exists in specified the value of parameters or not.
 
+If record is matched to specified the value of parameters, it returns true. Otherwise, it returns false.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/query.txt

@@ -114,14 +114,14 @@ There are two required parameter, ``match_columns`` and ``query_string``.
 ``match_columns``
 """""""""""""""""
 
-It specifies the default target column for fulltext search by
+Specifies the default target column for fulltext search by
 ``query_string`` parameter value. It is the same role as
 :ref:`select-match-columns` parameter in ``select``.
 
 ``query_string``
 """"""""""""""""
 
-It specifies the search condition in
+Specifies the search condition in
 :doc:`/reference/grn_expr/query_syntax`. It is the same role as
 ``query`` parameter in ``select``.
 
@@ -136,7 +136,7 @@ There are some optional parameters.
 ``query_expander``
 """"""""""""""""""
 
-It specifies the plugin name for query expansion.
+Specifies the plugin name for query expansion.
 
 There is one plugin bundled in official release - :doc:`/reference/query_expanders/tsv`.
 
@@ -146,7 +146,7 @@ See :doc:`/reference/query_expanders/tsv` about details.
 ``substitution_table``
 """"""""""""""""""""""
 
-It specifies the substitution table and substitution column name
+Specifies the substitution table and substitution column name
 by following format such as ``${TABLE}.${COLUMN}`` for query expansion.
 
 See :ref:`query-expander` about details.

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

@@ -67,8 +67,8 @@ Sample data:
 .. {"_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.
+Here is the simple usage of ``sub_filter`` function which extracts the
+blog entry commented by user 'A'.
 
 .. groonga-command
 .. include:: ../../example/reference/functions/sub_filter/usage_without_sub_filter.log
@@ -102,7 +102,7 @@ There are two required parameter, ``scope`` and ``filter_string``.
 ``scope``
 ^^^^^^^^^
 
-It specifies a column of the table that is specified by ``table``
+Specifies a column of the table that is specified by ``table``
 parameter in ``select``. The column has a limitation. The limitation
 is described later. ``filter_string`` is evaluated in the column
 context. It means that ``filter_string`` is evaluated like
@@ -119,7 +119,7 @@ See :ref:`select-table` about ``table`` parameter in ``select``.
 ``filter_string``
 ^^^^^^^^^^^^^^^^^
 
-It specifies a search condition in
+Specifies a search condition in
 :doc:`/reference/grn_expr/script_syntax`. It is evaluated in ``scope``
 context.
 

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

@@ -45,10 +45,10 @@ Here are a schema definition and sample data to show usage.
 ..  "content": "Welcome! This is my first post!",
 ..  "n_likes": 5},
 .. {"_key":    "Groonga",
-..  "content": "I started to use groonga. It's very fast!",
+..  "content": "I started to use Groonga. It's very fast!",
 ..  "n_likes": 10},
 .. {"_key":    "Mroonga",
-..  "content": "I also started to use mroonga. It's also very fast! Really fast!",
+..  "content": "I also started to use Mroonga. It's also very fast! Really fast!",
 ..  "n_likes": 15},
 .. {"_key":    "Good-bye Senna",
 ..  "content": "I migrated all Senna system!",
@@ -137,7 +137,7 @@ search conditions; ``search`` and ``keyword``. If you want to
 specifies a keyword that contains one or more spaces, you can use
 ``phrase search condition`` that is described below.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_full_text_search.log
@@ -170,7 +170,7 @@ adjacent. Thus, ``Put a search keyword in the form`` is matched but
 ``Search by the keyword`` and ``There is a keyword. Search by it!``
 aren't matched.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_phrase_search.log
@@ -212,7 +212,7 @@ the following features:
 See description of ``--match_columns`` option of
 :doc:`/reference/commands/select` about them.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_full_text_search_with_explicit_match_column.log
@@ -239,7 +239,7 @@ advanced match columns but ``phrase search condition (with explicit
 match column)`` isn't supported. See description of ``full text search
 condition (with explicit match column)`` about advanced match columns.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_phrase_search_with_explicit_match_column.log
@@ -273,7 +273,7 @@ time for large records.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_prefix_search.log
@@ -318,7 +318,7 @@ large records.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple. It uses fast suffix search for hiragana in
+Here is a simple example. It uses fast suffix search for hiragana in
 Japanese that is one of non-ASCII characters.
 
 .. groonga-command
@@ -350,7 +350,7 @@ It matches records that ``column`` value is equal to ``value``.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_equal.log
@@ -369,7 +369,7 @@ It matches records that ``column`` value isn't equal to ``value``.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_not_equal.log
@@ -393,7 +393,7 @@ compared as bit sequence.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_less_than.log
@@ -417,7 +417,7 @@ compared as bit sequence.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_greater_than.log
@@ -442,7 +442,7 @@ compared as bit sequence.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_less_than_or_equal_to.log
@@ -467,7 +467,7 @@ compared as bit sequence.
 It doesn't require the default match columns such as ``full text
 search condition`` and ``phrase search condition``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_greater_than_or_equal_to.log
@@ -476,6 +476,32 @@ Here is a simple exmaple.
 The expression matches records that ``n_likes`` column value is
 greater than or equal to ``10``.
 
+.. _query-regular-expression-condition:
+
+Regular expression condition
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 5.0.1
+
+Its syntax is ``column:~pattern``.
+
+It matches records that ``column`` value is matched to
+``pattern``. ``pattern`` must be valid
+:doc:`/reference/regular_expression`.
+
+The following example uses ``.roonga`` as pattern. It matches
+``Groonga``, ``Mroonga`` and so on.
+
+.. groonga-command
+.. include:: ../../example/reference/grn_expr/query_syntax/simple_regular_expression.log
+.. select Entries --query content:~.roonga
+
+In most cases, regular expression is evaluated sequentially. So it may
+be slow against many records.
+
+In some cases, Groonga evaluates regular expression by index. It's
+very fast. See :doc:`/reference/regular_expression` for details.
+
 .. _combined-expression:
 
 Combined expression
@@ -493,7 +519,7 @@ assignment expressions.
 
 If at least one of ``a`` and ``b`` are matched, ``a OR b`` is matched.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_logical_or.log
@@ -516,7 +542,7 @@ If both ``a`` and ``b`` are matched, ``a + b`` is matched.
 You can specify ``+`` the first expression such as ``+a``. The ``+``
 is just ignored.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_logical_and.log
@@ -539,7 +565,7 @@ If ``a`` is matched and ``b`` is not matched, ``a - b`` is matched.
 You can not specify ``-`` the first expression such as ``-a``. It's
 syntax error.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_logical_not.log
@@ -559,7 +585,7 @@ processed as an expression. ``a b OR c`` means that ``a`` and ``b``
 are matched or ``c`` is matched. ``a (b OR c)`` means that ``a`` and
 one of ``b`` and ``c`` are matched.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/query_syntax/simple_grouping.log

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

@@ -91,10 +91,10 @@ Here are a schema definition and sample data to show usage.
 ..  "content": "Welcome! This is my first post!",
 ..  "n_likes": 5},
 .. {"_key":    "Groonga",
-..  "content": "I started to use groonga. It's very fast!",
+..  "content": "I started to use Groonga. It's very fast!",
 ..  "n_likes": 10},
 .. {"_key":    "Mroonga",
-..  "content": "I also started to use mroonga. It's also very fast! Really fast!",
+..  "content": "I also started to use Mroonga. It's also very fast! Really fast!",
 ..  "n_likes": 15},
 .. {"_key":    "Good-bye Senna",
 ..  "content": "I migrated all Senna system!",
@@ -228,7 +228,7 @@ control syntax.
 
 ``A ? B : C`` returns ``B`` if ``A`` is true, ``C`` otherwise.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_control_syntax_ternary_operator.log
@@ -248,7 +248,7 @@ an expression. ``a && b || c`` means that ``a`` and ``b`` are matched
 or ``c`` is matched. ``a && (b || c)`` means that ``a`` and one of
 ``b`` and ``c`` are matched.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_grouping.log
@@ -273,7 +273,7 @@ Its syntax is ``name(arugment1, argument2, ...)``.
 
 See :doc:`/reference/function` for available functin list.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_function.log
@@ -836,7 +836,7 @@ Because tag search is also implemented by inverted index.
 
 :doc:`query_syntax` uses this operator by default.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_match_operator.log
@@ -866,7 +866,7 @@ Prefix search can be used with other table types but it causes all
 records scan. It's not problem for small records but it spends more
 time for large records.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_prefix_search_operator.log
@@ -908,7 +908,7 @@ table without ``KEY_WITH_SIS`` flag but it causes all records
 scan. It's not problem for small records but it spends more time for
 large records.
 
-Here is a simple exmaple. It uses fast suffix search for hiragana in
+Here is a simple example. It uses fast suffix search for hiragana in
 Japanese that is one of non-ASCII characters.
 
 .. groonga-command
@@ -952,7 +952,7 @@ N-gram family tokenizer.)
 Note that an index column for full text search must be defined for
 ``column``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_near_search_operator.log
@@ -992,7 +992,7 @@ search searches records that have similar content to
 Note that an index column for full text search must be defined for
 ``column``.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_similar_search_operator.log
@@ -1018,7 +1018,7 @@ double array trie (``TABLE_DAT_KEY``). You can't use hash table
 support longest common prefix search. Longest common prefix search is
 used to implement the operator.
 
-Here is a simple exmaple.
+Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_term_extract_operator.log
@@ -1037,3 +1037,33 @@ the successor project to Senna.``. In this case, ``KEY_NORMALIZE``
 flag is specified to ``Words``. So ``Groonga`` can be extracted even
 if it is loaded as ``groonga`` into ``Words``. All of extracted terms
 are also normalized.
+
+.. _script-regular-expression-operator:
+
+Regular expression operator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 5.0.1
+
+Its syntax is ``column @~ "pattern"``.
+
+The operator searches records by the regular expression
+``pattern``. If a record's ``column`` value is matched to ``pattern``,
+the record is matched.
+
+``pattern`` must be valid regular expression syntax. See
+:doc:`/reference/regular_expression` about regular expression syntax
+details.
+
+The following example uses ``.roonga`` as pattern. It matches
+``Groonga``, ``Mroonga`` and so on.
+
+.. groonga-command
+.. include:: ../../example/reference/grn_expr/script_syntax/simple_regular_expression_operator.log
+.. select Entries --filter 'content @~ ".roonga"'
+
+In most cases, regular expression is evaluated sequentially. So it may
+be slow against many records.
+
+In some cases, Groonga evaluates regular expression by index. It's
+very fast. See :doc:`/reference/regular_expression` for details.