From 856a5f58841d6a7ec0b3a53e9e5af6cb5383deaa Mon Sep 17 00:00:00 2001 From: Jax Liu Date: Mon, 23 Dec 2024 19:59:52 +0800 Subject: [PATCH] improve the doc --- datafusion/sql/src/unparser/extension_unparser.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/datafusion/sql/src/unparser/extension_unparser.rs b/datafusion/sql/src/unparser/extension_unparser.rs index 32643260cb3c..3ad224422ae6 100644 --- a/datafusion/sql/src/unparser/extension_unparser.rs +++ b/datafusion/sql/src/unparser/extension_unparser.rs @@ -26,6 +26,9 @@ pub trait UserDefinedLogicalNodeUnparser { /// /// This method is called when the custom logical node is part of a statement. /// e.g. `SELECT * FROM custom_logical_node` + /// + /// The return value should be [UnparseResult::WithinStatement] if the custom logical node was successfully unparsed. + /// Otherwise, return [UnparseResult::Original]. fn unparse( &self, _node: &dyn UserDefinedLogicalNode, @@ -40,6 +43,9 @@ pub trait UserDefinedLogicalNodeUnparser { /// Unparse the custom logical node to a statement. /// /// This method is called when the custom logical node is a custom statement. + /// + /// The return value should be [UnparseResult::Statement] if the custom logical node was successfully unparsed. + /// Otherwise, return [UnparseResult::Original]. fn unparse_to_statement( &self, _node: &dyn UserDefinedLogicalNode,