OmniSciDB  21ac014ffc
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RelAlgExecutionUnit.h File Reference

Execution unit for relational algebra. It's a low-level description of any relational algebra operation in a format understood by our VM. More...

#include "Descriptors/InputDescriptors.h"
#include "QueryHint.h"
#include "Shared/sqldefs.h"
#include "Shared/toString.h"
#include "TableFunctions/TableFunctionOutputBufferSizeType.h"
#include "TableFunctions/TableFunctionsFactory.h"
#include "ThriftHandler/QueryState.h"
#include <boost/graph/adjacency_list.hpp>
#include <list>
#include <memory>
#include <optional>
#include <vector>
+ Include dependency graph for RelAlgExecutionUnit.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SortInfo
 
struct  JoinCondition
 
struct  RelAlgExecutionUnit
 
struct  TableFunctionExecutionUnit
 

Namespaces

 Analyzer
 

Typedefs

using AdjacentList = boost::adjacency_list< boost::setS, boost::vecS, boost::directedS >
 
using RelNodeId = size_t
 
using RelNodeExplained = std::string
 
using RelNodeExplainedHash = size_t
 
using QueryPlan = std::string
 
using JoinColumnsInfo = std::string
 
using QueryPlanHash = size_t
 
using HashTableBuildDag = std::pair< JoinColumnsInfo, QueryPlan >
 
using HashTableBuildDagMap = std::unordered_map< JoinColumnsInfo, HashTableBuildDag >
 
using JoinQualsPerNestingLevel = std::vector< JoinCondition >
 
using ResultSetPtr = std::shared_ptr< ResultSet >
 

Enumerations

enum  JoinColumnSide { kInner, kOuter, kQual, kDirect }
 
enum  SortAlgorithm { SortAlgorithm::Default, SortAlgorithm::SpeculativeTopN, SortAlgorithm::StreamingTopN }
 

Functions

std::ostream & operator<< (std::ostream &os, const RelAlgExecutionUnit &ra_exe_unit)
 
std::string ra_exec_unit_desc_for_caching (const RelAlgExecutionUnit &ra_exe_unit)
 

Variables

constexpr char constEMPTY_QUERY_PLAN = ""
 

Detailed Description

Execution unit for relational algebra. It's a low-level description of any relational algebra operation in a format understood by our VM.

Author
Alex Suhan alex@.nosp@m.mapd.nosp@m..com Copyright (c) 2016 MapD Technologies, Inc. All rights reserved.
Todd Mostak todd@.nosp@m.omni.nosp@m.sci.c.nosp@m.om Copyright (c) 2020 Omnisci, Inc. All rights reserved.

Definition in file RelAlgExecutionUnit.h.

Typedef Documentation

using AdjacentList = boost::adjacency_list<boost::setS, boost::vecS, boost::directedS>

Definition at line 44 of file RelAlgExecutionUnit.h.

Definition at line 66 of file RelAlgExecutionUnit.h.

Definition at line 73 of file RelAlgExecutionUnit.h.

using JoinColumnsInfo = std::string

Definition at line 61 of file RelAlgExecutionUnit.h.

Definition at line 106 of file RelAlgExecutionUnit.h.

using QueryPlan = std::string

Definition at line 59 of file RelAlgExecutionUnit.h.

using QueryPlanHash = size_t

Definition at line 63 of file RelAlgExecutionUnit.h.

using RelNodeExplained = std::string

Definition at line 52 of file RelAlgExecutionUnit.h.

using RelNodeExplainedHash = size_t

Definition at line 54 of file RelAlgExecutionUnit.h.

using RelNodeId = size_t

Definition at line 50 of file RelAlgExecutionUnit.h.

using ResultSetPtr = std::shared_ptr<ResultSet>

Definition at line 151 of file RelAlgExecutionUnit.h.

Enumeration Type Documentation

Enumerator
kInner 
kOuter 
kQual 
kDirect 

Definition at line 75 of file RelAlgExecutionUnit.h.

75  {
76  kInner,
77  kOuter,
78  kQual, // INNER + OUTER
79  kDirect // set target directly (i.e., put Analyzer::Expr* instead of
80  // Analyzer::BinOper*)
81 };
enum SortAlgorithm
strong
Enumerator
Default 
SpeculativeTopN 
StreamingTopN 

Definition at line 84 of file RelAlgExecutionUnit.h.

Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const RelAlgExecutionUnit ra_exe_unit 
)

Definition at line 1274 of file Execute.cpp.

References EMPTY_QUERY_PLAN, RelAlgExecutionUnit::estimator, anonymous_namespace{Execute.cpp}::expr_container_to_string(), RelAlgExecutionUnit::groupby_exprs, i, RelAlgExecutionUnit::input_col_descs, join(), RelAlgExecutionUnit::join_quals, RelAlgExecutionUnit::quals, RelAlgExecutionUnit::query_plan_dag, RelAlgExecutionUnit::scan_limit, RelAlgExecutionUnit::simple_quals, anonymous_namespace{Execute.cpp}::sort_algorithm_to_string(), RelAlgExecutionUnit::sort_info, RelAlgExecutionUnit::target_exprs, to_string(), toString(), RelAlgExecutionUnit::union_all, and RelAlgExecutionUnit::use_bump_allocator.

1274  {
1275  auto query_plan_dag =
1276  ra_exe_unit.query_plan_dag == EMPTY_QUERY_PLAN ? "N/A" : ra_exe_unit.query_plan_dag;
1277  os << "\n\tExtracted Query Plan Dag: " << query_plan_dag;
1278  os << "\n\tTable/Col/Levels: ";
1279  for (const auto& input_col_desc : ra_exe_unit.input_col_descs) {
1280  const auto& scan_desc = input_col_desc->getScanDesc();
1281  os << "(" << scan_desc.getTableId() << ", " << input_col_desc->getColId() << ", "
1282  << scan_desc.getNestLevel() << ") ";
1283  }
1284  if (!ra_exe_unit.simple_quals.empty()) {
1285  os << "\n\tSimple Quals: "
1287  ", ");
1288  }
1289  if (!ra_exe_unit.quals.empty()) {
1290  os << "\n\tQuals: "
1291  << boost::algorithm::join(expr_container_to_string(ra_exe_unit.quals), ", ");
1292  }
1293  if (!ra_exe_unit.join_quals.empty()) {
1294  os << "\n\tJoin Quals: ";
1295  for (size_t i = 0; i < ra_exe_unit.join_quals.size(); i++) {
1296  const auto& join_condition = ra_exe_unit.join_quals[i];
1297  os << "\t\t" << std::to_string(i) << " " << ::toString(join_condition.type);
1298  os << boost::algorithm::join(expr_container_to_string(join_condition.quals), ", ");
1299  }
1300  }
1301  if (!ra_exe_unit.groupby_exprs.empty()) {
1302  os << "\n\tGroup By: "
1304  ", ");
1305  }
1306  os << "\n\tProjected targets: "
1308  os << "\n\tHas Estimator: " << ::toString(ra_exe_unit.estimator == nullptr);
1309  os << "\n\tSort Info: ";
1310  const auto& sort_info = ra_exe_unit.sort_info;
1311  os << "\n\t Order Entries: "
1312  << boost::algorithm::join(expr_container_to_string(sort_info.order_entries), ", ");
1313  os << "\n\t Algorithm: " << sort_algorithm_to_string(sort_info.algorithm);
1314  os << "\n\t Limit: " << std::to_string(sort_info.limit);
1315  os << "\n\t Offset: " << std::to_string(sort_info.offset);
1316  os << "\n\tScan Limit: " << std::to_string(ra_exe_unit.scan_limit);
1317  os << "\n\tBump Allocator: " << ::toString(ra_exe_unit.use_bump_allocator);
1318  if (ra_exe_unit.union_all) {
1319  os << "\n\tUnion: " << std::string(*ra_exe_unit.union_all ? "UNION ALL" : "UNION");
1320  }
1321  return os;
1322 }
std::vector< Analyzer::Expr * > target_exprs
std::string toString(const ExtArgumentType &sig_type)
const std::optional< bool > union_all
std::string join(T const &container, std::string const &delim)
const std::list< std::shared_ptr< Analyzer::Expr > > groupby_exprs
std::string to_string(char const *&&v)
const JoinQualsPerNestingLevel join_quals
std::vector< std::string > expr_container_to_string(const T &expr_container)
Definition: Execute.cpp:1186
const std::shared_ptr< Analyzer::Estimator > estimator
std::string sort_algorithm_to_string(const SortAlgorithm algorithm)
Definition: Execute.cpp:1208
std::list< std::shared_ptr< Analyzer::Expr > > quals
constexpr char const * EMPTY_QUERY_PLAN
std::list< std::shared_ptr< const InputColDescriptor > > input_col_descs
std::list< std::shared_ptr< Analyzer::Expr > > simple_quals

+ Here is the call graph for this function:

std::string ra_exec_unit_desc_for_caching ( const RelAlgExecutionUnit ra_exe_unit)

Definition at line 1223 of file Execute.cpp.

References RelAlgExecutionUnit::estimator, RelAlgExecutionUnit::groupby_exprs, i, RelAlgExecutionUnit::input_col_descs, RelAlgExecutionUnit::join_quals, RelAlgExecutionUnit::quals, RelAlgExecutionUnit::scan_limit, RelAlgExecutionUnit::simple_quals, RelAlgExecutionUnit::target_exprs, to_string(), and toString().

Referenced by RelAlgExecutor::executeWorkUnit().

1223  {
1224  // todo(yoonmin): replace a cache key as a DAG representation of a query plan
1225  // instead of ra_exec_unit description if possible
1226  std::ostringstream os;
1227  for (const auto& input_col_desc : ra_exe_unit.input_col_descs) {
1228  const auto& scan_desc = input_col_desc->getScanDesc();
1229  os << scan_desc.getTableId() << "," << input_col_desc->getColId() << ","
1230  << scan_desc.getNestLevel();
1231  }
1232  if (!ra_exe_unit.simple_quals.empty()) {
1233  for (const auto& qual : ra_exe_unit.simple_quals) {
1234  if (qual) {
1235  os << qual->toString() << ",";
1236  }
1237  }
1238  }
1239  if (!ra_exe_unit.quals.empty()) {
1240  for (const auto& qual : ra_exe_unit.quals) {
1241  if (qual) {
1242  os << qual->toString() << ",";
1243  }
1244  }
1245  }
1246  if (!ra_exe_unit.join_quals.empty()) {
1247  for (size_t i = 0; i < ra_exe_unit.join_quals.size(); i++) {
1248  const auto& join_condition = ra_exe_unit.join_quals[i];
1249  os << std::to_string(i) << ::toString(join_condition.type);
1250  for (const auto& qual : join_condition.quals) {
1251  if (qual) {
1252  os << qual->toString() << ",";
1253  }
1254  }
1255  }
1256  }
1257  if (!ra_exe_unit.groupby_exprs.empty()) {
1258  for (const auto& qual : ra_exe_unit.groupby_exprs) {
1259  if (qual) {
1260  os << qual->toString() << ",";
1261  }
1262  }
1263  }
1264  for (const auto& expr : ra_exe_unit.target_exprs) {
1265  if (expr) {
1266  os << expr->toString() << ",";
1267  }
1268  }
1269  os << ::toString(ra_exe_unit.estimator == nullptr);
1270  os << std::to_string(ra_exe_unit.scan_limit);
1271  return os.str();
1272 }
std::vector< Analyzer::Expr * > target_exprs
std::string toString(const ExtArgumentType &sig_type)
const std::list< std::shared_ptr< Analyzer::Expr > > groupby_exprs
std::string to_string(char const *&&v)
const JoinQualsPerNestingLevel join_quals
const std::shared_ptr< Analyzer::Estimator > estimator
std::list< std::shared_ptr< Analyzer::Expr > > quals
std::list< std::shared_ptr< const InputColDescriptor > > input_col_descs
std::list< std::shared_ptr< Analyzer::Expr > > simple_quals

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation