rroonga 0.9.5-x86-mingw32 → 1.0.1-x86-mingw32

data/vendor/local/share/groonga/doc/ja/html/_sources/commands.txt

@@ -0,0 +1,10 @@
+.. highlightlang:: none
+
+組み込みコマンド一覧
+====================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   commands/*

data/vendor/local/share/groonga/doc/ja/html/_sources/commands/cache_limit.txt

@@ -0,0 +1,52 @@
+.. highlightlang:: none
+
+cache_limit
+===========
+
+名前
+----
+
+cache_limit - cacheサイズの設定・取得
+
+書式
+----
+::
+
+ cache_limit max
+
+説明
+----
+
+groonga組込コマンドの一つであるcache_limitについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+cache_limitは、クエリキャッシュの最大件数を取得したり設定したりします。
+
+引数
+----
+
+``max``
+
+  クエリキャッシュの最大件数を整数で指定します。
+  maxが指定されなかった場合には、クエリキャッシュの最大件数は変更せず、
+  現在の設定値のみが返されます。
+
+返値
+----
+
+json
+^^^^
+
+::
+
+ [以前の設定値]
+
+ ``以前の設定値``
+
+   すでに設定されていたクエリキャッシュの最大件数を返す。
+
+例
+--
+::
+
+ cache_limit 4
+ [100]

data/vendor/local/share/groonga/doc/ja/html/_sources/commands/check.txt

@@ -0,0 +1,164 @@
+.. highlightlang:: none
+
+check
+=====
+
+名前
+----
+
+check - オブジェクトの状態表示
+
+書式
+----
+::
+
+ check obj
+
+説明
+----
+
+groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い）
+
+引数
+----
+
+``obj``
+
+  状態を表示するオブジェクトの名前を指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+チェックするオブジェクトにより返される値が変わります。
+
+インデックスカラムの場合::
+
+  下記のような配列が出力されます。
+
+    [インデックスの状態, バッファの状態1, バッファの状態2, ...]
+
+  ``インデックスの状態``には下記の項目がハッシュ形式で出力されます。
+
+  ``flags``
+
+    指定されているフラグ値です。16進数で表現されています。
+
+  ``max sid``
+
+    セグメントのうち最も大きなIDです。
+
+  ``number of garbage segments``
+
+    ゴミセグメントの数です。
+
+  ``number of array segments``
+
+    配列セグメントの数です。
+
+  ``max id of array segment``
+
+    配列セグメントのうち最も大きなIDです。
+
+  ``number of buffer segments``
+
+    バッファセグメントの数です。
+
+  ``max id of buffer segment``
+
+    バッファセグメントのうち最も大きなIDです。
+
+  ``max id of physical segment in use``
+
+    使用中の論理セグメントのうち最も大きなIDです。
+
+  ``number of unmanaged segments``
+
+    管理されていないセグメントの数です。
+
+  ``total chunk size``
+
+    チャンクサイズの合計です。
+
+  ``max id of chunk segments in use``
+
+    使用中のチャンクセグメントのうち最も大きなIDです。
+
+  ``number of garbage chunk``
+
+    各チャンク毎のゴミの数です。
+
+  ``バッファの状態``には下記の項目がハッシュ形式で出力されます。
+
+  ``buffer id``
+
+    バッファIDです。
+
+  ``chunk size``
+
+    チャンクのサイズです。
+
+  ``buffer term``
+
+    バッファ内にある語の一覧です。各語の状態は以下のような配列となっています。
+
+      [語, バッファに登録されている語のID, 用語集に登録されている語のID, バッファ内でのサイズ, チャンク内でのサイズ]
+
+  ``buffer free``
+
+    バッファの空き容量です。
+
+  ``size in buffer``
+
+    バッファの使用量です。
+
+  ``nterms``
+
+    バッファ内にある語の数です。
+
+  ``nterms with chunk``
+
+    バッファ内にある語のうち、チャンクを使っている語の数です。
+
+例
+--
+
+テーブル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,
+    ...},
+   ...]

data/vendor/local/share/groonga/doc/ja/html/_sources/commands/clearlock.txt

@@ -0,0 +1,61 @@
+.. highlightlang:: none
+
+clearlock
+=========
+
+名前
+----
+
+clearlock - オブジェクトにセットされたロックを解除する
+
+書式
+----
+::
+
+ clearlock objname
+
+説明
+----
+
+groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられたロックを再帰的に解除します。
+
+引数
+----
+
+``objname``
+
+  対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
+
+返値
+---
+
+json形式
+^^^^^^^^
+
+::
+
+ [成功かどうかのフラグ]
+
+ ``成功かどうかのフラグ``
+
+   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+例
+--
+
+開いているデータベースのロックをすべて解除する::
+
+ clearlock
+ [true]
+
+テーブル名 Entry のカラム body のロックを解除する::
+
+ clearlock Entry.body
+ [true]
+
+関連項目
+--------
+
+:doc:`load`

data/vendor/local/share/groonga/doc/ja/html/_sources/commands/column_create.txt

@@ -0,0 +1,93 @@
+.. highlightlang:: none
+
+column_create
+=============
+
+名前
+----
+
+column_create - カラムの追加
+
+書式
+----
+::
+
+ column_create table name flags type [source]
+
+説明
+----
+
+groonga組込コマンドの一つであるcolumn_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+column_createは、使用しているデータベースのテーブルに対してカラムを追加します。
+
+引数
+----
+
+``table``
+
+  カラムを追加するテーブルの名前を指定します。
+
+``name``
+
+  作成するカラムの名前を指定します。カラム名は、テーブルの中で一意でなければなりません。
+
+  ピリオド('.'), コロン(':')を含む名前のカラムは作成できません。また、アンダースコア('_')で始まる名前は予約済みであり、使用できません。
+
+``flags``
+
+  カラムの属性を表す以下の数値か、パイプ('|')で組み合わせたシンボル名を指定します。
+
+  0, ``COLUMN_SCALAR``
+    単一の値が格納できるカラムを作成します。
+  1, ``COLUMN_VECTOR``
+    複数の値の配列を格納できるカラムを作成します。
+  2, ``COLUMN_INDEX``
+    インデックス型のカラムを作成します。
+
+  インデックス型のカラムについては、flagsの値に以下の値を加えることによって、追加の属
+  性を指定することができます。
+
+  128, ``WITH_SECTION``
+    段落情報を格納するインデックスを作成します。
+
+  256, ``WITH_WEIGHT``
+    ウェイト情報を格納するインデックスを作成します。
+
+  512, ``WITH_POSITION``
+    位置情報を格納するインデックス(完全転置インデックス)を作成します。
+
+``type``
+
+  値の型を指定します。groongaの組込型か、同一データベースに定義済みのユーザ定義型、定義済みのテーブルを指定することができます。
+
+``source``
+
+  インデックス型のカラムを作成した場合は、インデックス対象となるカラムをsource引数に指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+ [成功かどうかのフラグ]
+
+ ``成功かどうかのフラグ``
+
+   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+例
+--
+
+テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。::
+
+  column_create Entry body --type ShortText
+  [true]
+
+テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。::
+
+  column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body
+  [true]

data/vendor/local/share/groonga/doc/ja/html/_sources/commands/column_list.txt

@@ -0,0 +1,97 @@
+.. highlightlang:: none
+
+column_list
+===========
+
+名前
+----
+
+column_list - テーブルに定義されているカラムのリスト表示
+
+書式
+----
+::
+
+ column_list table
+
+説明
+----
+
+groonga組込コマンドの一つであるcolumn_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+column_listはテーブルに定義されているカラムをリスト表示します。
+
+引数
+----
+
+``table``
+  カラム情報を出力するテーブルの名前を指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+  テーブル名一覧が以下の形式で返却されます。
+
+    [[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]
+
+  ``検索件数``
+
+    検索件数が出力されます。
+
+  ``カラム名n``
+
+    output_columnsに指定された条件に従って、対象となるカラム名が出力されます。
+    カラム名ごとに格納されている情報は、以下のとおりです。
+
+    ``id``
+
+      カラムオブジェクトに割り当てられたID
+
+    ``name``
+
+      カラム名
+
+    ``path``
+
+      カラム値を格納するファイル名
+
+    ``type``
+
+      スカラ型,ベクタ型,インデックス型の種別
+
+    ``flags``
+
+      カラムのflags属性
+
+    ``domain``
+
+      カラムの値の属する型
+
+    ``range``
+
+      テーブルのkeyの型
+
+    ``source``
+
+      インデックスカラムのとき、インデックス対象カラム名の配列
+
+  ``カラム型n``
+
+    output_columnsに指定された条件に従って、対象となるカラム型が出力されます。
+
+  ``テーブル情報n``
+
+    テーブル情報が出力されます。
+
+例
+--
+::
+
+ column_list Entry
+
+ [[["id", "UInt32"],["name","ShortText"],["path","ShortText"],["type","ShortText"],["flags","ShortText"],["domain", "ShortText"],["range", "ShortText"],["source","ShortText"]],[258,"Entry.body","test.db.0000102","var","COLUMN_SCALAR|COMPRESS_NONE|PERSISTENT","Entry","ShortText",[]]]