History

Shawn 88ca25c60c fix(resource): fast return when starting a unavailable resource		2022-06-01 08:24:53 +08:00
..
etc	feat: generate a minimized emqx.conf	2022-05-31 19:20:27 +08:00
i18n	feat(connector-http): using pos_integer() instead of boolean() for enable_pipelining	2022-05-31 17:14:59 +08:00
include	style: reformat all remaining apps	2022-04-27 15:51:18 +02:00
src	fix(resource): fast return when starting a unavailable resource	2022-06-01 08:24:53 +08:00
test	fix(test): update test cases for emqx_resource:health_check/1	2022-05-31 10:14:37 +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]]}