droonga/droonga.org at b6b7f0d [gh-pages] Add a command reference for Groona compatible table_remove event (Groonga-commit) - Groonga - fulltext search engine.

YUKI Hiroshi	2014-01-29 12:47:23 +0900 (Wed, 29 Jan 2014)

  New Revision: b6b7f0d8ab71a24e375b73ece613b8e1f825ddd8
  https://github.com/droonga/droonga.org/commit/b6b7f0d8ab71a24e375b73ece613b8e1f825ddd8

  Message:
    Add a command reference for Groona compatible table_remove event

  Added files:
    ja/reference/commands/table-remove/index.md
  Modified files:
    ja/reference/commands/index.md

  Modified: ja/reference/commands/index.md (+1 -0)
===================================================================

--- ja/reference/commands/index.md    2014-01-29 12:44:08 +0900 (aecbbab)
+++ ja/reference/commands/index.md    2014-01-29 12:47:23 +0900 (7ea9584)
@@ -14,4 +14,5 @@ layout: ja
 
  * [select](select/)
  * [table_create](table-create/)
+ * [table_remove](table-remove/)
  * [column_create](column-create/)

  Added: ja/reference/commands/table-remove/index.md (+72 -0) 100644
===================================================================
--- /dev/null
+++ ja/reference/commands/table-remove/index.md    2014-01-29 12:47:23 +0900 (63a8d38)
@@ -0,0 +1,72 @@
+---
+title: table_remove
+layout: en
+---
+
+* TOC
+{:toc}
+
+## 概要 {#abstract}
+
+`table_remove` は、既存のテーブルを1つ削除します。
+
+このコマンドは[Groonga の `table_remove` コマンド](http://groonga.org/ja/docs/reference/commands/table_remove.html)と互換性があります。
+
+形式
+: Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。
+
+リクエストの `type`
+: `table_remove`
+
+リクエストの `body`
+: パラメータのハッシュ。
+
+レスポンスの `type`
+: `table_remove.result`
+
+## パラメータの構文 {#syntax}
+
+    {
+      "name" : "<テーブル名>"
+    }
+
+## パラメータの詳細 {#parameters}
+
+唯一のパラメータとなる `name` は省略不可能です。
+
+すべてのパラメータは[Groonga の `table_remove` コマンドの引数](http://groonga.org/ja/docs/reference/commands/table_remove.html#parameters)と共通です。詳細はGroongaのコマンドリファレンスを参照して下さい。
+
+## レスポンス {#response}
+
+このコマンドは、レスポンスの `body` としてコマンドの実行結果に関する情報を格納した配列を返却します。
+
+    [
+      [
+        <Groongaのステータスコード>,
+        <開始時刻>,
+        <処理に要した時間>
+      ],
+      <テーブルが削除されたかどうか>
+    ]
+
+このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。
+
+レスポンスの `body` の詳細：
+
+ステータスコード
+: コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。
+  
+   * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。.
+   * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。
+
+開始時刻
+: 処理を開始した時刻を示す数値（UNIX秒）。
+
+処理に要した時間
+: 処理を開始してから完了までの間にかかった時間を示す数値。
+
+テーブルが削除されたかどうか
+: テーブルが削除されたかどうかを示す真偽値です。以下のいずれかの値をとります。
+  
+   * `true`：テーブルを削除した。
+   * `false`：テーブルを削除しなかった。
-------------- next part --------------
HTML����������������������������...
Download 


Groonga - fulltext search engine.

[Groonga-commit] droonga/droonga.org at b6b7f0d [gh-pages] Add a command reference for Groona compatible table_remove event