yzeng1618 opened a new pull request, #11312:
URL: https://github.com/apache/seatunnel/pull/11312
<!--
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 PR optimizes file discovery and the target/source comparison logic used
by the File Source connectors (LocalFile, HdfsFile, FtpFile, SftpFile) when
running in sync_mode=update. It introduces two new options to control how the
connector looks up target-side file metadata for large / sparse datasets:
update_compare_parallelism (int, default 8, valid range 1–64): the maximum
parallelism for sparse target metadata point-lookups in sync_mode=update. The
maximum number of submitted-but-incomplete lookups is bounded to 8× this value,
so target metadata queries no longer pile up unboundedly.
update_compare_bulk_threshold (int, default 0): for non-FTP/SFTP targets,
when the candidate count under a single target parent directory reaches this
threshold, the connector performs one directory listing instead of querying
every file individually. The default 0 disables automatic bulk listing and
keeps using bounded point-lookups, which avoids an unexpectedly expensive full
target-directory scan. FTP and SFTP targets always use directory listing.
Source filters are applied while entries are listed to reduce peak metadata
memory.
Together these give users a way to tune the update-mode comparison cost
between "bounded concurrent point lookups" and "single directory listing"
depending on how densely files are distributed under target directories.
### Does this PR introduce _any_ user-facing change?
Yes. This PR adds two new source options for the File connectors, so both
behavior and documentation change:
Previous behavior: in sync_mode=update, the connector had no way to bound
the concurrency of target metadata lookups, nor to switch to a single directory
listing for dense directories.
New behavior: users can now set update_compare_parallelism (default 8) and
update_compare_bulk_threshold (default 0, i.e. disabled). The defaults are
chosen to be safe/backward-compatible: with update_compare_bulk_threshold=0 the
connector keeps using bounded point-lookups and does not trigger any new
full-directory scan, so existing jobs behave essentially as before.
This is a change relative to the unreleased dev branch. English and Chinese
docs for all four connectors (LocalFile, HdfsFile, FtpFile, SftpFile) have been
updated accordingly, following the connector doc specification in
apache/seatunnel#4544.
<!--
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.
-->
### How was this patch tested?
Added unit tests
<!--
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.
-->
### 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/developer/new-license.md)
* [ * ] If necessary, please update the documentation to describe the new
feature. https://github.com/apache/seatunnel/tree/dev/docs
* [ ] If necessary, please update `incompatible-changes.md` to describe the
incompatibility caused by this PR.
* [ ] If you are contributing the connector code, please check that the
following files are updated:
1. Update
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
and add new connector information in it
2. Update the pom file of
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
3. Add ci label in
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml)
4. Add e2e testcase in
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/)
5. Update connector
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config)
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
