[GitHub] [incubator-pinot] yupeng9 commented on a change in pull request #6611: SegmentWriter and SegmentUploader interface

[GitBox <gi...@apache.org>]

yupeng9 commented on a change in pull request #6611:
URL: https://github.com/apache/incubator-pinot/pull/6611#discussion_r592674190



##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/writer/SegmentWriter.java
##########
@@ -0,0 +1,59 @@
+/**
+ * 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.pinot.spi.ingestion.segment.writer;
+
+import java.io.Closeable;
+import java.io.IOException;
+import org.apache.pinot.spi.data.readers.GenericRow;
+
+
+/**
+ * An interface to collect records and create a Pinot segment.
+ * This interface helps abstract out details regarding segment generation from the caller.
+ */
+public interface SegmentWriter extends Closeable {
+
+  /**
+   * Initializes the {@link SegmentWriter} with provided tableConfig and Pinot schema.
+   */
+  void init(SegmentWriterConfig segmentWriterConfig)
+      throws Exception;
+
+  /**
+   * Collects a single {@link GenericRow} into a buffer.
+   * This row is not available in the segment until a <code>flush()</code> is invoked.
+   */
+  void collect(GenericRow row)
+      throws IOException;
+
+  /**
+   * Collects a batch of {@link GenericRow}s into a buffer.
+   * These rows are not available in the segment until a <code>flush()</code> is invoked.
+   */
+  void collect(GenericRow[] rowBatch)
+      throws IOException;
+
+  /**
+   * Creates one Pinot segment using the {@link GenericRow}s collected in the buffer,
+   * at the outputDirUri as specified in the batchConfigs.

Review comment:
       I think returning `segmentURI ` from `flush` will be good, so as you said the caller can decide on uploading some specific segments, instead of all under the folder.
   
   The async is just the wrapper implementation, it shall package some default fault-tolerance mechanisms to handle generation/push fails with retry etc. Async just means that the caller can decide to run it in a separate thread and not to block `segmentWriter.collect`




----------------------------------------------------------------
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:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org