History

Thales Macedo Garitezi 62eeb4b8e8 feat(resource): reset metrics when stopping a resource		2022-10-18 09:32:35 -03:00
..
i18n	fix: rename queue_max_bytes -> max_queue_bytes	2022-08-30 17:18:54 +08:00
include	refactor: change some default values of resource_opts	2022-09-14 15:18:07 +08:00
src	feat(resource): reset metrics when stopping a resource	2022-10-18 09:32:35 -03:00
test	feat(resource): reset metrics when stopping a resource	2022-10-18 09:32:35 -03:00
README.md	feat: add test cases for batching query	2022-08-10 00:34:35 +08:00
rebar.config	style: reformat all remaining apps	2022-04-27 15:51:18 +02: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.