droonga/droonga.org at b0be5bd [gh-pages] Add descriptions of "add" command (Groonga-commit) - Groonga - fulltext search engine.

YUKI Hiroshi	2013-11-12 19:07:52 +0900 (Tue, 12 Nov 2013)

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

  Message:
    Add descriptions of "add" command

  Modified files:
    ja/reference/commands/add/index.md

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

--- ja/reference/commands/add/index.md    2013-11-12 18:22:09 +0900 (de75615)
+++ ja/reference/commands/add/index.md    2013-11-12 19:07:52 +0900 (ef33ae5)
@@ -8,16 +8,87 @@ layout: default
 
 ## 概要
 
+add は、テーブルにレコードを登録します。
+
+対象のテーブルが主キーを持っており、同じキーのレコードが既に存在している場合には、既存レコードのカラムの値を更新します。
 
 ## 構文
 
+対象のテーブルが主キーを持つ場合：
+
+    {
+      "table"  : "テーブル名",
+      "key"    : "主キー",
+      "values" : {
+        "カラム名1" : 値1,
+        "カラム名2" : 値2,
+        ...
+      }
+    }
 
-## 使い方
+対象のテーブルが主キーを持たない場合：
 
+    {
+      "table"  : "テーブル名",
+      "values" : {
+        "カラム名1" : 値1,
+        "カラム名2" : 値2,
+        ...
+      }
+    }
 
 ## パラメータ
 
+### `table`
+
+ * 概要：  
+   レコードを登録するテーブルの名前を指定します。
+ * 型：  
+   文字列
+ * 値：  
+   テーブル名の文字列。
+ * 指定の省略：  
+   不可能。
+<!-- * 省略時の初期値：なし -->
+
+### `key`
+
+ * 概要：  
+   レコードの主キーを指定します。
+ * 型：  
+   文字列
+ * 値：  
+   主キーとなる文字列。
+ * 指定の省略：  
+   対象のテーブルが主キーを持つ場合は省略不可能。
+<!-- * 省略時の初期値：なし -->
+
+既に同じ主キーを持つレコードが存在している場合は、レコードの各カラムの値を更新します。
+
+対象のテーブルが主キーを持たない場合は、指定しても単に無視されます。
+
+### `values`
+
+レコードの各カラムの値を指定します。
+
+ * 型：  
+   ハッシュ
+ * 値：  
+   カラム名をキー、カラムの値を値としたハッシュ。
+ * 指定の省略：  
+   可能。
+ * 省略時の初期値：  
+   `null`
+
+指定されなかったカラムの値は登録・更新されません。
+
 
 ## レスポンス
 
+ * 型：  
+   真偽型
+ * 値：  
+   レコードの登録の成否を示す真偽値。
 
+ * `true`：レコードの登録に成功した。
+ * `false`：レコードの登録に失敗した。
-------------- next part --------------
HTML����������������������������...
Download 


Groonga - fulltext search engine.

[Groonga-commit] droonga/droonga.org at b0be5bd [gh-pages] Add descriptions of "add" command