Shawn 46838a08cc fix(resource): update testcases for after_query functions 4 лет назад
..
include 9aa63358e6 fix(resource): type spec for resource_data() 4 лет назад
src 29ad6d215e feat(resource): add metrics to emqx_resource 4 лет назад
test 46838a08cc fix(resource): update testcases for after_query functions 4 лет назад
README.md 071c2c99e8 refactor(authn resources): add `emqx_resource` and `emqx_authn` tests 4 лет назад
rebar.config 9617b65d52 fix(dialyzer): incorrect function spec 4 лет назад

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.