[Groonga-commit] droonga/droonga.org at 37137fe [gh-pages] Add command reference for "load" command

Back to archive index

YUKI Hiroshi null+****@clear*****
Wed May 28 15:48:47 JST 2014


YUKI Hiroshi	2014-05-28 15:48:47 +0900 (Wed, 28 May 2014)

  New Revision: 37137fefd980856be8a1002d10eaa3bf68d2ce94
  https://github.com/droonga/droonga.org/commit/37137fefd980856be8a1002d10eaa3bf68d2ce94

  Message:
    Add command reference for "load" command

  Added files:
    _po/ja/reference/1.0.3/commands/load/index.po
    ja/reference/1.0.3/commands/load/index.md
    reference/1.0.3/commands/load/index.md
  Modified files:
    _po/ja/reference/1.0.3/commands/search/index.po
    ja/reference/1.0.3/commands/search/index.md

  Added: _po/ja/reference/1.0.3/commands/load/index.po (+213 -0) 100644
===================================================================
--- /dev/null
+++ _po/ja/reference/1.0.3/commands/load/index.po    2014-05-28 15:48:47 +0900 (e9b322b)
@@ -0,0 +1,213 @@
+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: load\n"
+"layout: en\n"
+"---"
+msgstr ""
+
+msgid ""
+"* TOC\n"
+"{:toc}"
+msgstr ""
+
+msgid "## Abstract {#abstract}"
+msgstr "## 概要 {#abstract}"
+
+msgid ""
+"The `load` command adds new records to the specified table.\n"
+"Column values of existing records are updated by new values, if the table has "
+"a primary key and there are existing records with specified keys."
+msgstr ""
+
+msgid ""
+"This is compatible to [the `load` command of the Groonga](http://groonga.org/d"
+"ocs/reference/commands/load.html)."
+msgstr ""
+
+msgid "## API types {#api-types}"
+msgstr "## APIの形式 {#api-types}"
+
+msgid "### HTTP (GET) {#api-types-http-get}"
+msgstr ""
+
+msgid ""
+"Request endpoint\n"
+": `(Document Root)/d/load`"
+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 "### HTTP (POST) {#api-types-http-post}"
+msgstr ""
+
+msgid ""
+"Request methd\n"
+": `POST`"
+msgstr ""
+"リクエストメソッド\n"
+": `POST`"
+
+msgid ""
+"Request URL parameters\n"
+": Same to the list of [parameters](#parameters), except `values`."
+msgstr ""
+
+msgid ""
+"Request body\n"
+": The value for the [parameter](#parameters) `values`."
+msgstr ""
+
+msgid "### REST {#api-types-rest}"
+msgstr ""
+
+msgid "Not supported."
+msgstr "対応していません。"
+
+msgid "### Fluentd {#api-types-fluentd}"
+msgstr ""
+
+msgid "## Parameter syntax {#syntax}"
+msgstr "## パラメータの構文 {#syntax}"
+
+msgid ""
+"    {\n"
+"      \"values\"     : <Array of records to be loaded>,\n"
+"      \"table\"      : \"<Name of the table>\",\n"
+"      \"columns\"    : \"<List of column names for values, separated by ','>\",\n"
+"      \"ifexists\"   : \"<Grn_expr to determine records which should be updated>\""
+",\n"
+"      \"input_type\" : \"<Format type of the values>\"\n"
+"    }"
+msgstr ""
+
+msgid "## Parameter details {#parameters}"
+msgstr "## パラメータの詳細 {#parameters}"
+
+msgid "All parameters except `table` are optional."
+msgstr "`table` 以外のパラメータはすべて省略可能です。"
+
+msgid ""
+"On the version {{ site.droonga_version }}, only following parameters are avail"
+"able. Others are simply ignored because they are not implemented."
+msgstr ""
+"また、バージョン {{ site.droonga_version }} の時点では以下のパラメータのみが動作します。\n"
+"これら以外のパラメータは未実装のため無視されます。"
+
+msgid ""
+" * `values`\n"
+" * `table`\n"
+" * `columns`"
+msgstr ""
+
+msgid ""
+"They are compatible to [the parameters of the `load` command of the Groonga](h"
+"ttp://groonga.org/docs/reference/commands/load.html#parameters). See the linke"
+"d document for more details."
+msgstr ""
+
+msgid ""
+"HTTP clients can send `values` as an URL parameter with `GET` method, or the r"
+"equest body with `POST` method.\n"
+"The URL parameter `values` is always ignored it it is sent with `POST` method."
+"\n"
+"You should send data with `POST` method if there is much data."
+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"
+"      [<Number of loaded records>]\n"
+"    ]"
+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"
+": 処理を開始してから完了までの間にかかった時間を示す数値。"
+
+msgid ""
+"Number of loaded records\n"
+": An positive integer meaning the number of added or updated records."
+msgstr ""

  Modified: _po/ja/reference/1.0.3/commands/search/index.po (+1 -1)
===================================================================
--- _po/ja/reference/1.0.3/commands/search/index.po    2014-05-28 15:08:10 +0900 (0ca4cba)
+++ _po/ja/reference/1.0.3/commands/search/index.po    2014-05-28 15:48:47 +0900 (028c71e)
@@ -1802,7 +1802,7 @@ msgid ""
 "   2. A hash of column definitions."
 msgstr ""
 "   1. カラムの定義の配列。\n"
-"   2. カラムの定義のハッシュ。"
+"   2. カラムの定義を値としたハッシュ。"
 
 msgid "  Each column can be defined in one of following styles:"
 msgstr "  各カラムは以下の形式のいずれかで指定します。"

  Added: ja/reference/1.0.3/commands/load/index.md (+126 -0) 100644
===================================================================
--- /dev/null
+++ ja/reference/1.0.3/commands/load/index.md    2014-05-28 15:48:47 +0900 (623ad87)
@@ -0,0 +1,126 @@
+---
+title: load
+layout: en
+---
+
+{% comment %}
+##############################################
+  THIS FILE IS AUTOMATICALLY GENERATED FROM
+  "_po/ja/reference/1.0.3/commands/load/index.po"
+  DO NOT EDIT THIS FILE MANUALLY!
+##############################################
+{% endcomment %}
+
+
+* TOC
+{:toc}
+
+## 概要 {#abstract}
+
+The `load` command adds new records to the specified table.
+Column values of existing records are updated by new values, if the table has a primary key and there are existing records with specified keys.
+
+This is compatible to [the `load` command of the Groonga](http://groonga.org/docs/reference/commands/load.html).
+
+## APIの形式 {#api-types}
+
+### HTTP (GET) {#api-types-http-get}
+
+Request endpoint
+: `(Document Root)/d/load`
+
+リクエストメソッド
+: `GET`
+
+リクエストのURLパラメータ
+: [パラメータの一覧](#parameters)で定義されている物を指定します。
+
+リクエストのbody
+: なし。
+
+レスポンスのbody
+: [レスポンスメッセージ](#response)。
+
+### HTTP (POST) {#api-types-http-post}
+
+Request endpoint
+: `(Document Root)/d/load`
+
+リクエストメソッド
+: `POST`
+
+Request URL parameters
+: Same to the list of [parameters](#parameters), except `values`.
+
+Request body
+: The value for the [parameter](#parameters) `values`.
+
+レスポンスのbody
+: [レスポンスメッセージ](#response)。
+
+### REST {#api-types-rest}
+
+対応していません。
+
+### Fluentd {#api-types-fluentd}
+
+対応していません。
+
+## パラメータの構文 {#syntax}
+
+    {
+      "values"     : <Array of records to be loaded>,
+      "table"      : "<Name of the table>",
+      "columns"    : "<List of column names for values, separated by ','>",
+      "ifexists"   : "<Grn_expr to determine records which should be updated>",
+      "input_type" : "<Format type of the values>"
+    }
+
+## パラメータの詳細 {#parameters}
+
+`table` 以外のパラメータはすべて省略可能です。
+
+また、バージョン {{ site.droonga_version }} の時点では以下のパラメータのみが動作します。
+これら以外のパラメータは未実装のため無視されます。
+
+ * `values`
+ * `table`
+ * `columns`
+
+They are compatible to [the parameters of the `load` command of the Groonga](http://groonga.org/docs/reference/commands/load.html#parameters). See the linked document for more details.
+
+HTTP clients can send `values` as an URL parameter with `GET` method, or the request body with `POST` method.
+The URL parameter `values` is always ignored it it is sent with `POST` method.
+You should send data with `POST` method if there is much data.
+
+## レスポンス {#response}
+
+このコマンドは、レスポンスの `body` としてコマンドの実行結果に関する情報を格納した配列を返却します。
+
+    [
+      [
+        <Groonga's status code>,
+        <Start time>,
+        <Elapsed time>
+      ],
+      [<Number of loaded records>]
+    ]
+
+このコマンドはレスポンスの `statusCode` として常に `200` を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。
+
+レスポンスの `body` の詳細:
+
+ステータスコード
+: コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。
+  
+   * `0` (`Droonga::GroongaHandler::Status::SUCCESS`) : 正常に処理された。.
+   * `-22` (`Droonga::GroongaHandler::Status::INVALID_ARGUMENT`) : 引数が不正である。
+
+開始時刻
+: 処理を開始した時刻を示す数値(UNIX秒)。
+
+処理に要した時間
+: 処理を開始してから完了までの間にかかった時間を示す数値。
+
+Number of loaded records
+: An positive integer meaning the number of added or updated records.

  Modified: ja/reference/1.0.3/commands/search/index.md (+1 -1)
===================================================================
--- ja/reference/1.0.3/commands/search/index.md    2014-05-28 15:08:10 +0900 (2c7bb8e)
+++ ja/reference/1.0.3/commands/search/index.md    2014-05-28 15:48:47 +0900 (4599b94)
@@ -1062,7 +1062,7 @@ Droongaはそのカラムの値が同じであるレコードを集約し、カ
   個々のカラムの値の出力形式は以下のいずれかで指定します。
   
    1. カラムの定義の配列。
-   2. カラムの定義のハッシュ。
+   2. カラムの定義を値としたハッシュ。
   
   各カラムは以下の形式のいずれかで指定します。
   

  Added: reference/1.0.3/commands/load/index.md (+116 -0) 100644
===================================================================
--- /dev/null
+++ reference/1.0.3/commands/load/index.md    2014-05-28 15:48:47 +0900 (3570770)
@@ -0,0 +1,116 @@
+---
+title: load
+layout: en
+---
+
+* TOC
+{:toc}
+
+## Abstract {#abstract}
+
+The `load` command adds new records to the specified table.
+Column values of existing records are updated by new values, if the table has a primary key and there are existing records with specified keys.
+
+This is compatible to [the `load` command of the Groonga](http://groonga.org/docs/reference/commands/load.html).
+
+## API types {#api-types}
+
+### HTTP (GET) {#api-types-http-get}
+
+Request endpoint
+: `(Document Root)/d/load`
+
+Request methd
+: `GET`
+
+Request URL parameters
+: Same to the list of [parameters](#parameters).
+
+Request body
+: Nothing.
+
+Response body
+: A [response message](#response).
+
+### HTTP (POST) {#api-types-http-post}
+
+Request endpoint
+: `(Document Root)/d/load`
+
+Request methd
+: `POST`
+
+Request URL parameters
+: Same to the list of [parameters](#parameters), except `values`.
+
+Request body
+: The value for the [parameter](#parameters) `values`.
+
+Response body
+: A [response message](#response).
+
+### REST {#api-types-rest}
+
+Not supported.
+
+### Fluentd {#api-types-fluentd}
+
+Not supported.
+
+## Parameter syntax {#syntax}
+
+    {
+      "values"     : <Array of records to be loaded>,
+      "table"      : "<Name of the table>",
+      "columns"    : "<List of column names for values, separated by ','>",
+      "ifexists"   : "<Grn_expr to determine records which should be updated>",
+      "input_type" : "<Format type of the values>"
+    }
+
+## Parameter details {#parameters}
+
+All parameters except `table` are optional.
+
+On the version {{ site.droonga_version }}, only following parameters are available. Others are simply ignored because they are not implemented.
+
+ * `values`
+ * `table`
+ * `columns`
+
+They are compatible to [the parameters of the `load` command of the Groonga](http://groonga.org/docs/reference/commands/load.html#parameters). See the linked document for more details.
+
+HTTP clients can send `values` as an URL parameter with `GET` method, or the request body with `POST` method.
+The URL parameter `values` is always ignored it it is sent with `POST` method.
+You should send data with `POST` method if there is much data.
+
+## Responses {#response}
+
+This returns an array meaning the result of the operation, as the `body`.
+
+    [
+      [
+        <Groonga's status code>,
+        <Start time>,
+        <Elapsed time>
+      ],
+      [<Number of loaded records>]
+    ]
+
+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.
+
+Number of loaded records
+: An positive integer meaning the number of added or updated records.
-------------- next part --------------
HTML����������������������������...
다운로드 



More information about the Groonga-commit mailing list
Back to archive index