Struct datafusion_python::datafusion_expr::logical_plan::display::PgJsonVisitor

pub struct PgJsonVisitor<'a, 'b> { /* private fields */ }

Formats plans to display as postgresql plan json format.

There are already many existing visualizer for this format, for example dalibo. Unfortunately, there is no formal spec for this format, but it is widely used in the PostgreSQL community.

Here is an example of the format:

[
    {
        "Plan": {
            "Node Type": "Sort",
            "Output": [
                "question_1.id",
                "question_1.title",
                "question_1.text",
                "question_1.file",
                "question_1.type",
                "question_1.source",
                "question_1.exam_id"
            ],
            "Sort Key": [
                "question_1.id"
            ],
            "Plans": [
                {
                    "Node Type": "Seq Scan",
                    "Parent Relationship": "Left",
                    "Relation Name": "question",
                    "Schema": "public",
                    "Alias": "question_1",
                    "Output": [
                       "question_1.id",
                        "question_1.title",
                       "question_1.text",
                        "question_1.file",
                        "question_1.type",
                        "question_1.source",
                        "question_1.exam_id"
                    ],
                    "Filter": "(question_1.exam_id = 1)"
                }
            ]
        }
    }
]

Implementations

impl<'a, 'b> PgJsonVisitor<'a, 'b>

pub fn new(f: &'a mut Formatter<'b>) -> PgJsonVisitor<'a, 'b>

pub fn with_schema(&mut self, with_schema: bool)

Sets a flag which controls if the output schema is displayed

Trait Implementations

impl<'n, 'a, 'b> TreeNodeVisitor<'n> for PgJsonVisitor<'a, 'b>

type Node = LogicalPlan

The node type which is visitable.

fn f_down( &mut self, node: &'n LogicalPlan, ) -> Result<TreeNodeRecursion, DataFusionError>

Invoked while traversing down the tree, before any children are visited. Default implementation continues the recursion.

fn f_up( &mut self, _node: &<PgJsonVisitor<'a, 'b> as TreeNodeVisitor<'n>>::Node, ) -> Result<TreeNodeRecursion, DataFusionError>

Invoked while traversing up the tree after children are visited. Default implementation continues the recursion.