diff --git a/apps/emqx_bridge_matrix/src/emqx_bridge_matrix.erl b/apps/emqx_bridge_matrix/src/emqx_bridge_matrix.erl index 78810bc9e..fb8ee9d4d 100644 --- a/apps/emqx_bridge_matrix/src/emqx_bridge_matrix.erl +++ b/apps/emqx_bridge_matrix/src/emqx_bridge_matrix.erl @@ -3,6 +3,8 @@ %%-------------------------------------------------------------------- -module(emqx_bridge_matrix). +-include_lib("hocon/include/hoconsc.hrl"). + -export([ conn_bridge_examples/1 ]). @@ -67,6 +69,8 @@ fields("post_connector") -> fields(Method) -> emqx_bridge_pgsql:fields(Method). +desc("config_connector") -> + ?DESC(emqx_postgresql_connector_schema, "config_connector"); desc(_) -> undefined. diff --git a/apps/emqx_bridge_pgsql/src/emqx_bridge_pgsql.erl b/apps/emqx_bridge_pgsql/src/emqx_bridge_pgsql.erl index c32504124..2fe3960d5 100644 --- a/apps/emqx_bridge_pgsql/src/emqx_bridge_pgsql.erl +++ b/apps/emqx_bridge_pgsql/src/emqx_bridge_pgsql.erl @@ -112,6 +112,12 @@ desc("config") -> ?DESC("desc_config"); desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" -> ["Configuration for PostgreSQL using `", string:to_upper(Method), "` method."]; +desc(pgsql_action) -> + ?DESC("pgsql_action"); +desc(action_parameters) -> + ?DESC("action_parameters"); +desc("config_connector") -> + ?DESC(emqx_postgresql_connector_schema, "config_connector"); desc(_) -> undefined. diff --git a/apps/emqx_bridge_timescale/src/emqx_bridge_timescale.erl b/apps/emqx_bridge_timescale/src/emqx_bridge_timescale.erl index 9cefabc15..759f69ed7 100644 --- a/apps/emqx_bridge_timescale/src/emqx_bridge_timescale.erl +++ b/apps/emqx_bridge_timescale/src/emqx_bridge_timescale.erl @@ -3,6 +3,8 @@ %%-------------------------------------------------------------------- -module(emqx_bridge_timescale). +-include_lib("hocon/include/hoconsc.hrl"). + -export([ conn_bridge_examples/1 ]). @@ -67,6 +69,8 @@ fields("post_connector") -> fields(Method) -> emqx_bridge_pgsql:fields(Method). +desc("config_connector") -> + ?DESC(emqx_postgresql_connector_schema, "config_connector"); desc(_) -> undefined. diff --git a/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl b/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl index 1ffe306e9..c2ce2568c 100644 --- a/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl +++ b/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl @@ -117,7 +117,7 @@ connector_structs() -> )}, {pgsql, mk( - hoconsc:map(name, ref(emqx_postgresql_connector_schema, "config_connector")), + hoconsc:map(name, ref(emqx_bridge_pgsql, "config_connector")), #{ desc => <<"PostgreSQL Connector Config">>, required => false diff --git a/apps/emqx_postgresql/src/schema/emqx_postgresql_connector_schema.erl b/apps/emqx_postgresql/src/schema/emqx_postgresql_connector_schema.erl index 1d6949856..366d9c71d 100644 --- a/apps/emqx_postgresql/src/schema/emqx_postgresql_connector_schema.erl +++ b/apps/emqx_postgresql/src/schema/emqx_postgresql_connector_schema.erl @@ -25,7 +25,8 @@ -export([ roots/0, - fields/1 + fields/1, + desc/1 ]). %% Examples @@ -35,7 +36,7 @@ ]). roots() -> - [{config, #{type => hoconsc:ref(?MODULE, config)}}]. + []. fields("config_connector") -> [{server, server()}] ++ @@ -199,3 +200,8 @@ values(producer) -> }, local_topic => <<"mqtt/local/topic">> }. + +desc("config_connector") -> + ?DESC("config_connector"); +desc(_) -> + undefined. diff --git a/rel/i18n/emqx_bridge_pgsql.hocon b/rel/i18n/emqx_bridge_pgsql.hocon index 0a5ca2b04..8fcf9139e 100644 --- a/rel/i18n/emqx_bridge_pgsql.hocon +++ b/rel/i18n/emqx_bridge_pgsql.hocon @@ -40,4 +40,17 @@ sql_template.desc: sql_template.label: """SQL Template""" +pgsql_action.desc: +"""Configuration for PostgreSQL Action""" + +pgsql_action.label: +"""PostgreSQL Action Configuration""" + + +action_parameters.desc: +"""Configuration Parameters Specific to the PostgreSQL Action""" + +action_parameters.label: +"""Action Parameters""" + } diff --git a/rel/i18n/emqx_postgresql.hocon b/rel/i18n/emqx_postgresql.hocon index c6d2581c1..9740b0814 100644 --- a/rel/i18n/emqx_postgresql.hocon +++ b/rel/i18n/emqx_postgresql.hocon @@ -8,4 +8,10 @@ The PostgreSQL default port 5432 is used if `[:Port]` is not specified.""" server.label: """Server Host""" +config_connector.desc: +"""The configuration for the PostgreSQL connector.""" + +config_connector.label: +"""PostgreSQL Connector Config""" + } diff --git a/rel/i18n/emqx_postgresql_connector_schema.hocon b/rel/i18n/emqx_postgresql_connector_schema.hocon new file mode 100644 index 000000000..8ecfb958a --- /dev/null +++ b/rel/i18n/emqx_postgresql_connector_schema.hocon @@ -0,0 +1,18 @@ + +emqx_postgresql_connector_schema { + +server.desc: +"""The IPv4 or IPv6 address or the hostname to connect to.
+A host entry has the following form: `Host[:Port]`.
+The PostgreSQL default port 5432 is used if `[:Port]` is not specified.""" + +server.label: +"""Server Host""" + +config_connector.desc: +"""The configuration for the PostgreSQL connector.""" + +config_connector.label: +"""PostgreSQL Connector Config""" + +}