rroonga 7.0.2-x86-mingw32 → 7.1.1-x86-mingw32

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

@@ -1,137 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: functions_sub_filter
-
-``sub_filter``
-==============
-
-Summary
--------
-
-``sub_filter`` evaluates ``filter_string`` in ``scope`` context.
-
-``sub_filter`` can be used in only ``--filter`` in
-:doc:`/reference/commands/select`.
-
-Syntax
-------
-
-``sub_filter`` requires two arguments. They are ``scope`` and
-``filter_string``.
-
-::
-
-  sub_filter(scope, filter_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 commented by user 'A'.
-
-.. 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 the 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 the 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 the following condition is met.
-
-* There are the records that user "A" mentions about "groonga".
-
-
-Parameters
-----------
-
-There are two required parameter, ``scope`` and ``filter_string``.
-
-``scope``
-^^^^^^^^^
-
-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
-``select --table TYPE_OF_THE_COLUMN --filter FILTER_STRING``.
-
-The specified column type must be a table. In other words, the column
-type must be reference type.
-
-You can chain columns by ``COLUMN_1.COLUMN_2.COLUMN_3...COLUMN_N``
-syntax. For example, ``user.group.name``.
-
-See :ref:`select-table` about ``table`` parameter in ``select``.
-
-``filter_string``
-^^^^^^^^^^^^^^^^^
-
-Specifies a search condition in
-:doc:`/reference/grn_expr/script_syntax`. It is evaluated in ``scope``
-context.
-
-Return value
-------------
-
-``sub_filter`` returns whether any record is matched or not. If one or
-more records are matched, it returns ``true``. Otherwise, it returns
-``false``.
-
-See also
---------
-
-* :doc:`/reference/commands/select`
-* :doc:`/reference/grn_expr/script_syntax`

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_day``
-=====================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_hour``
-======================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_minute``
-========================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,20 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_month``
-=======================
-
-.. WRITE ME
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_second``
-========================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_week``
-======================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``time_classify_year``
-======================
-
-Summary
--------
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,38 +0,0 @@
-.. -*- 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/functions/vector_size.txt

@@ -1,76 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: vector_size
-
-``vector_size``
-===============
-
-Summary
--------
-
-.. versionadded:: 5.0.3
-
-``vector_size`` returns the value of vector column size.
-
-To enable this function, register ``functions/vector`` plugin by following the command::
-
-  plugin_register functions/vector
-
-Then, use ``vector_size`` function with ``--command_version 2`` option. Note that you must specify ``--command_version 2`` to use ``vector_size`` function."
-
-Syntax
-------
-
-``vector_size`` requires one argument - ``target``.
-
-::
-
-  vector_size(target)
-
-Usage
------
-
-Here is a schema definition and sample data.
-
-Sample schema:
-
-.. groonga-command
-.. plugin_register functions/vector
-.. include:: ../../example/reference/functions/vector_size/usage_setup_schema.log
-.. table_create Memos TABLE_HASH_KEY ShortText
-.. column_create Memos tags COLUMN_VECTOR ShortText
-
-Sample data:
-
-.. groonga-command
-.. include:: ../../example/reference/functions/vector_size/usage_setup_data.log
-.. load --table Memos
-.. [
-.. {"_key": "Groonga",          "tags": ["Groonga"]},
-.. {"_key": "Rroonga",          "tags": ["Groonga", "Ruby"]},
-.. {"_key": "Nothing"}
-.. ]
-
-Here is the simple usage of ``vector_size`` function which returns tags and size - the value of ``tags`` column and size of it.
-
-.. groonga-command
-.. include:: ../../example/reference/functions/vector_size/usage_only.log
-.. select Memos --output_columns 'tags, vector_size(tags)' --command_version 2
-
-Parameters
-----------
-
-There is one required parameter, ``target``.
-
-``target``
-^^^^^^^^^^
-
-Specifies a vector column of table that is specified by ``table`` parameter in ``select``.
-
-Return value
-------------
-
-``vector_size`` returns the value of target vector column size.

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

@@ -1,27 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: vector_slice
-
-``vector_slice``
-================
-
-Summary
--------
-
-.. versionadded:: 6.0.7
-
-To enable this function, register ``functions/vector`` plugin by following the command::
-
-  plugin_register functions/vector
-
-Syntax
-------
-
-Usage
------
-
-Return value
-------------

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

@@ -1,59 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-grn_expr
-========
-
-Grn_expr is an object that searches records with specified conditions
-and manipulates a database. It's pronounced as ``gurun expression``.
-
-Conditions for searching records from a database can be represented by
-conbining condition expressions such as ``equal condition expression``
-and ``less than condition expression`` with set operations such as
-``AND``, ``OR`` and ``NOT``. Grn_expr executes those conditions to
-search records. You can also use advanced searches such as similar
-search and near search by grn_expr. You can also use flexible full
-text search. For example, you can control hit scores for specified
-words and improve recall by re-searching with high-recall algolithm
-dinamically. To determine whether re-searching or not, the number of
-matched rescords is used.
-
-There are three ways to create grn_expr:
-
-  * Parsing :doc:`/reference/grn_expr/query_syntax` string.
-  * Parsing :doc:`/reference/grn_expr/script_syntax` string.
-  * Calling grn_expr related APIs.
-
-:doc:`/reference/grn_expr/query_syntax` is for common search form in
-Internet search site. It's simple and easy to use but it has a
-limitation. You can not use all condition expressions and set
-operations in :doc:`/reference/grn_expr/query_syntax`. You can use
-:doc:`/reference/grn_expr/query_syntax` with ``query`` option in
-:doc:`/reference/commands/select`.
-
-:doc:`/reference/grn_expr/script_syntax` is ECMAScript like
-syntax. You can use all condition expressions and set operations in
-:doc:`/reference/grn_expr/script_syntax`. You can use
-:doc:`/reference/grn_expr/script_syntax` with ``filter`` option and
-``scorer`` option in :doc:`/reference/commands/select`.
-
-You can use groonga as a library and create a grn_expr by calling
-grn_expr related APIs. You can use full features with calling APIs
-like :doc:`/reference/grn_expr/script_syntax`. Calling APIs is useful
-creating a custom syntax to create grn_expr. They are used in `rroonga
-<http://ranguba.org/#about-rroonga>`_ that is Ruby bindings
-of Groonga. Rroonga can create a grn_expr by Ruby's syntax instead of
-parsing string.
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   grn_expr/query_syntax
-   grn_expr/script_syntax
-
-See also
---------
-
-  * :doc:`/reference/api/grn_expr`: grn_expr related APIs