You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ne...@apache.org on 2021/03/12 22:05:37 UTC
[incubator-pinot] branch master updated: SegmentWriter and
SegmentUploader interface (#6611)
This is an automated email from the ASF dual-hosted git repository.
nehapawar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 2731ce7 SegmentWriter and SegmentUploader interface (#6611)
2731ce7 is described below
commit 2731ce754e2abbb7c390adf2c9fe23a11bd20006
Author: Neha Pawar <ne...@gmail.com>
AuthorDate: Fri Mar 12 14:04:25 2021 -0800
SegmentWriter and SegmentUploader interface (#6611)
* SegmentWriter and SegmentUploader interface
---
.../segment/uploader/SegmentUploader.java | 52 ++++++++++++++++
.../ingestion/segment/writer/SegmentWriter.java | 70 ++++++++++++++++++++++
2 files changed, 122 insertions(+)
diff --git a/pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/uploader/SegmentUploader.java b/pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/uploader/SegmentUploader.java
new file mode 100644
index 0000000..64d6cfa
--- /dev/null
+++ b/pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/uploader/SegmentUploader.java
@@ -0,0 +1,52 @@
+/**
+ * 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.annotations.InterfaceStability;
+import org.apache.pinot.spi.config.table.TableConfig;
+
+
+/**
+ * Interface for uploading segments to Pinot
+ */
+@InterfaceStability.Evolving
+public interface SegmentUploader {
+
+ /**
+ * Initializes the {@link SegmentUploader}
+ * @param tableConfig The table config for the segment upload
+ */
+ void init(TableConfig tableConfig)
+ throws Exception;
+
+ /**
+ * Uploads the segment tar file to the cluster
+ * @param segmentTarFile URI of segment tar file
+ */
+ void uploadSegment(URI segmentTarFile)
+ throws Exception;
+
+ /**
+ * Uploads the segments from the segmentDir to the cluster
+ * @param segmentDir URI of directory containing segment tar files
+ */
+ void uploadSegments(URI segmentDir)
+ throws Exception;
+}
diff --git a/pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/writer/SegmentWriter.java b/pinot-spi/src/main/java/org/apache/pinot/spi/ingestion/segment/writer/SegmentWriter.java
new file mode 100644
index 0000000..86cc7fe
--- /dev/null
+++ b/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()
+ throws Exception;
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org