History

Thales Macedo Garitezi eebfb44f72 fix(resource): create `simple_async_internal_buffer` query mode for bridges with internal buffering Since authn/authz backends also use simple async/sync queries, we may want to avoid them calling the connector when it's not connected.		2023-10-09 15:02:25 -03:00
..
include	fix(kafka_producer): correctly handle metrics for connector that have internal buffers	2023-10-09 15:02:25 -03:00
src	fix(resource): create `simple_async_internal_buffer` query mode for bridges with internal buffering	2023-10-09 15:02:25 -03:00
test	fix: dialyzer warning	2023-09-20 22:41:26 +08: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.