[arrow-datafusion] branch main updated: Minor: Improve `TableProviderFilterPushDown` docs (#7685)

[dheres]

This is an automated email from the ASF dual-hosted git repository.

dheres pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git


The following commit(s) were added to refs/heads/main by this push:
     new 236893f452 Minor: Improve  `TableProviderFilterPushDown` docs (#7685)
236893f452 is described below

commit 236893f452f39d7236b653e03d8f26c9810221ac
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Fri Sep 29 03:19:27 2023 -0400

    Minor: Improve  `TableProviderFilterPushDown` docs (#7685)
---
 datafusion/expr/src/table_source.rs | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/datafusion/expr/src/table_source.rs 
b/datafusion/expr/src/table_source.rs
index b83ce77813..94f26d9158 100644
--- a/datafusion/expr/src/table_source.rs
+++ b/datafusion/expr/src/table_source.rs
@@ -30,14 +30,14 @@ use std::any::Any;
 pub enum TableProviderFilterPushDown {
     /// The expression cannot be used by the provider.
     Unsupported,
-    /// The expression can be used to help minimise the data retrieved,
-    /// but the provider cannot guarantee that all returned tuples
-    /// satisfy the filter. The Filter plan node containing this expression
-    /// will be preserved.
+    /// The expression can be used to reduce the data retrieved,
+    /// but the provider cannot guarantee it will omit all tuples that
+    /// may be filtered. In this case, DataFusion will apply an additional
+    /// `Filter` operation after the scan to ensure all rows are filtered 
correctly.
     Inexact,
-    /// The provider guarantees that all returned data satisfies this
-    /// filter expression. The Filter plan node containing this expression
-    /// will be removed.
+    /// The provider **guarantees** that it will omit **all** tuples that are
+    /// filtered by the filter expression. This is the fastest option, if 
available
+    /// as DataFusion will not apply additional filtering.
     Exact,
 }