From cb2a77622746956b8b1f55107c02a2c9e6b0b53d Mon Sep 17 00:00:00 2001 From: Trent Hauck Date: Thu, 28 Sep 2023 12:25:34 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andrew Lamb --- docs/source/library-user-guide/custom-table-providers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/library-user-guide/custom-table-providers.md b/docs/source/library-user-guide/custom-table-providers.md index 14bf943f8307..093cc41ed4d4 100644 --- a/docs/source/library-user-guide/custom-table-providers.md +++ b/docs/source/library-user-guide/custom-table-providers.md @@ -132,8 +132,8 @@ The `supports_filters_pushdown` method can be overridden to indicate which filte This returns a `Vec` of `TableProviderFilterPushDown` enums where each enum represents a filter that can be pushed down. The `TableProviderFilterPushDown` enum has three variants: - `TableProviderFilterPushDown::Unsupported` - the filter cannot be pushed down -- `TableProviderFilterPushDown::Exact` - the filter can be pushed down and the data source can guarantee that the filter will be applied exactly as specified -- `TableProviderFilterPushDown::Inexact` - the filter can be pushed down, but the data source cannot guarantee that the filter will be applied exactly as specified +- `TableProviderFilterPushDown::Exact` - the filter can be pushed down and the data source can guarantee that the filter will be applied completely to all rows. This is the highest performance option. +- `TableProviderFilterPushDown::Inexact` - the filter can be pushed down, but the data source cannot guarantee that the filter will be applied to all rows. DataFusion will apply `Inexact` filters again after the scan to ensure correctness. For filters that can be pushed down, they'll be passed to the `scan` method as the `filters` parameter and they can be made use of there.