You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "litiliu (via GitHub)" <gi...@apache.org> on 2024/06/07 06:12:27 UTC
[PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
litiliu opened a new pull request, #6960:
URL: https://github.com/apache/seatunnel/pull/6960
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB issue](https://github.com/apache/seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix typo in README.md doc`.
-->
### Purpose of this pull request
<!-- Describe the purpose of this pull request. For example: This pull request adds checkstyle plugin.-->
This close #6910
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released SeaTunnel versions or within the unreleased branches such as dev.
If no, write 'No'.
If you are adding/modifying connector documents, please follow our new specifications: https://github.com/apache/seatunnel/issues/4544.
-->
Yes.
The previous behavior of the `Transform-V2 Filter` is keeping the columns in the `fields` field. In this PR I added an optional option named `mode`, the default value is `KEEP`, which keeps the columns in the `fields` field. If the `mode` is set to `DELETE`, it will delete the columns in the `fields` field. Ep:
Before this PR:
If The data read from source is a table like this:
| name | age | card |
|----------|-----|------|
| Joy Ding | 20 | 123 |
| May Ding | 20 | 123 |
| Kin Dom | 20 | 123 |
| Joy Dom | 20 | 123 |
If we want to keep the field named `name`, `card`, we can add a `Filter` Transform like below:
```
transform {
Filter {
source_table_name = "fake"
result_table_name = "fake1"
fields = [name, card]
}
}
```
After this PR:
Or we can delete the field named `age` by adding a `Filter` Transform with the mode field set to `DELETE` like below:
It will be useful when you want to delete a small number of fields from a large table with tons of fields.
```
transform {
Filter {
source_table_name = "fake"
result_table_name = "fake1"
fields = [age]
mode = "DELETE"
}
}
```
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If you are adding E2E test cases, maybe refer to https://github.com/apache/seatunnel/blob/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-mysql-e2e/src/test/resources/mysqlcdc_to_mysql.conf, here is a good example.
-->
Added Addition UT cases.
### Check list
* [ ] If any new Jar binary package adding in your PR, please add License Notice according
[New License Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/contribution/new-license.md)
* [ ] If necessary, please update the documentation to describe the new feature. https://github.com/apache/seatunnel/tree/dev/docs
* [ ] If you are contributing the connector code, please check that the following files are updated:
1. Update change log that in connector document. For more details you can refer to [connector-v2](https://github.com/apache/seatunnel/tree/dev/docs/en/connector-v2)
2. Update [plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties) and add new connector information in it
3. Update the pom file of [seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
* [ ] Update the [`release-note`](https://github.com/apache/seatunnel/blob/dev/release-note.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "litiliu (via GitHub)" <gi...@apache.org>.
litiliu commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1634068927
##########
docs/en/transform-v2/filter.md:
##########
@@ -43,6 +48,21 @@ transform {
}
```
+Or we can delete the field named `age` by adding a `Filter` Transform with the mode field set to `DELETE` like below:
+
+```
+transform {
+ Filter {
+ source_table_name = "fake"
+ result_table_name = "fake1"
+ fields = [age]
+ mode = "DELETE"
+ }
Review Comment:
If we rename the original field named `fields` to `include_fields`, this PR will cause Seatunnel to lose backward compatibility. All users will be required to update the already existing config files; otherwise, the original config file won't work properly. I guess it's not acceptable? @hailin0
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "hailin0 (via GitHub)" <gi...@apache.org>.
hailin0 commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1637438341
##########
docs/zh/transform-v2/filter.md:
##########
@@ -31,14 +38,26 @@
| Kin Dom | 20 | 123 |
| Joy Dom | 20 | 123 |
-我们想要删除字段 `age`,我们可以像这样添加 `Filter` 转换
+我们想要删除字段 `age`,我们可以像这样添加 `Filter` 转换:
Review Comment:
```suggestion
我们想要保留字段 `name`, `card`,我们可以像这样添加 `Filter` 转换:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "EricJoy2048 (via GitHub)" <gi...@apache.org>.
EricJoy2048 commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1634219198
##########
docs/en/transform-v2/filter.md:
##########
@@ -43,6 +48,21 @@ transform {
}
```
+Or we can delete the field named `age` by adding a `Filter` Transform with the mode field set to `DELETE` like below:
+
+```
+transform {
+ Filter {
+ source_table_name = "fake"
+ result_table_name = "fake1"
+ fields = [age]
+ mode = "DELETE"
+ }
Review Comment:
> If we rename the original field named `fields` to `include_fields`, this PR will cause Seatunnel to lose backward compatibility. All users will be required to update the already existing config files; otherwise, the original config file won't work properly. I guess it's not acceptable? @hailin0
If we update the config option name and want to be compatible with old option names, we can use `withFallbackKeys` . Here is a example in class `MongodbConfig`:
```
public static final Option<String> MATCH_QUERY =
Options.key("match.query")
.stringType()
.noDefaultValue()
.withDescription("Mongodb's query syntax.")
.withFallbackKeys("matchQuery");
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1631122440
##########
seatunnel-transforms-v2/src/main/java/org/apache/seatunnel/transform/filter/FilterFieldTransform.java:
##########
@@ -35,20 +35,25 @@
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.List;
+import java.util.Set;
import java.util.stream.Collectors;
@Slf4j
public class FilterFieldTransform extends AbstractCatalogSupportTransform {
public static final String PLUGIN_NAME = "Filter";
private int[] inputValueIndex;
+ private Set<Integer> inputValueIndexSet;
Review Comment:
Can we keep only one variable? Depending on the mode, the value in the variable is kept or deleted.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "litiliu (via GitHub)" <gi...@apache.org>.
litiliu commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1634058869
##########
seatunnel-transforms-v2/src/main/java/org/apache/seatunnel/transform/filter/FilterFieldTransform.java:
##########
@@ -35,20 +35,25 @@
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.List;
+import java.util.Set;
import java.util.stream.Collectors;
@Slf4j
public class FilterFieldTransform extends AbstractCatalogSupportTransform {
public static final String PLUGIN_NAME = "Filter";
private int[] inputValueIndex;
+ private Set<Integer> inputValueIndexSet;
Review Comment:
sure, the redundant variable has been removed, please take a look again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "litiliu (via GitHub)" <gi...@apache.org>.
litiliu commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1635767699
##########
seatunnel-transforms-v2/src/main/java/org/apache/seatunnel/transform/filter/FilterFieldTransform.java:
##########
@@ -36,21 +36,39 @@
import java.util.ArrayList;
import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
import java.util.stream.Collectors;
+import java.util.stream.Stream;
@Slf4j
public class FilterFieldTransform extends AbstractCatalogSupportTransform {
public static final String PLUGIN_NAME = "Filter";
- private int[] inputValueIndex;
- private final List<String> fields;
+
+ private int[] inputValueIndexList;
+
+ private final List<String> includeFields;
+ private final List<String> excludeFields;
public FilterFieldTransform(
@NonNull ReadonlyConfig config, @NonNull CatalogTable catalogTable) {
super(catalogTable);
SeaTunnelRowType seaTunnelRowType = catalogTable.getTableSchema().toPhysicalRowDataType();
- fields = config.get(FilterFieldTransformConfig.KEY_FIELDS);
+ includeFields = config.get(FilterFieldTransformConfig.INCLUDE_FIELDS);
+ excludeFields = config.get(FilterFieldTransformConfig.EXCLUDE_FIELDS);
+ // only one should be set
+ if (Objects.nonNull(includeFields) && Objects.nonNull(excludeFields)) {
Review Comment:
fixed, PTAL again @EricJoy2048
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "litiliu (via GitHub)" <gi...@apache.org>.
litiliu commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1635711875
##########
docs/en/transform-v2/filter.md:
##########
@@ -43,6 +48,21 @@ transform {
}
```
+Or we can delete the field named `age` by adding a `Filter` Transform with the mode field set to `DELETE` like below:
+
+```
+transform {
+ Filter {
+ source_table_name = "fake"
+ result_table_name = "fake1"
+ fields = [age]
+ mode = "DELETE"
+ }
Review Comment:
@hailin0 @EricJoy2048 updated as suggested, PTAL again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "EricJoy2048 (via GitHub)" <gi...@apache.org>.
EricJoy2048 merged PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#issuecomment-2154718068
cc @hailin0
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "hailin0 (via GitHub)" <gi...@apache.org>.
hailin0 commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1631165462
##########
docs/en/transform-v2/filter.md:
##########
@@ -43,6 +48,21 @@ transform {
}
```
+Or we can delete the field named `age` by adding a `Filter` Transform with the mode field set to `DELETE` like below:
+
+```
+transform {
+ Filter {
+ source_table_name = "fake"
+ result_table_name = "fake1"
+ fields = [age]
+ mode = "DELETE"
+ }
Review Comment:
remove mode field
```suggestion
Filter {
source_table_name = "fake"
result_table_name = "fake1"
include_fields = [...] // old name fileds
exclude_fields = [...]
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Feature][Transform-V2 Filter] support exclude columns in the filter transform [seatunnel]
Posted by "EricJoy2048 (via GitHub)" <gi...@apache.org>.
EricJoy2048 commented on code in PR #6960:
URL: https://github.com/apache/seatunnel/pull/6960#discussion_r1635733759
##########
seatunnel-transforms-v2/src/main/java/org/apache/seatunnel/transform/filter/FilterFieldTransform.java:
##########
@@ -36,21 +36,39 @@
import java.util.ArrayList;
import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
import java.util.stream.Collectors;
+import java.util.stream.Stream;
@Slf4j
public class FilterFieldTransform extends AbstractCatalogSupportTransform {
public static final String PLUGIN_NAME = "Filter";
- private int[] inputValueIndex;
- private final List<String> fields;
+
+ private int[] inputValueIndexList;
+
+ private final List<String> includeFields;
+ private final List<String> excludeFields;
public FilterFieldTransform(
@NonNull ReadonlyConfig config, @NonNull CatalogTable catalogTable) {
super(catalogTable);
SeaTunnelRowType seaTunnelRowType = catalogTable.getTableSchema().toPhysicalRowDataType();
- fields = config.get(FilterFieldTransformConfig.KEY_FIELDS);
+ includeFields = config.get(FilterFieldTransformConfig.INCLUDE_FIELDS);
+ excludeFields = config.get(FilterFieldTransformConfig.EXCLUDE_FIELDS);
+ // only one should be set
+ if (Objects.nonNull(includeFields) && Objects.nonNull(excludeFields)) {
Review Comment:
use `ConfigValidator.of(config).validate()` replace this code
```
if (Objects.nonNull(includeFields) && Objects.nonNull(excludeFields)) {
throw TransformCommonError.bothIncludeAndExcludeFieldsError(getPluginName());
}
if (Objects.isNull(includeFields) && Objects.isNull(excludeFields)) {
throw TransformCommonError.noIncludeNorExcludeFieldsError(getPluginName());
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org