feat: Add DeleteFileIndex to improve position delete lookup

pyiceberg/table/__init__.py

@@ -33,7 +33,6 @@
 )
 
 from pydantic import Field
-from sortedcontainers import SortedList
 
 import pyiceberg.expressions.parser as parser
 from pyiceberg.expressions import (
@@ -56,7 +55,6 @@
 )
 from pyiceberg.io import FileIO, load_file_io
 from pyiceberg.manifest import (
-    POSITIONAL_DELETE_SCHEMA,
     DataFile,
     DataFileContent,
     ManifestContent,
@@ -70,6 +68,7 @@
     PartitionSpec,
 )
 from pyiceberg.schema import Schema
+from pyiceberg.table.delete_file_index import DeleteFileIndex
 from pyiceberg.table.inspect import InspectTable
 from pyiceberg.table.locations import LocationProvider, load_location_provider
 from pyiceberg.table.maintenance import MaintenanceTable
@@ -1857,29 +1856,19 @@ def _min_sequence_number(manifests: list[ManifestFile]) -> int:
         return INITIAL_SEQUENCE_NUMBER
 
 
-def _match_deletes_to_data_file(data_entry: ManifestEntry, positional_delete_entries: SortedList[ManifestEntry]) -> set[DataFile]:
-    """Check if the delete file is relevant for the data file.
-
-    Using the column metrics to see if the filename is in the lower and upper bound.
+def _match_deletes_to_data_file(data_entry: ManifestEntry, delete_file_index: DeleteFileIndex) -> set[DataFile]:
+    """Check if delete files are relevant for the data file.
 
     Args:
-        data_entry (ManifestEntry): The manifest entry path of the datafile.
-        positional_delete_entries (List[ManifestEntry]): All the candidate positional deletes manifest entries.
+        data_entry (ManifestEntry): The manifest entry of the data file.
+        delete_file_index (DeleteFileIndex): Index containing all delete files.
 
     Returns:
-        A set of files that are relevant for the data file.
+        A set of delete files that are relevant for the data file.
     """
-    relevant_entries = positional_delete_entries[positional_delete_entries.bisect_right(data_entry) :]
-
-    if len(relevant_entries) > 0:
-        evaluator = _InclusiveMetricsEvaluator(POSITIONAL_DELETE_SCHEMA, EqualTo("file_path", data_entry.data_file.file_path))
-        return {
-            positional_delete_entry.data_file
-            for positional_delete_entry in relevant_entries
-            if evaluator.eval(positional_delete_entry.data_file)
-        }
-    else:
-        return set()
+    return delete_file_index.for_data_file(
+        data_entry.sequence_number or 0, data_entry.data_file, partition_key=data_entry.data_file.partition
+    )
 
 
 class DataScan(TableScan):
@@ -2005,7 +1994,7 @@ def plan_files(self) -> Iterable[FileScanTask]:
             List of FileScanTasks that contain both data and delete files.
         """
         data_entries: list[ManifestEntry] = []
-        positional_delete_entries = SortedList(key=lambda entry: entry.sequence_number or INITIAL_SEQUENCE_NUMBER)
+        delete_index = DeleteFileIndex()
 
         residual_evaluators: dict[int, Callable[[DataFile], ResidualEvaluator]] = KeyDefaultDict(self._build_residual_evaluator)
 
@@ -2014,7 +2003,7 @@ def plan_files(self) -> Iterable[FileScanTask]:
             if data_file.content == DataFileContent.DATA:
                 data_entries.append(manifest_entry)
             elif data_file.content == DataFileContent.POSITION_DELETES:
-                positional_delete_entries.add(manifest_entry)
+                delete_index.add_delete_file(manifest_entry, partition_key=data_file.partition)
             elif data_file.content == DataFileContent.EQUALITY_DELETES:
                 raise ValueError("PyIceberg does not yet support equality deletes: https://github.com/apache/iceberg/issues/6568")
             else:
@@ -2025,7 +2014,7 @@ def plan_files(self) -> Iterable[FileScanTask]:
                 data_entry.data_file,
                 delete_files=_match_deletes_to_data_file(
                     data_entry,
-                    positional_delete_entries,
+                    delete_index,
                 ),
                 residual=residual_evaluators[data_entry.data_file.spec_id](data_entry.data_file).residual_for(
                     data_entry.data_file.partition

pyiceberg/table/delete_file_index.py

@@ -0,0 +1,143 @@
+# 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.
+from __future__ import annotations
+
+from bisect import bisect_left
+from typing import Any
+
+from pyiceberg.expressions import EqualTo
+from pyiceberg.expressions.visitors import _InclusiveMetricsEvaluator
+from pyiceberg.manifest import INITIAL_SEQUENCE_NUMBER, POSITIONAL_DELETE_SCHEMA, DataFile, ManifestEntry
+from pyiceberg.typedef import Record
+
+PATH_FIELD_ID = 2147483546
+
+
+class PositionDeletes:
+    """Collects position delete files and indexes them by sequence number."""
+
+    __slots__ = ("_buffer", "_seqs", "_files")
+
+    def __init__(self) -> None:
+        self._buffer: list[tuple[DataFile, int]] | None = []
+        self._seqs: list[int] = []
+        self._files: list[tuple[DataFile, int]] = []
+
+    def add(self, delete_file: DataFile, seq_num: int) -> None:
+        if self._buffer is None:
+            raise ValueError("Cannot add files after indexing")
+        self._buffer.append((delete_file, seq_num))
+
+    def _ensure_indexed(self) -> None:
+        if self._buffer is not None:
+            self._files = sorted(self._buffer, key=lambda file: file[1])
+            self._seqs = [seq for _, seq in self._files]
+            self._buffer = None
+
+    def filter_by_seq(self, seq: int) -> list[DataFile]:
+        self._ensure_indexed()
+        if not self._files:
+            return []
+        start_idx = bisect_left(self._seqs, seq)
+        return [delete_file for delete_file, _ in self._files[start_idx:]]
+
+
+def _has_path_bounds(delete_file: DataFile) -> bool:
+    lower = delete_file.lower_bounds
+    upper = delete_file.upper_bounds
+    if not lower or not upper:
+        return False
+
+    return PATH_FIELD_ID in lower and PATH_FIELD_ID in upper
+
+
+def _applies_to_data_file(delete_file: DataFile, data_file: DataFile) -> bool:
+    if not _has_path_bounds(delete_file):
+        return True
+
+    evaluator = _InclusiveMetricsEvaluator(POSITIONAL_DELETE_SCHEMA, EqualTo("file_path", data_file.file_path))
+    return evaluator.eval(delete_file)
+
+
+def _referenced_data_file_path(delete_file: DataFile) -> str | None:
+    """Return the path, if the path bounds evaluate to the same location."""
+    lower_bounds = delete_file.lower_bounds
+    upper_bounds = delete_file.upper_bounds
+
+    if not lower_bounds or not upper_bounds:
+        return None
+
+    lower = lower_bounds.get(PATH_FIELD_ID)
+    upper = upper_bounds.get(PATH_FIELD_ID)
+
+    if lower and upper and lower == upper:
+        try:
+            return lower.decode("utf-8")
+        except (UnicodeDecodeError, AttributeError):
+            pass
+
+    return None
+
+
+def _partition_key(spec_id: int, partition: Record | None) -> tuple[int, tuple[Any, ...]]:
+    if partition:
+        return spec_id, tuple(partition._data)
+    return spec_id, ()  # unpartitioned handling
+
+
+class DeleteFileIndex:
+    """Indexes position delete files by partition and by exact data file path."""
+
+    def __init__(self) -> None:
+        self._by_partition: dict[tuple[int, tuple[Any, ...]], PositionDeletes] = {}
+        self._by_path: dict[str, PositionDeletes] = {}
+
+    def is_empty(self) -> bool:
+        return not self._by_partition and not self._by_path
+
+    def add_delete_file(self, manifest_entry: ManifestEntry, partition_key: Record | None = None) -> None:
+        delete_file = manifest_entry.data_file
+        seq = manifest_entry.sequence_number or INITIAL_SEQUENCE_NUMBER
+        target_path = _referenced_data_file_path(delete_file)
+
+        if target_path:
+            deletes = self._by_path.setdefault(target_path, PositionDeletes())
+            deletes.add(delete_file, seq)
+        else:
+            key = _partition_key(delete_file.spec_id or 0, partition_key)
+            deletes = self._by_partition.setdefault(key, PositionDeletes())
+            deletes.add(delete_file, seq)
+
+    def for_data_file(self, seq_num: int, data_file: DataFile, partition_key: Record | None = None) -> set[DataFile]:
+        if self.is_empty():
+            return set()
+
+        deletes: set[DataFile] = set()
+        spec_id = data_file.spec_id or 0
+
+        key = _partition_key(spec_id, partition_key)
+        partition_deletes = self._by_partition.get(key)
+        if partition_deletes:
+            for delete_file in partition_deletes.filter_by_seq(seq_num):
+                if _applies_to_data_file(delete_file, data_file):
+                    deletes.add(delete_file)
+
+        path_deletes = self._by_path.get(data_file.file_path)
+        if path_deletes:
+            deletes.update(path_deletes.filter_by_seq(seq_num))
+
+        return deletes