update hbase维表部分文档

Author: Zhu4680

docs/plugin/hbaseSide.md

@@ -1,5 +1,5 @@
 
-## 1.格式：
+## 1.格式
 ```
  CREATE TABLE tableName(
      columnFamily:columnName type as alias,
@@ -31,7 +31,9 @@
 | PERIOD FOR SYSTEM_TIME | 关键字表明该定义的表为维表信息|
 | PRIMARY KEY(keyInfo) | 维表主键定义;hbase 维表rowkey的构造方式;可选择的构造包括 md5(alias + alias), '常量',也包括上述方式的自由组合 |
 
-## 3.参数
+## 4.参数
+
+参数详细说明请看[参数详细说明](./sideParams.md)
 
 |参数名称|含义|是否必填|默认值|
 |----|---|---|----|
@@ -43,31 +45,123 @@
 | partitionedJoin | 是否在維表join之前先根据 設定的key 做一次keyby操作(可以減少维表的数据缓存量)|否|false|
 
 --------------
-> 缓存策略
-  * NONE: 不做内存缓存
-  * LRU:
-    * cacheSize: 缓存的条目数量
-    * cacheTTLMs:缓存的过期时间(ms)
 
-## 4.样例
+## 5.样例
+### LRU维表示例
+```
+CREATE TABLE sideTable (  
+        wtz:message varchar as message,
+        wtz:info varchar as info , 
+        PRIMARY KEY (rowkey),
+        PERIOD FOR SYSTEM_TIME
+) WITH (
+        type = 'hbase',
+        zookeeperQuorum = '192.168.80.105:2181,192.168.80.106:2181,192.168.80.107:2181',
+        zookeeperParent = '/hbase',
+        tableName = 'testFlinkStreamSql',
+        parallelism = '1',
+        cache = 'LRU',
+        cacheSize ='10000',
+        cacheTTLMs ='60000',
+        parallelism ='1',
+        partitionedJoin='false'
+);
+```
+
+### ALL维表示例
+```
+CREATE TABLE sideTable (  
+        wtz:message varchar as message,
+        wtz:info varchar as info , 
+        PRIMARY KEY (rowkey),
+        PERIOD FOR SYSTEM_TIME
+) WITH (
+        type = 'hbase',
+        zookeeperQuorum = '192.168.80.105:2181,192.168.80.106:2181,192.168.80.107:2181',
+        zookeeperParent = '/hbase',
+        tableName = 'testFlinkStreamSql',
+        parallelism = '1',
+        cache = 'ALL',
+        cacheTTLMs ='60000',
+        parallelism ='1',
+        partitionedJoin='false'
+);
 ```
-CREATE TABLE sideTable(
-    cf:name varchar as name,
-    cf:info int as info,
-    PRIMARY KEY(md5(name) + 'test'),
-    PERIOD FOR SYSTEM_TIME
- )WITH(
-    type ='hbase',
-    zookeeperQuorum ='rdos1:2181',
-    zookeeperParent ='/hbase',
-    tableName ='workerinfo',
-    cache ='LRU',
-    cacheSize ='10000',
-    cacheTTLMs ='60000',
-    parallelism ='1',
-    partitionedJoin='true'
+
+### hbase异步维表关联完整案例
+```
+CREATE TABLE MyTable(
+        id varchar,
+        name varchar,
+        address varchar
+)WITH(
+        type = 'kafka10',
+        bootstrapServers = '172.16.101.224:9092',
+        zookeeperQuorm = '172.16.100.188:2181/kafka',
+        offsetReset = 'latest',
+        topic = 'tiezhu_test_in',
+        groupId = 'flink_sql',
+        timezone = 'Asia/Shanghai',
+        topicIsPattern = 'false',
+        parallelism = '1'
+);
+
+CREATE TABLE MyResult(
+		id varchar,
+		name varchar,
+		address varchar,
+		message varchar,
+		info varchar
+)WITH(
+		type = 'console'
  );
+ 
+ CREATE TABLE sideTable (  
+        wtz:message varchar as message,
+        wtz:info varchar as info , 
+        PRIMARY KEY (rowkey),
+         PERIOD FOR SYSTEM_TIME
+) WITH (
+        type = 'hbase',
+        zookeeperQuorum = '192.168.80.105:2181,192.168.80.106:2181,192.168.80.107:2181',
+        zookeeperParent = '/hbase',
+        tableName = 'testFlinkStreamSql',
+        parallelism = '1',
+        cache = 'LRU',
+        cacheSize ='10000',
+        cacheTTLMs ='60000',
+        parallelism ='1',
+        partitionedJoin='false'
+);
 
+insert
+into
+    MyResult
+    select
+        a.name,
+        a.id,
+        a.address,
+        b.message,
+        b.info
+    from
+        MyTable a
+    left join
+        sideTable b
+            on a.id=b.rowkey;
 ```
 
+## 6.hbase中数据存储形式
+
+在hbase中，数据是以列簇的形式存储，其中rowKey作为主键，按字典排序。
 
+在样例中，wtz为列族名，message, info为列名，数据在hbase中的存储情况为：
+```
+hbase(main):002:0> scan 'testFlinkStreamSql'
+ROW     COLUMN+CELL                                                                                                                
+ 0      column=wtz:info, timestamp=1587089266719, value=hadoop                                                                     
+ 0      column=wtz:message, timestamp=1587089245780, value=hbase                                                                   
+ 1      column=wtz:info, timestamp=1587088818432, value=flink                                                                      
+ 1      column=wtz:message, timestamp=1587088796633, value=dtstack                                                                 
+ 2      column=wtz:info, timestamp=1587088858564, value=sql                                                                        
+ 2      column=wtz:message, timestamp=1587088840507, value=stream
+```