emqx/apps/emqx_connector
Xinyu Liu 74bef22299
Merge pull request #7947 from emqx/fix_flaky_tests
fix: fix tests for connector so they do not fail
2022-05-16 09:35:00 +08:00
..
etc feat(connector): add new option 'mode' to mqtt connectors 2021-12-07 09:56:57 +08:00
i18n fix(doc): html line break use `</br>` 2022-04-24 18:56:21 +08:00
include style: reformat all remaining apps 2022-04-27 15:51:18 +02:00
src refactor: refine pmap implementation 2022-05-13 15:22:42 +02:00
test fix: fix tests for connector so they do not fail 2022-05-13 11:08:11 +02: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]]}