History

zmstone 98f70ea8d8 Merge remote-tracking branch 'origin/release-572' into release-57		2024-06-26 22:28:08 +02:00
..
include	chore: rename _probe_ to t_probe_	2024-02-27 17:57:15 +08:00
src	chore: minimize oss/platform diff	2024-06-24 15:30:03 +02:00
test	test: attempt to fix flaky test	2024-06-26 13:40:49 -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.