Skip to content

[SPARK-33298][CORE][FOLLOWUP] Add Unstable annotation to FileCommitProtocol #33148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
c21 wants to merge 3 commits into from
Closed

[SPARK-33298][CORE][FOLLOWUP] Add Unstable annotation to FileCommitProtocol #33148

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e61fc4
Add Unstable annotation to newly added methods of FileCommitProtocol
c21 Jun 30, 2021
4fb5113
Mark the whole class as Unstable
c21 Jun 30, 2021
d41ba14
Update the note with @note
c21 Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions core/src/main/scala/org/apache/spark/internal/io/FileCommitProtocol.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ package org.apache.spark.internal.io
import org.apache.hadoop.fs._
import org.apache.hadoop.mapreduce._

import org.apache.spark.annotation.Unstable
import org.apache.spark.internal.Logging
import org.apache.spark.util.Utils

Expand All @@ -41,7 +42,11 @@ import org.apache.spark.util.Utils
* (or abortTask if task failed).
* 3. When all necessary tasks completed successfully, the driver calls commitJob. If the job
* failed to execute (e.g. too many failed tasks), the job should call abortJob.
*
* @note This class is exposed as an API considering the usage of many downstream custom
* implementations, but will be subject to be changed and/or moved.
*/
@Unstable
abstract class FileCommitProtocol extends Logging {
import FileCommitProtocol._

Expand Down Expand Up @@ -107,9 +112,7 @@ abstract class FileCommitProtocol extends Logging {
* if a task is going to write out multiple files to the same dir. The file commit protocol only
* guarantees that files written by different tasks will not conflict.
*
* This API should be implemented and called, instead of
* [[newTaskTempFile(taskContest, dir, ext)]]. Provide a default implementation here to be
* backward compatible with custom [[FileCommitProtocol]] implementations before Spark 3.2.0.
* @since 3.2.0
*/
def newTaskTempFile(
taskContext: TaskAttemptContext, dir: Option[String], spec: FileNameSpec): String = {
Expand Down Expand Up @@ -144,10 +147,7 @@ abstract class FileCommitProtocol extends Logging {
* if a task is going to write out multiple files to the same dir. The file commit protocol only
* guarantees that files written by different tasks will not conflict.
*
* This API should be implemented and called, instead of
* [[newTaskTempFileAbsPath(taskContest, absoluteDir, ext)]]. Provide a default implementation
* here to be backward compatible with custom [[FileCommitProtocol]] implementations before
* Spark 3.2.0.
* @since 3.2.0
*/
def newTaskTempFileAbsPath(
taskContext: TaskAttemptContext, absoluteDir: String, spec: FileNameSpec): String = {
Expand Down