File tree Expand file tree Collapse file tree 1 file changed +10
-2
lines changed
datafusion/physical-expr/src/expressions Expand file tree Collapse file tree 1 file changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -33,8 +33,8 @@ use datafusion_physical_expr_common::physical_expr::{DynEq, DynHash};
3333
3434/// A source of dynamic runtime filters.
3535///
36- /// During query execution, operators implementing this trait can provide
37- /// filter expressions that other operators can use to dynamically prune data .
36+ /// Operators can create implementations of this trait that get wrapped
37+ /// in [`DynamicFilterPhysicalExpr`] to be pushed down into and through to scans, joins, etc .
3838///
3939/// For example:
4040/// - A `HashJoin` operator can use this to provide a filter expression
@@ -43,6 +43,14 @@ use datafusion_physical_expr_common::physical_expr::{DynEq, DynHash};
4343/// - A `TopK` operator can use this to provide a filter expression
4444/// that filters out rows from the input based on the values from the
4545/// top K rows.
46+ ///
47+ /// Initially this trait is intended to be only for internal use as a way to facilitate
48+ /// building [`DynamicFilterPhysicalExpr`]s in the various operators that will be generating
49+ /// dynamic filters.
50+ /// Because of this we've made it a public trait in a private module so that it is only
51+ /// accessible within the crate.
52+ /// If you would like to use this trait in your own code, please open an issue
53+ /// to discuss the use case and we can consider making it public.
4654pub trait DynamicFilterSource :
4755 Send + Sync + std:: fmt:: Debug + DynEq + DynHash + Display + ' static
4856{
You can’t perform that action at this time.
0 commit comments