YUKI Hiroshi
null+****@clear*****
Wed May 28 15:02:12 JST 2014
YUKI Hiroshi 2014-05-28 15:02:12 +0900 (Wed, 28 May 2014) New Revision: 8b775913c51739ee96e73b0004ae7a36acf9c043 https://github.com/droonga/droonga.org/commit/8b775913c51739ee96e73b0004ae7a36acf9c043 Message: Add command references for table_list and column_list Added files: _po/ja/reference/1.0.3/commands/column-list/index.po _po/ja/reference/1.0.3/commands/table-list/index.po ja/reference/1.0.3/commands/column-list/index.md ja/reference/1.0.3/commands/table-list/index.md reference/1.0.3/commands/column-list/index.md reference/1.0.3/commands/table-list/index.md Modified files: _po/ja/reference/1.0.3/commands/select/index.po ja/reference/1.0.3/commands/select/index.md reference/1.0.3/commands/select/index.md Added: _po/ja/reference/1.0.3/commands/column-list/index.po (+189 -0) 100644 =================================================================== --- /dev/null +++ _po/ja/reference/1.0.3/commands/column-list/index.po 2014-05-28 15:02:12 +0900 (5099253) @@ -0,0 +1,189 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"PO-Revision-Date: 2014-03-05 12:52+0900\n" +"Language: ja\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0;\n" + +msgid "" +"---\n" +"title: column_list\n" +"layout: en\n" +"---" +msgstr "" + +msgid "" +"* TOC\n" +"{:toc}" +msgstr "" + +msgid "## Abstract {#abstract}" +msgstr "## 概要 {#abstract}" + +msgid "The `column_list` command reports the list of all existing columns in a table." +msgstr "" + +msgid "" +"This is compatible to [the `column_list` command of the Groonga](http://groong" +"a.org/docs/reference/commands/column_list.html)." +msgstr "" + +msgid "## API types {#api-types}" +msgstr "## APIの形式 {#api-types}" + +msgid "### HTTP {#api-types-http}" +msgstr "" + +msgid "" +"Request endpoint\n" +": `(Document Root)/d/column_list`" +msgstr "" + +msgid "" +"Request methd\n" +": `GET`" +msgstr "" +"リクエストメソッド\n" +": `GET`" + +msgid "" +"Request URL parameters\n" +": Same to the list of [parameters](#parameters)." +msgstr "" +"リクエストのURLパラメータ\n" +": [パラメータの一覧](#parameters)で定義されている物を指定します。" + +msgid "" +"Request body\n" +": Nothing." +msgstr "" +"リクエストのbody\n" +": なし。" + +msgid "" +"Response body\n" +": A [response message](#response)." +msgstr "" +"レスポンスのbody\n" +": [レスポンスメッセージ](#response)。" + +msgid "### REST {#api-types-rest}" +msgstr "" + +msgid "Not supported." +msgstr "対応していません。" + +msgid "### Fluentd {#api-types-fluentd}" +msgstr "" + +msgid "" +"Style\n" +": Request-Response. One response message is always returned per one request." +msgstr "" +"形式\n" +": Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。" + +msgid "" +"`type` of the request\n" +": `column_list`" +msgstr "" + +msgid "" +"`body` of the request\n" +": A hash of [parameters](#parameters)." +msgstr "" +"リクエストの `body`\n" +": [パラメータ](#parameters)のハッシュ。" + +msgid "" +"`type` of the response\n" +": `column_list.result`" +msgstr "" + +msgid "## Parameter syntax {#syntax}" +msgstr "## パラメータの構文 {#syntax}" + +msgid "" +" {\n" +" \"table\" : \"<Name of the table>\"\n" +" }" +msgstr "" + +msgid "## Parameter details {#parameters}" +msgstr "## パラメータの詳細 {#parameters}" + +msgid "The only one parameter `table` is required." +msgstr "" + +msgid "" +"They are compatible to [the parameters of the `column_list` command of the Gro" +"onga](http://groonga.org/docs/reference/commands/column_list.html#parameters)." +" See the linked document for more details." +msgstr "" + +msgid "## Responses {#response}" +msgstr "## レスポンス {#response}" + +msgid "This returns an array meaning the result of the operation, as the `body`." +msgstr "このコマンドは、レスポンスの `body` としてコマンドの実行結果に関する情報を格納した配列を返却します。" + +msgid "" +" [\n" +" [\n" +" <Groonga's status code>,\n" +" <Start time>,\n" +" <Elapsed time>\n" +" ],\n" +" <List of columns>\n" +" ]" +msgstr "" + +msgid "" +"The structure of the returned array is compatible to [the returned value of th" +"e Groonga's `table_list` command](http://groonga.org/docs/reference/commands/c" +"olumn_list.html#return-value). See the linked document for more details." +msgstr "" + +msgid "" +"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 handl" +"ed in the way same to Groonga's one." +msgstr "" +"このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそ" +"れと同じ形で処理される必要があるためです。" + +msgid "Response body's details:" +msgstr "レスポンスの `body` の詳細：" + +msgid "" +"Status code\n" +": An integer which means the operation's result. Possible values are:" +msgstr "" +"ステータスコード\n" +": コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。" + +msgid "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : Successfully processed" +".\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : There is an" +"y invalid argument." +msgstr "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。.\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。" + +msgid "" +"Start time\n" +": An UNIX time which the operation was started on." +msgstr "" +"開始時刻\n" +": 処理を開始した時刻を示す数値（UNIX秒）。" + +msgid "" +"Elapsed time\n" +": A decimal of seconds meaning the elapsed time for the operation." +msgstr "" +"処理に要した時間\n" +": 処理を開始してから完了までの間にかかった時間を示す数値。" Modified: _po/ja/reference/1.0.3/commands/select/index.po (+44 -0) =================================================================== --- _po/ja/reference/1.0.3/commands/select/index.po 2014-05-28 14:08:07 +0900 (3fcea48) +++ _po/ja/reference/1.0.3/commands/select/index.po 2014-05-28 15:02:12 +0900 (66e3387) @@ -213,6 +213,17 @@ msgid "This returns an array including search results as the response's `body`." msgstr "このコマンドは、レスポンスの `body` として検索結果の配列を返却します。" msgid "" +" [\n" +" [\n" +" <Groonga's status code>,\n" +" <Start time>,\n" +" <Elapsed time>\n" +" ],\n" +" <List of columns>\n" +" ]" +msgstr "" + +msgid "" "The structure of the returned array is compatible to [the returned value of th" "e Groonga's `select` command](http://groonga.org/docs/reference/commands/selec" "t.html#id6). See the linked document for more details." @@ -227,3 +238,36 @@ msgid "" msgstr "" "このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそ" "れと同じ形で処理される必要があるためです。" + +msgid "Response body's details:" +msgstr "レスポンスの `body` の詳細：" + +msgid "" +"Status code\n" +": An integer which means the operation's result. Possible values are:" +msgstr "" +"ステータスコード\n" +": コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。" + +msgid "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : Successfully processed" +".\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : There is an" +"y invalid argument." +msgstr "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。.\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。" + +msgid "" +"Start time\n" +": An UNIX time which the operation was started on." +msgstr "" +"開始時刻\n" +": 処理を開始した時刻を示す数値（UNIX秒）。" + +msgid "" +"Elapsed time\n" +": A decimal of seconds meaning the elapsed time for the operation." +msgstr "" +"処理に要した時間\n" +": 処理を開始してから完了までの間にかかった時間を示す数値。" Added: _po/ja/reference/1.0.3/commands/table-list/index.po (+168 -0) 100644 =================================================================== --- /dev/null +++ _po/ja/reference/1.0.3/commands/table-list/index.po 2014-05-28 15:02:12 +0900 (f33c7d5) @@ -0,0 +1,168 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"PO-Revision-Date: 2014-03-05 12:52+0900\n" +"Language: ja\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0;\n" + +msgid "" +"---\n" +"title: table_list\n" +"layout: en\n" +"---" +msgstr "" + +msgid "" +"* TOC\n" +"{:toc}" +msgstr "" + +msgid "## Abstract {#abstract}" +msgstr "## 概要 {#abstract}" + +msgid "" +"The `table_list` command reports the list of all existing tables in the datase" +"t." +msgstr "" + +msgid "" +"This is compatible to [the `table_list` command of the Groonga](http://groonga" +".org/docs/reference/commands/table_list.html)." +msgstr "" + +msgid "## API types {#api-types}" +msgstr "## APIの形式 {#api-types}" + +msgid "### HTTP {#api-types-http}" +msgstr "" + +msgid "" +"Request endpoint\n" +": `(Document Root)/d/table_list`" +msgstr "" + +msgid "" +"Request methd\n" +": `GET`" +msgstr "" +"リクエストメソッド\n" +": `GET`" + +msgid "" +"Request URL parameters\n" +": Nothing." +msgstr "" +"リクエストのURLパラメータ\n" +": なし。" + +msgid "" +"Request body\n" +": Nothing." +msgstr "" +"リクエストのbody\n" +": なし。" + +msgid "" +"Response body\n" +": A [response message](#response)." +msgstr "" +"レスポンスのbody\n" +": [レスポンスメッセージ](#response)。" + +msgid "### REST {#api-types-rest}" +msgstr "" + +msgid "Not supported." +msgstr "対応していません。" + +msgid "### Fluentd {#api-types-fluentd}" +msgstr "" + +msgid "" +"Style\n" +": Request-Response. One response message is always returned per one request." +msgstr "" +"形式\n" +": Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。" + +msgid "" +"`type` of the request\n" +": `table_list`" +msgstr "" + +msgid "" +"`body` of the request\n" +": `null` or a blank hash." +msgstr "" + +msgid "" +"`type` of the response\n" +": `table_list.result`" +msgstr "" + +msgid "## Responses {#response}" +msgstr "## レスポンス {#response}" + +msgid "This returns an array including list of tables as the response's `body`." +msgstr "" + +msgid "" +" [\n" +" [\n" +" <Groonga's status code>,\n" +" <Start time>,\n" +" <Elapsed time>\n" +" ],\n" +" <List of tables>\n" +" ]" +msgstr "" + +msgid "" +"The structure of the returned array is compatible to [the returned value of th" +"e Groonga's `table_list` command](http://groonga.org/docs/reference/commands/t" +"able_list.html#id5). See the linked document for more details." +msgstr "" + +msgid "" +"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 handl" +"ed in the way same to Groonga's one." +msgstr "" +"このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそ" +"れと同じ形で処理される必要があるためです。" + +msgid "Response body's details:" +msgstr "レスポンスの `body` の詳細：" + +msgid "" +"Status code\n" +": An integer which means the operation's result. Possible values are:" +msgstr "" +"ステータスコード\n" +": コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。" + +msgid "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : Successfully processed" +".\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : There is an" +"y invalid argument." +msgstr "" +" * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。.\n" +" * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。" + +msgid "" +"Start time\n" +": An UNIX time which the operation was started on." +msgstr "" +"開始時刻\n" +": 処理を開始した時刻を示す数値（UNIX秒）。" + +msgid "" +"Elapsed time\n" +": A decimal of seconds meaning the elapsed time for the operation." +msgstr "" +"処理に要した時間\n" +": 処理を開始してから完了までの間にかかった時間を示す数値。" Added: ja/reference/1.0.3/commands/column-list/index.md (+103 -0) 100644 =================================================================== --- /dev/null +++ ja/reference/1.0.3/commands/column-list/index.md 2014-05-28 15:02:12 +0900 (0bb8d6f) @@ -0,0 +1,103 @@ +--- +title: column_list +layout: en +--- + +{% comment %} +############################################## + THIS FILE IS AUTOMATICALLY GENERATED FROM + "_po/ja/reference/1.0.3/commands/column-list/index.po" + DO NOT EDIT THIS FILE MANUALLY! +############################################## +{% endcomment %} + + +* TOC +{:toc} + +## 概要 {#abstract} + +The `column_list` command reports the list of all existing columns in a table. + +This is compatible to [the `column_list` command of the Groonga](http://groonga.org/docs/reference/commands/column_list.html). + +## APIの形式 {#api-types} + +### HTTP {#api-types-http} + +Request endpoint +: `(Document Root)/d/column_list` + +リクエストメソッド +: `GET` + +リクエストのURLパラメータ +: [パラメータの一覧](#parameters)で定義されている物を指定します。 + +リクエストのbody +: なし。 + +レスポンスのbody +: [レスポンスメッセージ](#response)。 + +### REST {#api-types-rest} + +対応していません。 + +### Fluentd {#api-types-fluentd} + +形式 +: Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。 + +`type` of the request +: `column_list` + +リクエストの `body` +: [パラメータ](#parameters)のハッシュ。 + +`type` of the response +: `column_list.result` + +## パラメータの構文 {#syntax} + + { + "table" : "<Name of the table>" + } + +## パラメータの詳細 {#parameters} + +The only one parameter `table` is required. + +They are compatible to [the parameters of the `column_list` command of the Groonga](http://groonga.org/docs/reference/commands/column_list.html#parameters). See the linked document for more details. + +## レスポンス {#response} + +このコマンドは、レスポンスの `body` としてコマンドの実行結果に関する情報を格納した配列を返却します。 + + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <List of columns> + ] + +The structure of the returned array is compatible to [the returned value of the Groonga's `table_list` command](http://groonga.org/docs/reference/commands/column_list.html#return-value). See the linked document for more details. + +このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。 + +レスポンスの `body` の詳細： + +ステータスコード +: コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。 + + * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。. + * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。 + +開始時刻 +: 処理を開始した時刻を示す数値（UNIX秒）。 + +処理に要した時間 +: 処理を開始してから完了までの間にかかった時間を示す数値。 + Modified: ja/reference/1.0.3/commands/select/index.md (+24 -2) =================================================================== --- ja/reference/1.0.3/commands/select/index.md 2014-05-28 14:08:07 +0900 (f9558d5) +++ ja/reference/1.0.3/commands/select/index.md 2014-05-28 15:02:12 +0900 (da52321) @@ -105,12 +105,34 @@ layout: ja すべてのパラメータの意味は[Groonga の `select` コマンドの引数](http://groonga.org/ja/docs/reference/commands/select.html#parameters)と共通です。詳細はGroongaのコマンドリファレンスを参照して下さい。 - - ## レスポンス {#response} このコマンドは、レスポンスの `body` として検索結果の配列を返却します。 + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <List of columns> + ] + 検索結果の配列の構造は[Groonga の `select` コマンドの返り値](http://groonga.org/ja/docs/reference/commands/select.html#id6)と共通です。詳細はGroongaのコマンドリファレンスを参照して下さい。 このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。 + +レスポンスの `body` の詳細： + +ステータスコード +: コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。 + + * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。. + * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。 + +開始時刻 +: 処理を開始した時刻を示す数値（UNIX秒）。 + +処理に要した時間 +: 処理を開始してから完了までの間にかかった時間を示す数値。 + Added: ja/reference/1.0.3/commands/table-list/index.md (+91 -0) 100644 =================================================================== --- /dev/null +++ ja/reference/1.0.3/commands/table-list/index.md 2014-05-28 15:02:12 +0900 (e436284) @@ -0,0 +1,91 @@ +--- +title: table_list +layout: en +--- + +{% comment %} +############################################## + THIS FILE IS AUTOMATICALLY GENERATED FROM + "_po/ja/reference/1.0.3/commands/table-list/index.po" + DO NOT EDIT THIS FILE MANUALLY! +############################################## +{% endcomment %} + + +* TOC +{:toc} + +## 概要 {#abstract} + +The `table_list` command reports the list of all existing tables in the dataset. + +This is compatible to [the `table_list` command of the Groonga](http://groonga.org/docs/reference/commands/table_list.html). + +## APIの形式 {#api-types} + +### HTTP {#api-types-http} + +Request endpoint +: `(Document Root)/d/table_list` + +リクエストメソッド +: `GET` + +リクエストのURLパラメータ +: なし。 + +リクエストのbody +: なし。 + +レスポンスのbody +: [レスポンスメッセージ](#response)。 + +### REST {#api-types-rest} + +対応していません。 + +### Fluentd {#api-types-fluentd} + +形式 +: Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。 + +`type` of the request +: `table_list` + +`body` of the request +: `null` or a blank hash. + +`type` of the response +: `table_list.result` + +## レスポンス {#response} + +This returns an array including list of tables as the response's `body`. + + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <List of tables> + ] + +The structure of the returned array is compatible to [the returned value of the Groonga's `table_list` command](http://groonga.org/docs/reference/commands/table_list.html#id5). See the linked document for more details. + +このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。 + +レスポンスの `body` の詳細： + +ステータスコード +: コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。 + + * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。. + * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。 + +開始時刻 +: 処理を開始した時刻を示す数値（UNIX秒）。 + +処理に要した時間 +: 処理を開始してから完了までの間にかかった時間を示す数値。 + Added: reference/1.0.3/commands/column-list/index.md (+94 -0) 100644 =================================================================== --- /dev/null +++ reference/1.0.3/commands/column-list/index.md 2014-05-28 15:02:12 +0900 (6167700) @@ -0,0 +1,94 @@ +--- +title: column_list +layout: en +--- + +* TOC +{:toc} + +## Abstract {#abstract} + +The `column_list` command reports the list of all existing columns in a table. + +This is compatible to [the `column_list` command of the Groonga](http://groonga.org/docs/reference/commands/column_list.html). + +## API types {#api-types} + +### HTTP {#api-types-http} + +Request endpoint +: `(Document Root)/d/column_list` + +Request methd +: `GET` + +Request URL parameters +: Same to the list of [parameters](#parameters). + +Request body +: Nothing. + +Response body +: A [response message](#response). + +### REST {#api-types-rest} + +Not supported. + +### Fluentd {#api-types-fluentd} + +Style +: Request-Response. One response message is always returned per one request. + +`type` of the request +: `column_list` + +`body` of the request +: A hash of [parameters](#parameters). + +`type` of the response +: `column_list.result` + +## Parameter syntax {#syntax} + + { + "table" : "<Name of the table>" + } + +## Parameter details {#parameters} + +The only one parameter `table` is required. + +They are compatible to [the parameters of the `column_list` command of the Groonga](http://groonga.org/docs/reference/commands/column_list.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> + ], + <List of columns> + ] + +The structure of the returned array is compatible to [the returned value of the Groonga's `table_list` command](http://groonga.org/docs/reference/commands/column_list.html#return-value). See the linked document for more details. + +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. + Modified: reference/1.0.3/commands/select/index.md (+24 -2) =================================================================== --- reference/1.0.3/commands/select/index.md 2014-05-28 14:08:07 +0900 (a02f005) +++ reference/1.0.3/commands/select/index.md 2014-05-28 15:02:12 +0900 (aeb6860) @@ -95,12 +95,34 @@ On the version {{ site.droonga_version }}, only following parameters are availab All parameters are compatible to [parameters for `select` command of the Groonga](http://groonga.org/docs/reference/commands/select.html#parameters). See the linked document for more details. - - ## Responses {#response} This returns an array including search results as the response's `body`. + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <List of columns> + ] + The structure of the returned array is compatible to [the returned value of the Groonga's `select` command](http://groonga.org/docs/reference/commands/select.html#id6). See the linked document for more details. 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. + Added: reference/1.0.3/commands/table-list/index.md (+82 -0) 100644 =================================================================== --- /dev/null +++ reference/1.0.3/commands/table-list/index.md 2014-05-28 15:02:12 +0900 (3c97f08) @@ -0,0 +1,82 @@ +--- +title: table_list +layout: en +--- + +* TOC +{:toc} + +## Abstract {#abstract} + +The `table_list` command reports the list of all existing tables in the dataset. + +This is compatible to [the `table_list` command of the Groonga](http://groonga.org/docs/reference/commands/table_list.html). + +## API types {#api-types} + +### HTTP {#api-types-http} + +Request endpoint +: `(Document Root)/d/table_list` + +Request methd +: `GET` + +Request URL parameters +: Nothing. + +Request body +: Nothing. + +Response body +: A [response message](#response). + +### REST {#api-types-rest} + +Not supported. + +### Fluentd {#api-types-fluentd} + +Style +: Request-Response. One response message is always returned per one request. + +`type` of the request +: `table_list` + +`body` of the request +: `null` or a blank hash. + +`type` of the response +: `table_list.result` + +## Responses {#response} + +This returns an array including list of tables as the response's `body`. + + [ + [ + <Groonga's status code>, + <Start time>, + <Elapsed time> + ], + <List of tables> + ] + +The structure of the returned array is compatible to [the returned value of the Groonga's `table_list` command](http://groonga.org/docs/reference/commands/table_list.html#id5). See the linked document for more details. + +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. + -------------- next part -------------- HTML����������������������������...ダウンロード
