nuno-faria commented on code in PR #19316: URL: https://github.com/apache/datafusion/pull/19316#discussion_r3004969744
########## datafusion/core/src/execution/plan_observer.rs: ########## @@ -0,0 +1,158 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! Provides callbacks to keep track of planned and executed queries. + +use std::collections::HashMap; +use std::io::Write; +use std::sync::Arc; +use std::time::Duration; +use std::{fmt::Debug, fs}; + +use arrow::{array::RecordBatch, util::pretty::pretty_format_batches}; +use datafusion_common::error::Result; +use datafusion_expr::LogicalPlan; +use datafusion_physical_plan::ExecutionPlan; +use parking_lot::Mutex; + +#[cfg(feature = "sql")] +use datafusion_sql::unparser::Unparser; + +/// Provides callbacks to keep track of planned and executed queries. +pub trait PlanObserver: Send + Sync + 'static + Debug { + /// Called after the physical plan has been created but before it has been executed. + /// Receives the logical and physical plans, as well as a unique identifier. + fn plan_created( + &self, + id: &str, + logical_plan: &LogicalPlan, + physical_plan: &Arc<dyn ExecutionPlan>, + ) -> Result<()>; + + /// Called after the physical plan has been executed. + /// Receives the identifier, the EXPLAIN ANALYZE output, and the duration. + fn plan_executed( + &self, + id: &str, + explain_result: RecordBatch, Review Comment: The annotated plan. I changed the variable name to `annotated_plan` to make it clearer. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
