YUKI Hiroshi
null+****@clear*****
Wed Jan 29 12:09:49 JST 2014
YUKI Hiroshi 2014-01-29 12:09:49 +0900 (Wed, 29 Jan 2014) New Revision: 36084876e23a6c33b7347136d062b9f0135ad708 https://github.com/droonga/droonga.org/commit/36084876e23a6c33b7347136d062b9f0135ad708 Message: Add description of "table_remove" command Added files: reference/commands/table-remove/index.md Modified files: reference/commands/index.md Modified: reference/commands/index.md (+1 -0) =================================================================== --- reference/commands/index.md 2014-01-29 11:32:32 +0900 (313b3f8) +++ reference/commands/index.md 2014-01-29 12:09:49 +0900 (bd9ab4d) @@ -14,4 +14,5 @@ Here are available commands * [select](select/) * [table_create](table-create/) + * [table_remove](table-remove/) * [column_create](column-create/) Added: reference/commands/table-remove/index.md (+72 -0) 100644 =================================================================== --- /dev/null +++ reference/commands/table-remove/index.md 2014-01-29 12:09:49 +0900 (dc0d865) @@ -0,0 +1,72 @@ +--- +title: table_remove +layout: en +--- + +* TOC +{:toc} + +## Abstract {#abstract} + +The `table_remove` command removes an existing table. + +This is compatible to [the `table_remove` command of the Groonga](http://groonga.org/docs/reference/commands/table_remove.html). + +Style +: Request-Response. One response message is always returned per one request. + +`type` of the request +: `table_remove` + +`body` of the request +: A hash of parameters. + +`type` of the response +: `table_remove.result` + +## Parameter syntax {#syntax} + + { + "name" : "<Name of the table>" + } + +## Parameter details {#parameters} + +The only one parameter `name` is required. + +They are compatible to [the parameters of the `table_remove` command of the Groonga](http://groonga.org/docs/reference/commands/table_remove.html#parameters). See the linked document for more details. + +## Responses {#response} + +This returns an array meaning the result of the operation, as the `body`. + + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <Table is successfully removed or not> + ] + +This command always returns a response with `200` as its `statusCode`, because this is a Groonga compatible command and errors of this command must be handled in the way same to Groonga's one. + +Response body's details: + +Status code +: An integer which means the operation's result. Possible values are: + + * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : Successfully processed. + * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : There is any invalid argument. + +Start time +: An UNIX time which the operation was started on. + +Elapsed time +: A decimal of seconds meaning the elapsed time for the operation. + +Table is successfully removed or not +: A boolean value meaning the table was successfully removed or not. Possible values are: + + * `true`：The table was successfully removed. + * `false`：The table was not removed. -------------- next part -------------- HTML����������������������������...下載
