emqx/apps/emqx_connector
Yang Miao 4a43a10296
Merge pull request #7701 from EMQ-YangM/improve_docs
fix: improve document quality
2022-04-22 16:52:09 +08:00
..
etc feat(connector): add new option 'mode' to mqtt connectors 2021-12-07 09:56:57 +08:00
i18n Merge pull request #7701 from EMQ-YangM/improve_docs 2022-04-22 16:52:09 +08:00
include docs(schema): Minor improvements to spelling and formatting. 2022-03-30 13:05:56 +02:00
src Merge pull request #7701 from EMQ-YangM/improve_docs 2022-04-22 16:52:09 +08:00
test refactor: always recreate resources no matter it is connected or not 2022-04-20 11:43:05 +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 fix: update MongoDB version 2022-04-07 09:52:22 +08: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]]}