upgrade plugin buildrun emqx backend mysql

Author: wuguokai

.DS_Store

@@ -3,13 +3,24 @@ EMQX  client connection and message save to MySQL
 
 emqx 客户端连接状态和消息持久化到MySQL 插件
 
+### erlang 环境配置
+
+若没配置erlang环境，请参考[erlang 环境配置](./erlang环境配置.md).
 
 ### 编译发布插件
 
-1、clone emqx-rel 项目
+1、clone emqx-rel 项目, 切换到改 tag  v4.1.2
+
+``` bash
+git clone https://github.com/emqx/emqx-rel.git
+cd emqx-rel
+git checkout v4.1.2
+make
+```
 
-> git clone https://github.com/emqx/emqx-rel.git
+正常构建成功后，运行 `_build/emqx/rel/emqx/bin/emqx console` 启动 emqx
 
+### 添加自定义插件
 
 2.rebar.config 添加依赖
 
@@ -41,6 +52,8 @@ emqx 客户端连接状态和消息持久化到MySQL 插件
 
 > make
 
+打开 `localhost:18083` 的插件栏可以看到 `buildrun_emqx_backend_mysql` 插件。
+
 ### config配置
 
 File: etc/buildrun_emqx_backend_mysql.conf
@@ -68,7 +81,7 @@ mysql.query_timeout = 10s
 
 ### mqtt_client.sql, mqtt_msg.sql
 
-mqtt_client.sql, mqtt_msg.sql到你的数据库中
+到你的数据库中执行[mqtt_client.sql](./sql/mqtt_client.sql), [mqtt_msg.sql](./sql/mqtt_msg.sql)。
 
 ### 加载插件
 
@@ -80,11 +93,17 @@ data/loaded_plugins
 
 > 添加 {buildrun_emqx_backend_mysql, true}.
 
+设置插件自动启动
+
 注意：这种方式适用emqx未启动之前
 
+或者
+
+可以在emqx启动后，在 dashboard 插件栏点击启用 `buildrun_emqx_backend_mysql` 即可启用成功
+
 ### 使用
 
-此插件会把public发布的消息保存到mysql中，但并不是全部。
+此插件会把public发布的消息保存到mysql中，但并不是全部。也可以在业务规则中添加存储类型的资源。
 
 需要在发布消息的参数中 retain 值设置为 true。 这样这条消息才会被保存在mysql中
 
@@ -100,6 +119,14 @@ eg：
 }
 ```
 
+### 构建镜像
+
+`emqx-rel` 项目自带构建镜像的功能
+
+``` bash
+make emqx-docker-build
+```
+
 ### 最后
 
 有什么问题和功能需求都可以给我提issue，欢迎关注。

README.md

@@ -0,0 +1,43 @@
+# erlang环境配置
+
+erlang 推荐使用 22 版本，经过测试用 23 版本编译出来运行有问题。各平台安装 erlang 详情请参考官方文档。 linux 系统可以使用 kerl 脚本安装，构建最新版本的 emqx 时注意编译的 gcc 版本不能用 10，编译通不过，推荐用 gcc-9
+
+下载 kerl
+
+``` bash
+curl -O https://raw.githubusercontent.com/kerl/kerl/master/kerl
+chmod +x kerl
+```
+
+安装 erlang
+
+``` bash
+kerl update releases
+# 如果直接构建报错，修改 ~/.kerl/builds/22.3/otp_src_22.3/Makefile
+# 将 gcc 改为 gcc9
+kerl build 22.3 22.3
+kerl install 22.3 /opt/erlang/22.3
+# 启用环境
+source /opt/erlang/22.3/activate
+# 设置环境变量，这样不用每次手动启用
+echo 'source /opt/erlang/22.3/activate' >> ~/.bashrc
+```
+
+安装 rebar3
+
+``` bash
+curl -OL https://s3.amazonaws.com/rebar3/rebar3
+./rebar3 local install
+# 然后根据输出操作
+```
+
+<a id="orgeb79a2a"></a>
+
+## emacs 编辑器配置
+
+需要安装 erlang 包，提供 erlang-mode 再安装 erlang-lsp
+
+``` bash
+git clone https://github.com/erlang-ls/erlang_ls.git
+cd erlang_ls && make
+```

TODO

@@ -0,0 +1,56 @@
+##====================================================================
+## Configuration for EMQ X MySQL Backend
+##====================================================================
+
+## MySQL Server
+backend.mysql.pool1.server = 127.0.0.1:3306
+
+## MySQL Pool Size
+backend.mysql.pool1.pool_size = 8
+## MySQL Username
+backend.mysql.pool1.user = root
+## MySQL Password
+backend.mysql.pool1.password = public
+## MySQL Database
+backend.mysql.pool1.database = mqtt
+
+## Client Connected Record 
+backend.mysql.hook.client.connected.1    = {"action": {"function": "on_client_connected"}, "pool": "pool1"}
+
+## Session Created Record 
+backend.mysql.hook.client.connected.2     = {"action": {"function": "on_subscribe_lookup"}, "pool": "pool1"}
+
+## Client DisConnected Record 
+backend.mysql.hook.client.disconnected.1 = {"action": {"function": "on_client_disconnected"}, "pool": "pool1"}
+
+## Lookup Unread Message QOS > 0
+backend.mysql.hook.session.subscribed.1  = {"topic": "#", "action": {"function": "on_message_fetch"}, "offline_opts": {"max_returned_count": 500, "time_range": "2h"}, "pool": "pool1"}
+
+## Lookup Retain Message
+backend.mysql.hook.session.subscribed.2  = {"topic": "#", "action": {"function": "on_retain_lookup"}, "pool": "pool1"}
+
+## Delete Acked Record
+backend.mysql.hook.session.unsubscribed.1= {"topic": "#", "action": {"sql": ["delete from mqtt_acked where clientid = ${clientid} and topic = ${topic}"]}, "pool": "pool1"}
+
+## Store Publish Message QOS > 0
+backend.mysql.hook.message.publish.1     = {"topic": "#", "action": {"function": "on_message_publish"}, "pool": "pool1"}
+
+## Store Retain Message
+backend.mysql.hook.message.publish.2     = {"topic": "#", "action": {"function": "on_message_retain"}, "pool": "pool1"}
+
+## Delete Retain Message
+backend.mysql.hook.message.publish.3     = {"topic": "#", "action": {"function": "on_retain_delete"}, "pool": "pool1"}
+
+## Store Ack
+backend.mysql.hook.message.acked.1       = {"topic": "#", "action": {"function": "on_message_acked"}, "pool": "pool1"}
+
+## Max number of fetch offline messages
+## max_returned_count = 500
+
+## Time Range
+## d - day
+## h - hour
+## m - minute
+## s - second
+## time_range = 2h
+## backend.mysql.hook.session.subscribed.1  = {"topic": "#", "action": {"function": "on_message_fetch"}, "offline_opts": {"max_returned_count": 500, "time_range": "2h"}, "pool": "pool1"}

erlang环境配置.md

@@ -0,0 +1 @@
+-define(APP, emqx_backend_mysql).