Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
/*
* 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.hudi.io.storage;

import org.apache.hudi.exception.HoodieException;
import org.apache.hudi.exception.HoodieIOException;

import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.vector.VectorSchemaRoot;
import org.apache.arrow.vector.ipc.ArrowReader;
import org.apache.spark.sql.vectorized.ColumnVector;
import org.apache.spark.sql.vectorized.ColumnarBatch;
import org.lance.file.LanceFileReader;
import org.lance.spark.vectorized.LanceArrowColumnVector;

import java.io.Closeable;
import java.io.IOException;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.Objects;

/**
* Iterator that returns {@link ColumnarBatch} directly from Lance files without
* decomposing to individual rows. Used for vectorized/columnar batch reading
* in Spark's COW base-file-only read path.
*
* <p>Unlike {@link LanceRecordIterator} which extracts rows one by one,
* this iterator preserves the columnar format for zero-copy batch processing.
*
* <p>Manages the lifecycle of:
* <ul>
* <li>BufferAllocator - Arrow memory management</li>
* <li>LanceFileReader - Lance file handle</li>
* <li>ArrowReader - Arrow batch reader</li>
* </ul>
*/
public class LanceBatchIterator implements Iterator<ColumnarBatch>, Closeable {
private final BufferAllocator allocator;
private final LanceFileReader lanceReader;
private final ArrowReader arrowReader;
private final String path;

private ColumnVector[] columnVectors;
private ColumnarBatch currentBatch;
private boolean hasCachedBatch = false;
private boolean finished = false;
private boolean closed = false;

/**
* Creates a new Lance batch iterator.
*
* @param allocator Arrow buffer allocator for memory management
* @param lanceReader Lance file reader
* @param arrowReader Arrow reader for batch reading
* @param path File path (for error messages)
*/
public LanceBatchIterator(BufferAllocator allocator,
LanceFileReader lanceReader,
ArrowReader arrowReader,
String path) {
this.allocator = Objects.requireNonNull(allocator, "allocator must not be null");
this.lanceReader = Objects.requireNonNull(lanceReader, "lanceReader must not be null");
this.arrowReader = Objects.requireNonNull(arrowReader, "arrowReader must not be null");
this.path = path;
}

@Override
public boolean hasNext() {
if (finished) {
return false;
}
if (hasCachedBatch) {
return true;
}

try {
if (arrowReader.loadNextBatch()) {
VectorSchemaRoot root = arrowReader.getVectorSchemaRoot();

// Create column vector wrappers once and reuse across batches
// (ArrowReader reuses the same VectorSchemaRoot)
if (columnVectors == null) {
columnVectors = root.getFieldVectors().stream()
.map(LanceArrowColumnVector::new)
.toArray(ColumnVector[]::new);
}

currentBatch = new ColumnarBatch(columnVectors, root.getRowCount());
hasCachedBatch = true;
return true;
}
} catch (IOException e) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the event you hit this IOExeception I believe you need to set the finished=true right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No — the throw on line 108 unwinds the stack, so finished is never read after this point. Setting it before the throw would be dead code. If we wanted to swallow the exception and return false instead, then yes, finished = true would be required — but silently hiding an I/O error would be worse.

throw new HoodieException("Failed to read next batch from Lance file: " + path, e);
}

finished = true;
return false;
}

@Override
public ColumnarBatch next() {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 nit: arrowReader, lanceReader, and allocator are all final fields set in the constructor, so they can never be null unless the caller explicitly passes null. The != null guards here add noise — could you either drop them and trust the non-null contract, or enforce it upfront with Objects.requireNonNull in the constructor?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — added Objects.requireNonNull in the constructor for all three fields; removed the null guards in close().

if (!hasNext()) {
throw new NoSuchElementException("No more batches available");
}
hasCachedBatch = false;
return currentBatch;
}

@Override
public void close() {
if (closed) {
return;
}
closed = true;

Exception arrowException = null;
Exception lanceException = null;
Exception allocatorException = null;

// Don't close currentBatch here: ColumnarBatch.close() would close the
// underlying Arrow FieldVectors through LanceArrowColumnVector, but they
// are owned by the ArrowReader (via VectorSchemaRoot) and will be closed
// when arrowReader.close() is called below.
currentBatch = null;

try {
arrowReader.close();
} catch (Exception e) {
arrowException = e;
}

try {
lanceReader.close();
} catch (Exception e) {
lanceException = e;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 If allocator.close() throws (e.g., due to a buffer leak detected by Arrow), both arrowException and lanceException are silently swallowed. Consider wrapping this in a try-catch and adding any prior exceptions as suppressed, similar to the pattern used for the other two resources.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed — allocator.close() is now wrapped in try-catch. If it throws, prior exceptions from arrowReader/lanceReader are attached as suppressed. The propagation order is: allocator exception > arrow exception > lance exception, with earlier ones added as suppressed to the one that's thrown.

try {
allocator.close();
} catch (Exception e) {
allocatorException = e;
}

// Propagate exceptions, attaching earlier ones as suppressed so nothing is silently lost.
if (allocatorException != null) {
if (arrowException != null) {
allocatorException.addSuppressed(arrowException);
}
if (lanceException != null) {
allocatorException.addSuppressed(lanceException);
}
throw new HoodieException("Failed to close Arrow allocator", allocatorException);
}
if (arrowException != null) {
if (lanceException != null) {
arrowException.addSuppressed(lanceException);
}
// Preserve the IOException-specific subclass when the underlying close raised IOException;
// fall back to HoodieException so RuntimeExceptions from arrowReader.close() are still surfaced
// (and don't strand the lanceReader/allocator close paths above).
if (arrowException instanceof IOException) {
throw new HoodieIOException("Failed to close Arrow reader", (IOException) arrowException);
} else {
throw new HoodieException("Failed to close Arrow reader", arrowException);
}
}
if (lanceException != null) {
throw new HoodieException("Failed to close Lance reader", lanceException);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,10 @@ public boolean hasNext() {
return true;
}

if (currentBatch != null) {
currentBatch.close();
currentBatch = null;
}
// Release reference to previous batch (don't close — the underlying
// FieldVectors are reused by ArrowReader across loadNextBatch() calls,
// and closing would corrupt the cached LanceArrowColumnVector wrappers).
currentBatch = null;

// Try to load next batch. Loop so zero-row batches (legitimately returned e.g. after
// filter pushdown) don't silently terminate iteration and drop subsequent non-empty batches.
Expand Down
Loading
Loading