This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-seatunnel-datasource-sdk.git
The following commit(s) were added to refs/heads/main by this push:
new 04d412b Add SeaTunnelDataSourceClient docs (#5)
04d412b is described below
commit 04d412b064d5968f89e774640bbf62bcc0a19277
Author: Kirs <[email protected]>
AuthorDate: Fri Dec 30 11:24:06 2022 +0800
Add SeaTunnelDataSourceClient docs (#5)
* Add guava dependency
* Add client doc
---
.../client/SeaTunnelDataSourceClient.java | 32 +++++------
.../client/SimpleSeaTunnelDataSourceClient.java | 12 ++---
.../service/SeaTunnelDataSourceService.java | 63 ++++++++++++++++++++--
3 files changed, 82 insertions(+), 25 deletions(-)
diff --git
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SeaTunnelDataSourceClient.java
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SeaTunnelDataSourceClient.java
index 46dd654..6346ff4 100644
---
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SeaTunnelDataSourceClient.java
+++
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SeaTunnelDataSourceClient.java
@@ -34,67 +34,67 @@ public class SeaTunnelDataSourceClient extends
AbstractSeaTunnelDataSourceClient
}
@Override
- public List<DataSourcePluginInfo> listAllDataSources() {
+ public OptionRule getDataSourceMetadataFieldsByDataSourceName(String
dataSourceName) {
return null;
}
@Override
- public OptionRule queryDataSourceFieldByName(String dataSourceName) {
+ public OptionRule getDataSourceMetadataFieldsByDataSourceId(String
dataSourceId) {
return null;
}
@Override
- public Boolean checkDataSourceFields(Map<String, Object> parameters) {
+ public List<String> getTables(String dataSourceId, Map<String, Object>
requestParams) {
return null;
}
@Override
- public DataSource queryDataSourceById(Long dataSourceId) {
+ public List<String> getDatabases(String dataSourceId, Map<String, Object>
requestParams) {
return null;
}
@Override
- public Boolean saveDataSource(String dataSourceName, String comment,
String pluginName, Map<String, Object> parameters) {
- return false;
+ public Table getTable(String dataSourceId, Map<String, Object>
requestParams) {
+ return null;
}
@Override
- public Boolean deleteDataSource(Long id) {
- return false;
+ public List<DataSourcePluginInfo> listAllDataSources() {
+ return null;
}
@Override
- public Boolean updateDataSource(Long dataSourceId, String dataSourceName,
String comment, Map<String, Object> parameters) {
- return false;
+ public OptionRule queryDataSourceFieldByName(String pluginName) {
+ return null;
}
@Override
- public Boolean checkDataSourceConnectivity(Map<String, Object>
dataSourceParams) {
+ public Boolean checkDataSourceFields(String pluginName, Map<String,
Object> parameters) {
return null;
}
@Override
- public OptionRule getDataSourceMetadataFieldsByDataSourceName(String
dataSourceName) {
+ public DataSource queryDataSourceById(Long dataSourceId) {
return null;
}
@Override
- public OptionRule getDataSourceMetadataFieldsByDataSourceId(String
dataSourceId) {
+ public Boolean saveDataSource(String dataSourceName, String comment,
String pluginName, Map<String, Object> parameters) {
return null;
}
@Override
- public List<String> getTables(String dataSourceId, Map<String, Object>
requestParams) {
+ public Boolean deleteDataSource(Long id) {
return null;
}
@Override
- public List<String> getDatabases(String dataSourceId, Map<String, Object>
requestParams) {
+ public Boolean updateDataSource(Long dataSourceId, String dataSourceName,
String comment, Map<String, Object> parameters) {
return null;
}
@Override
- public Table getTable(String dataSourceId, Map<String, Object>
requestParams) {
+ public Boolean checkDataSourceConnectivity(String pluginName, Map<String,
Object> dataSourceParams) {
return null;
}
diff --git
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SimpleSeaTunnelDataSourceClient.java
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SimpleSeaTunnelDataSourceClient.java
index 6e1689f..dafa783 100644
---
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SimpleSeaTunnelDataSourceClient.java
+++
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/client/SimpleSeaTunnelDataSourceClient.java
@@ -39,12 +39,12 @@ public class SimpleSeaTunnelDataSourceClient extends
AbstractSeaTunnelDataSource
}
@Override
- public OptionRule queryDataSourceFieldByName(String dataSourceName) {
+ public OptionRule queryDataSourceFieldByName(String pluginName) {
return null;
}
@Override
- public Boolean checkDataSourceFields(Map<String, Object> parameters) {
+ public Boolean checkDataSourceFields(String pluginName, Map<String,
Object> parameters) {
return null;
}
@@ -55,21 +55,21 @@ public class SimpleSeaTunnelDataSourceClient extends
AbstractSeaTunnelDataSource
@Override
public Boolean saveDataSource(String dataSourceName, String comment,
String pluginName, Map<String, Object> parameters) {
- return false;
+ return null;
}
@Override
public Boolean deleteDataSource(Long id) {
- return false;
+ return null;
}
@Override
public Boolean updateDataSource(Long dataSourceId, String dataSourceName,
String comment, Map<String, Object> parameters) {
- return false;
+ return null;
}
@Override
- public Boolean checkDataSourceConnectivity(Map<String, Object>
dataSourceParams) {
+ public Boolean checkDataSourceConnectivity(String pluginName, Map<String,
Object> dataSourceParams) {
return null;
}
}
diff --git
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/service/SeaTunnelDataSourceService.java
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/service/SeaTunnelDataSourceService.java
index 9b2db50..d383c63 100644
---
a/datasource-client/src/main/java/org/apache/seatunnel/datasource/service/SeaTunnelDataSourceService.java
+++
b/datasource-client/src/main/java/org/apache/seatunnel/datasource/service/SeaTunnelDataSourceService.java
@@ -26,19 +26,76 @@ import java.util.Map;
public interface SeaTunnelDataSourceService {
+ /**
+ * get all data source plugins
+ *
+ * @return data source plugins info
+ */
List<DataSourcePluginInfo> listAllDataSources();
- OptionRule queryDataSourceFieldByName(String dataSourceName);
+ /**
+ * get data source plugin fields
+ *
+ * @param pluginName data source name
+ * @return data source plugin fields
+ */
+ OptionRule queryDataSourceFieldByName(String pluginName);
- Boolean checkDataSourceFields(Map<String, Object> parameters);
+ /**
+ * check data source params is valid and connectable
+ *
+ * @param parameters data source params
+ * eg mysql plugin
+ * key: url // jdbc url
+ * key: username
+ * key: password
+ * other key...
+ * @return true if valid, false if invalid
+ */
+ Boolean checkDataSourceFields(String pluginName, Map<String, Object>
parameters);
DataSource queryDataSourceById(Long dataSourceId);
+ /**
+ * save data source
+ *
+ * @param dataSourceName data source name
+ * @param comment data source comment
+ * @param pluginName data source plugin name
+ * @param parameters data source params
+ * eg mysql plugin
+ * key: url // jdbc url
+ * key: username
+ * key: password
+ * other key...
+ * @return save result
+ */
Boolean saveDataSource(String dataSourceName, String comment, String
pluginName, Map<String, Object> parameters);
+ /**
+ * delete data source, only set delete flag, we don't really delete data.
+ *
+ * @param id data source id
+ * @return delete result
+ */
Boolean deleteDataSource(Long id);
+ /**
+ * update data source
+ *
+ * @param dataSourceId data source id
+ * @param dataSourceName data source name
+ * @param comment data source comment
+ * @param parameters data source params
+ * @return update result
+ */
Boolean updateDataSource(Long dataSourceId, String dataSourceName, String
comment, Map<String, Object> parameters);
- Boolean checkDataSourceConnectivity(Map<String, Object> dataSourceParams);
+ /**
+ * we can use this method to check data source connectivity
+ *
+ * @param dataSourceParams data source params
+ * @return check result
+ */
+ Boolean checkDataSourceConnectivity(String pluginName, Map<String, Object>
dataSourceParams);
}
