`MoveTowardsLeafNodes` placement implies speculative evaluation, but the docs don't say so
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 75/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- rust
- Domaine
- backend-api-design, documentation
Piste de recherche
Commence par la documentation de ExpressionPlacement::MoveTowardsLeafNodes et de ScalarUDFImpl::placement, vers laquelle renvoie l’issue. Lis comment l’extraction et le pushdown d’expressions feuilles peuvent évaluer des expressions sur des lignes exclues par des branches de CASE ou des filtres, puis documente l’exigence de sécurité pour les deux APIs. La tâche est terminée lorsque les deux documentations indiquent que les expressions avec ce placement ne doivent échouer ni avoir d’effets secondaires sur aucune ligne d’entrée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Describe the bug
ExpressionPlacement::MoveTowardsLeafNodes is documented as a performance hint: the expression is cheap and can be pushed down towards the leaves of the plan. When the optimizer acts on that hint, it also runs the expression on rows that the original plan never evaluated it on:
ExtractLeafExpressionsextractsMoveTowardsLeafNodessub-expressions from anywhere inside an expression tree, including the branches ofCASE. In the extraction projection, they are evaluated for every input row, not just the rows the branch selects.PushDownLeafProjectionsthen pushes the extraction projections belowFilternodes, so the expressions also run on rows the filter removes.
So an expression with this placement must be safe to evaluate on rows that a filter or a conditional would exclude: it must not fail on them or have side effects. Neither ExpressionPlacement::MoveTowardsLeafNodes nor ScalarUDFImpl::placement states this. The built-in functions with this placement (get_field, input_file_name, file_row_index) meet the requirement as far as I can tell. A user-defined function that returns MoveTowardsLeafNodes because it is cheap, but fails on some inputs, can make a query fail even though SQL CASE and WHERE semantics say that input is never evaluated.
To Reproduce
The plan below shows how get_field is moved with the default configuration (datafusion.optimizer.enable_leaf_expression_pushdown = true):
CREATE TABLE t AS SELECT * FROM (VALUES
(1, named_struct('a', 1, 'b', 2)),
(-1, named_struct('a', 3, 'b', 4))
) AS v(x, s);
EXPLAIN SELECT CASE WHEN x > 0 THEN s['a'] WHEN x < -100 THEN 0 END FROM t WHERE x <> 5;
logical_plan
01)Projection: CASE WHEN t.x > Int64(0) THEN __datafusion_extracted_1 WHEN t.x < Int64(-100) THEN Int64(0) END AS ...
02)--Filter: t.x != Int64(5)
03)----Projection: get_field(t.s, Utf8("a")) AS __datafusion_extracted_1, t.x
04)------TableScan: t projection=[x, s]
get_field(t.s, 'a') came from the first THEN branch, and it is now evaluated below the filter for every row of t.
Replace s['a'] with a UDF that returns MoveTowardsLeafNodes and fails on some values, for example a checked conversion that fails when its argument is 0. The query then fails on rows where x <= 0 or x = 5, even though the result would never include the UDF's value for those rows.
Expected behavior
Either of these would resolve it:
- Document the requirement (preferred). State on
ExpressionPlacement::MoveTowardsLeafNodesandScalarUDFImpl::placementthat an expression with this placement may be evaluated on rows that enclosing filters or conditional expressions would exclude, so it must not fail or have side effects on any input row. This matches what the optimizer already relies on. - Stop speculative evaluation: don't extract leaf expressions from conditional sub-expressions (
CASEbranches, the right side of short-circuitingAND/OR), and don't push extraction projections below filters when the extracted expression could fail. That would give up much of the benefit of the leaf pushdown optimization, which is mainly about evaluatingget_fieldclose to the scan.
Additional context
The question came up while reviewing #26589, which precomputes MoveTowardsLeafNodes expressions over the whole batch before evaluating CASE branches (https://github.com/apache/datafusion/pull/26589#discussion_r4581490634). That PR relies on the same assumption at the physical level, so documenting the requirement would cover both.
- Langage dominant
- Rust
- Étoiles
- 9.6k
- Forks
- 2.6k
- Merge moyen
- 3 j 5 h
- PR mergées (30 j)
- 352
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de apache/datafusion
-
`verify-release-candidate.sh` version check doesn't catch `-dev` versions and is skipped on macOSPeut-être pris @vinycalves l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
apache/datafusion#27563 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
`lpad` and `rpad` with a literal length above `i32::MAX` error on a NULL string or fillPeut-être pris @TechWizard9999 l’a pris il y a 1 jour. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
apache/datafusion#27482 · 1 commentaire · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Window constructors panic when the expression list is emptyPeut-être pris @abp002 l’a pris il y a 4 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
apache/datafusion#27315 · 3 commentaires · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
apache/datafusion#27094 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Substrait consumer doesn't recognise `shift_left` / `shift_right` from functions_arithmetic.yamlPeut-être pris @jonasHanhan l’a pris il y a 15 jours. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
apache/datafusion#27059 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de apache/datafusion
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
tinystream-dev/tinystream#132 ·
-
contract good first issue testing
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Emmyt24/nova-launch#2436 ·
Les mainteneurs répondent en général sous 1 jour