null+****@clear*****
null+****@clear*****
2012年 7月 23日 (月) 15:10:10 JST
Kouhei Sutou 2012-07-23 15:10:10 +0900 (Mon, 23 Jul 2012) New Revision: e063a129ccba05752aeb32acfbad70412492aed4 https://github.com/groonga/groonga/commit/e063a129ccba05752aeb32acfbad70412492aed4 Log: doc: fix path Modified files: doc/source/install/others.txt doc/source/install/windows.txt doc/source/news.txt doc/source/news/0.x.txt doc/source/news/1.0.x.txt doc/source/news/1.1.x.txt doc/source/news/1.2.x.txt doc/source/reference.txt doc/source/reference/commands/select.txt doc/source/reference/commands/suggest.txt doc/source/reference/executables/grntest.txt doc/source/reference/executables/groonga-http.txt doc/source/reference/functions/geo_distance.txt doc/source/reference/grn_expr.txt doc/source/reference/grn_expr/query_syntax.txt doc/source/reference/type.txt doc/source/spec/search.txt doc/source/suggest/completion.txt doc/source/suggest/correction.txt doc/source/suggest/suggestion.txt doc/source/troubleshooting/different_results_with_the_same_keyword.txt doc/source/tutorial/data.txt doc/source/tutorial/introduction.txt doc/source/tutorial/network.txt doc/source/tutorial/query_expansion.txt doc/source/tutorial/search.txt Modified: doc/source/install/others.txt (+3 -3) =================================================================== --- doc/source/install/others.txt 2012-07-23 14:37:29 +0900 (966e35c) +++ doc/source/install/others.txt 2012-07-23 15:10:10 +0900 (df24be9) @@ -60,7 +60,7 @@ All libraries are optional. Here are optional libraries: * `MessagePack <http://msgpack.org/>`_ for supporting MessagePack output and :doc:`/suggest` * `libedit <http://www.thrysoee.dk/editline/>`_ for command line - editing in :doc:`/executables/groonga` + editing in :doc:`/reference/executables/groonga` * `zlib <http://zlib.net/>`_ for compressing column value * `LZO <http://www.oberhumer.com/opensource/lzo/>`_ for compressing column value @@ -81,7 +81,7 @@ steps:: % make % sudo make install -After the above steps, :doc:`/executables/groonga` is found in +After the above steps, :doc:`/reference/executables/groonga` is found in ``/usr/local/bin/groonga``. The default build will work well but you can customize groonga at @@ -103,7 +103,7 @@ options: Specifies the install base directory. Groonga related files are installed under ``${PATH}/`` directory. -The default is ``/usr/local``. In this case, :doc:`/executables/groonga` is +The default is ``/usr/local``. In this case, :doc:`/reference/executables/groonga` is installed into ``/usr/local/bin/groonga``. Here is an example that installs groonga into ``~/local`` for an user Modified: doc/source/install/windows.txt (+3 -3) =================================================================== --- doc/source/install/windows.txt 2012-07-23 14:37:29 +0900 (1e367d5) +++ doc/source/install/windows.txt 2012-07-23 15:10:10 +0900 (be9b613) @@ -25,7 +25,7 @@ For 64-bit environment, download `groonga-2.0.5-x64.exe <http://packages.groonga.org/windows/groonga/groonga-2.0.5-x64.exe>`_ and run it. -Use command prompt for :doc:`/executables/groonga` installed in start menu. +Use command prompt for :doc:`/reference/executables/groonga` installed in start menu. zip --- @@ -38,7 +38,7 @@ For 64-bit environment, download `groonga-2.0.5-x64.zip <http://packages.groonga.org/windows/groonga/groonga-2.0.5-x64.zip>`_ and extract it. -:doc:`/executables/groonga` is in ``bin`` folder. +:doc:`/reference/executables/groonga` is in ``bin`` folder. Build from source ----------------- @@ -73,5 +73,5 @@ Install:: groonga-2.0.5> devenv groonga.sln /Build Release /Project Install -After the above steps, :doc:`/executables/groonga` is found in +After the above steps, :doc:`/reference/executables/groonga` is found in ``c:\groonga\bin\groonga.exe``. Modified: doc/source/news.txt (+1 -1) =================================================================== --- doc/source/news.txt 2012-07-23 14:37:29 +0900 (6041c84) +++ doc/source/news.txt 2012-07-23 15:10:10 +0900 (3e59e45) @@ -109,7 +109,7 @@ Improvements * [doc] Added about release procedure. * Removed restriction that the max number of opened files is 4096. * [experimental] Added table plugin. -* [doc] Added more descriptions about :doc:`/commands/select` command. +* [doc] Added more descriptions about :doc:`/reference/commands/select` command. * [doc] Made execution example copy & paste friendly. * [windows] Supported build with Visual Studio 2010 Express and CMake. See :doc:`/install/windows` about details. Modified: doc/source/news/0.x.txt (+3 -3) =================================================================== --- doc/source/news/0.x.txt 2012-07-23 14:37:29 +0900 (da02ecc) +++ doc/source/news/0.x.txt 2012-07-23 15:10:10 +0900 (0e4d666) @@ -12,11 +12,11 @@ ^^^^ * 編集距離（レーベンシュタイン距離）を計算する - :doc:`/functions/edit_distance` ()関数の追加。 + :doc:`/reference/functions/edit_distance` ()関数の追加。 * manを追加。 -* :doc:`/commands/delete` コマンドでデータの整合性が壊れる場合はエラー +* :doc:`/reference/commands/delete` コマンドでデータの整合性が壊れる場合はエラー を返すようにした。 * MeCabの辞書のエンコーディング検出処理を改善。 @@ -26,7 +26,7 @@ 修正 ^^^^ -* :doc:`/functions/geo_in_rectangle` ()関数が引数を「左上」と「右下」で +* :doc:`/reference/functions/geo_in_rectangle` ()関数が引数を「左上」と「右下」で はなく、「左下」と「右上」と扱っていた問題を修正。 * 前方一致検索がマッチしない問題を修正。 Modified: doc/source/news/1.0.x.txt (+16 -16) =================================================================== --- doc/source/news/1.0.x.txt 2012-07-23 14:37:29 +0900 (3be5a1a) +++ doc/source/news/1.0.x.txt 2012-07-23 15:10:10 +0900 (8889a45) @@ -31,11 +31,11 @@ * エラーメッセージをわかりやすくした。 * --enable-memory-debug付きでビルドしたときに終了時に未開放のメモリが 割り当てられた場所を表示するようにした。 -* ベクタの値を :doc:`/commands/load` するときにキャストに失敗したら、そ +* ベクタの値を :doc:`/reference/commands/load` するときにキャストに失敗したら、そ のことを報告するようにした。 * groongaのメモリリークを検出するユーティリティツール groonga-check-memory-leak.rbを追加。（インストールはされない。） -* :doc:`/commands/dump` がテーブル単位のダンプに対応。 +* :doc:`/reference/commands/dump` がテーブル単位のダンプに対応。 修正 ^^^^ @@ -45,7 +45,7 @@ * Mac OS Xではrealloc(ptr, 0)ではなくfree()を使うように修正。 * grntestで結果の比較が常に失敗していた問題を修正。 * groonga-suggest-learnerのメモリリークを修正。 -* :doc:`/commands/load` 時のメモリリークを修正。 +* :doc:`/reference/commands/load` 時のメモリリークを修正。 （Kenichi Aramakiさんが報告） * ベクタの値を出力するときのメモリリークを修正。 @@ -76,7 +76,7 @@ * サジェスト機能用の学習プログラムを追加。 * groongaスクリプト内での行コメントに対応。（「#」以降を無視） #723 -* :doc:`/commands/column_list` のXML出力対応。 #748 +* :doc:`/reference/commands/column_list` のXML出力対応。 #748 * 主キーが数値のテーブルを参照しているカラムでの比較演算に対応。 #776 * grntestがmlockの情報出力に対応。 * NetBSDでのビルドに対応。 （OBATA Akioさんがパッチ作成） @@ -87,19 +87,19 @@ 変更 ^^^^ -* :doc:`/commands/table_list` のXML出力のタグ名をより適切な名前に変更。 #757 +* :doc:`/reference/commands/table_list` のXML出力のタグ名をより適切な名前に変更。 #757 修正 ^^^^ -* :doc:`/commands/load` で存在しないカラムを--columnsで指定するとクラッシュする問題を修正。 +* :doc:`/reference/commands/load` で存在しないカラムを--columnsで指定するとクラッシュする問題を修正。 （Masahiro Tomitaさんが報告） #751 -* :doc:`/commands/load` で配列でTABLE_NO_KEYなテーブルにレコードをロードできない問題を修正。 +* :doc:`/reference/commands/load` で配列でTABLE_NO_KEYなテーブルにレコードをロードできない問題を修正。 （Masahiro Tomitaさんが報告） #750 -* :doc:`/commands/delete` でTABLE_NO_KEYなテーブルのレコードを削除するとテーブルが壊れる +* :doc:`/reference/commands/delete` でTABLE_NO_KEYなテーブルのレコードを削除するとテーブルが壊れる 問題を修正。 （Masahiro Tomitaさんがパッチ作成） #794 -* :doc:`/commands/load` で不正なJSONを指定した場合にそれ以降コマンドを受け付けなくなる +* :doc:`/reference/commands/load` で不正なJSONを指定した場合にそれ以降コマンドを受け付けなくなる 問題を修正。 #807 感謝 @@ -116,8 +116,8 @@ * すべてのモジュールで同じ名前の関数をエクスポートするようにした。#624 * 不正な名前を指定したときに指定された名前も報告するようにした。 -* :doc:`/commands/select` の--filter内での数値比較演算をサポート。 （@s3kiさんが報告） -* :doc:`/executables/grntest` の一行あたりの最大バイト数の制限を撤廃。 #608, #690 +* :doc:`/reference/commands/select` の--filter内での数値比較演算をサポート。 （@s3kiさんが報告） +* :doc:`/reference/executables/grntest` の一行あたりの最大バイト数の制限を撤廃。 #608, #690 * Int8/UInt8/Int16/UInt16の等値比較にC言語の比較演算子を使用。 #660 * HTTP経由で存在しないパスにアクセスした時に存在しないパスを報告するように した。 @@ -219,13 +219,13 @@ 改良 ^^^^ -* :doc:`/commands/suggest` コマンドのサンプルを追加。（examples/dictionary/） +* :doc:`/reference/commands/suggest` コマンドのサンプルを追加。（examples/dictionary/） 変更 ^^^^ * HTTPで公開するディレクトリを指定する--admin-html-pathを--document-rootに変更。 -* :doc:`/commands/select` コマンドのデフォルトの--output_columnsから_valueを削除。 +* :doc:`/reference/commands/select` コマンドのデフォルトの--output_columnsから_valueを削除。 修正 ^^^^ @@ -270,9 +270,9 @@ 改良 ^^^^ -* 指定したクエリに対する補完・修正・提案を行う :doc:`/commands/suggest` コマンドを追加。 +* 指定したクエリに対する補完・修正・提案を行う :doc:`/reference/commands/suggest` コマンドを追加。 -* :doc:`/commands/delete` コマンドが失敗したらfalseを返すように変更。（Itagaki Takahiroさんが提案） +* :doc:`/reference/commands/delete` コマンドが失敗したらfalseを返すように変更。（Itagaki Takahiroさんが提案） 修正 ^^^^ @@ -281,7 +281,7 @@ * 索引付きカラムを等価条件で検索できない問題を修正。 -* :doc:`/commands/delete` コマンドでキーがShortText以外のレコードを削除できない問題の修正。（Itagaki Takahiroさんが報告） +* :doc:`/reference/commands/delete` コマンドでキーがShortText以外のレコードを削除できない問題の修正。（Itagaki Takahiroさんが報告） 感謝 ^^^^ Modified: doc/source/news/1.1.x.txt (+1 -1) =================================================================== --- doc/source/news/1.1.x.txt 2012-07-23 14:37:29 +0900 (35b8042) +++ doc/source/news/1.1.x.txt 2012-07-23 15:10:10 +0900 (1343314) @@ -14,7 +14,7 @@ * TokenDelimitNullトークナイザーを追加。 * プラグイン登録APIの名前を改良。 grn_db_register_by_name() -> grn_plugin_register() #834 -* :doc:`/commands/select` の--query内で前方一致検索構文"キーワード*"対応。 #837 +* :doc:`/reference/commands/select` の--query内で前方一致検索構文"キーワード*"対応。 #837 * groonga.pcにgroonga-suggest-create-datasetのパスが設定されている groonga_suggest_create_dataset変数を追加。 Modified: doc/source/news/1.2.x.txt (+16 -16) =================================================================== --- doc/source/news/1.2.x.txt 2012-07-23 14:37:29 +0900 (f834365) +++ doc/source/news/1.2.x.txt 2012-07-23 15:10:10 +0900 (ed298fd) @@ -21,10 +21,10 @@ Improvements * Added ``grn_obj_get_values()``. * Added ``grn_obj_delete_by_id()``. * Supported string vector column for query expansion. [#1216] -* Added ``--filter`` option to :doc:`/commands/delete` to delete +* Added ``--filter`` option to :doc:`/reference/commands/delete` to delete many record at once. [#1225] * Supported approximate type customization for - :doc:`/functions/geo_in_circle` and :doc:`/functions/geo_distance`. [#1226] + :doc:`/reference/functions/geo_in_circle` and :doc:`/reference/functions/geo_distance`. [#1226] * Made ``geo_distance2()`` and ``geo_distance3()`` are deprecated. * Changed to use ``null`` instead of ``""`` for empty geo point value in JSON output. @@ -162,9 +162,9 @@ Improvements * Added geo point value validation on type cast. * Supported :doc:`/tutorial/query_expansion`. * Added `--query_expansion` option to - :doc:`/commands/select` for query expansion. + :doc:`/reference/commands/select` for query expansion. * Added geometry conversion macro between degree and msec. -* Supported type cast in :doc:`/functions/geo_distance` (). +* Supported type cast in :doc:`/reference/functions/geo_distance` (). * Don't split tokens with full width space in command line. #986 * Supported conversion between TokyoGeoPoint and WGS84GeoPoint. * Exported grn_geo_select_in_circle() and grn_geo_select_in_rectangle(). @@ -193,11 +193,11 @@ Improvements * Added experimental Windows installer support. * Accepted "#" and "-" as a valid name characters. #1043 * Accepted all valid characters except "_" as the first character. #1043 -* Supported `--each` for `[...]` form :doc:`/commands/load`. #1044 +* Supported `--each` for `[...]` form :doc:`/reference/commands/load`. #1044 * Added documentation for :doc:`/suggest`. * Supported threshold as `--frequency_threshold` and `--conditional_probability_threshold` options in all - :doc:`/commands/suggest` types. #1042 + :doc:`/reference/commands/suggest` types. #1042 * [groonga-suggest-httpd] Supported log reopen by SIGUSR1. #1048 * Supported string input for reference vector column value. #1051 * [groonga-suggest-httpd] Added `--n-lines-per-log-file` @@ -211,7 +211,7 @@ Fixes ^^^^^ * Fixed a crash bug that invalid value is passed as match expression - argument in :doc:`/commands/select`. #1047 + argument in :doc:`/reference/commands/select`. #1047 * Fixed a bug that hash table cursor returns garbage records. .. _release-1-2-4: @@ -225,8 +225,8 @@ Improvements * Re-supported ``*BSD``. (Reported by OBATA Akio) * Improved sed related portability. (Suggested by OBATA Akio) * Re-supported Visual C++ 2008. -* Supported :doc:`/commands/check` for hash table. -* Ignored invalid _score in --sortby of :doc:`/commands/select` +* Supported :doc:`/reference/commands/check` for hash table. +* Ignored invalid _score in --sortby of :doc:`/reference/commands/select` for convenience. #1030 * Added document about :doc:`/log`. * Supported ~/.editrc. @@ -261,7 +261,7 @@ Improvements * Added groonga-query-log-analyzer that analyze query log. * groonga command shows failed command on error. * groonga command shows file name and line no on error. -* Improved error message of :doc:`/commands/column_create`. #952 +* Improved error message of :doc:`/reference/commands/column_create`. #952 * Added GRN_OBJ_TABLE_DAT_KEY, double array trie, table. (experimental) Fixes @@ -304,7 +304,7 @@ Improvements * plugin: Added grn_plugin_get_system_plugins_dir() and grn_plugin_get_suffix() API. * Added grn_obj_is_builtin() API. -* :doc:`/commands/load`: Added table name check. #934 +* :doc:`/reference/commands/load`: Added table name check. #934 * Showed invalid name context in error message. #935 Fixes @@ -365,14 +365,14 @@ Fixes * MeCabトークナイザーの読み込みに失敗したときにクラッシュする問題を修正。 （@tomotaka_itoさんが報告） * [非互換] 位置情報の小数表記からミリ秒への変換誤差が大きい問題を修正。 -* :doc:`/functions/geo_in_rectangle` の ``top_left`` と +* :doc:`/reference/functions/geo_in_rectangle` の ``top_left`` と ``bottom_right`` に同じ位置を指定するとクラッシュする問題を修正。 * メモリリークを修正。 * 小数形式のTimeリテラルをロードするとミリ秒情報が落ちる問題を修正。 #880 -* :doc:`/commands/column_list` のドキュメントを修正。 #758 -* :doc:`/commands/table_list` のドキュメントを修正。 -* :doc:`/commands/load` で_valueを指定するとメモリリークする問題を修正。 #878 -* :doc:`/commands/load` でクラッシュする問題を修正。 #661 +* :doc:`/reference/commands/column_list` のドキュメントを修正。 #758 +* :doc:`/reference/commands/table_list` のドキュメントを修正。 +* :doc:`/reference/commands/load` で_valueを指定するとメモリリークする問題を修正。 #878 +* :doc:`/reference/commands/load` でクラッシュする問題を修正。 #661 実験的 ^^^^^^ Modified: doc/source/reference.txt (+1 -0) =================================================================== --- doc/source/reference.txt 2012-07-23 14:37:29 +0900 (d7e7552) +++ doc/source/reference.txt 2012-07-23 15:10:10 +0900 (f1aa068) @@ -10,6 +10,7 @@ reference/executables reference/output + reference/command_version reference/commands reference/type reference/tokenizers Modified: doc/source/reference/commands/select.txt (+7 -7) =================================================================== --- doc/source/reference/commands/select.txt 2012-07-23 14:37:29 +0900 (eabeb01) +++ doc/source/reference/commands/select.txt 2012-07-23 15:10:10 +0900 (511a570) @@ -427,12 +427,12 @@ The first ``select`` command searches records that contain a word records are matched because the ``TokenBigram`` tokenizer tokenizes ``groonga`` to ``groonga`` not ``gr|ro|oo|on|ng|ga``. (The ``TokenBigramSplitSymbolAlpha`` tokenizer tokenizes ``groonga`` to -``gr|ro|oo|on|ng|ga``. See :doc:`/tokenizers` for details.) It means -that ``groonga`` is indexed but ``groo`` isn't indexed. So no records -are matched against ``groo`` by exact match. In the case, the search -storategy escalation is used because the number of matched records (0) -is equal to ``match_escalation_threshold`` (0). One record is matched -against ``groo`` by unsplit search. +``gr|ro|oo|on|ng|ga``. See :doc:`/reference//tokenizers` for details.) +It means that ``groonga`` is indexed but ``groo`` isn't indexed. So no +records are matched against ``groo`` by exact match. In the case, the +search storategy escalation is used because the number of matched +records (0) is equal to ``match_escalation_threshold`` (0). One record +is matched against ``groo`` by unsplit search. The second ``select`` command also searches records that contain a word ``groo`` in ``content`` column value from ``Entries`` table. And @@ -552,7 +552,7 @@ The ``select`` command just outputs ``_id`` and ``_key`` column values. ``*`` is a special value. It means that all columns that are not -:doc:`/pseudo_column`. +:doc:`/reference/pseudo_column`. Here is a ``*`` usage example. Modified: doc/source/reference/commands/suggest.txt (+1 -1) =================================================================== --- doc/source/reference/commands/suggest.txt 2012-07-23 14:37:29 +0900 (1af1115) +++ doc/source/reference/commands/suggest.txt 2012-07-23 15:10:10 +0900 (364bd93) @@ -267,4 +267,4 @@ SEE ALSO -------- * :doc:`/suggest` -* :doc:`/executables/groonga-suggest-create-dataset` +* :doc:`/reference/executables/groonga-suggest-create-dataset` Modified: doc/source/reference/executables/grntest.txt (+1 -1) =================================================================== --- doc/source/reference/executables/grntest.txt 2012-07-23 14:37:29 +0900 (3f244de) +++ doc/source/reference/executables/grntest.txt 2012-07-23 15:10:10 +0900 (f0e0a81) @@ -134,7 +134,7 @@ grntest命令 コマンドファイル ^^^^^^^^^^^^^^^^ -コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては :doc:`/commands` を参照してください。 +コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては :doc:`/reference/commands` を参照してください。 サンプル ^^^^^^^^ Modified: doc/source/reference/executables/groonga-http.txt (+1 -1) =================================================================== --- doc/source/reference/executables/groonga-http.txt 2012-07-23 14:37:29 +0900 (23de8d0) +++ doc/source/reference/executables/groonga-http.txt 2012-07-23 15:10:10 +0900 (c3f89f6) @@ -50,7 +50,7 @@ GETメソッドのみが使用可能です。 output_typeにはjson, tsv, xmlが指定可能です。 -command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`/command_version` を参照してください。 +command_versionはコマンドの仕様の互換性を指定します。詳細は :doc:`/reference/command_version` を参照してください。 返値 ---- Modified: doc/source/reference/functions/geo_distance.txt (+2 -2) =================================================================== --- doc/source/reference/functions/geo_distance.txt 2012-07-23 14:37:29 +0900 (a629ee5) +++ doc/source/reference/functions/geo_distance.txt 2012-07-23 15:10:10 +0900 (16b6a4e) @@ -106,7 +106,7 @@ you want to calculate the value of distance between two points. You can specify the value of GeoPoint type. [#]_ -See :doc:`/type` about GeoPoint. +See :doc:`/reference/type` about GeoPoint. ``point2`` """""""""" @@ -117,7 +117,7 @@ you want to calculate the value of distance between two points. You can specify the value of GeoPoint type or the string indicating the coordinate. -See :doc:`/type` about GeoPoint and the coordinate. +See :doc:`/reference/type` about GeoPoint and the coordinate. Optional parameter ^^^^^^^^^^^^^^^^^^ Modified: doc/source/reference/grn_expr.txt (+2 -2) =================================================================== --- doc/source/reference/grn_expr.txt 2012-07-23 14:37:29 +0900 (e024939) +++ doc/source/reference/grn_expr.txt 2012-07-23 15:10:10 +0900 (e2f8395) @@ -30,13 +30,13 @@ 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:`/commands/select`. +: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:`/commands/select`. +``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 Modified: doc/source/reference/grn_expr/query_syntax.txt (+7 -7) =================================================================== --- doc/source/reference/grn_expr/query_syntax.txt 2012-07-23 14:37:29 +0900 (12395dc) +++ doc/source/reference/grn_expr/query_syntax.txt 2012-07-23 15:10:10 +0900 (5f2eba7) @@ -17,7 +17,7 @@ groogna searches records that contain either ``word1`` or ``word2``. Query syntax consists of ``conditional expression``, ``combind expression`` and ``assignment expression``. Nomrally ``assignment expression`` can be ignored. Because ``assignment expression`` is -disabled in ``--query`` option of :doc:`/commands/select`. You can use +disabled in ``--query`` option of :doc:`/reference/commands/select`. You can use it if you use groonga as library and customize query syntax parser options. @@ -113,7 +113,7 @@ target columns. You should specify the default match columns for full text search. They can be specified by ``--match_columns`` option of -:doc:`/commands/select`. If you don't specify the default match +:doc:`/reference/commands/select`. If you don't specify the default match columns, this conditional expression fails. This conditional expression does full text search with @@ -146,7 +146,7 @@ against the default match columns. You should specify the default match columns for full text search. They can be specified by ``--match_columns`` option of -:doc:`/commands/select`. If you don't specify the default match +:doc:`/reference/commands/select`. If you don't specify the default match columns, this conditional expression fails. This conditional expression does phrase search with ``search @@ -176,7 +176,7 @@ Its syntax is ``column:@keyword``. It's similar to ``full text search condition`` but it doesn't require the default match columns. You need to specify match column for the full text search condition by ``column:`` instead of -``--match_columns`` option of :doc:`/commands/select`. +``--match_columns`` option of :doc:`/reference/commands/select`. This condtional expression is useful when you want to use two or more full text search against different columns. The default match columns @@ -196,7 +196,7 @@ the following features: * Using index column as a match column is supported. See description of ``--match_columns`` option of -:doc:`/commands/select` about them. +:doc:`/reference/commands/select` about them. Here is a simple exmaple. @@ -215,7 +215,7 @@ Its syntax is ``column:@"search keyword"``. It's similar to ``phrase search condition`` but it doesn't require the default match columns. You need to specify match column for the phrase search condition by ``column:`` instead of ``--match_columns`` option -of :doc:`/commands/select`. +of :doc:`/reference/commands/select`. The different between ``phrase search condition`` and ``phrase search condition (with explicit match column)`` is similar to between ``full @@ -564,7 +564,7 @@ Assignment expression --------------------- This section is for advanced users. Because assignment expression is -disabled in ``--query`` option of :doc:`/commands/select`. You need to +disabled in ``--query`` option of :doc:`/reference/commands/select`. You need to use groonga as a library instead of server or command line tool for assignment expression. Modified: doc/source/reference/type.txt (+4 -4) =================================================================== --- doc/source/reference/type.txt 2012-07-23 14:37:29 +0900 (771614e) +++ doc/source/reference/type.txt 2012-07-23 15:10:10 +0900 (7d138ee) @@ -36,7 +36,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの ブーリアン型やブール型などと呼ばれる型であり、真偽値を表します。取り得る値はtrueとfalseです。（デフォルト値: false） - :doc:`/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。 + :doc:`/reference/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。 ``Int8`` @@ -80,7 +80,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの 日時を表す型であり、1970年1月1日0時0分0秒からの経過時間を、マイクロ秒単位で64bit符号付き整数により表現します。（デフォルト値: 0） - :doc:`/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。 + :doc:`/reference/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。 ``ShortText`` @@ -99,7 +99,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの 旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） 度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。 - :doc:`/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。 + :doc:`/reference/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。 測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。 @@ -107,7 +107,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの 世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） - 度分秒形式からミリ秒形式への変換方法や :doc:`/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。 + 度分秒形式からミリ秒形式への変換方法や :doc:`/reference/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。 型に関する制限事項 ------------------ Modified: doc/source/spec/search.txt (+1 -1) =================================================================== --- doc/source/spec/search.txt 2012-07-23 14:37:29 +0900 (a66971d) +++ doc/source/spec/search.txt 2012-07-23 15:10:10 +0900 (12440cf) @@ -5,7 +5,7 @@ 検索 ==== -:doc:`/commands/select` コマンドがqueryパラメータを使ってどのように検索するのかを説明します。 +:doc:`/reference/commands/select` コマンドがqueryパラメータを使ってどのように検索するのかを説明します。 検索の挙動 ---------- Modified: doc/source/suggest/completion.txt (+1 -1) =================================================================== --- doc/source/suggest/completion.txt 2012-07-23 14:37:29 +0900 (e5599ff) +++ doc/source/suggest/completion.txt 2012-07-23 15:10:10 +0900 (faa809e) @@ -153,7 +153,7 @@ How to use .. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"} .. ] -Groonga provides :doc:`/commands/suggest` command to use +Groonga provides :doc:`/reference/commands/suggest` command to use completion. `--type complete` option requests completion. For example, here is an command to get completion results by Modified: doc/source/suggest/correction.txt (+2 -2) =================================================================== --- doc/source/suggest/correction.txt 2012-07-23 14:37:29 +0900 (50d1a9d) +++ doc/source/suggest/correction.txt 2012-07-23 15:10:10 +0900 (0a8907a) @@ -66,7 +66,7 @@ Similar search Similar search can find registered words that has one or more the same tokens as user input. TokenBigram tokenizer is used for tokenization because suggest dataset schema -created by :doc:`/executables/groonga-suggest-create-dataset` +created by :doc:`/reference/executables/groonga-suggest-create-dataset` uses TokenBigram tokenizer as the default tokenizer. For example, there is a registered query "search engine". An @@ -101,7 +101,7 @@ How to use .. {"sequence": "1", "time": 1312950810.86057, "item": "search", "type": "submit"} .. ] -Groonga provides :doc:`/commands/suggest` command to use +Groonga provides :doc:`/reference/commands/suggest` command to use correction. `--type correct` option requests corrections. For example, here is an command to get correction results by Modified: doc/source/suggest/suggestion.txt (+1 -1) =================================================================== --- doc/source/suggest/suggestion.txt 2012-07-23 14:37:29 +0900 (82f459c) +++ doc/source/suggest/suggestion.txt 2012-07-23 15:10:10 +0900 (18dda55) @@ -81,7 +81,7 @@ How to use .. {"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"} .. ] -Groonga provides :doc:`/commands/suggest` command to use +Groonga provides :doc:`/reference/commands/suggest` command to use suggestion. `--type suggest` option requests suggestion For example, here is an command to get suggestion results by Modified: doc/source/troubleshooting/different_results_with_the_same_keyword.txt (+1 -1) =================================================================== --- doc/source/troubleshooting/different_results_with_the_same_keyword.txt 2012-07-23 14:37:29 +0900 (e7c27e5) +++ doc/source/troubleshooting/different_results_with_the_same_keyword.txt 2012-07-23 15:10:10 +0900 (be9cc40) @@ -81,7 +81,7 @@ groongaは完全一致検索した結果のヒット件数が所定の閾値を TokenMecabトークナイザーは事前に準備した辞書を用いてトークナイズするため、再現率よりも適合率を重視したトークナイザーと言えます。一方、TokenBigramなど、N-gram系のトークナイザーは適合率を重視したトークナイザーと言えます。例えば、TokenMecabの場合「東京都」で「京都」に完全一致することはありませんが、TokenBigramでは完全一致します。一方、TokenMecabでは「東京都民」に完全一致しませんが、TokenBigramでは完全一致します。 -このようにN-gram系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには :doc:`/commands/select` のmatch_columnsで使用する索引毎に重み付けを指定します。 +このようにN-gram系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには :doc:`/reference/commands/select` のmatch_columnsで使用する索引毎に重み付けを指定します。 ここでも、前述の例を使って具体例を示します。まず、TokenBigramを用いた索引を追加します。:: Modified: doc/source/tutorial/data.txt (+11 -11) =================================================================== --- doc/source/tutorial/data.txt 2012-07-23 14:37:29 +0900 (368cc09) +++ doc/source/tutorial/data.txt 2012-07-23 15:10:10 +0900 (b216f2e) @@ -15,7 +15,7 @@ Groonga is a full text search engine but also serves as a column-oriented data s Overview -------- -The basic data types of groonga are roughly divided into 5 groups --- boolean type, numeric types, string types, date/time type and longitude/latitude types. The numeric types are further divided according to whether integer or floating point number, signed or unsigned and the number of bits allocated to each integer. The string types are further divided according to the maximum length. The longitude/latitude types are further divided according to the geographic coordinate system. For more details, see :doc:`/type`. +The basic data types of groonga are roughly divided into 5 groups --- boolean type, numeric types, string types, date/time type and longitude/latitude types. The numeric types are further divided according to whether integer or floating point number, signed or unsigned and the number of bits allocated to each integer. The string types are further divided according to the maximum length. The longitude/latitude types are further divided according to the geographic coordinate system. For more details, see :doc:`/reference/type`. In addition, groonga supports reference types and vector types. Reference types are designed for accessing other tables. Vector types are designed for storing a variable number of values in one element. @@ -28,7 +28,7 @@ First, let's create a table for this tutorial. Boolean type ------------ -The boolean type is used to store true or false. To create a boolean type column, specify Bool to the `type` parameter of :doc:`/commands/column_create` command. The default value of the boolean type is false. +The boolean type is used to store true or false. To create a boolean type column, specify Bool to the `type` parameter of :doc:`/reference/commands/column_create` command. The default value of the boolean type is false. The following example creates a boolean type column and adds three records. Note that the third record has the default value because no value is specified. @@ -46,9 +46,9 @@ The following example creates a boolean type column and adds three records. Note Numeric types ------------- -The numeric types are divided into integer types and a floating point number type. The integer types are further divided into the signed integer types and unsigned integer types. In addition, you can choose the number of bits allocated to each integer. For more details, see :doc:`/type`. The default value of the numeric types is 0. +The numeric types are divided into integer types and a floating point number type. The integer types are further divided into the signed integer types and unsigned integer types. In addition, you can choose the number of bits allocated to each integer. For more details, see :doc:`/reference/type`. The default value of the numeric types is 0. -The following example creates an Int8 column and a Float column, and then updates existing records. The :doc:`/commands/load` command updates the weight column as expected. On the other hand, the price column values are different from the specified values because 15.9 is not an integer and 200 is too large. 15.9 is converted to 15 by removing the fractional part. 200 causes an overflow and the result becomes -56. Note that the result of an overflow/underflow is undefined. +The following example creates an Int8 column and a Float column, and then updates existing records. The :doc:`/reference/commands/load` command updates the weight column as expected. On the other hand, the price column values are different from the specified values because 15.9 is not an integer and 200 is too large. 15.9 is converted to 15 by removing the fractional part. 200 causes an overflow and the result becomes -56. Note that the result of an overflow/underflow is undefined. .. groonga-command .. include:: ../example/tutorial/data-3.log @@ -65,7 +65,7 @@ The following example creates an Int8 column and a Float column, and then update String types ------------ -The string types are divided according to the maximum length. For more details, see :doc:`/type`. The default value is the zero-length string. +The string types are divided according to the maximum length. For more details, see :doc:`/reference/type`. The default value is the zero-length string. The following example creates a ShortText column and updates existing records. The third record has the default value because not updated. @@ -82,7 +82,7 @@ The following example creates a ShortText column and updates existing records. T Date and time type ------------------ -The date and time type of groonga is Time. Actually, a Time column stores a date and time as the number of microseconds since the Epoch, 1970-01-01 00:00:00. A Time value can represent a date and time before the Epoch because the actual data type is a signed integer. Note that :doc:`/commands/load` and :doc:`/commands/select` commands use a decimal number to represent a data and time in seconds. The default value is 0.0, which means the Epoch. +The date and time type of groonga is Time. Actually, a Time column stores a date and time as the number of microseconds since the Epoch, 1970-01-01 00:00:00. A Time value can represent a date and time before the Epoch because the actual data type is a signed integer. Note that :doc:`/reference//commands/load` and :doc:`/commands/select` commands use a decimal number to represent a data and time in seconds. The default value is 0.0, which means the Epoch. The following example creates a Time column and updates existing records. The first record has the default value because not updated. @@ -99,7 +99,7 @@ The following example creates a Time column and updates existing records. The fi Longitude and latitude types ---------------------------- -The longitude and latitude types are divided according to the geographic coordinate system. For more details, see :doc:`/type`. To represent a longitude and latitude, groonga uses a string formatted as follows: +The longitude and latitude types are divided according to the geographic coordinate system. For more details, see :doc:`/reference/type`. To represent a longitude and latitude, groonga uses a string formatted as follows: * "longitude x latitude" in milliseconds (e.g.: "128452975x503157902") * "longitude x latitude" in degrees (e.g.: "35.6813819x139.7660839") @@ -123,7 +123,7 @@ Reference types Groonga supports a reference column, which stores references to records in its associated table. In practice, a reference column stores the IDs of the referred records in the associated table and enables access to those records. -You can specify a column in the associated table to the `output_columns` parameter of a :doc:`/commands/select` command. The format is "Src.Dest" where Src is the name of the reference column and Dest is the name of the target column. If only the reference column is specified, it is handled as "Src._key". Note that if a reference does not point to a valid record, a :doc:`/commands/select` command outputs the default value of the target column. +You can specify a column in the associated table to the `output_columns` parameter of a :doc:`/reference/commands/select` command. The format is "Src.Dest" where Src is the name of the reference column and Dest is the name of the target column. If only the reference column is specified, it is handled as "Src._key". Note that if a reference does not point to a valid record, a :doc:`/reference/commands/select` command outputs the default value of the target column. The following example adds a reference column to the Site table that was created in the previous tutorial. The new column, named link, is designed for storing links among records in the Site table. @@ -134,12 +134,12 @@ The following example adds a reference column to the Site table that was created .. [{"_key":"http://example.org/","link":"http://example.net/"}] .. select --table Site --output_columns _key,title,link._key,link.title --query title:@this -The `type` parameter of the :doc:`/commands/column_create` command specifies the table to be associated with the reference column. In this example, the reference column is associated with the own table. Then, the :doc:`/commands/load` command registers a link from "http://example.org" to "http://example.net". Note that a reference column requires the primary key, not the ID, of the record to be referred to. After that, the link is confirmed by the :doc:`/commands/select` command. In this case, the primary key and the title of the referred record are output because link._key and link.title are specified to the `output_columns` parameter. +The `type` parameter of the :doc:`/reference/commands/column_create` command specifies the table to be associated with the reference column. In this example, the reference column is associated with the own table. Then, the :doc:`/reference/commands/load` command registers a link from "http://example.org" to "http://example.net". Note that a reference column requires the primary key, not the ID, of the record to be referred to. After that, the link is confirmed by the :doc:`/reference/commands/select` command. In this case, the primary key and the title of the referred record are output because link._key and link.title are specified to the `output_columns` parameter. Vector types ------------ -Groonga supports a vector column, in which each element can store a variable number of values. To create a vector column, specify the COLUMN_VECTOR flag to the `flags` parameter of a :doc:`/commands/column_create` command. A vector column is useful to represent a many-to-many relationship. +Groonga supports a vector column, in which each element can store a variable number of values. To create a vector column, specify the COLUMN_VECTOR flag to the `flags` parameter of a :doc:`/reference/commands/column_create` command. A vector column is useful to represent a many-to-many relationship. The previous example used a regular column, so each record could have at most one link. Obviously, the specification is insufficient because a site usually has more than one links. To solve this problem, the following example uses a vector column. @@ -152,4 +152,4 @@ The previous example used a regular column, so each record could have at most on .. [{"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]}] .. select --table Site --output_columns _key,title,links._key,links.title --query title:@this -The only difference at the first step is the `flags` parameter that specifies to create a vector column. The `type` parameter of the :doc:`/commands/column_create` command is the same as in the previous example. Then, the :doc:`/commands/load` command registers three links from "http://example.org/" to "http://example.net/", "http://example.org/" and "http://example.com/". After that, the links are confirmed by the :doc:`/commands/select` command. In this case, the primary keys and the titles are output as arrays because links._key and links.title are specified to the `output_columns` parameter. +The only difference at the first step is the `flags` parameter that specifies to create a vector column. The `type` parameter of the :doc:`/reference/commands/column_create` command is the same as in the previous example. Then, the :doc:`/reference/commands/load` command registers three links from "http://example.org/" to "http://example.net/", "http://example.org/" and "http://example.com/". After that, the links are confirmed by the :doc:`/reference/commands/select` command. In this case, the primary keys and the titles are output as arrays because links._key and links.title are specified to the `output_columns` parameter. Modified: doc/source/tutorial/introduction.txt (+23 -23) =================================================================== --- doc/source/tutorial/introduction.txt 2012-07-23 14:37:29 +0900 (7cc1770) +++ doc/source/tutorial/introduction.txt 2012-07-23 15:10:10 +0900 (b593067) @@ -42,7 +42,7 @@ DB_PATH specifies the path of a target database. This command fails if the speci If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and executes them one by one. This tutorial focuses on the interactive mode. -Let's see the status of a groonga process by using a :doc:`/commands/status` command. +Let's see the status of a groonga process by using a :doc:`/reference/commands/status` command. .. groonga-command .. include:: ../example/tutorial/introduction-2.log @@ -66,34 +66,34 @@ In the second form, you can specify a parameter name with its value. So, the ord If you want to specify a value which contains white-spaces or special characters, such as quotes and parentheses, please enclose the value with single-quotes or double-quotes. -For details, see also the paragraph of "command" in :doc:`/executables/groonga`. +For details, see also the paragraph of "command" in :doc:`/reference/executables/groonga`. Basic commands -------------- - :doc:`/commands/status` + :doc:`/reference/commands/status` shows status of a groonga process. - :doc:`/commands/table_list` + :doc:`/reference/commands/table_list` shows a list of tables in a database. - :doc:`/commands/column_list` + :doc:`/reference/commands/column_list` shows a list of columns in a table. - :doc:`/commands/table_create` + :doc:`/reference/commands/table_create` adds a table to a database. - :doc:`/commands/column_create` + :doc:`/reference/commands/column_create` adds a column to a table. - :doc:`/commands/select` + :doc:`/reference/commands/select` searches records from a table and shows the result. - :doc:`/commands/load` + :doc:`/reference/commands/load` inserts records to a table. Create a table -------------- -A :doc:`/commands/table_create` command creates a new table. +A :doc:`/reference/commands/table_create` command creates a new table. In most cases, a table has a primary key which must be specified with its data type and index type. -There are various data types such as integers, strings, etc. See also :doc:`/type` for more details. The index type determines the search performance and the availability of prefix searches. The details will be described later. +There are various data types such as integers, strings, etc. See also :doc:`/reference/type` for more details. The index type determines the search performance and the availability of prefix searches. The details will be described later. Let's create a table. The following example creates a table with a primary key. The `name` parameter specifies the name of the table. The `flags` parameter specifies the index type for the primary key. The `key_type` parameter specifies the data type of the primary key. @@ -106,20 +106,20 @@ The second element of the result indicates that the operation succeeded. View a table ------------ -A :doc:`/commands/select` command can enumerate records in a table. +A :doc:`/reference/commands/select` command can enumerate records in a table. .. groonga-command .. include:: ../example/tutorial/introduction-4.log .. select --table Site -When only a table name is specified with a `table` parameter, a :doc:`/commands/select` command returns the first (at most) 10 records in the table. [0] in the result shows the number of records in the table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named _id. ["_key","ShortText"] is a column of ShortText, named _key. +When only a table name is specified with a `table` parameter, a :doc:`/reference/commands/select` command returns the first (at most) 10 records in the table. [0] in the result shows the number of records in the table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named _id. ["_key","ShortText"] is a column of ShortText, named _key. The above two columns, _id and _key, are the necessary columns. The _id column stores IDs those are automatically allocated by groonga. The _key column is associated with the primary key. You are not allowed to rename these columns. Create a column --------------- -A :doc:`/commands/column_create` command creates a new column. +A :doc:`/reference/commands/column_create` command creates a new column. Let's add a column. The following example adds a column to the Site table. The `table` parameter specifies the target table. The `name` parameter specifies the name of the column. The `type` parameter specifies the data type of the column. @@ -131,7 +131,7 @@ Let's add a column. The following example adds a column to the Site table. The ` Load records ------------ -A :doc:`/commands/load` command loads JSON-formatted records into a table. +A :doc:`/reference/commands/load` command loads JSON-formatted records into a table. The following example loads nine records into the Site table. @@ -161,9 +161,9 @@ Let's make sure that these records are correctly stored. Get a record ------------ -A :doc:`/commands/select` command can search records in a table. +A :doc:`/reference/commands/select` command can search records in a table. -If a search condition is specified with a `query` parameter, a :doc:`/commands/select` command searches records matching the search condition and returns the matched records. +If a search condition is specified with a `query` parameter, a :doc:`/reference/commands/select` command searches records matching the search condition and returns the matched records. Let's get a record having a specified record ID. The following example gets the first record in the Site table. More precisely, the `query` parameter specifies a record whose _id column stores 1. @@ -190,7 +190,7 @@ The following shows a command which creates a lexicon table named Terms. The dat .. include:: ../example/tutorial/introduction-10.log .. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram -The :doc:`/commands/table_create` command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works. +The :doc:`/reference/commands/table_create` command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works. The TABLE_PAT_KEY flag specifies to store index terms in a patricia trie. The KEY_NORMALIZE flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The `default_tokenizer` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram. @@ -214,7 +214,7 @@ The `table` parameter specifies the index table and the `name` parameter specifi Full text search ---------------- -It's time. You can make full text search with a :doc:`/commands/select` command. +It's time. You can make full text search with a :doc:`/reference/commands/select` command. A query for full text search is specified with a `query` parameter. The following example searches records whose "title" column contains "this". The '@' specifies to make full text search. Note that a lower case query matches upper case and capitalized terms in a record if KEY_NORMALIZE was specified when creating a lexcon table. @@ -224,7 +224,7 @@ A query for full text search is specified with a `query` parameter. The followin In this example, the first record matches the query because its title contains "This", that is the capitalized form of the query. -A :doc:`/commands/select` command accepts an optional parameter, named `match_columns`, that specifies the default target columns. This parameter is used if target columns are not specified in a query. [#]_ +A :doc:`/reference/commands/select` command accepts an optional parameter, named `match_columns`, that specifies the default target columns. This parameter is used if target columns are not specified in a query. [#]_ The combination of "`--match_columns` title" and "`--query` this" brings you the same result that "`--query` title:@this" does. @@ -235,7 +235,7 @@ The combination of "`--match_columns` title" and "`--query` this" brings you the Specify output columns ---------------------- -An `output_columns` parameter of a :doc:`/commands/select` command specifies columns to appear in the search result. If you want to specify more than one columns, please separate column names by commas (','). +An `output_columns` parameter of a :doc:`/reference/commands/select` command specifies columns to appear in the search result. If you want to specify more than one columns, please separate column names by commas (','). .. groonga-command .. include:: ../example/tutorial/introduction-14.log @@ -246,7 +246,7 @@ This example specifies three output columns including the _score column, which s Specify output ranges --------------------- -A :doc:`/commands/select` command returns a part of its search result if `offset` and/or `limit` parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis. +A :doc:`/reference/commands/select` command returns a part of its search result if `offset` and/or `limit` parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis. An `offset` parameter specifies the starting point and a `limit` parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted. @@ -259,7 +259,7 @@ An `offset` parameter specifies the starting point and a `limit` parameter speci Sort a search result -------------------- -A :doc:`/commands/select` command sorts its result when used with a `sortby` parameter. +A :doc:`/reference/commands/select` command sorts its result when used with a `sortby` parameter. A `sortby` parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen ('-') to the column name in a parameter. Modified: doc/source/tutorial/network.txt (+1 -1) =================================================================== --- doc/source/tutorial/network.txt 2012-07-23 14:37:29 +0900 (a658a43) +++ doc/source/tutorial/network.txt 2012-07-23 15:10:10 +0900 (d6f19e4) @@ -74,7 +74,7 @@ In interactive mode, groonga reads commands from the standard input and executes How to terminate a gqtp server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You can terminate a gqtp server with a :doc:`/commands/shutdown` command. +You can terminate a gqtp server with a :doc:`/reference/commands/shutdown` command. .. groonga-command .. include:: ../example/tutorial/network-2.log Modified: doc/source/tutorial/query_expansion.txt (+1 -1) =================================================================== --- doc/source/tutorial/query_expansion.txt 2012-07-23 14:37:29 +0900 (909b90d) +++ doc/source/tutorial/query_expansion.txt 2012-07-23 15:10:10 +0900 (42dfdf4) @@ -8,7 +8,7 @@ クエリ拡張 ========== -groongaでは、 :doc:`/commands/select` コマンドにquery_expansionパラメータを指定することによって、ユーザが指定した検索文字列を適宜拡張することが可能です。 +groongaでは、 :doc:`/reference/commands/select` コマンドにquery_expansionパラメータを指定することによって、ユーザが指定した検索文字列を適宜拡張することが可能です。 たとえば、ユーザが'シークヮーサー'という文字列で検索した場合に、'シークヮーサー OR シークァーサー'で検索した場合と同一の結果を返すことによって、本来ユーザが必要とする結果をよりもれなく検索できるようになります。 Modified: doc/source/tutorial/search.txt (+3 -3) =================================================================== --- doc/source/tutorial/search.txt 2012-07-23 14:37:29 +0900 (9970501) +++ doc/source/tutorial/search.txt 2012-07-23 15:10:10 +0900 (cb4a3da) @@ -92,7 +92,7 @@ groongaでは、位置情報（経緯度）を保存することができます .. ] .. select --table Site --query "_id:1 OR _id:2" --output_columns _key,location -scorerパラメータにおいて、 :doc:`/functions/geo_distance` 関数を用いることにより、２点間の距離を計算することができます。 +scorerパラメータにおいて、 :doc:`/reference/functions/geo_distance` 関数を用いることにより、２点間の距離を計算することができます。 ここでは、秋葉原駅からの距離を表示させてみましょう。世界測地系では、秋葉原駅の位置は緯度が35度41分55.259秒、経度が139度46分27.188秒です。よって、geo_distance関数に与える文字列は"128515259x503187188"となります。 @@ -110,7 +110,7 @@ geo_distance関数は、_scoreを通じてソートでも用いることがで 「ある地点から何m以内に存在する」といった絞込も可能です。 -filterパラメータにおいて、 :doc:`/functions/geo_in_circle` 関数を用いることにより、２点間の距離が指定のm以下におさまるかどうかを判定することができます。 +filterパラメータにおいて、 :doc:`/reference/functions/geo_in_circle` 関数を用いることにより、２点間の距離が指定のm以下におさまるかどうかを判定することができます。 たとえば、秋葉原駅から5000m以内にあるレコードを検索してみましょう。 @@ -118,4 +118,4 @@ filterパラメータにおいて、 :doc:`/functions/geo_in_circle` 関数を .. include:: ../example/tutorial/search-7.log .. select --table Site --output_columns _key,location --filter 'geo_in_circle(location, "128515259x503187188", 5000)' -また、経緯度が指定の矩形領域内であるかどうかを判定する :doc:`../functions/geo_in_rectangle` 関数も存在します。 +また、経緯度が指定の矩形領域内であるかどうかを判定する :doc:`/reference/functions/geo_in_rectangle` 関数も存在します。 -------------- next part -------------- HTML$B$NE:IU%U%!%$%k$rJ]4I$7$^$7$?(B...下载
