rroonga 6.1.3-x86-mingw32 → 7.0.2-x86-mingw32

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

@@ -0,0 +1,195 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_in_records
+
+``in_records``
+==============
+
+Summary
+-------
+
+.. versionadded:: 7.0.2
+
+You can use ``in_records`` for using an existing table as condition patterns. Each record in the existing table is treated as a condition pattern.
+
+You may be able to reduce multiple queries to only one query by ``in_records``.
+
+``in_records`` is similar to :doc:`sub_filter`. Here are differences of them:
+
+  * ``sub_filter`` requires a reference column to condition table but ``in_records`` doesn't require.
+
+  * ``sub_filter`` requires an index column for the reference column but ``in_records`` doesn't require.
+
+  * ``sub_filter`` can use all logical operations but ``in_records`` can use only AND logical operation in one pattern.
+
+  * ``sub_filter`` can use only the value of one reference column for condition but ``in_records`` can use one or more values for condition. You can use multiple columns, functions and so on for multiple values.
+
+  * ``sub_filter`` uses index search but ``in_records`` uses sequential search.
+
+.. _in-records-syntax:
+
+Syntax
+------
+
+``in_records`` has four or more parameters::
+
+  in_records(condition_table,
+             value1, mode1, condition_column_name1,
+             ...,
+             valueN, modeN, condition_column_nameN)
+
+.. _in-records-usage:
+
+Usage
+-----
+
+Here is a schema definition and sample data.
+
+Sample schema:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_records/usage_setup_schema.log
+.. table_create Tags TABLE_PAT_KEY ShortText
+..
+.. table_create Conditions TABLE_PAT_KEY ShortText
+.. column_create Conditions user_pattern COLUMN_SCALAR ShortText
+.. column_create Conditions tag COLUMN_SCALAR Tags
+.. column_create Conditions max_length COLUMN_SCALAR UInt32
+..
+.. table_create Memos TABLE_HASH_KEY ShortText
+.. column_create Memos user COLUMN_SCALAR ShortText
+.. column_create Memos tag COLUMN_SCALAR Tags
+
+Sample data:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_records/usage_setup_data.log
+.. load --table Memos
+.. [
+.. {"_key": "Groonga is fast",          "user": "alice", "tag": "groonga"},
+.. {"_key": "Mroonga is fast",          "user": "alice", "tag": "mroonga"},
+.. {"_key": "Groonga is very good!",    "user": "alice", "tag": "groonga"},
+.. {"_key": "Droonga is fast",          "user": "david", "tag": "droonga"},
+.. {"_key": "Groonga is a HTTP server", "user": "david", "tag": "groonga"}
+.. ]
+
+Sample conditions:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_records/usage_setup_conditions.log
+.. load --table Conditions
+.. [
+.. {"_key": "lic + groonga", "user_pattern": "lic", "tag": "groonga", max_length: 20},
+.. {"_key": "dav + droonga", "user_pattern": "dav", "tag": "droonga", max_length: 50}
+.. ]
+
+Here is a simple usage of ``in_records`` that searches by records in ``Conditions`` table. Each record is used as a condition:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/in_records/usage_search.log
+.. plugin_register functions/string
+.. select \
+..   --table Memos \
+..   --filter 'in_records(Conditions, \
+..                        user,                 "@", "user_pattern", \
+..                        tag,                 "==", "tag", \
+..                        string_length(_key), "<=", "max_length")' \
+..   --sort_by _id \
+..   --output_columns _key,user,tag
+
+The ``filter`` tries the following three conditions for each record:
+
+  * ``Memos.user`` matches (``@``) ``Conditions.user_pattern``.
+
+  * ``Memos.tag`` equals (``==``) ``Conditions.tag``.
+
+  * The number of characters in ``Memos._key`` is less than or equals to ``Conditions.max_length``.
+
+If at least one record in ``Conditions`` table returns true for the all three conditions, the record in ``Memos`` is matched.
+
+The first record in ``Conditions`` table use the following conditions:
+
+  * ``Memos.user`` has ``"lic"`` substring.
+
+  * ``Memos.tag`` is ``"groonga"``.
+
+  * The number of characters in ``Memos._key`` is less than or equals to ``20``.
+
+This condition matches the following records:
+
+  * ``{"_key": "Groonga is fast", "user": "alice", "tag": "groonga"}``
+
+The second record in ``Conditions`` table use the following conditions:
+
+  * ``Memos.user`` has ``"dav"`` substring.
+
+  * ``Memos.tag`` is ``"droonga"``.
+
+  * The number of characters in ``Memos._key`` is less than or equals to ``50``.
+
+This condition matches the following records:
+
+  * ``{"_key": "Droonga is fast", "user": "david", "tag": "droonga"}``
+
+The result has the all above records.
+
+.. _in-records-parameters:
+
+Parameters
+----------
+
+``in_records`` requires four or more parameters.
+
+.. _in-records-required-parameters:
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+``condition_table`` and tuples of ``value``, ``mode_name`` and ``condition_column_name`` are required. You can specify multiple tuples of ``value``, ``mode_name`` and ``condition_column_name``
+
+.. _in-records-condition-table:
+
+``condition_table``
+"""""""""""""""""""
+
+Specifies a table that has conditions as its records.
+
+.. _in-records-value:
+
+``value``
+^^^^^^^^^
+
+Specifies a value to be compared.
+
+.. _in-records-mode-name:
+
+``mode_name``
+^^^^^^^^^^^^^
+
+Specifies a mode name that specifies how to compare :ref:`in-records-value` with a value of :ref:`in-records-condition-column-name`.
+
+See :ref:`query-default-mode` for available mode names. All mode names except ``NEAR``, ``SIMILAR`` and ``SUFFIX`` are supported.
+
+.. _in-records-condition-column-name:
+
+``condition_column_name``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Specifies a column name of :ref:`in-records-condition-table` to be used as condition.
+
+.. _in-records-optional-parameters:
+
+Optional parameter
+^^^^^^^^^^^^^^^^^^
+
+There are no optional parameter.
+
+Return value
+------------
+
+``in_records`` returns whether the record is matched one of records of the specified condition table or not.
+
+If the record is matched, it returns ``true``. Otherwise, it returns ``false``.

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

@@ -27,13 +27,23 @@ Syntax
 
 ``query`` requires two arguments - ``match_columns`` and ``query_string``.
 
-The parameter ``query_expander`` or ``substitution_table`` is optional.
+The parameter ``query_expander``, ``substitution_table`` and
+``options`` are optional.
 
 ::
 
   query(match_columns, query_string)
   query(match_columns, query_string, query_expander)
   query(match_columns, query_string, substitution_table)
+  query(match_columns, query_string, options)
+
+``options`` accepts the following keys::
+
+  {
+    "expander": query_expander,
+    "default_mode": default_mode,
+    "flags": flags
+  }
 
 
 Usage
@@ -79,8 +89,8 @@ search by keyword 'alice' without using ``--match_columns`` and
 .. include:: ../../example/reference/functions/query/usage_basic.log
 .. select Users --output_columns name,_score --filter 'query("name * 10", "alice")'
 
-When executing above query, the keyword 'alice' is weighted to the value -
-'10'.
+When executing above query, the keyword ``alice`` is weighted to the
+value ``10``.
 
 Here are the contrasting examples with/without ``query``.
 
@@ -88,20 +98,19 @@ Here are the contrasting examples with/without ``query``.
 .. include:: ../../example/reference/functions/query/usage_without_query.log
 .. select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sortby -_score
 
-In this case, the keywords 'groonga' and 'mroonga' and 'user' are
-given same weight value.
-You can't pass different weight value to each keyword in this way.
-
+In this case, the all keywords ``groonga``, ``mroonga`` and ``user``
+use the default weight. You can't pass different weight value to each
+keyword in this way.
 
 .. groonga-command
 .. include:: ../../example/reference/functions/query/usage_with_query.log
 .. select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sortby -_score
 
 On the other hand, by specifying multiple ``query``, the keywords
-'groonga' and 'mroonga' and 'user' are given different value of weight.
+``groonga``, ``mroonga`` and ``user`` use different weight.
 
-As a result, you can control full text search result by giving different weight to the
-keywords on your purpose.
+As a result, you can control full text search result score by
+specifying different weight to the keywords on your purpose.
 
 Parameters
 ----------
@@ -151,6 +160,87 @@ by following format such as ``${TABLE}.${COLUMN}`` for query expansion.
 
 See :ref:`select-query-expander` about details.
 
+.. _query-default-mode:
+
+``default_mode``
+""""""""""""""""
+
+Specifies the default search mode. You can custom the default search
+mode by ``column:@keyword`` like syntax. The default search mode is
+used when you just specify ``keyword`` instead of
+``column:@keyword``. See :doc:`/reference/grn_expr/query_syntax` for
+more syntax details.
+
+Here are available modes. The default is ``MATCH`` mode. It does full
+text search.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Mode
+     - Aliases
+     - Description
+   * - ``EQUAL``
+     - ``==``
+     - It uses :ref:`query-syntax-equal-condition` as the default mode.
+   * - ``NOT_EQUAL``
+     - ``!=``
+     - It uses :ref:`query-syntax-not-equal-condition` as the default mode.
+   * - ``LESS``
+     - ``<``
+     - It uses :ref:`query-syntax-less-than-condition` as the default mode.
+   * - ``GREATER``
+     - ``>``
+     - It uses :ref:`query-syntax-greater-than-condition` as the default mode.
+   * - ``LESS_EQUAL``
+     - ``<=``
+     - It uses :ref:`query-syntax-less-than-or-equal-condition` as the
+       default mode.
+   * - ``GREATER_EQUAL``
+     - ``>=``
+     - It uses :ref:`query-syntax-greater-than-or-equal-condition` as the
+       default mode.
+   * - ``MATCH``
+     - ``@``
+     - It uses :ref:`query-syntax-full-text-search-condition` as the
+       default mode.
+
+       It's the default.
+   * - ``NEAR``
+     - ``*N``
+     - It uses :ref:`query-syntax-near-search-condition` as the default
+       mode.
+   * - ``SIMILAR``
+     - ``*S``
+     - It uses :ref:`query-syntax-similar-search-condition` as the default
+       mode.
+   * - ``PREFIX``
+     - ``^``, ``@^``
+     - It uses :ref:`query-syntax-prefix-search-condition` as the default
+       mode.
+   * - ``SUFFIX``
+     - ``$``, ``@$``
+     - It uses :ref:`query-syntax-suffix-search-condition` as the default
+       mode.
+   * - ``REGEXP``
+     - ``~``, ``@~``
+     - It uses :ref:`query-syntax-regular-expression-condition` as the default
+       mode.
+
+``flags``
+"""""""""
+
+Specifies the flags that customizes how to parse query.
+
+You can specify multiple flags by separating each flags by ``|``. Here
+is the example to specify multiple flags::
+
+  query("title * 10 || content",
+        "keyword",
+        {"flags": "ALLOW_COLUMN|ALLOW_LEADING_NOT"})
+
+See :ref:`select-query-flags` for available flags.
+
 Return value
 ------------
 
@@ -158,11 +248,6 @@ Return value
 records are matched, it returns ``true``. Otherwise, it returns
 ``false``.
 
-TODO
-----
-
-* Support query_flags
-
 See also
 --------
 

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

@@ -0,0 +1,33 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: string_length
+
+``string_length``
+=================
+
+Summary
+-------
+
+.. versionadded:: 6.0.0
+
+It returns the number of characters in the given string.
+
+TODO
+
+Syntax
+------
+
+TODO
+
+Usage
+-----
+
+TODO
+
+Return value
+------------
+
+TODO

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

@@ -0,0 +1,38 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: vector_new
+
+``vector_new``
+==============
+
+Summary
+-------
+
+.. versionadded:: 7.0.1
+
+It creates a new vector from arguments.
+
+TODO
+
+Syntax
+------
+
+TODO
+
+Usage
+-----
+
+TODO
+
+Parameters
+----------
+
+TODO
+
+Return value
+------------
+
+TODO

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

@@ -107,14 +107,14 @@ quoted ``"Alice's brother (Bob)"`` or ``'Alice\'s brother (Bob)'``.
    from database. If you can't do intended search by Groonga, confirm
    whether special character is escaped properly.
 
-.. _conditional-expression:
+.. _query-syntax-conditional-expression:
 
 Conditional expression
 ----------------------
 
 Here is available conditional expression list.
 
-.. _full-text-search-condition:
+.. _query-syntax-full-text-search-condition:
 
 Full text search condition
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -148,7 +148,7 @@ The expression matches records that contain a word ``fast`` in
 
 ``content`` column is the default match column.
 
-.. _phrase-search-condition:
+.. _query-syntax-phrase-search-condition:
 
 Phrase search condition
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -182,6 +182,8 @@ The expression matches records that contain a phrase ``I started`` in
 
 ``content`` column is the default match column.
 
+.. _query-syntax-full-text-search-condition-with-explicit-match-column:
+
 Full text search condition (with explicit match column)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -249,7 +251,7 @@ The expression matches records that contain a phrase ``I started`` in
 ``content`` column value. ``I also started`` isn't matched because
 ``I`` and ``started`` aren't adjacent.
 
-.. _prefix-search-condition:
+.. _query-syntax-prefix-search-condition:
 
 Prefix search condition
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -283,7 +285,7 @@ The expression matches records that contain a word that starts with
 ``Goo`` in ``_key`` pseudo column value. ``Good-bye Senna`` and
 ``Good-bye Tritonn`` are matched with the expression.
 
-.. _suffix-search-condition:
+.. _query-syntax-suffix-search-condition:
 
 Suffix search condition
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -340,6 +342,22 @@ The expression matches records that have value that ends with ``んが``
 in ``content`` column value. ``ぐるんが`` and ``むるんが`` are matched
 with the expression.
 
+.. _query-syntax-near-search-condition:
+
+Near search condition
+^^^^^^^^^^^^^^^^^^^^^
+
+TODO
+
+.. _query-syntax-similar-search-condition:
+
+Similar search condition
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+TODO
+
+.. _query-syntax-equal-condition:
+
 Equal condition
 ^^^^^^^^^^^^^^^
 
@@ -359,6 +377,8 @@ Here is a simple example.
 The expression matches records that ``_key`` column value is
 equal to ``Groonga``.
 
+.. _query-syntax-not-equal-condition:
+
 Not equal condition
 ^^^^^^^^^^^^^^^^^^^
 
@@ -378,6 +398,8 @@ Here is a simple example.
 The expression matches records that ``_key`` column value is not equal
 to ``Groonga``.
 
+.. _query-syntax-less-than-condition:
+
 Less than condition
 ^^^^^^^^^^^^^^^^^^^
 
@@ -402,6 +424,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is less
 than ``10``.
 
+.. _query-syntax-greater-than-condition:
+
 Greater than condition
 ^^^^^^^^^^^^^^^^^^^^^^
 
@@ -426,6 +450,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is greater
 than ``10``.
 
+.. _query-syntax-less-than-or-equal-condition:
+
 Less than or equal to condition
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -451,6 +477,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is less
 than or equal to ``10``.
 
+.. _query-syntax-greater-than-or-equal-condition:
+
 Greater than or equal to condition
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -476,7 +504,7 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is
 greater than or equal to ``10``.
 
-.. _query-regular-expression-condition:
+.. _query-syntax-regular-expression-condition:
 
 Regular expression condition
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -502,7 +530,7 @@ 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:
+.. _query-syntax-combined-expression:
 
 Combined expression
 -------------------