From afa3da6d0d9740f652e153b9d4dd934e48c77212 Mon Sep 17 00:00:00 2001 From: Kjell Winblad Date: Wed, 20 Mar 2024 10:50:44 +0100 Subject: [PATCH] refactor(cassandra connector): to use emqx_connector_info This commit refactors the cassandra connector to use the `emqx_connector_info` behavior. --- .../src/emqx_bridge_cassandra.app.src | 5 ++- .../src/emqx_bridge_cassandra_action_info.erl | 3 ++ .../emqx_bridge_cassandra_connector_info.erl | 42 +++++++++++++++++++ .../src/emqx_connector_info.erl | 3 +- .../src/schema/emqx_connector_ee_schema.erl | 12 ------ .../src/schema/emqx_connector_schema.erl | 2 - 6 files changed, 51 insertions(+), 16 deletions(-) create mode 100644 apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_connector_info.erl diff --git a/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra.app.src b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra.app.src index aa8290b98..84f9ccd21 100644 --- a/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra.app.src +++ b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra.app.src @@ -8,7 +8,10 @@ emqx_resource, ecql ]}, - {env, [{emqx_action_info_modules, [emqx_bridge_cassandra_action_info]}]}, + {env, [ + {emqx_action_info_modules, [emqx_bridge_cassandra_action_info]}, + {emqx_connector_info_modules, [emqx_bridge_cassandra_connector_info]} + ]}, {modules, []}, {links, []} ]}. diff --git a/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_action_info.erl b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_action_info.erl index 14db7cf50..158207971 100644 --- a/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_action_info.erl +++ b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_action_info.erl @@ -1,3 +1,6 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2023-2024 EMQ Technologies Co., Ltd. All Rights Reserved. +%%-------------------------------------------------------------------- -module(emqx_bridge_cassandra_action_info). -behaviour(emqx_action_info). diff --git a/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_connector_info.erl b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_connector_info.erl new file mode 100644 index 000000000..b86740625 --- /dev/null +++ b/apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_connector_info.erl @@ -0,0 +1,42 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2023-2024 EMQ Technologies Co., Ltd. All Rights Reserved. +%%-------------------------------------------------------------------- +-module(emqx_bridge_cassandra_connector_info). + +-behaviour(emqx_connector_info). + +-export([ + type_name/0, + bridge_types/0, + resource_callback_module/0, + config_schema/0, + schema_module/0, + api_schema/1 +]). + +type_name() -> + cassandra. + +bridge_types() -> + [cassandra]. + +resource_callback_module() -> + emqx_bridge_cassandra_connector. + +config_schema() -> + {cassandra, + hoconsc:mk( + hoconsc:map(name, hoconsc:ref(emqx_bridge_cassandra, "config_connector")), + #{ + desc => <<"Cassandra Connector Config">>, + required => false + } + )}. + +schema_module() -> + emqx_bridge_cassandra. + +api_schema(Method) -> + emqx_connector_schema:api_ref( + emqx_bridge_cassandra, <<"cassandra">>, Method ++ "_connector" + ). diff --git a/apps/emqx_connector/src/emqx_connector_info.erl b/apps/emqx_connector/src/emqx_connector_info.erl index c5fb1d411..568c66ec4 100644 --- a/apps/emqx_connector/src/emqx_connector_info.erl +++ b/apps/emqx_connector/src/emqx_connector_info.erl @@ -70,7 +70,8 @@ hard_coded_connector_info_modules_ee() -> emqx_bridge_timescale_connector_info, emqx_bridge_mongodb_connector_info, emqx_bridge_oracle_connector_info, - emqx_bridge_influxdb_connector_info + emqx_bridge_influxdb_connector_info, + emqx_bridge_cassandra_connector_info ]. -else. hard_coded_connector_info_modules_ee() -> 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 e46728188..98b55606d 100644 --- a/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl +++ b/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl @@ -21,8 +21,6 @@ resource_type(Type) when is_binary(Type) -> resource_type(binary_to_atom(Type, utf8)); -resource_type(cassandra) -> - emqx_bridge_cassandra_connector; resource_type(clickhouse) -> emqx_bridge_clickhouse_connector; resource_type(mysql) -> @@ -81,14 +79,6 @@ fields(connectors) -> connector_structs() -> [ - {cassandra, - mk( - hoconsc:map(name, ref(emqx_bridge_cassandra, "config_connector")), - #{ - desc => <<"Cassandra Connector Config">>, - required => false - } - )}, {clickhouse, mk( hoconsc:map(name, ref(emqx_bridge_clickhouse, "config_connector")), @@ -213,7 +203,6 @@ connector_structs() -> schema_modules() -> [ - emqx_bridge_cassandra, emqx_bridge_clickhouse, emqx_bridge_mysql, emqx_bridge_syskeeper_connector, @@ -236,7 +225,6 @@ api_schemas(Method) -> [ %% We need to map the `type' field of a request (binary) to a %% connector schema module. - api_ref(emqx_bridge_cassandra, <<"cassandra">>, Method ++ "_connector"), api_ref(emqx_bridge_clickhouse, <<"clickhouse">>, Method ++ "_connector"), api_ref(emqx_bridge_mysql, <<"mysql">>, Method ++ "_connector"), api_ref(emqx_bridge_syskeeper_connector, <<"syskeeper_forwarder">>, Method), diff --git a/apps/emqx_connector/src/schema/emqx_connector_schema.erl b/apps/emqx_connector/src/schema/emqx_connector_schema.erl index 940d92cba..8236f57aa 100644 --- a/apps/emqx_connector/src/schema/emqx_connector_schema.erl +++ b/apps/emqx_connector/src/schema/emqx_connector_schema.erl @@ -127,8 +127,6 @@ connector_info_schema_modules() -> %% @doc Return old bridge(v1) and/or connector(v2) type %% from the latest connector type name. -connector_type_to_bridge_types(cassandra) -> - [cassandra]; connector_type_to_bridge_types(clickhouse) -> [clickhouse]; connector_type_to_bridge_types(mysql) ->