Skip to content


SortShuffleWriter is a concrete ShuffleWriter that is used when[SortShuffleManager returns a ShuffleWriter for ShuffleHandle] (and the more specialized[BypassMergeSortShuffleWriter] and[UnsafeShuffleWriter] could not be used).

SortShuffleWriter is created when[SortShuffleManager returns a ShuffleWriter for the fallback BaseShuffleHandle].

SortShuffleWriter[K, V, C] is a parameterized type with K keys, V values, and C combiner values.

== [[creating-instance]] Creating Instance

SortShuffleWriter takes the following to be created:

  • [[shuffleBlockResolver]][IndexShuffleBlockResolver]
  • [[handle]][BaseShuffleHandle]
  • [[mapId]] Map ID
  • [[context]][TaskContext]

== [[mapStatus]] MapStatus

SortShuffleWriter uses an internal variable for a[MapStatus] after <>.

<> itself does not return a value, SortShuffleWriter uses the variable when requested to <> (which allows returning a MapStatus).

== [[write]] Writing Records (Into Shuffle Partitioned File In Disk Store)

[source, scala]

write( records: Iterator[Product2[K, V]]): Unit

write creates an[ExternalSorter] based on the[ShuffleDependency] (of the <>), namely the Map-Size Partial Aggregation flag. The ExternalSorter uses the aggregator and keyOrdering when the flag is enabled.

write requests the ExternalSorter to inserts all the records.

write requests the <> for a[shuffle output file] (for the shuffle and the <> IDs) and creates a temporary file alongside the shuffle output file (in the same directory).

write creates a[ShuffleBlockId] (for the shuffle and the <> IDs).

write requests ExternalSorter to[write all the records (previously inserted in) into the temporary partitioned file in the disk store]. ExternalSorter returns the length of every partition.

write requests <> to[write an index file and commit] (with the shuffle and the <> IDs, the temporary shuffle output file).

write creates a[MapStatus] (with the[location of the shuffle server] that serves the shuffle files and the sizes of the shuffle partitions). The MapStatus is later available as the <> internal attribute.

write does not handle exceptions so when they occur, they will break the processing.

In the end, write deletes the temporary shuffle output file. write prints out the following ERROR message to the logs if the file count not be deleted:

Error while deleting temp file [path]

write is part of the[ShuffleWriter] abstraction.

== [[stop]] Closing SortShuffleWriter (and Calculating MapStatus)

[source, scala]

stop( success: Boolean): Option[MapStatus]

stop turns <> flag on and returns the internal <> if the input success is enabled.

Otherwise, when <> flag is already enabled or the input success is disabled, stop returns no MapStatus (i.e. None).

In the end, stop requests the ExternalSorter to[stop] and increments the shuffle write time task metrics.

stop is part of the[ShuffleWriter] abstraction.

== [[shouldBypassMergeSort]] Requirements of BypassMergeSortShuffleHandle (as ShuffleHandle)

[source, scala]

shouldBypassMergeSort( conf: SparkConf, dep: ShuffleDependency[_, _, _]): Boolean

shouldBypassMergeSort returns true when all of the following hold:

. No map-side aggregation (the mapSideCombine flag of the given ShuffleDependency is off)

. Number of partitions (of the Partitioner of the given ShuffleDependency) is not greater than spark.shuffle.sort.bypassMergeThreshold configuration property

Otherwise, shouldBypassMergeSort does not hold (i.e. false).

shouldBypassMergeSort is used when SortShuffleManager is requested to register a shuffle (and creates a ShuffleHandle).

== [[logging]] Logging

Enable ALL logging level for org.apache.spark.shuffle.sort.SortShuffleWriter logger to see what happens inside.

Add the following line to conf/


Refer to[Logging].

== [[internal-properties]] Internal Properties

[cols="30m,70",options="header",width="100%"] |=== | Name | Description

| [[stopping]] stopping | Internal flag to mark that <>.


Last update: 2020-10-09