Skip to content

Improve explain tree formatting for longer lines / word wrap #15019

@alamb

Description

@alamb

Is your feature request related to a problem or challenge?

The new tree explain format currently truncates pretty aggressively

For example, the query like this

set datafusion.explain.format = "tree";

 create table  table1 (
  int_col INT,
  string_col TEXT,
  bigint_col BIGINT,
  date_col DATE
) as VALUES (1, 'foo', 1, '2023-01-01'), (2, 'bar', 2, '2023-01-02'), (3, 'baz', 3, '2023-01-03');
0 row(s) fetched.

explain SELECT int_col FROM table1
WHERE string_col != 'foo' AND string_col != 'bar' AND string_col != 'a really long string constant'

The output looks like this (note that the predicate has been truncated):

+---------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type     | plan                                                                                                                                           |
+---------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| logical_plan  | Projection: table1.int_col                                                                                                                     |
|               |   Filter: table1.string_col != Utf8("foo") AND table1.string_col != Utf8("bar") AND table1.string_col != Utf8("a really long string constant") |
|               |     TableScan: table1 projection=[int_col, string_col]                                                                                         |
| physical_plan | ┌───────────────────────────┐                                                                                                                  |
|               | │    CoalesceBatchesExec    │                                                                                                                  |
|               | └─────────────┬─────────────┘                                                                                                                  |
|               | ┌─────────────┴─────────────┐                                                                                                                  |
|               | │         FilterExec        │                                                                                                                  |
|               | │    --------------------   │                                                                                                                  |
|               | │         predicate:        │                                                                                                                  |
|               | │string_col@1 != foo AND ...│                                                                                                                  |
|               | └─────────────┬─────────────┘                                                                                                                  |
|               | ┌─────────────┴─────────────┐                                                                                                                  |
|               | │       DataSourceExec      │                                                                                                                  |
|               | │    --------------------   │                                                                                                                  |
|               | │    partition_sizes: [1]   │                                                                                                                  |
|               | │       partitions: 1       │                                                                                                                  |
|               | └───────────────────────────┘                                                                                                                  |
|               |                                                                                                                                                |
+---------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2 row(s) fetched.

As @irenjj says in #15001 (comment)

This is a very nice case for // TODO: check every line is less than MAX_LINE_RENDER_SIZE. In DuckDB, we can get the following result:

D explain select * from t1 where c != 'foo' and c != 'bar' and c != 'a really long string constant';

┌─────────────────────────────┐
│┌───────────────────────────┐│
││       Physical Plan       ││
│└───────────────────────────┘│
└─────────────────────────────┘
┌───────────────────────────┐
│         SEQ_SCAN          │
│    ────────────────────   │
│         Table: t1         │
│   Type: Sequential Scan   │
│       Projections: c      │
│                           │
│          Filters:         │
│ c!='foo' AND c!='bar' AND │
│  c!='a really long string │
│          constant'        │
│                           │
│          ~1 Rows          │
└───────────────────────────┘

Describe the solution you'd like

I would like more of the predicate to be visible in the explain plan (there probably needs to still be some limit, but more than one line would be nice)

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions