添加sqlserver维表和结果表文档说明

Author: xiuzhu9527

README.md

@@ -27,8 +27,8 @@
 
 # 已支持
   * 源表：kafka 0.9、0.10、0.11、1.x版本
-  * 维表：mysql, SQlServer,oracle, hbase, mongo, redis, cassandra, serversocket, kudu, postgresql, clickhouse
-  * 结果表：mysql, SQlServer, oracle, hbase, elasticsearch5.x, mongo, redis, cassandra, console, kudu, postgresql, clickhouse
+  * 维表：mysql, SQlServer,oracle, hbase, mongo, redis, cassandra, serversocket, kudu, postgresql, clickhouse, sqlserver
+  * 结果表：mysql, SQlServer, oracle, hbase, elasticsearch5.x, mongo, redis, cassandra, console, kudu, postgresql, clickhouse, sqlserver
 
 # 后续开发计划
   * 维表快照
@@ -186,6 +186,7 @@ sh submit.sh -sql D:\sideSql.txt  -name xctest -remoteSqlPluginPath /opt/dtstack
 * [kudu 结果表插件](docs/kuduSink.md)
 * [postgresql 结果表插件](docs/postgresqlSink.md)
 * [clickhouse 结果表插件](docs/clickhouseSink.md)
+* [sqlserver 结果表插件](docs/sqlserverSink.md)
 
 ### 2.3 维表插件
 * [hbase 维表插件](docs/hbaseSide.md)
@@ -197,6 +198,7 @@ sh submit.sh -sql D:\sideSql.txt  -name xctest -remoteSqlPluginPath /opt/dtstack
 * [kudu 维表插件](docs/kuduSide.md)
 * [postgresql 维表插件](docs/postgresqlSide.md)
 * [clickhouse 维表插件](docs/clickhouseSide.md)
+* [sqlserver 维表插件](docs/sqlserverSide.md)
 
 ## 3 性能指标(新增)
 

docs/sqlserverSide.md

@@ -0,0 +1,79 @@
+
+## 1.格式：
+```
+ CREATE TABLE tableName(
+     colName cloType,
+     ...
+     PRIMARY KEY(keyInfo),
+     PERIOD FOR SYSTEM_TIME
+  )WITH(
+     type='sqlserver',
+     url='jdbcUrl',
+     userName='dbUserName',
+     password='dbPwd',
+     tableName='tableName',
+     cache ='LRU',
+     cacheSize ='10000',
+     cacheTTLMs ='60000',
+     parallelism ='1',
+     partitionedJoin='false'
+  );
+```
+
+# 2.支持版本
+ mysql-5.6.35
+ 
+## 3.表结构定义
+  
+ |参数名称|含义|
+ |----|---|
+ | tableName | sqlserver表名称|
+ | colName | 列名称|
+ | colType | 列类型 [colType支持的类型](colType.md)|
+ | PERIOD FOR SYSTEM_TIME | 关键字表明该定义的表为维表信息|
+ | PRIMARY KEY(keyInfo) | 维表主键定义;多个列之间用逗号隔开|
+ 
+## 4.参数
+
+  |参数名称|含义|是否必填|默认值|
+  |----|---|---|----|
+  | type | 表明维表的类型 sqlserver |是||
+  | url | 连接mysql数据库 jdbcUrl |是||
+  | userName | sqlserver连接用户名 |是||
+  | password | sqlserver连接密码|是||
+  | tableName | sqlserver表名称|是||
+  | tableName | sqlserver 的表名称|是||
+  | cache | 维表缓存策略(NONE/LRU)|否|NONE|
+  | partitionedJoin | 是否在維表join之前先根据 設定的key 做一次keyby操作(可以減少维表的数据缓存量)|否|false|
+  
+  ----------
+  > 缓存策略
+  * NONE: 不做内存缓存
+  * LRU:
+    * cacheSize: 缓存的条目数量
+    * cacheTTLMs:缓存的过期时间(ms)
+
+## 5.样例
+```
+create table sideTable(
+    channel varchar,
+    xccount int,
+    PRIMARY KEY(channel),
+    PERIOD FOR SYSTEM_TIME
+ )WITH(
+    type='sqlserver',
+    url='jdbc:sqlserver://172.16.8.104:1433/test?charset=utf8',
+    userName='dtstack',
+    password='abc123',
+    tableName='sidetest',
+    cache ='LRU',
+    cacheSize ='10000',
+    cacheTTLMs ='60000',
+    parallelism ='1',
+    partitionedJoin='false'
+ );
+
+
+```
+
+

docs/sqlserverSink.md

@@ -0,0 +1,53 @@
+## 1.格式：
+```
+CREATE TABLE tableName(
+    colName colType,
+    ...
+    colNameX colType
+ )WITH(
+    type ='sqlserver',
+    url ='jdbcUrl',
+    userName ='userName',
+    password ='pwd',
+    tableName ='tableName',
+    parallelism ='parllNum'
+ );
+
+```
+
+## 2.支持版本
+ sqlserver-5.6.35
+ 
+## 3.表结构定义
+ 
+|参数名称|含义|
+|----|---|
+| tableName| sqlserver表名称|
+| colName | 列名称|
+| colType | 列类型 [colType支持的类型](colType.md)|
+
+## 4.参数：
+
+|参数名称|含义|是否必填|默认值|
+|----|----|----|----|
+|type |表名 输出表类型[mysq|hbase|elasticsearch]|是||
+|url | 连接sqlserver数据库 jdbcUrl |是||
+|userName | sqlserver连接用户名 |是||
+| password | sqlserver连接密码|是||
+| tableName | sqlserver表名称|是||
+| parallelism | 并行度设置|否|1|
+  
+## 5.样例：
+```
+CREATE TABLE MyResult(
+    channel VARCHAR,
+    pv VARCHAR
+ )WITH(
+    type ='sqlserver',
+    url ='jdbc:sqlserver://172.16.8.104:1433/test?charset=utf8',
+    userName ='dtstack',
+    password ='abc123',
+    tableName ='pv2',
+    parallelism ='1'
+ )
+ ```