You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by GitBox <gi...@apache.org> on 2021/03/12 05:33:57 UTC
[GitHub] [incubator-pinot] kishoreg commented on a change in pull request #6611: SegmentWriter and SegmentUploader interface
kishoreg commented on a change in pull request #6611:
URL: https://github.com/apache/incubator-pinot/pull/6611#discussion_r592920377
##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/writer/SegmentWriter.java
##########
@@ -0,0 +1,70 @@
+/**
+ * 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.net.URI;
+import org.apache.pinot.spi.config.table.TableConfig;
+import org.apache.pinot.spi.data.Schema;
+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.
+ * @param tableConfig The table config for the segment
+ * @param schema The Pinot schema for the table
+ */
+ void init(TableConfig tableConfig, Schema schema)
+ 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 Exception;
+
+ /**
+ * 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.
+ */
+ default void collect(GenericRow[] rowBatch)
+ throws Exception {
+ for (GenericRow row : rowBatch) {
+ collect(row);
+ }
+ }
+
+ /**
+ * Creates one Pinot segment using the {@link GenericRow}s collected in the buffer,
+ * at the outputDirUri as specified in the tableConfig->batchConfigs.
Review comment:
almost feels like it might better to take the output directory as an explicit parameter. Typically the one in tableConfig might be for the minion or controller
##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/uploader/SegmentUploader.java
##########
@@ -0,0 +1,43 @@
+/**
+ * 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.uploader;
+
+import java.net.URI;
+import org.apache.pinot.spi.config.table.TableConfig;
+
+
+/**
+ * Interface for uploading segments to Pinot
+ */
+public interface SegmentUploader {
+
+ /**
+ * Initializes the {@link SegmentUploader}
+ * @param tableConfig The table config for the segment upload
+ */
+ void init(TableConfig tableConfig)
+ throws Exception;
+
+ /**
+ * Uploads the segments from the segmentDir to the cluster
+ * @param segmentDir URI of segment tar file or URI of directory containing segment tar files
Review comment:
should we have separate methods for a single tar file vs a directory?
##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/writer/SegmentWriter.java
##########
@@ -0,0 +1,70 @@
+/**
+ * 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.net.URI;
+import org.apache.pinot.spi.config.table.TableConfig;
+import org.apache.pinot.spi.data.Schema;
+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.
+ * @param tableConfig The table config for the segment
+ * @param schema The Pinot schema for the table
+ */
+ void init(TableConfig tableConfig, Schema schema)
+ 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 Exception;
+
+ /**
+ * 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.
+ */
+ default void collect(GenericRow[] rowBatch)
+ throws Exception {
+ for (GenericRow row : rowBatch) {
+ collect(row);
+ }
+ }
+
+ /**
+ * Creates one Pinot segment using the {@link GenericRow}s collected in the buffer,
+ * at the outputDirUri as specified in the tableConfig->batchConfigs.
+ * Successful invocation of this method means that the {@link GenericRow}s collected so far,
+ * are now available in the Pinot segment and not available in the buffer anymore.
+ *
+ * @return URI of the generated segment
+ */
+ URI flush()
Review comment:
flush is a bit misleading? for e.g. FileWriter has flush and close. maybe finish/build/close
----------------------------------------------------------------
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