History

Shawn 67a60e1153 refactor(rule): add more metrics for rule and bridges		2022-01-07 09:34:54 +08:00
..
include	chore: update copyright	2022-01-05 20:55:00 +01:00
src	refactor(rule): add more metrics for rule and bridges	2022-01-07 09:34:54 +08:00
test	chore: update copyright	2022-01-05 20:55:00 +01:00
README.md	refactor(authn resources): add `emqx_resource` and `emqx_authn` tests	2021-11-22 21:08:04 +03:00
rebar.config	fix(emqx_resource): disable the debug print for parse-transformed code	2021-06-07 22:11:05 +08: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_test_resource.erl for a minimal emqx_resource implementation;
test/emqx_resource_SUITE.erl for examples of emqx_resource usage.