rroonga 5.0.5-x86-mingw32 → 5.0.8-x86-mingw32

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

@@ -10,8 +10,7 @@ Summary
 
 table_list - DBに定義されているテーブルをリスト表示
 
-Groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準
-入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
 
 table_listは、DBに定義されているテーブルのリストを表示します。
 

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

@@ -2,46 +2,237 @@
 
 .. highlightlang:: none
 
+.. groonga-command
+.. database: commands_table_remove
+
 ``table_remove``
 ================
 
 Summary
 -------
 
-table_remove - テーブルの削除
-
-groonga組込コマンドの一つであるtable_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-table_removeはテーブルと定義されているカラムを削除します。カラムに付随するインデックスも再帰的に削除されます。
+``table_remove`` removes a table and its columns. If there are one or
+more indexes against key of the table and its columns, they are also
+removed.
 
 Syntax
 ------
-::
 
- table_remove name
+This command takes only one required parameter::
+
+  table_remove name
+
+.. _table-remove-usage:
 
 Usage
 -----
-::
 
- table_remove Entry
+You just specify table name that you want to remove. ``table_remove``
+removes the table and its columns. If the table and its columns are
+indexed, all index columns for the table and its columns are also
+removed.
+
+This section describes about the followings:
+
+  * Basic usage
+  * Unremovable cases
+  * Decreases used resources
+
+.. _table-remove-basic-usage:
+
+Basic usage
+^^^^^^^^^^^
+
+Let's think about the following case:
+
+  * There is one table ``Entries``.
+  * ``Entries`` table has some columns.
+  * ``Entries`` table's key is indexed.
+  * A column of ``Entries`` is indexed.
+
+Here are commands that create ``Entries`` table:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_create_entries_table.log
+.. table_create Entries TABLE_HASH_KEY UInt32
+.. column_create Entries title COLUMN_SCALAR ShortText
+.. column_create Entries content COLUMN_SCALAR Text
+
+Here are commands that create an index for ``Entries`` table's key:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_create_index_for_entries_table.log
+.. table_create EntryKeys TABLE_HASH_KEY UInt32
+.. column_create EntryKeys key_index COLUMN_INDEX Entries _key
+
+Here are commands that create an index for ``Entries`` table's column:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_create_index_for_entries_table_column.log
+.. table_create Terms TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto
+.. column_create Terms content_index COLUMN_INDEX Entries content
+
+Let's confirm the current schema before running ``table_remove``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_dump_before_table_remove.log
+.. dump
+
+If you remove ``Entries`` table, the following tables and columns are
+removed:
+
+  * ``Entries``
+  * ``Entries.title``
+  * ``Entries.context``
+  * ``EntryKeys.key_index``
+  * ``Terms.content_index``
+
+The following tables (lexicons) aren't removed:
+
+  * ``EntryKeys``
+  * ``Terms``
+
+Let's run ``table_remove``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_table_remove.log
+.. table_remove Entries
+
+Here is schema after ``table_remove``. Only ``EntryKeys`` and
+``Terms`` exist:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/basic_usage_dump_after_table_remove.log
+.. dump
+
+.. _table-remove-unremovable-cases:
+
+Unremovable cases
+^^^^^^^^^^^^^^^^^
+
+There are some unremovable cases:
+
+  * One or more tables use the table as key type.
+  * One or more columns use the table as value type.
+
+Both cases blocks dangling references. If the table is referenced as
+type and the table is removed, tables and columns that refer the table
+are broken.
 
- [true]
+If the target table satisfies one of them, ``table_remove`` is
+failed. The target table and its columns aren't removed.
+
+Here is an example for the table is used as key type case.
+
+The following commands create a table to be removed and a table that
+uses the table to be removed as key type:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_key_type_create.log
+.. table_create ReferencedByTable TABLE_HASH_KEY ShortText
+.. table_create ReferenceTable TABLE_HASH_KEY ReferencedByTable
+
+``table_remove`` against ``ReferencedByTable`` is failed:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_key_type_remove_fail.log
+.. table_remove ReferencedByTable
+
+You need to remove ``ReferenceTable`` before you remove
+``ReferencedByTable``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_key_type_remove_success.log
+.. table_remove ReferenceTable
+.. table_remove ReferencedByTable
+
+Here is an example for the table is used as value type case.
+
+The following commands create a table to be removed and a column that
+uses the table to be removed as value type:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_value_type_create.log
+.. table_create ReferencedByColumn TABLE_HASH_KEY ShortText
+.. table_create Table TABLE_NO_KEY
+.. column_create Table reference_column COLUMN_SCALAR ReferencedByColumn
+
+``table_remove`` against ``ReferencedByColumn`` is failed:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_value_type_remove_fail.log
+.. table_remove ReferencedByColumn
+
+You need to remove ``Table.reference_column`` before you remove
+``ReferencedByColumn``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/unremovable_cases_value_type_remove_success.log
+.. column_remove Table reference_column
+.. table_remove ReferencedByColumn
+
+Decreases used resources
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+``table_remove`` opens all tables and columns in database to check
+:ref:`table-remove-unremovable-cases`.
+
+If you have many tables and columns, ``table_remove`` may use many
+resources. There is a workaround to avoid the case.
+
+``table_remove`` closes temporary opened tables and columns for
+checking when the max number of threads is ``1``.
+
+You can confirm and change the current max number of threads by
+:doc:`thread_limit`.
+
+.. groonga-command
+.. thread_limit 4
+
+The feature is used in the following case:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/decreases_used_resources_close_temporary_opened_objects.log
+.. table_create Entries TABLE_NO_KEY
+.. thread_limit 1
+.. table_remove Entries
+
+The feature isn't used in the following case:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/decreases_used_resources_close_temporary_opened_objects.log
+.. table_create Entries TABLE_NO_KEY
+.. thread_limit 2
+.. table_remove Entries
 
 Parameters
 ----------
 
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is only one required parameters.
+
+.. _table-remove-name:
+
 ``name``
-  削除対象のカラムが定義されているテーブルの名前を指定します。
+""""""""
+
+Specifies the table name to be removed.
+
+See :ref:`table-remove-usage` how to use this parameter.
 
 Return value
 ------------
 
-::
-
- [成功かどうかのフラグ]
+The command returns ``true`` as body on success such as::
 
-``成功かどうかのフラグ``
+  [HEADER, true]
 
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+If the command fails, error details are in ``HEADER``.
 
+See :doc:`/reference/command/output_format` for ``HEADER``.

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

@@ -12,6 +12,8 @@ highlight_html
 
    This feature is experimental. API will be changed.
 
+.. versionadded:: 4.0.5
+
 Summary
 -------
 
@@ -25,9 +27,9 @@ For example, a tagged text of ``I am a groonga user. <3`` for keyword
 Syntax
 ------
 
-``highlight_html`` has only one parameter::
+This function has only one parameter::
 
-  highlight_html(column)
+  highlight_html(text)
 
 Usage
 -----
@@ -48,8 +50,6 @@ Here are a schema definition and sample data to show usage.
 ``highlight_html`` can be used in only ``--output_columns`` in
 :doc:`/reference/commands/select`.
 
-``highlight_html`` requires Groonga 4.0.5 or later.
-
 ``highlight_html`` requires :doc:`/reference/command/command_version` 2
 or later.
 
@@ -79,12 +79,22 @@ You can specify string literal instead of column.
 Parameters
 ----------
 
-There is only one parameter ``column`` .
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is only one required parameters.
+
+``text``
+""""""""
+
+The text to be highlighted in HTML.
 
-``column``
-^^^^^^^^^^
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
 
-Specifies a column of the table.
+There is no optional parameters.
 
 Return value
 ------------

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

@@ -612,6 +612,8 @@ Comparison operators
 
 Here are comparison operators.
 
+.. _script-syntax-equal-operator:
+
 Equal operator
 """"""""""""""
 
@@ -864,7 +866,7 @@ Script syntax adds the original binary opearators to ECMAScript
 syntax. They operate search specific operations. They are starts with
 ``@`` or ``*``.
 
-.. _script-syntax-match-oeprator:
+.. _script-syntax-match-operator:
 
 Match operator
 ^^^^^^^^^^^^^^

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

@@ -28,6 +28,27 @@ In some cases, pattern match by regular expression can be evaluated
 by index. It's very fast rather than sequential search. Patterns
 that can be evaluated by index are described later.
 
+.. versionadded:: 5.0.7
+
+   Groonga normalizes match target text by :ref:`normalizer-auto`
+   normalizer when Groonga doesn't use index for regular expression
+   search. It means that regular expression that has upper case such
+   as ``Groonga`` never match. Because :ref:`normalizer-auto`
+   normalizer normalizes all alphabets to lower case. ``groonga``
+   matches to both ``Groonga`` and ``groonga``.
+
+   Why is match target text normalizered? It's for increasing index
+   search-able patterns. If Groonga doesn't normalize match target
+   text, you need to write complex regular expression such as
+   ``[Dd][Ii][Ss][Kk]`` and ``(?i)disk`` for case-insensitive match.
+   Groonga can't use index against complex regular expression.
+
+   If you write ``disk`` regular expression for case-insensitive
+   match, Groonga can search the pattern with index. It's fast.
+
+   You may feel the behavior is strange. But fast search based on this
+   behavior will help you.
+
 There are many regular expression syntaxes. Groonga uses the same
 syntax in Ruby. Because Groonga uses the same regular expression
 engine as Ruby. The regular expression engine is `Onigmo
@@ -39,8 +60,13 @@ means the end of text in other most regular expression syntaxes. The regular
 expression syntax in Ruby uses ``\A`` for the beginning of text and
 ``\z`` for the end of text.
 
-Groonga uses multiline mode since 5.0.6. It means that ``.`` matches
-on ``\n``.
+.. versionadded:: 5.0.6
+
+   Groonga uses multiline mode since 5.0.6. It means that ``.``
+   matches on ``\n``.
+
+   But it's meaningless. Because ``\n`` is removed by
+   :ref:`normalizer-auto` normalizer.
 
 You can use regular expression in :ref:`select-query` and
 :ref:`select-filter` options of :doc:`/reference/commands/select`
@@ -73,7 +99,7 @@ Here is an example that uses regular expression in
 
 .. groonga-command
 .. include:: ../example/reference/regular_expression/usage_query.log
-.. select Logs --query 'message:~"[Dd]isk"'
+.. select Logs --query 'message:~"disk (space|full)"'
 
 Here is an example that uses regular expression in
 :ref:`select-filter`. You need to use
@@ -81,7 +107,7 @@ Here is an example that uses regular expression in
 
 .. groonga-command
 .. include:: ../example/reference/regular_expression/usage_filter.log
-.. select Logs --filter 'message @~ "[Dd]isk"'
+.. select Logs --filter 'message @~ "disk (space|full)"'
 
 Index
 -----
@@ -295,11 +321,11 @@ Character class
 Character class syntax is ``[...]``. Character class is useful to
 specify multiple characters to be matched.
 
-For example, ``[Dd]`` matches ``D`` or ``d``.
+For example, ``[12]`` matches ``1`` or ``2``.
 
 .. groonga-command
 .. include:: ../example/reference/regular_expression/character_class_characters.log
-.. select Logs --filter 'message @~ "[Dd]isk"'
+.. select Logs --filter 'message @~ "host[12]"'
 
 You can specify characters by range. For example, ``[0-9]`` matches
 one digit.

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

@@ -26,9 +26,9 @@ cases:
     the technique.
 
 Score function can solve these cases. For example, `TF-IDF
-<http://en.wikipedia.org/wiki/Tf%E2%80%93idf>`_ (term
+<https://en.wikipedia.org/wiki/Tf%E2%80%93idf>`_ (term
 frequency-inverse document frequency) can solve the first case.
-`Okapi BM25 <http://en.wikipedia.org/wiki/Okapi_BM25>`_ can solve the
+`Okapi BM25 <https://en.wikipedia.org/wiki/Okapi_BM25>`_ can solve the
 second case. But their are slower than TF.
 
 Groonga provides TF-IDF based scorer as
@@ -177,7 +177,7 @@ scorer, ``_score`` is ``4``. But the actual ``_score`` is ``2``.
 Because the scorer used in the ``select`` command limits the maximum
 score value to ``2``.
 
-Here is an example that uses multiple scorers::
+Here is an example that uses multiple scorers:
 
 .. groonga-command
 .. include:: ../example/reference/scorer/usage_multiple_scorers.log
@@ -192,7 +192,7 @@ The ``--match_columns`` uses ``scorer_tf_idf(title)`` and
 
 You can use the default scorer and custom scorer in the same
 ``--match_columns``. You can use the default scorer by just specifying
-a match column::
+a match column:
 
 .. groonga-command
 .. include:: ../example/reference/scorer/usage_default_and_custom_scorers.log

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

@@ -19,4 +19,118 @@ Summary
 
 ``scorer_tf_at_most`` is a scorer based on TF (term frequency).
 
-TODO
+TF based scorer includes TF-IDF based scorer has a problem for the
+following case:
+
+If document contains many same keywords such as "They are keyword,
+keyword, keyword ... and keyword", the document has high score. It's
+not expected. Search engine spammer may use the technique.
+
+``scorer_tf_at_most`` is a TF based scorer but it can solve the case.
+
+``scorer_tf_at_most`` limits the maximum score value. It means that
+``scorer_tf_at_most`` limits effect of a match.
+
+If document contains many same keywords such as "They are keyword,
+keyword, keyword ... and keyword", ``scorer_tf_at_most(column, 2.0)``
+returns at most ``2`` as score.
+
+.. include:: ../scoring_note.rst
+
+Syntax
+------
+
+This scorer has two parameters::
+
+  scorer_tf_at_most(column, max)
+  scorer_tf_at_most(index, max)
+
+Usage
+-----
+
+This section describes how to use this scorer.
+
+Here are a schema definition and sample data to show usage.
+
+Sample schema:
+
+.. groonga-command
+.. include:: ../example/reference/scorers/scorer_tf_at_most/usage_setup_schema.log
+.. table_create Logs TABLE_NO_KEY
+.. column_create Logs message COLUMN_SCALAR Text
+..
+.. table_create Terms TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto
+.. column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
+
+Sample data:
+
+.. groonga-command
+.. include:: ../example/reference/scorers/scorer_tf_at_most/usage_setup_data.log
+.. load --table Logs
+.. [
+.. {"message": "Notice"},
+.. {"message": "Notice Notice"},
+.. {"message": "Notice Notice Notice"},
+.. {"message": "Notice Notice Notice Notice"},
+.. {"message": "Notice Notice Notice Notice Notice"}
+.. ]
+
+You specify ``scorer_tf_at_most`` in :ref:`select-match-columns` like
+the following:
+
+.. groonga-command
+.. include:: ../example/reference/scorers/scorer_tf_at_most/usage_no_weight.log
+.. select Logs \
+..   --match_columns "scorer_tf_at_most(message, 3.0)" \
+..   --query "Notice" \
+..   --output_columns "message, _score" \
+..   --sortby "-_score"
+
+If a document has three or more ``Notice`` terms, its score is ``3``.
+Because the ``select`` specify ``3.0`` as the max score.
+
+If a document has one or two ``Notice`` terms, its score is ``1`` or
+``2``. Because the score is less than ``3.0`` specified as the max score.
+
+Parameters
+----------
+
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is only one required parameters.
+
+``column``
+""""""""""
+
+The data column that is match target. The data column must be indexed.
+
+``index``
+"""""""""
+
+The index column to be used for search.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no optional parameters.
+
+Return value
+------------
+
+This scorer returns score as :ref:`builtin-type-float`.
+
+:doc:`/reference/commands/select` returns ``_score`` as ``Int32`` not
+``Float``. Because it casts to ``Int32`` from ``Float`` for keeping
+backward compatibility.
+
+Score is computed as TF with limitation.
+
+See also
+--------
+
+* :doc:`../scorer`