emqx/apps/emqx_resource
JimMoen 68946f1f6c feat: influxdb support `async`/`batch_async` query 2022-08-15 14:02:17 +08:00
..
i18n chore: refine influxdb bridge/connector i18n 2022-08-15 14:00:14 +08:00
include fix: schema default value using raw type before convert 2022-08-12 16:38:46 +08:00
src feat: influxdb support `async`/`batch_async` query 2022-08-15 14:02:17 +08:00
test feat(resource): resource batch/async/queue config schema 2022-08-11 16:59:18 +08:00
README.md feat: add test cases for batching query 2022-08-10 00:34:35 +08:00
rebar.config style: reformat all remaining apps 2022-04-27 15:51:18 +02:00

README.md

emqx_resource

The emqx_resource is a behavior that manages configuration specs and runtime states for resources like mysql or redis backends.

It is intended to be used by the emqx_bridges and all other resources that need CRUD operations to their configs, and need to initialize the states when creating.

There can be foreign references between resource instances via resource-id. So they may find each other via this Id.

The main idea of the emqx resource is to put all the general code in a common lib, including the config operations (like config validation, config dump back to files), and the state management. And we put all the specific codes to the callback modules.

See

  • test/emqx_connector_demo.erl for a minimal emqx_resource implementation;
  • test/emqx_resource_SUITE.erl for examples of emqx_resource usage.