diff --git a/docs/SupportsRowIndexFilters.md b/docs/SupportsRowIndexFilters.md index 78e4f2a783..6046c8b857 100644 --- a/docs/SupportsRowIndexFilters.md +++ b/docs/SupportsRowIndexFilters.md @@ -1,3 +1,24 @@ # SupportsRowIndexFilters -`SupportsRowIndexFilters` is...FIXME +`SupportsRowIndexFilters` is an [abstraction](#contract) of [file indices](#implementations) that can support [row index filters](#rowIndexFilters). + +!!! note "Appears Change Data Feed Only" + The only implementation of `SupportsRowIndexFilters` is [TahoeFileIndex](TahoeFileIndex.md) yet [rowIndexFilters](#rowIndexFilters) is only used to create [CdcAddFileIndex](change-data-feed/CdcAddFileIndex.md#rowIndexFilters) and [TahoeRemoveFileIndex](change-data-feed/TahoeRemoveFileIndex.md#rowIndexFilters) for [Change Data Feed](change-data-feed/index.md) for [CDCReaderImpl](change-data-feed/CDCReaderImpl.md#processDeletionVectorActions). + +## Contract + +### Row Index Filters { #rowIndexFilters } + +```scala +rowIndexFilters: Option[Map[String, RowIndexFilterType]] = None +``` + +A mapping of `URI`-encoded file paths to a row index filter type. + +Used when: + +* `CDCReaderImpl` is requested to [processDeletionVectorActions](change-data-feed/CDCReaderImpl.md#processDeletionVectorActions) (to create a [CdcAddFileIndex](change-data-feed/CdcAddFileIndex.md#rowIndexFilters) and a [TahoeRemoveFileIndex](change-data-feed/TahoeRemoveFileIndex.md#rowIndexFilters)) + +## Implementations + +* [TahoeFileIndex](TahoeFileIndex.md) diff --git a/docs/TahoeFileIndex.md b/docs/TahoeFileIndex.md index 3d5a1a58ed..5890aea762 100644 --- a/docs/TahoeFileIndex.md +++ b/docs/TahoeFileIndex.md @@ -4,6 +4,8 @@ The aim of `TahoeFileIndex` (and `FileIndex` in general) is to reduce usage of very expensive disk access for file-related information using Hadoop [FileSystem]({{ hadoop.api }}/org/apache/hadoop/fs/FileSystem.html) API. +`TahoeFileIndex` is [SupportsRowIndexFilters](SupportsRowIndexFilters.md). + ## Contract ### Matching Files { #matchingFiles } diff --git a/mkdocs.yml b/mkdocs.yml index 2ee5bda622..55b176b6c8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -202,7 +202,6 @@ nav: - FileFormat: - DeltaFileFormat: DeltaFileFormat.md - DeltaParquetFileFormat: DeltaParquetFileFormat.md - - SupportsRowIndexFilters.md - Transaction Log (DeltaLog): - DeltaLog: DeltaLog.md - Operation: Operation.md @@ -247,6 +246,7 @@ nav: - PreprocessTimeTravel: PreprocessTimeTravel.md - StagedDeltaTableV2: StagedDeltaTableV2.md - File Indices: + - SupportsRowIndexFilters.md - TahoeFileIndex: TahoeFileIndex.md - TahoeBatchFileIndex: TahoeBatchFileIndex.md - TahoeFileIndexWithSnapshotDescriptor: TahoeFileIndexWithSnapshotDescriptor.md