rroonga 5.0.4-x86-mingw32 → 5.0.5-x86-mingw32

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

@@ -17,8 +17,9 @@ to create one or more tables to store and search data.
 Syntax
 ------
 
-``table_create`` has many parameters. The required parameter is only
-``name`` and otehrs are optional::
+This command takes many parameters.
+
+The required parameter is only ``name`` and otehrs are optional::
 
   table_create name
                [flags=TABLE_HASH_KEY]
@@ -156,6 +157,8 @@ Parameters
 
 This section describes all parameters.
 
+.. _table-create-name:
+
 ``name``
 ^^^^^^^^
 
@@ -176,6 +179,8 @@ You need to create a name with one or more the above chracters. Note
 that you cannot use ``_`` as the first character such as
 ``_name``.
 
+.. _table-create-flags:
+
 ``flags``
 ^^^^^^^^^
 
@@ -213,6 +218,8 @@ See :doc:`/reference/tables` for difference between table types.
 
 The default flags are ``TABLE_HASH_KEY``.
 
+.. _table-create-key-type:
+
 ``key_type``
 ^^^^^^^^^^^^
 
@@ -226,6 +233,8 @@ See :doc:`/reference/types` for all types.
 
 The default value is none.
 
+.. _table-create-value-type:
+
 ``value_type``
 ^^^^^^^^^^^^^^
 
@@ -238,19 +247,36 @@ but ``ShortText`` cannot be used. Use columns instead of value.
 
 The default value is none.
 
+.. _table-create-default-tokenizer:
+
 ``default_tokenizer``
 ^^^^^^^^^^^^^^^^^^^^^
 
 Specifies the default tokenizer that is used on searching and data
 loading.
 
-You cannot use ``default_tokenizer`` with ``TABLE_NO_KEY`` because
-``TABLE_NO_KEY`` cannot be used for index.
-
 You must specify ``default_tokenizer`` for a table that is used for
-fulltext search index.
+lexicon of fulltext search index. See :doc:`/reference/tokenizers` for
+available tokenizers. You must choose a tokenizer from the list for
+fulltext search.
+
+You don't need to specify ``default_tokenizer`` in the following
+cases:
+
+  * You don't use the table as a lexicon.
+
+  * You use the table as a lexicon but you don't need fulltext
+    search. For example:
+
+      * Index target data isn't text data such as ``Int32`` and ``Time``.
+      * You just need exact match search, prefix search and so on.
+
+You can't use ``default_tokenizer`` with ``TABLE_NO_KEY`` flag because
+a table that uses ``TABLE_NO_KEY`` flag can't be used as lexicon.
 
-See :doc:`/reference/tokenizers` for all tokenizers
+You must specify ``TABLE_HASH_KEY``, ``TABLE_PAT_KEY``,
+``TABLE_DAT_KEY`` to :ref:`table-create-flags` when you want to use
+the table as a lexicon.
 
 The default value is none.
 

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

@@ -0,0 +1,90 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_table_rename
+
+``table_rename``
+=================
+
+Summary
+-------
+
+``table_rename`` command renames a table.
+
+It is a light operation. It just changes a relationship between name
+and the table object. It doesn't copy table and its column values.
+
+It is a dangerous operation. You must stop all operations including
+read operations while you run ``table_rename``. If the following case
+is occurred, Groonga process may be crashed:
+
+  * Starts an operation (like ``select``) that accesses the table to
+    be renamed by the current table name. The current table name is
+    called as ``the old table name`` in the below because the table
+    name is renamed.
+  * Runs ``table_rename``. The ``select`` is still running.
+  * The ``select`` accesses the table to be renamed by the old table
+    name. But the ``select`` can't find the table by the old name
+    because the table has been renamed to the new table name. It may
+    crash the Groonga process.
+
+Syntax
+------
+
+This command takes two parameters.
+
+All parameters are required::
+
+  table_rename name new_name
+
+Usage
+-----
+
+Here is a simple example of ``table_rename`` command.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_rename/usage.log
+.. table_create Users TABLE_PAT_KEY ShortText
+.. column_create Users score COLUMN_SCALAR Int32
+.. load --table Users
+.. [
+.. {"_key": "Alice",  "score": 2},
+.. {"_key": "Bob",    "score": 0},
+.. {"_key": "Carlos", "score": -1}
+.. ]
+.. table_rename Users Players
+.. table_list
+.. select Players
+
+Parameters
+----------
+
+This section describes parameters of ``table_rename``.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+All parameters are required.
+
+``name``
+""""""""
+
+Specifies the table name to be renamed.
+
+``new_name``
+""""""""""""
+
+Specifies the new table name.
+
+Return value
+------------
+
+The command returns ``true`` as body on success such as::
+
+  [HEADER, true]
+
+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/commands/table_tokenize.txt

@@ -16,7 +16,8 @@ Summary
 Syntax
 ------
 
-``table_tokenize`` command has required parameters and optional parameters.
+This command takes many parameters.
+
 ``table`` and ``string`` are required parameters. Others are
 optional::
 

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

@@ -0,0 +1,110 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_thread_limit
+
+.. groonga-command
+.. thread_limit 2
+
+``thread_limit``
+================
+
+Summary
+-------
+
+.. versionadded:: 5.0.7
+
+``thread_limit`` has the following two features:
+
+  * It returns the max number of threads.
+  * It sets the max number of threads.
+
+:doc:`/reference/executables/groonga` is the only Groonga server that
+supports full ``thread_limit`` features.
+
+:doc:`/reference/executables/groonga-httpd` supports only one feature
+that returns the max number of threads. The max number of threads of
+:doc:`/reference/executables/groonga-httpd` always returns ``1``
+because :doc:`/reference/executables/groonga-httpd` uses single thread
+model.
+
+If you're using Groonga as a library, ``thread_limit`` doesn't work
+without you set custom functions by
+:c:func:`grn_thread_set_get_limit_func()` and
+:c:func:`grn_thread_set_set_limit_func()`. If you set a function by
+:c:func:`grn_thread_set_get_limit_func()`, the feature that returns
+the max number of threads works. If you set a function by
+:c:func:`grn_thread_set_set_limit_func()`, the feature that sets the
+max number of threads works.
+
+Syntax
+------
+
+This command takes only one optional parameter::
+
+  thread_limit [max=null]
+
+Usage
+-----
+
+You can get the max number of threads by calling without any parameters:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/thread_limit/usage_get.log
+.. thread_limit
+
+If it returns ``0``, your Groonga server doesn't support the feature.
+
+You can set the max number of threads by calling ``max`` parameter:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/thread_limit/usage_set.log
+.. thread_limit --max 4
+
+It returns the previous max number of threads when you pass
+``max`` parameter.
+
+Parameters
+----------
+
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no required parameters.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is one optional parameter.
+
+.. _thread-limit-max:
+
+``max``
+"""""""
+
+Specifies the new max number of threads.
+
+You must specify positive integer:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/thread_limit/max.log
+.. thread_limit --max 3
+
+If you specify ``max`` parameter, ``thread_limit`` returns the
+max number of threads before ``max`` is applied.
+
+Return value
+------------
+
+The command returns the max number of threads as body::
+
+  [HEADER, N_MAX_THREADS]
+
+If ``max`` is specified, ``N_MAX_THREADS`` is the max number of
+threads before ``max`` is applied.
+
+See :doc:`/reference/command/output_format` for ``HEADER``.

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

@@ -17,7 +17,8 @@ It is useful to debug tokenization.
 Syntax
 ------
 
-``tokenize`` command has required parameters and optional parameters.
+This command takes many parameters.
+
 ``tokenizer`` and ``string`` are required parameters. Others are
 optional::
 

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

@@ -13,12 +13,10 @@ Summary
 
 ``tokenizer_list`` command lists tokenizers in a database.
 
-
 Syntax
 ------
 
-``tokenizer_list`` command takes no parameter.
-::
+This command takes no parameters::
 
   tokenizer_list
 

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

@@ -14,9 +14,7 @@ values from specified column.
 Syntax
 ------
 
-``truncate`` command takes only one parameter.
-
-The required parameter is only ``target_name``::
+This command takes only one required parameter::
 
   truncate target_name
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-httpd.txt

@@ -72,11 +72,10 @@ To check, request a simple query (:doc:`/reference/commands/status`).
 Loading data by POST
 ^^^^^^^^^^^^^^^^^^^^
 
-The feature of groonga-httpd in contrast to groonga is supporting POST method.
-
 You can load data by POST JSON data.
 
-Here is an example curl command line that loads two users alice and bob to Users table::
+Here is an example ``curl`` command line that loads two users ``alice``
+and ``bob`` to ``Users`` table::
 
     % curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users"
 
@@ -87,7 +86,7 @@ If you loads users from JSON file, prepare JSON file like this::
     {"_key": "bob"}
     ]
 
-Then specify JSON file in curl command line::
+Then specify JSON file in ``curl`` command line::
 
     % curl -X POST 'http://localhost:10041/d/load?table=Users' -H 'Content-Type: application/json' -d @users.json
 

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

@@ -42,7 +42,6 @@ Here are a schema definition and sample data to show usage.
 .. column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
 .. load --table Entries
 .. [
-.. ["content"],
 .. {"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
 .. ]
 

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

@@ -42,7 +42,6 @@ Here are a schema definition and sample data to show usage.
 .. column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
 .. load --table Entries
 .. [
-.. ["content"],
 .. {"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
 .. ]
 

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

@@ -47,7 +47,7 @@ Sample schema:
 .. include:: ../../example/reference/functions/query/usage_setup_schema.log
 .. table_create Documents TABLE_NO_KEY
 .. column_create Documents content COLUMN_SCALAR Text
-.. table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram  --normalizer NormalizerAuto
 .. column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
 .. table_create Users TABLE_NO_KEY
 .. column_create Users name COLUMN_SCALAR ShortText
@@ -149,7 +149,7 @@ See :doc:`/reference/query_expanders/tsv` about details.
 Specifies the substitution table and substitution column name
 by following format such as ``${TABLE}.${COLUMN}`` for query expansion.
 
-See :ref:`query-expander` about details.
+See :ref:`select-query-expander` about details.
 
 Return value
 ------------

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

@@ -42,7 +42,7 @@ Here are a schema definition and sample data to show usage.
 .. include:: ../../example/reference/functions/snippet_html/usage_setup.log
 .. table_create Documents TABLE_NO_KEY
 .. column_create Documents content COLUMN_SCALAR Text
-.. table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram  --normalizer NormalizerAuto
 .. column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
 .. load --table Documents
 .. [

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

@@ -36,7 +36,7 @@ Here are a schema definition and sample data to show usage.
 .. table_create Entries TABLE_PAT_KEY ShortText
 .. column_create Entries content COLUMN_SCALAR Text
 .. column_create Entries n_likes COLUMN_SCALAR UInt32
-.. table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
 .. column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
 .. column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
 .. load --table Entries

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

@@ -49,7 +49,7 @@ here is the constructed :ref:`select-filter` parameter::
   column @ "query"
 
 If the input is ``x" || true || "``, here is the constructed
-ref:`select-filter` parameter::
+:ref:`select-filter` parameter::
 
   column @ "x" || true || ""
 
@@ -83,7 +83,7 @@ Here are a schema definition and sample data to show usage.
 .. table_create Entries TABLE_PAT_KEY ShortText
 .. column_create Entries content COLUMN_SCALAR Text
 .. column_create Entries n_likes COLUMN_SCALAR UInt32
-.. table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
 .. column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
 .. column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
 .. load --table Entries
@@ -462,11 +462,15 @@ Here is a simple example.
 The expression matches records that ``content`` column value has the
 word ``fast`` but doesn't have the word ``mroonga``.
 
+.. _script-syntax-bitwise-operators:
+
 Bitwise operators
 ^^^^^^^^^^^^^^^^^
 
 Here are bitwise operators.
 
+.. _script-syntax-bitwise-not:
+
 Bitwise NOT operator
 """"""""""""""""""""
 
@@ -483,6 +487,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is equal
 to ``5`` because bitwise NOT of ``5`` is equal to ``-6``.
 
+.. _script-syntax-bitwise-and:
+
 Bitwise AND operator
 """"""""""""""""""""
 
@@ -501,6 +507,8 @@ number because bitwise AND between an even number and ``1`` is equal
 to ``1`` and bitwise AND between an odd number and ``1`` is equal to
 ``0``.
 
+.. _script-syntax-bitwise-or:
+
 Bitwise OR operator
 ^^^^^^^^^^^^^^^^^^^
 
@@ -517,6 +525,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is equal
 to ``5`` (= ``1 | 4``).
 
+.. _script-syntax-bitwise-xor:
+
 Bitwise XOR operator
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -533,11 +543,15 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is equal
 to ``5`` (= ``10 ^ 15``).
 
+.. _script-syntax-shift-operators:
+
 Shift operators
 ^^^^^^^^^^^^^^^
 
 Here are shift operators.
 
+.. _script-syntax-shift-left:
+
 Left shift operator
 """""""""""""""""""
 
@@ -555,6 +569,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is equal
 to ``10`` (= ``5 << 1``).
 
+.. _script-syntax-shift-signed-right:
+
 Signed right shift operator
 """""""""""""""""""""""""""
 
@@ -572,6 +588,8 @@ Here is a simple example.
 The expression matches records that ``n_likes`` column value is equal
 to ``5`` (= ``-(-10 >> 1)`` = ``-(-5)``).
 
+.. _script-syntax-shift-unsigned-right:
+
 Unsigned right shift operator
 """""""""""""""""""""""""""""
 
@@ -799,6 +817,8 @@ is 10.
 
 So the expression ``1 & 10`` is evaluated and stored to ``_score`` column as the execution result.
 
+.. _script-syntax-bitwise-or-assign:
+
 Bitwise OR assignment operator
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -844,7 +864,7 @@ Script syntax adds the original binary opearators to ECMAScript
 syntax. They operate search specific operations. They are starts with
 ``@`` or ``*``.
 
-.. _match-oeprator:
+.. _script-syntax-match-oeprator:
 
 Match operator
 ^^^^^^^^^^^^^^
@@ -866,7 +886,7 @@ Here is a simple example.
 The expression matches records that contain a word ``fast`` in
 ``content`` column value.
 
-.. _prefix-search-operator:
+.. _script-syntax-prefix-search-operator:
 
 Prefix search operator
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -897,7 +917,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-operator:
+.. _script-syntax-suffix-search-operator:
 
 Suffix search operator
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -951,7 +971,7 @@ The expression matches records that have value that ends with ``んが``
 in ``content`` column value. ``ぐるんが`` and ``むるんが`` are matched
 with the expression.
 
-.. _near-search-operator:
+.. _script-syntax-near-search-operator:
 
 Near search operator
 ^^^^^^^^^^^^^^^^^^^^
@@ -999,7 +1019,7 @@ the record that its content is ``I also st arted to use mroonga. It's
 also very fast! Really fast!`` is matched. The number of words between
 ``also`` and ``Really`` is 10.
 
-.. _similar-search-operator:
+.. _script-syntax-similar-search-operator:
 
 Similar search
 ^^^^^^^^^^^^^^
@@ -1023,7 +1043,7 @@ The expression matches records that have similar content to ``I
 migrated all Solr system!``. In this case, records that have ``I
 migrated all XXX system!`` content are matched.
 
-.. _term-extract-operator:
+.. _script-syntax-term-extract-operator:
 
 Term extract operator
 ^^^^^^^^^^^^^^^^^^^^^
@@ -1043,7 +1063,7 @@ Here is a simple example.
 
 .. groonga-command
 .. include:: ../../example/reference/grn_expr/script_syntax/simple_term_extract_operator.log
-.. table_create Words TABLE_PAT_KEY|KEY_NORMALIZE ShortText
+.. table_create Words TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
 .. load --table Words
 .. [
 .. {"_key": "groonga"},
@@ -1054,12 +1074,12 @@ Here is a simple example.
 .. select Words --filter '_key *T "Groonga is the successor project to Senna."' --output_columns _key
 
 The expression extrcts terms that included in document ``Groonga is
-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.
+the successor project to Senna.``. In this case, ``NormalizerAuto``
+normalizer 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:
+.. _script-syntax-regular-expression-operator:
 
 Regular expression operator
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^