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

data/vendor/local/share/groonga/doc/ja/html/_sources/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/html/_sources/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/html/_sources/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]
+

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

@@ -0,0 +1,68 @@
+.. highlightlang:: none
+
+.. _delete:
+
+delete
+======
+
+名前
+----
+
+delete - 一件のレコードの削除
+
+書式
+----
+::
+
+ delete table [key [id]]
+
+説明
+----
+
+groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。
+
+引数
+----
+
+``table``
+
+  レコードを削除しようとするテーブルの名前を指定します。
+
+``key``
+
+  削除するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。
+
+``id``
+
+  レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。
+
+返値
+---
+
+json形式
+^^^^^^^^
+
+::
+
+ [成功かどうかのフラグ]
+
+ ``成功かどうかのフラグ``
+
+   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+例
+--
+
+テーブルEntryからレコードを削除します。::
+
+ delete Entry abandon
+
+ [true]
+
+関連項目
+--------
+
+:doc:`load`
+

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

@@ -0,0 +1,62 @@
+.. highlightlang:: none
+
+dump
+====
+
+名前
+----
+
+dump - データベースのスキーマとデータを出力する
+
+書式
+----
+::
+
+  dump
+
+説明
+----
+
+groonga組込コマンドの一つであるdumpについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。
+
+dumpが出力するフォーマットは直接groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベースをコピーすることができます。::
+
+  % groonga original/db dump > dump.grn
+  % mkdir backup
+  % groonga -n backup/db < dump.grn
+
+引数
+----
+
+ありません。
+
+返値
+----
+
+データベースのスキーマとデータをgroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。
+
+例
+--
+::
+
+  dump
+
+  table_create LocalNames 48 ShortText
+  table_create Entries 48 ShortText
+  column_create Entries local_name 0 LocalNames
+  column_create LocalNames Entries_local_name 2 Entries local_name
+  ...
+
+  load --table LocalNames
+  [
+  ["_key"],
+  ["Items"],
+  ["BLT"],
+  ...
+  ]
+  ...
+
+
+

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

@@ -0,0 +1,98 @@
+.. highlightlang:: none
+
+load
+====
+
+名前
+----
+
+load - データのロード
+
+書式
+----
+::
+
+ load values table [columns [ifexists [input_type]]]
+
+説明
+----
+
+groonga組込コマンドの一つであるloadについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+loadは、使用しているデータベースのテーブルにレコードを登録し、カラムの値を更新します。
+
+引数
+----
+
+``values``
+
+  input_typeに指定する形式で登録するレコードの値を表現した文字列を渡します。
+
+  input_typeがjsonである場合には、以下のいずれかの形式が使用できます。
+
+  ``形式1``
+    [[カラム名1, カラム名2,..], [カラム値1, カラム値2,..], [カラム値1, カラム値2,..],..]
+
+  ``形式2``
+    [{カラム名1: カラム値1, カラム名2: カラム値2}, {カラム名1: カラム値1, カラム名2: カラム値2},..]
+
+  形式1の[カラム名1, カラム名2,..]の要素はcolumns引数が省略された場合のみ有効です。
+
+  対象のテーブルが主キーを持つテーブルであった場合は、カラム名の中に'_key'(主キーを示す疑似カラム名)が含まれていなければなりません。
+
+  values引数が省略された場合には、括弧の対応が取れるまで標準入力からvaluesの値を読み取ります。引数として値を指定する場合は、文字列のエスケープが必要ですが、標準入力から与える文字列はエスケープする必要がありません。
+
+続きの文字列については、空白文字(' ')をエスケープする必要はありません。
+
+``table``
+
+  レコードを追加しようとするテーブルの名前を指定します。
+
+``columns``
+
+  テーブルに登録するレコードに値を設定するカラム名のリストを、カンマ区切りで指定します。
+
+``ifexists``
+
+  指定した主キーに対応するレコードが既にテーブルに登録済みであった場合に実行するscript形式のgrn_expr文字列を指定します。ifexistsにgrn_exprが指定された場合は、式の値が真である場合に限り、その他のカラムの値が更新されます。(デフォルトはtrue)
+
+``input_type``
+
+  入力形式を指定します。jsonのみに対応しています。
+
+返値
+---
+
+json形式
+^^^^^^^^
+
+::
+
+ [登録件数]
+
+``登録件数``
+
+  テーブルに登録されたレコードの件数が返されます。
+
+例
+--
+
+テーブルEntryにレコードを登録します。::
+
+ load --table Entry --input_type json --values [{\"_key\":\"abandon\",\"body\":\"放棄する\"}]
+
+ [1]
+
+標準入力からvaluesの値を与えます。::
+
+ load --table Entry --input_type json
+ [
+ {"_key": "abbreviate", "body": "短縮する"}
+ ]
+
+ [1]
+
+関連項目
+--------
+
+:doc:`../expr`