RelAlgDagViewer Class Reference

#include <RelAlgDagViewer.h>

Inheritance diagram for RelAlgDagViewer:

Collaboration diagram for RelAlgDagViewer:

Classes
struct	BreadthFirstSearch
struct	CollectImmediateChildren
struct	NodeInfo

Public Types
using	id_map = std::unordered_map< std::uintptr_t, NodeInfo >

Public Member Functions
	RelAlgDagViewer ()
	RelAlgDagViewer (bool showing_steps, bool verbose)
virtual void	clear ()
virtual std::string	str () const
virtual id_map::iterator	emplace (RelAlgDagNode const *n)
virtual void	handleQueryEngineVector (std::vector< std::shared_ptr< RelAlgNode >> const nodes)
Public Member Functions inherited from RelAlgDagNode::Visitor
virtual	~Visitor ()

Protected Member Functions
virtual id_map::iterator	emplaceVoid (void const *n)
void	beginNextLine (std::optional< size_t > step={})
template<typename T >
void	visitChild (T child, std::string name)
template<typename T >
bool	innerVisit (T t, std::string name, bool recurse=true)
bool	visit (RelAggregate const *n, std::string s) override
bool	visit (RelCompound const *n, std::string s) override
bool	visit (RelFilter const *n, std::string s) override
bool	visit (RelJoin const *n, std::string s) override
bool	visit (RelLeftDeepInnerJoin const *n, std::string s) override
bool	visit (RelLogicalUnion const *n, std::string s) override
bool	visit (RelLogicalValues const *n, std::string s) override
bool	visit (RelModify const *n, std::string s) override
bool	visit (RelProject const *n, std::string s) override
bool	visit (RelScan const *n, std::string s) override
bool	visit (RelSort const *n, std::string s) override
bool	visit (RelTableFunction const *n, std::string s) override
bool	visit (RelTranslatedJoin const *n, std::string s) override
bool	visit (RexAbstractInput const *n, std::string s) override
bool	visit (RexCase const *n, std::string s) override
bool	visit (RexFunctionOperator const *n, std::string s) override
bool	visit (RexInput const *n, std::string s) override
bool	visit (RexLiteral const *n, std::string s) override
bool	visit (RexOperator const *n, std::string s) override
bool	visit (RexRef const *n, std::string s) override
bool	visit (RexAgg const *n, std::string s) override
bool	visit (RexSubQuery const *n, std::string s) override
bool	visit (RexWindowFunctionOperator const *n, std::string s) override
Protected Member Functions inherited from RelAlgDagNode::Visitor
virtual bool	visitAny (RelAlgDagNode const *n, std::string s)

Protected Attributes
std::ostringstream	out_
size_t	indent_level_ {0}
size_t	line_number_ {1}
bool	showing_steps_ {false}
id_map	ids_
size_t	next_id_ {1}
bool	top_call_ {true}
bool	already_indented_ {false}
bool	needs_newline_ {false}
bool	needs_colon_ {false}
bool	verbose_ {false}

Static Protected Attributes
static constexpr size_t	indent_spaces_ {4}

Detailed Description

Definition at line 30 of file RelAlgDagViewer.h.

Member Typedef Documentation

using RelAlgDagViewer::id_map = std::unordered_map<std::uintptr_t, NodeInfo>

Definition at line 51 of file RelAlgDagViewer.h.

Constructor & Destructor Documentation

RelAlgDagViewer::RelAlgDagViewer ( )

inline

Definition at line 32 of file RelAlgDagViewer.h.

Referenced by clear().

{}

Here is the caller graph for this function:

RelAlgDagViewer::RelAlgDagViewer ( bool  showing_steps, bool  verbose  )

inline

Definition at line 33 of file RelAlgDagViewer.h.

      : showing_steps_(showing_steps), verbose_(verbose) {}

Member Function Documentation

void RelAlgDagViewer::beginNextLine ( std::optional< size_t >  step = {} )

inlineprotected

Definition at line 79 of file RelAlgDagViewer.h.

Referenced by innerVisit().

                                                {}) {
    if (!already_indented_) {
      if (needs_colon_) {
        out_ << ":";
      }
      if (needs_newline_) {
        out_ << "\n";
      } else {
        needs_newline_ = true;
      }
      if (showing_steps_) {
        if (!step || *step == 0) {
          out_ << "           ";
        } else {
          out_ << "STEP " << std::to_string(*step) << ":    ";
        }
      }
      out_ << std::string(indent_level_ * indent_spaces_, ' ');
    } else {
      already_indented_ = false;
    }
    ++line_number_;
  }

Here is the caller graph for this function:

virtual void RelAlgDagViewer::clear ( )

inlinevirtual

Definition at line 36 of file RelAlgDagViewer.h.

References RelAlgDagViewer(), showing_steps_, and verbose_.

Referenced by innerVisit().

{ *this = RelAlgDagViewer(showing_steps_, verbose_); }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual id_map::iterator RelAlgDagViewer::emplace ( RelAlgDagNode const *  n )

inlinevirtual

Definition at line 53 of file RelAlgDagViewer.h.

References emplaceVoid(), and RelAlgDagNode::setIdInPlanTree().

Referenced by handleQueryEngineVector(), and innerVisit().

                                                         {
    // Ensures we always emplace RelAlgDagNode* to give a consistent uintptr_t key.
    auto it = emplaceVoid(n);
    n->setIdInPlanTree(it->second.id);
    return it;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual id_map::iterator RelAlgDagViewer::emplaceVoid ( void const *  n )

inlineprotectedvirtual

Definition at line 69 of file RelAlgDagViewer.h.

References CHECK, ids_, next_id_, and top_call_.

Referenced by emplace().

                                                    {
    CHECK(n);
    auto [it, id_is_new] = ids_.emplace(
        std::uintptr_t(n), NodeInfo{next_id_, top_call_, /*used_node=*/false});
    if (id_is_new) {
      ++next_id_;
    }
    return it;
  }

Here is the caller graph for this function:

void RelAlgDagViewer::handleQueryEngineVector ( std::vector< std::shared_ptr< RelAlgNode >> const  nodes )

inlinevirtual

Definition at line 316 of file RelAlgDagViewer.h.

References CHECK, emplace(), ids_, anonymous_namespace{Utm.h}::n, showing_steps_, and top_call_.

Referenced by RelAlgExecutor::executeRelAlgQueryNoRetry().

                                                      {
  if (nodes.empty()) {
    return;
  }

  // Determines if a steps column needs to be displayed.
  // TODO(sy): Do this recursively from the root node?
  for (auto const& node : nodes) {
    if (node && node->getStepNumber() > 1) {
      showing_steps_ = true;
      break;
    }
  }

  // Ensure that the root node is always node #1.
  emplace(nodes.back().get());  // The last node in the vector is the root node.

  // Breadth-first search starting at the root node to assign node ID's to all used nodes,
  // in order of importance. BFS is done instead of recursing which would give a
  // depth-first search and a less helpful ordering of node ID's.
  top_call_ = false;
  BreadthFirstSearch bfs([this](RelAlgDagNode const* n) {
    auto it = emplace(n);
    CHECK(it != ids_.end());
    it->second.used_node = true;
  });
  bfs.search(nodes.back().get());
  top_call_ = true;

  // Visit all nodes, building the text output.
  nodes.back()->accept(*this, {});
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

bool RelAlgDagViewer::innerVisit ( T  t, std::string  name, bool  recurse = true  )

inlineprotected

Definition at line 158 of file RelAlgDagViewer.h.

References RelRexToStringConfig::attributes_only, beginNextLine(), CHECK, clear(), emplace(), ids_, indent_level_, line_number_, next_id_, RelAlgDagViewer::CollectImmediateChildren::nodes, out_, RelRexToStringConfig::skip_input_nodes, top_call_, verbose_, and visitChild().

Referenced by visit().

                                                            {
    static_assert(std::is_base_of_v<RelAlgDagNode, std::remove_pointer_t<T>>);

    // Top nodes are directly emplaced by or directly visited by the user and must start
    // with all the default settings, except that we want to preserve any node ID's that
    // were assigned during the user's previous calls.
    bool const top_call{top_call_};
    if (top_call_) {
      auto ids = std::move(ids_);
      auto next_id = std::move(next_id_);
      auto line_number = std::move(line_number_);
      clear();
      ids_ = std::move(ids);
      next_id_ = std::move(next_id);
      line_number_ = line_number;
    }

    if (!t) {
      return /*recurse=*/false;
    }
    id_map::iterator it = emplace(t);  // Needs the original top_call_ setting.
    CHECK(it != ids_.end());

    // Output some info about this node.
    beginNextLine(t->getStepNumber());
    std::string key_text{!name.empty() ? ("[" + name + "] ") : ""};
    out_ << "#" << it->second.id << " " << key_text;

    RelRexToStringConfig cfg;
    cfg.skip_input_nodes = true;
    cfg.attributes_only = true;
    out_ << t->toString(cfg);

    // Recurse to child nodes.
    // Non-top child nodes always will be recursed.
    // Top child nodes normally won't be recursed because they'll be visited with their
    // own direct call from the user (or from operator<< for the user). If we're here from
    // a direct user call (top_call is true), the node will be recursed.
    if (recurse) {
      top_call_ = false;  // Must turn off top_call_ before recursing to any children.
      ++indent_level_;
      CollectImmediateChildren visitor;
      t->acceptChildren(visitor);
      for (auto [key, child] : visitor.nodes) {
        if (child) {
          if (!verbose_) {
            // Only show RelScan or RexInput nodes when verbose_ is true.
            if (dynamic_cast<RelScan const*>(child) ||
                dynamic_cast<RexInput const*>(child)) {
              continue;
            }
          }
          beginNextLine(child->getStepNumber());
          visitChild(child, key);
        }
      }
      --indent_level_;
    }

    // Resets top_call_ to clear the out_ buffer if user directly calls visit again.
    top_call_ = top_call;

    return /*recurse=*/false;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual std::string RelAlgDagViewer::str ( ) const

inlinevirtual

Definition at line 38 of file RelAlgDagViewer.h.

References out_.

Referenced by operator<<().

                                {
    std::string ret{out_.str()};
    if (!ret.empty()) {
      ret += '\n';
    }
    return ret;
  }

Here is the caller graph for this function:

bool RelAlgDagViewer::visit ( RelAggregate const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 225 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelCompound const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 227 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelFilter const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 229 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelJoin const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 231 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelLeftDeepInnerJoin const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 233 of file RelAlgDagViewer.h.

References innerVisit().

                                                                  {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelLogicalUnion const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 237 of file RelAlgDagViewer.h.

References innerVisit().

                                                             {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelLogicalValues const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 241 of file RelAlgDagViewer.h.

References innerVisit().

                                                              {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelModify const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 245 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelProject const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 247 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelScan const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 249 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelSort const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 251 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelTableFunction const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 253 of file RelAlgDagViewer.h.

References innerVisit().

                                                              {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RelTranslatedJoin const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 257 of file RelAlgDagViewer.h.

References innerVisit().

                                                               {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexAbstractInput const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 263 of file RelAlgDagViewer.h.

References innerVisit().

                                                              {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexCase const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 267 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexFunctionOperator const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 269 of file RelAlgDagViewer.h.

References innerVisit().

                                                                 {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexInput const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 273 of file RelAlgDagViewer.h.

References RexInput::getSourceNode(), ids_, innerVisit(), and out_.

                                                      {
    // As a special case, don't print out the addtional lines for the source child under a
    // RexInput node. The information is already shown inline elsewhere in the plan.
    auto ret = innerVisit(n, s, /*recurse=*/false);
    auto it =
        ids_.find(std::uintptr_t(static_cast<RelAlgDagNode const*>(n->getSourceNode())));
    if (it != ids_.end()) {
      out_ << ": source #" << it->second.id;
    }
    return ret;
  }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexLiteral const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 285 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexOperator const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 287 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexRef const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 289 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexAgg const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 291 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexSubQuery const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 293 of file RelAlgDagViewer.h.

References innerVisit().

{ return innerVisit(n, s); }

Here is the call graph for this function:

bool RelAlgDagViewer::visit ( RexWindowFunctionOperator const *  n, std::string  s  )

inlineoverrideprotectedvirtual

Reimplemented from RelAlgDagNode::Visitor.

Definition at line 295 of file RelAlgDagViewer.h.

References innerVisit().

                                                                       {
    return innerVisit(n, s);
  }

Here is the call graph for this function:

template<typename T >

void RelAlgDagViewer::visitChild ( T  child, std::string  name  )

inlineprotected

Definition at line 146 of file RelAlgDagViewer.h.

References already_indented_, CHECK, ids_, and needs_colon_.

Referenced by innerVisit().

                                           {
    static_assert(std::is_base_of_v<RelAlgDagNode, std::remove_pointer_t<T>>);
    auto it = ids_.find(std::uintptr_t(static_cast<RelAlgDagNode const*>(child)));
    CHECK(it != ids_.end());
    it->second.used_node = true;  // Node is a child node.
    already_indented_ = true;
    needs_colon_ = true;
    child->accept(*this, name);
    needs_colon_ = false;
  }

Here is the caller graph for this function:

Member Data Documentation

bool RelAlgDagViewer::already_indented_ {false}

protected

Definition at line 308 of file RelAlgDagViewer.h.

Referenced by visitChild().

id_map RelAlgDagViewer::ids_

protected

Definition at line 305 of file RelAlgDagViewer.h.

Referenced by emplaceVoid(), handleQueryEngineVector(), innerVisit(), visit(), and visitChild().

size_t RelAlgDagViewer::indent_level_ {0}

protected

Definition at line 302 of file RelAlgDagViewer.h.

Referenced by innerVisit().

constexpr size_t RelAlgDagViewer::indent_spaces_ {4}

staticprotected

Definition at line 313 of file RelAlgDagViewer.h.

size_t RelAlgDagViewer::line_number_ {1}

protected

Definition at line 303 of file RelAlgDagViewer.h.

Referenced by innerVisit().

bool RelAlgDagViewer::needs_colon_ {false}

protected

Definition at line 310 of file RelAlgDagViewer.h.

Referenced by visitChild().

bool RelAlgDagViewer::needs_newline_ {false}

protected

Definition at line 309 of file RelAlgDagViewer.h.

size_t RelAlgDagViewer::next_id_ {1}

protected

Definition at line 306 of file RelAlgDagViewer.h.

Referenced by emplaceVoid(), and innerVisit().

std::ostringstream RelAlgDagViewer::out_

protected

Definition at line 301 of file RelAlgDagViewer.h.

Referenced by innerVisit(), str(), and visit().

bool RelAlgDagViewer::showing_steps_ {false}

protected

Definition at line 304 of file RelAlgDagViewer.h.

Referenced by clear(), and handleQueryEngineVector().

bool RelAlgDagViewer::top_call_ {true}

protected

Definition at line 307 of file RelAlgDagViewer.h.

Referenced by emplaceVoid(), handleQueryEngineVector(), and innerVisit().

bool RelAlgDagViewer::verbose_ {false}

protected

Definition at line 311 of file RelAlgDagViewer.h.

Referenced by clear(), and innerVisit().

---

The documentation for this class was generated from the following file:

• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/Visitors/RelAlgDagViewer.h