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

data/vendor/local/share/groonga/doc/ja/source/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/source/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/source/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",[]]]

data/vendor/local/share/groonga/doc/ja/source/commands/column_remove.txt

@@ -0,0 +1,58 @@
+.. highlightlang:: none
+
+column_remove
+=============
+
+名前
+----
+
+column_remove - テーブルに定義されているカラムの削除
+
+書式
+----
+::
+
+ column_remove table name
+
+説明
+----
+
+groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+column_removeはテーブルに定義されているカラムを削除します。
+また、付随するインデックスも削除されます。[#]_
+
+引数
+----
+
+``table``
+  削除対象のカラムが定義されているテーブルの名前を指定します。
+
+``name``
+  削除対象のカラム名を指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+ [成功かどうかのフラグ]
+
+ ``成功かどうかのフラグ``
+
+   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+例
+--
+::
+
+ column_remove Entry body
+
+ [true]
+
+.. rubric:: 脚注
+
+.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。

data/vendor/local/share/groonga/doc/ja/source/commands/define_selector.txt

@@ -0,0 +1,114 @@
+.. highlightlang:: none
+
+define_selector
+===============
+
+名前
+----
+
+define_selector - 検索コマンドを定義
+
+書式
+----
+::
+
+ define_selector name table [match_columns [query [filter [scorer [sortby
+                 [output_columns [offset [limit [drilldown [drilldown_sortby
+                 [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]]
+
+説明
+----
+
+groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
+
+引数
+----
+
+``name``
+
+  定義するselectorコマンドの名前を指定します。
+
+``table``
+
+  検索対象のテーブルを指定します。
+
+``match_columns``
+
+  追加するselectorコマンドのmatch_columns引数のデフォルト値を指定します。
+
+``query``
+
+  追加するselectorコマンドのquery引数のデフォルト値を指定します。
+
+``filter``
+
+  追加するselectorコマンドのfilter引数のデフォルト値を指定します。
+
+``scorer``
+
+  追加するselectorコマンドのscorer引数のデフォルト値を指定します。
+
+``sortby``
+
+  追加するselectorコマンドのsortby引数のデフォルト値を指定します。
+
+``output_columns``
+
+  追加するselectorコマンドのoutput_columns引数のデフォルト値を指定します。
+
+``offset``
+
+  追加するselectorコマンドのoffset引数のデフォルト値を指定します。
+
+``limit``
+
+  追加するselectorコマンドのlimit引数のデフォルト値を指定します。
+
+``drilldown``
+
+  追加するselectorコマンドのdrilldown引数のデフォルト値を指定します。
+
+``drilldown_sortby``
+
+  追加するselectorコマンドのdrilldown_sortby引数のデフォルト値を指定します。
+
+``drilldown_output_columns``
+
+  追加するselectorコマンドのdrilldown_output_columns引数のデフォルト値を指定します。
+
+``drilldown_offset``
+
+  追加するselectorコマンドのdrilldown_offset引数のデフォルト値を指定します。
+
+``drilldown_limit``
+
+  追加するselectorコマンドのdrilldown_limit引数のデフォルト値を指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+ [成功かどうかのフラグ]
+
+ ``成功かどうかのフラグ``
+
+   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+例
+--
+
+テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
+
+ define_selector entry_selector Entry
+ [true]
+
+関連項目
+--------
+
+:doc:`../expr`

data/vendor/local/share/groonga/doc/ja/source/commands/defrag.txt

@@ -0,0 +1,57 @@
+.. highlightlang:: none
+
+defrag
+======
+
+名前
+----
+
+defrag - オブジェクトにセットされたロックを解除する
+
+書式
+----
+::
+
+ defrag objname threshold
+
+説明
+----
+
+groonga組込コマンドの一つであるdefragについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+defragは、対象となるオブジェクト(データベースか可変長サイズカラム)を指定し、オブジェクトのフラグメンテーションを解消します。
+
+引数
+----
+
+``objname``
+
+  対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+ [フラグメンテーション解消を実行したセグメントの数]
+
+ ``フラグメンテーション解消を実行したセグメントの数``
+
+   フラグメンテーション解消を実行したセグメントの数を返す。
+
+例
+--
+
+開いているデータベースのフラグメンテーションを解消する::
+
+ defrag
+ [300]
+
+テーブル名 Entry のカラム body のフラグメンテーションを解消する::
+
+ defrag Entry.body
+ [30]
+