emqx/apps/emqx_resource
Zaiming (Stone) Shi 1c3e055b13
Merge pull request #9822 from JimMoen/fix-schema-typo
chore: i18n typo fix
2023-01-20 11:11:18 +01:00
..
i18n chore: i18n typo fix 2023-01-20 11:50:01 +08:00
include chore(resources): add missing parameters to emqx_resource schema 2023-01-18 14:33:45 +02:00
src chore(resources): add missing parameters to emqx_resource schema 2023-01-18 14:33:45 +02:00
test chore: don't cancel inflight items upon worker death; retry them 2023-01-17 19:50:30 -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.