History

Zaiming (Stone) Shi 58627b7958 chore(emqx_resource_manager): ignore unused return value for dialyzer		2023-02-02 14:11:12 +01:00
..
i18n	test: remove async from redis ct	2023-02-02 17:37:18 +08:00
include	fix(buffer_worker): type spec	2023-02-02 14:11:12 +01:00
src	chore(emqx_resource_manager): ignore unused return value for dialyzer	2023-02-02 14:11:12 +01:00
test	Merge pull request #9884 from savonarola/resource-fixes	2023-02-02 12:02:34 +01: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.