diff --git a/python/pyspark/sql/connect/plan.py b/python/pyspark/sql/connect/plan.py index 2f0caaf0b6d57..9351998c19561 100644 --- a/python/pyspark/sql/connect/plan.py +++ b/python/pyspark/sql/connect/plan.py @@ -83,6 +83,16 @@ def _verify(self, session: "RemoteSparkSession") -> bool: def to_proto( self, session: Optional["RemoteSparkSession"] = None, debug: bool = False ) -> proto.Plan: + """ + Generates connect proto plan based on this LogicalPlan. + + Parameters + ---------- + session : :class:`RemoteSparkSession`, optional. + a session that connects remote spark cluster. + debug: bool + if enabled, the proto plan will be printed. + """ plan = proto.Plan() plan.root.CopyFrom(self.plan(session))