andygrove commented on code in PR #9988:
URL: https://github.com/apache/arrow-datafusion/pull/9988#discussion_r1559714760
##########
datafusion/core/src/datasource/provider.rs:
##########
@@ -161,20 +161,73 @@ pub trait TableProvider: Sync + Send {
/// Specify if DataFusion should provide filter expressions to the
/// TableProvider to apply *during* the scan.
///
+ /// Some TableProviders can evaluate filters more efficiently than the
+ /// `Filter` operator in DataFusion, for example by using an index.
+ ///
/// The return value must have one element for each filter expression
passed
/// in. The value of each element indicates if the TableProvider can apply
- /// that particular filter during the scan.
+ /// that particular filter during the scan. The position in the return
value
+ /// Vec corresponds to the expression in the `filters` input.
+ ///
+ /// Here is an example of how this can be done:
+ ///
+ /// ```rust
+ /// use datafusion::error::{Result, DataFusionError};
+ /// use datafusion_expr::{Expr, TableProviderFilterPushDown};
+ ///
+ /// // Override the supports_filters_pushdown to evaluate which
expressions
+ /// // to accept as pushdown predicates.
+ /// fn supports_filters_pushdown(&self, filters: &[&Expr]) ->
Result<Vec<TableProviderFilterPushDown>> {
Review Comment:
@alamb already said this, but you can prefix lines of code with `#` to still
have them compile, but not appear in the generated docs.
See
https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#hiding-portions-of-the-example
for more info
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
