vanzin commented on a change in pull request #25007: [SPARK-28209][CORE][SHUFFLE] Proposed new shuffle writer API URL: https://github.com/apache/spark/pull/25007#discussion_r302755425
########## File path: core/src/main/java/org/apache/spark/shuffle/api/ShufflePartitionWriter.java ########## @@ -0,0 +1,46 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.spark.shuffle.api; + +import java.io.IOException; +import java.io.OutputStream; + +import org.apache.spark.annotation.Experimental; + +/** + * :: Experimental :: + * An interface for opening streams to persist partition bytes to a backing data store. + * + * @since 3.0.0 + */ +@Experimental +public interface ShufflePartitionWriter { + + /** + * Opens and returns an underlying {@link OutputStream} that can write bytes to the underlying + * data store. + * <p> + * The same caller that invokes this method will also close the returned output stream. + */ + OutputStream openStream() throws IOException; + + /** + * Get the number of bytes written by this writer's stream returned by {@link #openStream()}. Review comment: This method seems to imply that there is supposed to be a single call to `openStream()`, but that isn't clear from the rest of the docs. (The local implementation of `openStream()` is actually idempotent. If that's the contract, it should be called out.) On a side note, is this really needed or could the caller instead use a `CountingOutputStream`? If it's really needed, might be worth to mention that this count can be different than the number of bytes written by the caller. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
