From e09ec84f450d51cae678de96be7a8a4a429f90e1 Mon Sep 17 00:00:00 2001
From: Liu Jianping <heljoy@foxmail.com>
Date: Fri, 10 Apr 2020 16:03:38 +0800
Subject: [PATCH] gdbwriter: update readme doc

---
 gdbwriter/doc/gdbwriter.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/gdbwriter/doc/gdbwriter.md b/gdbwriter/doc/gdbwriter.md
index 82cdd899..70524a59 100644
--- a/gdbwriter/doc/gdbwriter.md
+++ b/gdbwriter/doc/gdbwriter.md
@@ -41,6 +41,14 @@ GDBWriter通过DataX框架获取Reader生成的协议数据，使用`g.addV/E(GD
                             {
                                 "random": "60,64",
                                 "type": "string"
+                            },
+                            {
+                                "random": "100,1000",
+                                "type": "long"
+                            },
+                            {
+                                "random": "32,48",
+                                "type": "string"
                             }
                         ],
                         "sliceRecordCount": 1000
@@ -70,6 +78,18 @@ GDBWriter通过DataX框架获取Reader生成的协议数据，使用`g.addV/E(GD
                                 "name": "vertex_propKey",
                                 "value": "${2}",
                                 "type": "string",
+                                "columnType": "vertexSetProperty"
+                            },
+                            {
+                                "name": "vertex_propKey",
+                                "value": "${3}",
+                                "type": "long",
+                                "columnType": "vertexSetProperty"
+                            },
+                            {
+                                "name": "vertex_propKey2",
+                                "value": "${4}",
+                                "type": "string",
                                 "columnType": "vertexProperty"
                             }
                         ]
@@ -290,6 +310,7 @@ GDBWriter通过DataX框架获取Reader生成的协议数据，使用`g.addV/E(GD
       * primaryKey：表示该字段是主键id
     * 点枚举值：
       * vertexProperty：labelType为点时，表示该字段是点的普通属性
+      * vertexSetProperty：labelType为点时，表示该字段是点的SET属性，value是SET属性中的一个属性值
       * vertexJsonProperty：labelType为点时，表示是点json属性，value结构请见备注**json properties示例**，点配置最多只允许出现一个json属性；
     * 边枚举值：
       * srcPrimaryKey：labelType为边时，表示该字段是起点主键id
@@ -305,6 +326,14 @@ GDBWriter通过DataX框架获取Reader生成的协议数据，使用`g.addV/E(GD
   >    {"k":"age","t":"int","v":"20"},
   >    {"k":"sex","t":"string","v":"male"}
   > ]}
+  >
+  > # json格式同样支持给点添加SET属性，格式如下
+  > {"properties":[
+  >    {"k":"name","t":"string","v":"tom","c":"set"},
+  >    {"k":"name","t":"string","v":"jack","c":"set"},
+  >    {"k":"age","t":"int","v":"20"},
+  >    {"k":"sex","t":"string","v":"male"}
+  > ]}
   > ```
 
 ## 4 性能报告
@@ -367,4 +396,5 @@ DataX压测机器
 - GDBWriter插件与用户查询DSL使用相同的GDB实例端口，导入时可能会影响查询性能
 
 ## FAQ
-无
+1. 使用SET属性需要升级GDB实例到`1.0.20`版本及以上。
+2. 边只支持普通单值属性，不能给边写SET属性数据。