c21 opened a new pull request #32881: URL: https://github.com/apache/spark/pull/32881
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html 2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html 3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'. 4. Be sure to keep the PR description updated to reflect all changes. 5. Please write your PR title to summarize what this PR proposes. 6. If possible, provide a concise example to reproduce the issue for a faster review. 7. If you want to add a new configuration, please read the guideline first for naming configurations in 'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'. 8. If you want to add or modify an error message, please read the guideline first: https://spark.apache.org/error-message-guidelines.html --> ### What changes were proposed in this pull request? <!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below. 1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers. 2. If you fix some SQL features, you can provide some references of other DBMSes. 3. If there is design documentation, please add the link. 4. If there is a discussion in the mailing list, please add the link. --> This PR is to propose to decouple file naming functionality from `FileCommitProtocol`. Currently `FileCommitProtocol` mainly does two things: * commit task output by renaming from stage file name to final file name * commit job output by renaming directory for dynamic partitions query or writing to custom location * specify task staging output file name, and final output file name if needed A `FileCommitProtocol` should cover first two functionalities, but not the 3rd (naming output file). The file commit protocol (by its name and design) should take care of committing output (e.g. rename file and directory), but it should not control what's the file name as well. It should leave caller the flexibility to specify file names (e.g. Hive/Trino compatible bucket file name is different from what Spark has now - https://github.com/apache/spark/pull/30003). So here the PR is to decouple the file naming from `FileCommitProtocol`. The changes are: * Introduce an interface `FileNamingProtocol` to allow users to specify how to do output file naming. Add an implementation `HadoopMapReduceNamingProtocol` for `HadoopMapReduceCommitProtocol`. User can implement their own subclass for their own commit protocol implementation, by setting config `"spark.sql.sources.namingProtocolClass"`. * Introduce a new method `newTaskFile` in `FileCommitProtocol` to allow commit protocol to be notified when a new task output file is added. This is needed for dynamic partitions query and writing to custom location to do job commit. Mark previous `newTaskTempFile` and `newTaskTempFileAbsPath` as deprecated. * Change `FileFormatDataWriter` to call `FileNamingProtocol` and `FileCommitProtocol.newTaskFile`, instead of originally `FileCommitProtocol.newTaskTempFile/newTaskTempFileAbsPath`. ### Why are the changes needed? <!-- Please clarify why the changes are needed. For instance, 1. If you propose a new API, clarify the use case for a new API. 2. If you fix a bug, you can clarify why it is a bug. --> To make commit protocol clearer and allow future flexibility to specify Spark output file name. Pre-requisite of https://github.com/apache/spark/pull/30003. ### 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 Spark versions or within the unreleased branches such as master. If no, write 'No'. --> No. But for Spark developer or whoever uses custom `FileCommitProtocol` implementation. Two new configurations are introduced for file naming protocol - `spark.sql.sources.namingProtocolClass` and `spark.sql.streaming.namingProtocolClass`. ### 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. --> Existing unit test e.g. `DataFrameReaderWriterSuite.scala` to test `HadoopMapReduceNamingProtocol`. Will add more unit tests later. -- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org