RubyGems - rroonga - Versions diffs - 2.1.2-x86-mingw32 → 2.1.3-x86-mingw32 - Mend

rroonga 2.1.2-x86-mingw32 → 2.1.3-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (788) hide show

data/vendor/local/share/doc/groonga/source/reference/commands/shutdown.txt DELETED Viewed

@@ -1,40 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-shutdown
-========
-名前
-----
-shutdown - サーバプロセスの停止
-書式
-----
-::
- shutdown
-説明
-----
-groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-shutdownは、接続しているgroongaサーバプロセスを停止します。
-引数
-----
-ありません。
-返値
-----
-ありません。
-例
---
-::
- shutdown

data/vendor/local/share/doc/groonga/source/reference/commands/status.txt DELETED Viewed

@@ -1,60 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-.. _command-status:
-status
-======
-名前
-----
-status - groongaプロセスの状態表示
-書式
-----
-::
- status
-説明
-----
-groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。
-引数
-----
-ありません。
-返値
-----
-json形式
-^^^^^^^^
-::
-  下記の項目がハッシュ形式で出力されます。
-  ``alloc_count``
-    groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を示します。groongaをbuildする際に、configureオプションで --enable-exact-alloc-countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を返す場合があります。
-  ``starttime``
-    groongaプロセスが起動した時刻のtvsec値を返します。
-  ``uptime``
-    groongaプロセスが起動してから経過した秒数を返します。
-例
---
-.. groonga-command
-.. include:: ../../example/reference/commands/status.log
-.. status

data/vendor/local/share/doc/groonga/source/reference/commands/suggest.txt DELETED Viewed

@@ -1,270 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-.. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/suggest query
-.. database: suggest
-suggest
-=======
-.. note::
-   The suggest feature specification isn't stable. The
-   specification may be changed.
-NAME
-----
-suggest - returns completion, correction and/or suggestion for a query.
-SYNOPSIS
---------
-::
- suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]
-DESCRIPTION
------------
-The suggest command returns completion, correction and/or
-suggestion for a specified query.
-See :doc:`/suggest/introduction` about completion,
-correction and suggestion.
-OPTIONS
--------
-``types``
-  It specifies what types are returned by the suggest
-  command.
-  Here are available types:
-    ``complete``
-      The suggest command does completion.
-    ``correct``
-      The suggest command does correction.
-    ``suggest``
-      The suggest command does suggestion.
-  You can specify one or more types separated by ``|``.
-  Here are examples:
-    It returns correction::
-      correct
-    It returns correction and suggestion::
-      correct|suggest
-    It returns complete, correction and suggestion::
-      complete|correct|suggest
-``table``
-  It specifies table name that has ``item_${DATA_SET_NAME}`` format.
-  For example, ``item_query`` is a table name if you created
-  dataset by the following command::
-    groonga-suggest-create-dataset /tmp/db-path query
-``column``
-  It specifies a column name that has furigana in
-  Katakana in ``table`` table.
-``query``
-  It specifies query for completion, correction and/or
-  suggestion.
-``sortby``
-  It specifies sort key.
-  Default:
-    ``-_score``
-``output_columns``
-  It specifies output columns.
-  Default:
-    ``_key,_score``
-``offset``
-  It specifies returned records offset.
-  Default:
-    ``0``
-``limit``
-  It specifies number of returned records.
-  Default:
-    ``10``
-``frequency_threshold``
-  It specifies threshold for item frequency. Returned records must have
-  ``_score`` that is greater than or equal to ``frequency_threshold``.
-  Default:
-    ``100``
-``conditional_probability_threshold``
-  It specifies threshold for conditional
-  probability. Conditional probability is used for learned
-  data. It is probability of query submission when ``query``
-  is occurred. Returned records must have conditional
-  probability that is greater than or equal to
-  ``conditional_probability_threshold``.
-  Default:
-    ``0.2``
-``prefix_search``
-  It specifies whether optional prefix search is used or not
-  in completion.
-  Here are available values:
-    ``yes``
-      Prefix search is always used.
-    ``no``
-      Prefix search is never used.
-    ``auto``
-      Prefix search is used only when other search can't
-      find any records.
-  Default:
-    ``auto``
-``similar_search``
-  It specifies whether optional similar search is used or not
-  in correction.
-  Here are available values:
-    ``yes``
-      Similar search is always used.
-    ``no``
-      Similar search is never used.
-    ``auto``
-      Similar search is used only when other search can't
-      find any records.
-  Default:
-    ``auto``
-RETURN VALUE
-------------
-JSON format
-^^^^^^^^^^^
-Here is a returned JSON format::
- {"type1": [["candidate1", score of candidate1],
-            ["candidate2", score of candidate2],
-            ...],
-  "type2": [["candidate1", score of candidate1],
-            ["candidate2", score of candidate2],
-            ...],
-  ...}
-``type``
-  A type specified by ``types``.
-``candidate``
-  A candidate for completion, correction or suggestion.
-``score of candidate``
-  A score of corresponding ``candidate``. It means that
-  higher score candidate is more likely candidate for
-  completion, correction or suggestion. Returned candidates
-  are sorted by ``score of candidate`` descending by
-  default.
-EXAMPLE
--------
-Here are learned data for completion.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-completion.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "1", "time": 1312950803.86057, "item": "e"},
-.. {"sequence": "1", "time": 1312950803.96857, "item": "en"},
-.. {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
-.. {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
-.. {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
-.. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
-.. ]
-Here are learned data for correction.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-correction.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "2", "time": 1312950803.86057, "item": "s"},
-.. {"sequence": "2", "time": 1312950803.96857, "item": "sa"},
-.. {"sequence": "2", "time": 1312950804.26057, "item": "sae"},
-.. {"sequence": "2", "time": 1312950804.56057, "item": "saer"},
-.. {"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
-.. {"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
-.. {"sequence": "2", "time": 1312950809.76057, "item": "serch"},
-.. {"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
-.. ]
-Here are learned data for suggestion.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-suggestion.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
-.. {"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
-.. ]
-Here is a completion example.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-completion.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
-Here is a correction example.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-correction.log
-.. suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
-Here is a suggestion example.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-suggestion.log
-.. suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
-Here is a mixed example.
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-mixed.log
-.. suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
-SEE ALSO
---------
-* :doc:`/suggest`
-* :doc:`/reference/executables/groonga-suggest-create-dataset`

data/vendor/local/share/doc/groonga/source/reference/commands/table_create.txt DELETED Viewed

@@ -1,286 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-.. groonga-command
-.. database: commands_table_create
-``table_create``
-================
-Summary
--------
-``table_create`` creates a new table in the current database. You need
-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::
-  table_create name
-               [flags=TABLE_HASH_KEY]
-               [key_type=null]
-               [value_type=null]
-               [default_tokenizer=null]
-               [normalizer=null]
-Usage
------
-``table_create`` command creates a new persistent table. See
-:doc:`/reference/tables` for table details.
-Create data store table
-^^^^^^^^^^^^^^^^^^^^^^^
-You can use all table types for data store table. See
-:doc:`/reference/tables` for all table types.
-Table type is specified as ``TABLE_${TYPE}`` to ``flags`` parameter.
-Here is an example to create ``TABLE_NO_KEY`` table:
-.. groonga-command
-.. include:: ../../example/reference/commands/table_create/data_store_table_no_key.log
-.. table_create Logs TABLE_NO_KEY
-The ``table_create`` command creates a table that is named ``Logs``
-and is ``TABLE_NO_KEY`` type.
-If your records aren't searched by key, ``TABLE_NO_KEY`` type table is
-suitable. Because ``TABLE_NO_KEY`` doesn't support key but it is fast
-and small table. Storing logs into groonga database is the case.
-If your records are searched by key or referenced by one or more
-columns, ``TABLE_NO_KEY`` type isn't suitable. Lexicon for fulltext
-search is the case.
-Create lexicon table
-^^^^^^^^^^^^^^^^^^^^
-You can use all table types except ``TABLE_NO_KEY`` for lexicon table.
-Lexicon table needs key support but ``TABLE_NO_KEY`` doesn't support
-key.
-Here is an example to create ``TABLE_PAT_KEY`` table:
-.. groonga-command
-.. include:: ../../example/reference/commands/table_create/lexicon_table_pat_key.log
-.. table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
-The ``table_create`` command creates the following table:
-* The table is named ``Lexicon``.
-* The table is ``TABLE_PAT_KEY`` type table.
-* The table's key is ``ShortText`` type.
-* The table uses ``TokenBigram`` tokenizer to extract tokens from a
-  normalized text.
-* The table uses ``NormalizerAuto`` normalizer to normalize a text.
-``TABLE_PAT_KEY`` is suitable table type for lexicon table. Lexicon
-table is used for fulltext search.
-In fulltext search, predictive search may be used for fuzzy
-search. Predictive search is supported by ``TABLE_PAT_KEY`` and
-``TABLE_DAT_KEY``.
-Lexicon table has many keys because a fulltext target text has many
-tokens. Table that has many keys should consider table size because
-large table requires large memory. Requiring large memory causes disk
-I/O. It blocks fast search. So table size is important for a table
-that has many keys. ``TABLE_PAT_KEY`` is less table size than
-``TABLE_DAT_KEY``.
-Because of the above reasons, ``TABLE_PAT_KEY`` is suitable table type
-for lexicon table.
-Create tag index table
-^^^^^^^^^^^^^^^^^^^^^^
-You can use all table types except ``TABLE_NO_KEY`` for tag index
-table. Tag index table needs key support but ``TABLE_NO_KEY`` doesn't
-support key.
-Here is an example to create ``TABLE_HASH_KEY`` table:
-.. groonga-command
-.. include:: ../../example/reference/commands/table_create/tag_index_table_hash_key.log
-.. table_create Tags TABLE_HASH_KEY ShortText
-The ``table_create`` command creates a table that is named ``Tags``,
-is ``TABLE_HASH_KEY`` type and has ``ShortText`` type key.
-``TABLE_HASH_KEY`` or ``TABLE_DAT_KEY`` are suitable table types for
-tag index table.
-If you need only exact match tag search feature, ``TABLE_HASH_KEY`` is
-suitable. It is the common case.
-If you also need predictive tag search feature (for example, searching
-``"groonga"`` by ``"gr"`` keyword.), ``TABLE_DAT_KEY`` is suitable.
-``TABLE_DAT_KEY`` is large table size but it is not important because
-the number of tags will not be large.
-Create range index table
-^^^^^^^^^^^^^^^^^^^^^^^^
-You can use ``TABLE_PAT_KEY`` and ``TABLE_DAT_KEY`` table types for
-range index table. Range index table needs range search support but
-``TABLE_NO_KEY`` and ``TABLE_HASH_KEY`` don't support it.
-Here is an example to create ``TABLE_DAT_KEY`` table:
-.. groonga-command
-.. include:: ../../example/reference/commands/table_create/tag_index_table_hash_key.log
-.. table_create Ages TABLE_DAT_KEY UInt32
-The ``table_create`` command creates a table that is named ``Ages``,
-is ``TABLE_DAT_KEY`` type and has ``UInt32`` type key.
-``TABLE_PAT_KEY`` and ``TABLE_DAT_KEY`` are suitable table types for
-range index table.
-If you don't have many indexed items, ``TABLE_DAT_KEY`` is
-suitable. Index for age is the case in the above example. Index for
-age will have only 0-100 items because human doesn't live so long.
-If you have many indexed items, ``TABLE_PAT_KEY`` is suitable. Because
-``TABLE_PAT_KEY`` is smaller than ``TABLE_DAT_KEY``.
-Parameters
-----------
-This section describes all parameters.
-``name``
-^^^^^^^^
-It specifies a table name to be created. ``name`` must be specified.
-Here are available characters:
-* ``0`` .. ``9`` (digit)
-* ``a`` .. ``z`` (alphabet, lower case)
-* ``A`` .. ``Z`` (alphabet, upper case)
-* ``#`` (hash)
-* ``@`` (at mark)
-* ``-`` (hyphen)
-* ``_`` (underscore) (NOTE: Underscore can't be used as the first
-  character.)
-You need to create a name with one or more the above chracters. Note
-that you cannot use ``_`` as the first charcter such as
-``_name``.
-``flags``
-^^^^^^^^^
-It specifies a table type and table customize options.
-Here are available flags:
-+--------------------+------------------------------+
-|      flags         | description                  |
-+--------------------+------------------------------+
-| ``TABLE_NO_KEY``   | Array table.                 |
-+--------------------+------------------------------+
-| ``TABLE_HASH_HEY`` | Hash table.                  |
-+--------------------+------------------------------+
-| ``TABLE_PAT_KEY``  | Patricia trie.               |
-+--------------------+------------------------------+
-| ``TABLE_DAT_KEY``  | Double Array trie.           |
-+--------------------+------------------------------+
-| ``KEY_WITH_SIS``   | Enable Semi Infinite String. |
-|                    | Require ``TABLE_PAT_KEY``.   |
-+--------------------+------------------------------+
-.. note::
-   Since groonga 2.1.0 ``KEY_NORMALIZE`` flag is deprecated. Use
-   ``normalizer`` option with ``NormalizerAuto`` instead.
-You must specify one of ``TABLE_${TYPE}`` flags. You cannot specify two
-or more ``TABLE_${TYPE}`` flags. For example,
-``TABLE_NO_KEY|TABLE_HASH_KEY`` is invalid.
-You can combine flags with ``|`` (vertical bar) such as
-``TABLE_PAT_KEY|KEY_WITH_SIS``.
-See :doc:`/reference/tables` for difference between table types.
-The default flags are ``TABLE_HASH_KEY``.
-``key_type``
-^^^^^^^^^^^^
-It specifies key type.
-If you specify ``TABLE_HASH_KEY``, ``TABLE_PAT_KEY`` or
-``TABLE_DAT_KEY`` as ``flags`` parameter, you need to specify
-``key_type`` option.
-See :doc:`/reference/types` for all types.
-The default value is none.
-``value_type``
-^^^^^^^^^^^^^^
-It specifies value type.
-You can use value when you specify ``TABLE_NO_KEY``,
-``TABLE_HASH_KEY`` or ``TABLE_PAT_KEY`` as ``flags`` parameter. Value
-type must be a fixed size type. For example, ``UInt32`` can be used
-but ``ShortText`` cannot be used. Use columns instead of value.
-The default value is none.
-``default_tokenizer``
-^^^^^^^^^^^^^^^^^^^^^
-It 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.
-See :doc:`/reference/tokenizers` for all tokenizers
-The default value is none.
-``normalizer``
-^^^^^^^^^^^^^^
-It specifies a normalizer that is used to normalize key.
-You cannot use ``normalizer`` with ``TABLE_NO_KEY`` because
-``TABLE_NO_KEY`` doesn't support key.
-See :doc:`/reference/normalizers` for all normalizsers.
-The default value is none.
-Return value
-------------
-``table_create`` returns ``true`` as body on success such as::
-  [HEADER, true]
-If ``table_create`` fails, error details are in ``HEADER``.
-See :doc:`/reference/command/output_format` for ``HEADER``.
-See also
---------
-* :doc:`/reference/tables`
-* :doc:`/reference/commands/column_create`
-* :doc:`/reference/tokenizers`
-* :doc:`/reference/normalizers`
-* :doc:`/reference/command/output_format`