naoa
null+****@clear*****
Tue Aug 12 08:24:09 JST 2014
naoa 2014-08-12 08:24:09 +0900 (Tue, 12 Aug 2014) New Revision: a1ada20fec587d3a6684e1bc83479e0f2da0e502 https://github.com/groonga/groonga/commit/a1ada20fec587d3a6684e1bc83479e0f2da0e502 Merged 13a8eb1: Merge pull request #189 from naoa/reformat-command-reference Message: doc: follow new markup guideline about check command documentation Modified files: doc/source/reference/commands/check.rst Modified: doc/source/reference/commands/check.rst (+50 -55) =================================================================== --- doc/source/reference/commands/check.rst 2014-08-11 19:53:30 +0900 (10574ea) +++ doc/source/reference/commands/check.rst 2014-08-12 08:24:09 +0900 (0b87964) @@ -2,39 +2,72 @@ .. highlightlang:: none -check -===== +``check`` +========= -名前 ----- +Summary +------- check - オブジェクトの状態表示 -書式 ----- +Groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。 + +checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い） + +Syntax +------ :: check obj -説明 ----- +Usage +----- -Groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。 +テーブルTermsのインデックスカラムnameの状態を表示します。:: -checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い） + check Terms.name + [{"flags":"00008202", + "max sid":1, + "number of garbage segments":0, + "number of array segments":1, + "max id of array segment":1, + "number of buffer segments":110, + "max id of buffer segment":111, + "max id of physical segment in use":111, + "number of unmanaged segments":4294967185, + "total chunk size":7470239, + "max id of chunk segments in use":127, + "number of garbage chunk":[0,0,0,0,0,0,0,0,2,2,0,0,0,0,0]}, + {"buffer id":0, + "chunk size":94392, + "buffer term":["596","59777","6",...], + "buffer free":152944, + "size in buffer":7361, + "nterms":237, + "nterms with chunk":216, + "buffer id":1, + "chunk size":71236, + "buffer term":[["に述",18149,18149,2,25,6,6], + ["に追",4505,4505,76,485,136,174], + ["に退",26568,26568,2,9,2,2], + ...], + "buffer free":120000, + "size in buffer":11155, + "nterms":121, + "nterms with chunk":116}, + {"buffer id":1, + ...}, + ...] -引数 ----- +Parameters +---------- ``obj`` 状態を表示するオブジェクトの名前を指定します。 -返値 ----- - -json形式 -^^^^^^^^ +Return value +------------ チェックするオブジェクトにより返される値が変わります。 @@ -126,41 +159,3 @@ json形式 バッファ内にある語のうち、チャンクを使っている語の数です。 -例 --- - -テーブルTermsのインデックスカラムnameの状態を表示します。:: - - check Terms.name - [{"flags":"00008202", - "max sid":1, - "number of garbage segments":0, - "number of array segments":1, - "max id of array segment":1, - "number of buffer segments":110, - "max id of buffer segment":111, - "max id of physical segment in use":111, - "number of unmanaged segments":4294967185, - "total chunk size":7470239, - "max id of chunk segments in use":127, - "number of garbage chunk":[0,0,0,0,0,0,0,0,2,2,0,0,0,0,0]}, - {"buffer id":0, - "chunk size":94392, - "buffer term":["596","59777","6",...], - "buffer free":152944, - "size in buffer":7361, - "nterms":237, - "nterms with chunk":216, - "buffer id":1, - "chunk size":71236, - "buffer term":[["に述",18149,18149,2,25,6,6], - ["に追",4505,4505,76,485,136,174], - ["に退",26568,26568,2,9,2,2], - ...], - "buffer free":120000, - "size in buffer":11155, - "nterms":121, - "nterms with chunk":116}, - {"buffer id":1, - ...}, - ...] -------------- next part -------------- HTML����������������������������...Download