History

Zaiming (Stone) Shi 1ada840bc9 refactor: relocate i18n files for apps/emqx		2023-03-28 20:33:39 +02:00
..
include	fix(buffer_worker): change the default `resume_interval` value and expose it as hidden config	2023-03-22 11:47:36 -03:00
src	chore: add some example annotations for config importance level	2023-03-28 14:29:24 +02:00
test	feat(buffer_worker): decouple query mode from underlying connector call mode	2023-03-23 13:40:31 -03:00
README.md	feat: add test cases for batching query	2022-08-10 00:34:35 +08:00
rebar.config	fix: drop no longer supported dialyzer option	2022-12-16 13:45:05 +03: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.