emqx/apps/emqx_connector
Xinyu Liu 54a6505984
Merge pull request #7982 from terry-xiaoyu/bridge_mode_in_mqtt_connector
fix: add bridge_mode field to the mqtt connector
2022-05-19 08:56:42 +08:00
..
etc feat(connector): add new option 'mode' to mqtt connectors 2021-12-07 09:56:57 +08:00
i18n fix(spell): please the spell checker 2022-05-19 08:55:47 +08:00
include style: reformat all remaining apps 2022-04-27 15:51:18 +02:00
src Merge pull request #7982 from terry-xiaoyu/bridge_mode_in_mqtt_connector 2022-05-19 08:56:42 +08:00
test refactor: move some APIs to new module emqx_bridge_resource 2022-05-18 15:12:34 +08:00
.gitignore Revert "chore: mv emqx_connector to emqx_data_bridge" 2021-06-17 19:11:10 +08:00
README.md fix(emqx_connector): fix resource status 2022-02-25 16:47:32 +08:00
rebar.config style: reformat all remaining apps 2022-04-27 15:51:18 +02:00

README.md

emqx_connector

This application is a collection of connectors.

A connector is a callback module of emqx_resource that maintains the data related to external resources. Put all resource related callback modules in a single application is good as we can put some util functions/modules here for reusing purpose.

For example, a MySQL connector is an emqx resource that maintains all the MySQL connection related parameters (configs) and the TCP connections to the MySQL server.

An MySQL connector can be used as following:

(emqx@127.0.0.1)5> emqx_resource:list_instances_verbose().
[#{config =>
       #{auto_reconnect => true,cacertfile => [],certfile => [],
         database => "mqtt",keyfile => [],password => "public",
         pool_size => 1,
         server => {{127,0,0,1},3306},
         ssl => false,user => "root",verify => false},
   id => <<"mysql-abc">>,mod => emqx_connector_mysql,
   state => #{poolname => 'mysql-abc'},
   status => connected}]
(emqx@127.0.0.1)6> emqx_resource:query(<<"mysql-abc">>, {sql, <<"SELECT count(1)">>}).
{ok,[<<"count(1)">>],[[1]]}