From 5ce1d17fa8435e118d1599c502dd528fbb969dd8 Mon Sep 17 00:00:00 2001 From: Rui Wang Date: Sun, 16 Oct 2022 22:09:12 -0700 Subject: [PATCH] update --- python/pyspark/sql/connect/plan.py | 10 ++++++++++ 1 file changed, 10 insertions(+) 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))