RubyGems - rroonga - Versions diffs - 7.0.2-x86-mingw32 → 7.1.1-x86-mingw32 - Mend

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

Files changed (1237) hide show

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

@@ -1,110 +0,0 @@
-.. -*- 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 parameter.
-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 DELETED Viewed

@@ -1,248 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-.. groonga-command
-.. database: commands_tokenize
-``tokenize``
-============
-Summary
--------
-``tokenize`` command tokenizes text by the specified tokenizer.
-It is useful to debug tokenization.
-Syntax
-------
-This command takes many parameters.
-``tokenizer`` and ``string`` are required parameters. Others are
-optional::
-  tokenize tokenizer
-           string
-           [normalizer=null]
-           [flags=NONE]
-           [mode=ADD]
-           [token_filters=NONE]
-Usage
------
-Here is a simple example.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/simple_example.log
-.. tokenize TokenBigram "Fulltext Search"
-It has only required parameters. ``tokenizer`` is ``TokenBigram`` and
-``string`` is ``"Fulltext Search"``. It returns tokens that is
-generated by tokenizing ``"Fulltext Search"`` with ``TokenBigram``
-tokenizer. It doesn't normalize ``"Fulltext Search"``.
-Parameters
-----------
-This section describes all parameters. Parameters are categorized.
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-There are required parameters, ``tokenizer`` and ``string``.
-.. _tokenize-tokenizer:
-``tokenizer``
-"""""""""""""
-Specifies the tokenizer name. ``tokenize`` command uses the
-tokenizer that is named ``tokenizer``.
-See :doc:`/reference/tokenizers` about built-in tokenizers.
-Here is an example to use built-in ``TokenTrigram`` tokenizer.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/tokenizer_token_trigram.log
-.. tokenize TokenTrigram "Fulltext Search"
-If you want to use other tokenizers, you need to register additional
-tokenizer plugin by :doc:`register` command. For example, you can use
-`KyTea <http://www.phontron.com/kytea/>`_ based tokenizer by
-registering ``tokenizers/kytea``.
-.. _tokenize-string:
-``string``
-""""""""""
-Specifies any string which you want to tokenize.
-If you want to include spaces in ``string``, you need to quote
-``string`` by single quotation (``'``) or double quotation (``"``).
-Here is an example to use spaces in ``string``.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/string_include_spaces.log
-.. tokenize TokenBigram "Groonga is a fast fulltext earch engine!"
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-There are optional parameters.
-.. _tokenize-normalizer:
-``normalizer``
-""""""""""""""
-Specifies the normalizer name. ``tokenize`` command uses the
-normalizer that is named ``normalizer``. Normalizer is important for
-N-gram family tokenizers such as ``TokenBigram``.
-Normalizer detects character type for each character while
-normalizing. N-gram family tokenizers use character types while
-tokenizing.
-Here is an example that doesn't use normalizer.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/normalizer_none.log
-.. tokenize TokenBigram "Fulltext Search"
-All alphabets are tokenized by two characters. For example, ``Fu`` is
-a token.
-Here is an example that uses normalizer.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/normalizer_use.log
-.. tokenize TokenBigram "Fulltext Search" NormalizerAuto
-Continuous alphabets are tokenized as one token. For example,
-``fulltext`` is a token.
-If you want to tokenize by two characters with noramlizer, use
-``TokenBigramSplitSymbolAlpha``.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/normalizer_use_with_split_symbol_alpha.log
-.. tokenize TokenBigramSplitSymbolAlpha "Fulltext Search" NormalizerAuto
-All alphabets are tokenized by two characters. And they are normalized
-to lower case characters. For example, ``fu`` is a token.
-.. _tokenize-flags:
-``flags``
-"""""""""
-Specifies a tokenization customize options. You can specify
-multiple options separated by "``|``". For example,
-``NONE|ENABLE_TOKENIZED_DELIMITER``.
-Here are available flags.
-.. list-table::
-   :header-rows: 1
-   * - Flag
-     - Description
-   * - ``NONE``
-     - Just ignored.
-   * - ``ENABLE_TOKENIZED_DELIMITER``
-     - Enables tokenized delimiter. See :doc:`/reference/tokenizers` about
-       tokenized delimiter details.
-Here is an example that uses ``ENABLE_TOKENIZED_DELIMITER``.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/flags_enable_tokenized_delimiter.log
-.. tokenize TokenDelimit "Fulltext Seacrch" NormalizerAuto ENABLE_TOKENIZED_DELIMITER
-``TokenDelimit`` tokenizer is one of tokenized delimiter supported
-tokenizer. ``ENABLE_TOKENIZED_DELIMITER`` enables tokenized delimiter.
-Tokenized delimiter is special character that indicates token
-border. It is ``U+FFFE``. The character is not assigned any
-character. It means that the character is not appeared in normal
-string. So the character is good character for this puropose. If
-``ENABLE_TOKENIZED_DELIMITER`` is enabled, the target string is
-treated as already tokenized string. Tokenizer just tokenizes by
-tokenized delimiter.
-.. _tokenize-mode:
-``mode``
-""""""""
-Specifies a tokenize mode. If the mode is specified ``ADD``, the text
-is tokenized by the rule that adding a document. If the mode is specified
-``GET``, the text is tokenized by the rule that searching a document. If
-the mode is omitted, the text is tokenized by the ``ADD`` mode.
-The default mode is ``ADD``.
-Here is an example to the ``ADD`` mode.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/add_mode.log
-.. tokenize TokenBigram "Fulltext Search" --mode ADD
-The last alphabet is tokenized by one character.
-Here is an example to the ``GET`` mode.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenize/get_mode.log
-.. tokenize TokenBigram "Fulltext Search" --mode GET
-The last alphabet is tokenized by two characters.
-.. _tokenize-token-filters:
-``token_filters``
-"""""""""""""""""
-Specifies the token filter names. ``tokenize`` command uses the
-tokenizer that is named ``token_filters``.
-See :doc:`/reference/token_filters` about token filters.
-.. _tokenize-return-value:
-Return value
-------------
-``tokenize`` command returns tokenized tokens. Each token has some
-attributes except token itself. The attributes will be increased in
-the feature::
-  [HEADER, tokens]
-``HEADER``
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-``tokens``
-  ``tokens`` is an array of token. Token is an object that has the following
-  attributes.
-  .. list-table::
-     :header-rows: 1
-     * - Name
-       - Description
-     * - ``value``
-       - Token itself.
-     * - ``position``
-       - The N-th token.
-See also
---------
-* :doc:`/reference/tokenizers`

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

@@ -1,63 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-.. groonga-command
-.. database: commands_tokenizer_list
-``tokenizer_list``
-==================
-Summary
--------
-``tokenizer_list`` command lists tokenizers in a database.
-Syntax
-------
-This command takes no parameters::
-  tokenizer_list
-Usage
------
-Here is a simple example.
-.. groonga-command
-.. include:: ../../example/reference/commands/tokenizer_list/simple_example.log
-.. tokenizer_list
-It returns tokenizers in a database.
-Return value
-------------
-``tokenizer_list`` command returns tokenizers. Each tokenizers has an attribute
-that contains the name. The attribute will be increased in the feature::
-  [HEADER, tokenizers]
-``HEADER``
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-``tokenizers``
-  ``tokenizers`` is an array of tokenizer. Tokenizer is an object that has the following
-  attributes.
-  .. list-table::
-     :header-rows: 1
-     * - Name
-       - Description
-     * - ``name``
-       - Tokenizer name.
-See also
---------
-* :doc:`/reference/tokenizers`
-* :doc:`/reference/commands/tokenize`

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

@@ -1,95 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-``truncate``
-============
-Summary
--------
-``truncate`` command deletes all records from specified table or all
-values from specified column.
-Syntax
-------
-This command takes only one required parameter::
-  truncate target_name
-.. versionadded:: 4.0.9
-   ``target_name`` parameter can be used since 4.0.9. You need to use
-   ``table`` parameter for 4.0.8 or earlier.
-   For backward compatibility, ``truncate`` command accepts ``table``
-   parameter. But it should not be used for newly written code.
-Usage
------
-Here is a simple example of ``truncate`` command against a table.
-.. groonga-command
-.. database: commands_truncate_table
-.. include:: ../../example/reference/commands/truncate/truncate_table.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}
-.. ]
-.. select Users
-.. truncate Users
-.. select Users
-Here is a simple example of ``truncate`` command against a column.
-.. groonga-command
-.. database: commands_truncate_column
-.. include:: ../../example/reference/commands/truncate/truncate_column.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}
-.. ]
-.. select Users
-.. truncate Users.score
-.. select Users
-Parameters
-----------
-This section describes parameters of ``truncate``.
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-There is required parameter, ``target_name``.
-``target_name``
-"""""""""""""""
-Specifies the name of table or column.
-Return value
-------------
-``truncate`` command returns whether truncation is succeeded or not::
-  [HEADER, SUCCEEDED_OR_NOT]
-``HEADER``
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-``SUCCEEDED_OR_NOT``
-  If command succeeded, it returns true, otherwise it returns false on error.