emqx/apps/emqx_connector
Stefan Strigler 1690a6dcfc
Merge branch 'master' into dev/api-refactor
2023-01-13 15:34:13 +01:00
..
etc feat: generate a minimized emqx.conf 2022-05-31 19:20:27 +08:00
i18n refactor: remove the auto_reconnect field 2023-01-11 21:47:06 +08:00
include refactor: remove the auto_reconnect field 2023-01-11 21:47:06 +08:00
src Merge branch 'master' into dev/api-refactor 2023-01-13 15:34:13 +01:00
test ci: wait for redis in emqx_ee_bridge_redis_SUITE 2023-01-09 14:39:56 +01:00
.gitignore Revert "chore: mv emqx_connector to emqx_data_bridge" 2021-06-17 19:11:10 +08:00
README.md refactor: remove the auto_reconnect field 2023-01-11 21:47:06 +08:00
docker-ct ci: only start required docker for integration tests 2022-09-06 19:25:53 +02:00
rebar.config chore: upgrade mongodb-erlang to v3.0.19 2023-01-09 18:14:11 +01: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 =>
       #{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]]}