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

data/vendor/local/share/doc/groonga/source/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 expresssions 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://groonga.rubyforge.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

data/vendor/local/share/doc/groonga/source/reference/indexing.txt

@@ -1,110 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: indexing
-
-Indexing
-========
-
-Groonga supports both online index construction and offline
-index construction since 2.0.0.
-
-Online index construction
--------------------------
-
-In online index construction, registered documents can be
-searchable quickly while indexing. But indexing requires
-more cost rather than indexing by offline index
-construction.
-
-Online index construction is suitable for a search system
-that values freshness. For example, a search system for
-tweets, news, blog posts and so on will value
-freshness. Online index construction can make fresh
-documents searchable and keep searchable while indexing.
-
-.. _offline-index-construction:
-
-Offline index construction
---------------------------
-
-In offline index construction, indexing cost is less than
-indexing cost by online index construction. Indexing time
-will be shorter. Index will be smaller. Resources required
-for indexing will be smaller. But a registering document
-cannot be searchable until all registered documents are
-indexed.
-
-Offline index construction is suitable for a search system
-that values less required resources. If a search system
-doesn't value freshness, offline index construction will be
-suitable. For example, a reference manual search system
-doesn't value freshness because a reference manual will be
-updated only at a release.
-
-How to use
-----------
-
-Groonga uses online index construction by default. We
-register a document, we can search it quickly.
-
-Groonga uses offline index construction by adding an index
-to a column that already has data.
-
-We define a schema:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-schema.log
-.. table_create Tweets TABLE_NO_KEY
-.. column_create Tweets content COLUMN_SCALAR ShortText
-.. table_create Lexicon TABLE_HASH_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
-
-We register data:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-data.log
-.. load --table Tweets
-.. [
-.. {"content":"Hello!"},
-.. {"content":"I just start it!"},
-.. {"content":"I'm sleepy... Have a nice day... Good night..."}
-.. ]
-
-We search without index. We get no result:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-search-without-index.log
-.. select Tweets --match_columns content --query 'good nice'
-
-We create index for ``Tweets.content``. Already registered
-data in ``Tweets.content`` are indexed by offline index
-construction:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-offline-index-construction.log
-.. column_create Lexicon tweet COLUMN_INDEX|WITH_POSITION Tweets content
-
-We search with index. We get a matched record:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-search-after-offline-index-construction.log
-.. select Tweets --match_columns content --query 'good nice'
-
-We register data again. They are indexed by online index
-construction:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-online-index-construction.log
-.. load --table Tweets
-.. [
-.. {"content":"Good morning! Nice day."},
-.. {"content":"Let's go shopping."}
-.. ]
-
-We can also get newly registered records by searching:
-
-.. groonga-command
-.. include:: ../example/reference/indexing-search-after-online-index-construction.log
-.. select Tweets --match_columns content --query 'good nice'

data/vendor/local/share/doc/groonga/source/reference/log.txt

@@ -1,214 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Log
-===
-
-Groonga has two log files. They are process log and query
-log. Process log is for all of :doc:`executables/groonga`
-works. Query log is just for query processing.
-
-Process log
------------
-
-Process log is enabled by default. Log path can be
-customized by :option:`--log-path` option.  Each log has its
-log level. If a log is smaller than groonga process' log
-level, it's not logged. Log level can be customized by
-:option:`-l` or :doc:`commands/log_level`.
-
-Format
-^^^^^^
-
-Process log uses the following format::
-
-  #{TIME_STAMP}|#{L}| #{MESSAGE}
-
-TIME_STAMP
-  It's time stamp uses the following format::
-
-    YYYY-MM-DD hh:mm:ss.SSSSSS
-
-  YYYY
-    Year with four digits.
-
-  MM
-    Month with two digits.
-
-  DD
-    Day with two digits.
-
-  hh
-    Hour with two digits.
-
-  mm
-    Minute with two digits.
-
-  ss
-    Second with two digits.
-
-  SSSSSS
-    Microsecond with six digits.
-
-  Example::
-
-    2011-07-05 06:25:18.345734
-
-L
-  Log level with a character. Here is a character and log
-  level map.
-
-  E
-    Emergency
-
-  A
-    Alert
-
-  C
-    Critical
-
-  e
-    Error
-
-  w
-    Warning
-
-  n
-    Notification
-
-  i
-    Information
-
-  d
-    Debug
-
-  \-
-    Dump
-
-  Example::
-
-    E
-
-MESSAGE
-  Details about the log with free format.
-
-  Example::
-
-    log opened.
-
-Example::
-
-  2011-07-05 08:35:09.276421|n| grn_init
-  2011-07-05 08:35:09.276553|n| RLIMIT_NOFILE(4096,4096)
-
-Query log
----------
-
-Query log is disabled by default. It can be enabled by
-:option:`--query-log-path` option.
-
-Format
-^^^^^^
-
-Query log uses the following formats::
-
-  #{TIME_STAMP}|#{MESSAGE}
-  #{TIME_STAMP}|#{ID}|>#{QUERY}
-  #{TIME_STAMP}|#{ID}|:#{ELAPSED_TIME} #{PROGRESS}
-  #{TIME_STAMP}|#{ID}|<#{ELAPSED_TIME} #{RETURN_CODE}
-
-TIME_STAMP
-  It's time stamp uses the following format::
-
-    YYYY-MM-DD hh:mm:ss.SSSSSS
-
-  YYYY
-    Year with four digits.
-
-  MM
-    Month with two digits.
-
-  DD
-    Day with two digits.
-
-  hh
-    Hour with two digits.
-
-  mm
-    Minute with two digits.
-
-  ss
-    Second with two digits.
-
-  SSSSSS
-    Microsecond with six digits.
-
-  Example::
-
-    2011-07-05 06:25:18.345734
-
-ID
-  ID of a thread. Groonga process creates threads to process
-  requests concurrently. Each thread outputs some logs for a
-  request. This ID can be used to extract a log sequence by
-  a thread.
-
-  Example::
-
-    45ea3034
-
->
-  A character that indicates query is started.
-
-:
-  A character that indicates query is processing.
-
-<
-  A character that indicates query is finished.
-
-MESSAGE
-  Details about the log with free format.
-
-  Example::
-
-    query log opened.
-
-QUERY
-  A query to be processed.
-
-  Example::
-
-    select users --match_columns hobby --query music
-
-ELAPSED_TIME
-  Elapsed time in nanoseconds since query is started.
-
-  Example::
-
-    000000000075770
-    (It means 75,770 nanoseconds.)
-
-PROGRESS
-  A processed work at the time.
-
-  Example::
-
-    select(313401)
-    (It means that 'select' is processed and 313,401 records are remained.)
-
-RETURN_CODE
-  A return code for the query.
-
-  Example::
-
-    rc=0
-    (It means return code is 0. 0 means GRN_SUCCESS.)
-
-Example::
-
-  2011-07-05 06:25:19.458756|45ea3034|>select Properties --limit 0
-  2011-07-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
-  2011-07-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
-  2011-07-05 06:25:19.458875|45ea3034|<000000000119062 rc=0
-  2011-07-05 06:25:19.458986|45ea3034|>quit

data/vendor/local/share/doc/groonga/source/reference/normalizers.txt

@@ -1,122 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: normalisers
-
-Normalizers
-===========
-
-Summary
--------
-
-Groonga has normalizer module. It is used when tokenizing text and
-storing table key. For example, ``A`` and ``a`` are processed as the
-same character after normalization.
-
-Normalizer module can be added as a plugin. You can customize text
-normalization by registering your normalizer plugins to groonga.
-
-A normalizer module is attached to a table. A table can have zero or
-one normalizer module. You can attach a normalizer module to a table
-by :ref:`table-create-normalizer` option in
-:doc:`/reference/commands/table_create`.
-
-Here is an example ``table_create`` that uses ``NormalizerAuto``
-normalizer module:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/example-table-create.log
-.. table_create Dictionary TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
-
-.. note::
-
-   Groonga 2.0.9 or earlier doesn't have ``--normalizer`` option in
-   ``table_create``. ``KEY_NORMALIZE`` flag was used instead.
-
-   You can open an old database by groonga 2.1.0 or later. An old
-   database means that the database is created by groonga 2.0.9 or
-   earlier. But you cannot open the opened old database by groonga
-   2.0.9 or earlier. Once you open the old database by groonga 2.1.0
-   or later, ``KEY_NORMALIZE`` flag information in the old database is
-   converted to normalizer information. So groogna 2.0.9 or earlier
-   cannot find ``KEY_NORMALIZE`` flag information in the opened old
-   database.
-
-Keys of a table that has a normalizer module are normalized:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/example-load.log
-.. load --table Dictionary
-.. [
-.. {"_key": "Apple"},
-.. {"_key": "black"},
-.. {"_key": "COLOR"}
-.. ]
-.. select Dictionary
-
-``NormalizerAuto`` normalizer normalizes a text as a downcased text.
-For example, ``"Apple"`` is normalized to ``"apple"``, ``"black"`` is
-normalized to ``"blank"`` and ``"COLOR"`` is normalized to
-``"color"``.
-
-If a table is a lexicon for fulltext search, tokenized tokens are
-normalized. Because tokens are stored as table keys. Table keys are
-normalized as described above.
-
-Built-in normalizers
---------------------
-
-Here is a list of built-in-normalizers:
-
-  * ``NormalizerAuto``
-  * ``NormalizerNFKC51``
-
-``NormalizerAuto``
-^^^^^^^^^^^^^^^^^^
-
-Normally you should use ``NormalizerAuto``
-normalizer. ``NormalizerAuto`` was the normalizer for groonga 2.0.9 or
-earlier. ``KEY_NORMALIZE`` flag in ``table_create`` on groonga 2.0.9
-or earlier equals to ``--normalizer NormalizerAuto`` option in
-``table`` on groonga 2.1.0 or later.
-
-``NormalizerAuto`` supports all encoding. It uses Unicode NFKC
-(Normalization Form Compatibility Composition) for UTF-8 encoding
-text. It uses encoding specific original normalization for other
-encodings. The results of those original normalization are similar to
-NFKC.
-
-For example, half-width katakana (such as U+FF76 HALFWIDTH KATAKANA
-LETTER KA) + half-width katakana voiced sound mark (U+FF9E HALFWIDTH
-KATAKANA VOICED SOUND MARK) is normalized to full-width katakana with
-voiced sound mark (U+30AC KATAKANA LETTER GA). The former is two
-chracters but the latter is one character.
-
-Here is an example that uses ``NormalizerAuto`` normalizer:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-auto.log
-.. table_create NormalLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
-
-``NormalizerNFKC51``
-^^^^^^^^^^^^^^^^^^^^
-
-``NormalizerNFKC51`` normalizes texts by Unicode NFKC (Normalization
-Form Compatibility Composition) for Unicode version 5.1. It supports
-only UTF-8 encoding.
-
-Normally you don't need to use ``NormalizerNFKC51`` explicitly. You can
-use ``NormalizerAuto`` instead.
-
-Here is an example that uses ``NormalizerNFKC51`` normalizer:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-nfkc51.log
-.. table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51
-
-See also
---------
-
-* :doc:`/reference/commands/table_create`

data/vendor/local/share/doc/groonga/source/reference/output.txt

@@ -1,164 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Output
-======
-
-Groonga supports the following output format types:
-
-  * `JSON <http://www.json.org/>`_
-  * `XML <http://www.w3.org/XML/>`_
-  * TSV (Tab Separated Values)
-  * `MessagePack <http://msgpack.org/>`_
-
-JSON is the default output format.
-
-Usage
------
-
-Groonga has the following query interfaces:
-
-  * command line
-  * HTTP
-
-They provides different ways to change output format type.
-
-Command line
-^^^^^^^^^^^^
-
-You can use command line query interface by ``groonga
-DB_PATH`` or ``groonga -c``. Those groonga commands shows
-``> `` prompt. In this query interface, you can specify
-output format type by ``output_type`` option.
-
-If you don't specify ``output_type`` option, you will get
-a result in JSON format::
-
-  > status
-  [[0,1327721628.10738,0.000131845474243164],{"alloc_count":142,"starttime":1327721626,"uptime":2,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
-
-You can specify ``json`` as ``output_type`` value to get a
-result in JSON format explicitly::
-
-  > status --output_type json
-  [[0,1327721639.08321,7.93933868408203e-05],{"alloc_count":144,"starttime":1327721626,"uptime":13,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
-
-You need to specify ``xml`` as ``output_type`` value to
-get a result in XML format::
-
-  > status --output_type xml
-  <?xml version="1.0" encoding="utf-8"?>
-  <RESULT CODE="0" UP="1327721649.61095" ELAPSED="0.000126361846923828">
-  <RESULT>
-  <TEXT>alloc_count</TEXT>
-  <INT>146</INT>
-  <TEXT>starttime</TEXT>
-  <INT>1327721626</INT>
-  <TEXT>uptime</TEXT>
-  <INT>23</INT>
-  <TEXT>version</TEXT>
-  <TEXT>1.2.9-92-gb87d9f8</TEXT>
-  <TEXT>n_queries</TEXT>
-  <INT>0</INT>
-  <TEXT>cache_hit_rate</TEXT>
-  <FLOAT>0.0</FLOAT>
-  <TEXT>command_version</TEXT>
-  <INT>1</INT>
-  <TEXT>default_command_version</TEXT>
-  <INT>1</INT>
-  <TEXT>max_command_version</TEXT>
-  <INT>2</INT></RESULT>
-  </RESULT>
-
-You need to specify ``tsv`` as ``output_type`` value to
-get a result in TSV format::
-
-  > status --output_type tsv
-  0	1327721664.82675	0.000113964080810547
-  "alloc_count"	146
-  "starttime"	1327721626
-  "uptime"	38
-  "version"	"1.2.9-92-gb87d9f8"
-  "n_queries"	0
-  "cache_hit_rate"	0.0
-  "command_version"	1
-  "default_command_version"	1
-  "max_command_version"	2
-  END
-
-
-You need to specify ``msgpack`` as ``output_type`` value to
-get a result in MessagePack format::
-
-  > status --output_type msgpack
-  (... omitted because MessagePack is binary data format. ...)
-
-HTTP
-^^^^
-
-You can use HTTP query interface by ``groonga --protocol
-http -s DB_PATH``. Groonga HTTP server starts on port 10041
-by default. In this query interface, you can specify
-output format type by extension.
-
-If you don't specify extension, you will get a result in
-JSON format::
-
-  % curl http://localhost:10041/d/status
-  [[0,1327809294.54311,0.00082087516784668],{"alloc_count":155,"starttime":1327809282,"uptime":12,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
-
-You can specify ``json`` as extension to get a result in
-JSON format explicitly::
-
-  % curl http://localhost:10041/d/status.json
-  [[0,1327809319.01929,9.5367431640625e-05],{"alloc_count":157,"starttime":1327809282,"uptime":37,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
-
-You need to specify ``xml`` as extension to get a result in
-XML format::
-
-  % curl http://localhost:10041/d/status.xml
-  <?xml version="1.0" encoding="utf-8"?>
-  <RESULT CODE="0" UP="1327809339.5782" ELAPSED="9.56058502197266e-05">
-  <RESULT>
-  <TEXT>alloc_count</TEXT>
-  <INT>159</INT>
-  <TEXT>starttime</TEXT>
-  <INT>1327809282</INT>
-  <TEXT>uptime</TEXT>
-  <INT>57</INT>
-  <TEXT>version</TEXT>
-  <TEXT>1.2.9-92-gb87d9f8</TEXT>
-  <TEXT>n_queries</TEXT>
-  <INT>0</INT>
-  <TEXT>cache_hit_rate</TEXT>
-  <FLOAT>0.0</FLOAT>
-  <TEXT>command_version</TEXT>
-  <INT>1</INT>
-  <TEXT>default_command_version</TEXT>
-  <INT>1</INT>
-  <TEXT>max_command_version</TEXT>
-  <INT>2</INT></RESULT>
-  </RESULT>
-
-You need to specify ``tsv`` as extension to get a result in
-TSV format::
-
-  % curl http://localhost:10041/d/status.tsv
-  0	1327809366.84187	8.44001770019531e-05
-  "alloc_count"	159
-  "starttime"	1327809282
-  "uptime"	84
-  "version"	"1.2.9-92-gb87d9f8"
-  "n_queries"	0
-  "cache_hit_rate"	0.0
-  "command_version"	1
-  "default_command_version"	1
-  "max_command_version"	2
-  END
-
-You need to specify ``msgpack`` as extension to get a result
-in MessagePack format::
-
-  % curl http://localhost:10041/d/status.msgpack
-  (... omitted because MessagePack is binary data format. ...)

data/vendor/local/share/doc/groonga/source/reference/pseudo_column.txt

@@ -1,40 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-疑似カラム (pseudo_column)
-==========================
-
-名前
-----
-
-疑似カラム
-
-説明
-----
-
-groongaのデータベースで作成したテーブルには、いくつかのカラムが自動的に定義されます。
-
-これらのカラムはいずれもアンダースコア('_')で始まる名前が付与されます。定義される疑似カラムは、テーブルの種類によって異なります。
-
-``_id``
-
-  レコードに付与される一意な番号です。全てのテーブルに定義されます。値の範囲は1〜1073741824の整数で、通常はレコードを追加した順に1ずつ加算されます。_idの値は不変で、レコードが存在する限り変更することはできません。ただし、削除されたレコードの_idの値は再利用されます。
-
-``_key``
-
-  レコードの主キー値を表します。主キーを持つテーブルのみに定義されます。主キー値はテーブルの中で一意であり、変更することはできません。
-
-``_value``
-
-  レコードの値を表します。value_typeを指定したテーブルのみに定義されます。自由に変更可能です。
-
-``_score``
-
-  各レコードのスコア値を表します。検索結果として生成されたテーブルのみに定義されます。
-
-  検索処理を実行する過程で値が設定されますが、自由に変更可能です。
-
-``_nsubrecs``
-
-  主キーの値が同一であったレコードの件数を表します。検索結果として生成されたテーブルのみに定義されます。グループ化(drilldown)処理を実行すると、グループ化前のテーブルにおいて、グループ化キーの値が同一であったレコードの件数が、グループ化処理の結果を格納するテーブルの_nsubrecsに記録されます。