Skip to content

Commit 961c79c

Browse files
authored
[SPARK] Improve documentation in DataSkippingReader (delta-io#4323)
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://github.com/delta-io/delta/blob/master/CONTRIBUTING.md 2. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP] Your PR title ...'. 3. Be sure to keep the PR description updated to reflect all changes. 4. Please write your PR title to summarize what this PR proposes. 5. If possible, provide a concise example to reproduce the issue for a faster review. 6. If applicable, include the corresponding issue number in the PR title and link it in the body. --> #### Which Delta project/connector is this regarding? <!-- Please add the component selected below to the beginning of the pull request title For example: [Spark] Title of my pull request --> - [x] Spark - [ ] Standalone - [ ] Flink - [ ] Kernel - [ ] Other (fill in here) ## Description A minor improvement to documentation in `DataSkippingReader`. ## How was this patch tested? <!-- If tests were added, say they were added here. Please make sure to test the changes thoroughly including negative and positive cases if possible. If the changes were tested in any way other than unit tests, please clarify how you tested step by step (ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future). If the changes were not tested, please explain why. --> N/A. Documentation-only. ## Does this PR introduce _any_ user-facing changes? <!-- If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible. If possible, please also clarify if this is a user-facing change compared to the released Delta Lake versions or within the unreleased branches such as master. If no, write 'No'. --> No.
1 parent d3f0604 commit 961c79c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

spark/src/main/scala/org/apache/spark/sql/delta/stats/DataSkippingReader.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,10 @@ trait DataSkippingReaderBase
421421
* NOTE: The skipping predicate does *NOT* need to worry about missing stats columns (which also
422422
* manifest as NULL). That case is handled separately by `verifyStatsForFilter` (which disables
423423
* skipping for any file that lacks the needed stats columns).
424+
*
425+
* @return An optional data skipping predicate, if this function returns None, then this means
426+
* that the dataFilter Expression is not eligible for data skipping, i.e. we cannot skip any
427+
* files.
424428
*/
425429
private[stats] def constructDataFilters(dataFilter: Expression):
426430
Option[DataSkippingPredicate] = dataFilter match {

0 commit comments

Comments
 (0)