emqx/apps/emqx_connector
Zaiming (Stone) Shi 53f9b59805
Merge pull request #8408 from zmstone/0704-docs-fix-enable_pipelining-docs
fix: enable_pipelining should not be allowed to be zero
2022-07-19 21:13:29 +01:00
..
etc feat: generate a minimized emqx.conf 2022-05-31 19:20:27 +08:00
i18n Merge pull request #8408 from zmstone/0704-docs-fix-enable_pipelining-docs 2022-07-19 21:13:29 +01:00
include chore(connector): schema validator throw error messages directly 2022-06-14 16:20:10 +02:00
src fix(connector): redis sentinel field required 2022-07-13 10:37:16 +08:00
test test(connector): redis sentinel include name 2022-07-13 10:37:16 +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 feat(quic): bump emqtt to 1.6.0 with quic 0.0.11 2022-06-16 10:38:46 +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]]}