History

Zaiming (Stone) Shi e8ccdb8d0f Merge pull request #10998 from zmstone/0609-no-batch-for-mongodb fix(mongodb): hide batch_size for mongodb resource		2023-06-11 21:26:12 +02:00
..
include	fix: dialyzer type problem	2023-06-09 11:00:05 +02:00
src	Merge pull request #10998 from zmstone/0609-no-batch-for-mongodb	2023-06-11 21:26:12 +02:00
test	fix(schema): avoid `function_clause` error when compacting errors	2023-06-07 10:34:58 -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.