2020-06-08 09:14:58 +00:00
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
#include <list>
|
|
|
|
#include <vector>
|
2020-12-02 12:08:03 +00:00
|
|
|
#include <set>
|
|
|
|
|
|
|
|
#include <Core/Names.h>
|
2020-06-08 09:14:58 +00:00
|
|
|
|
|
|
|
namespace DB
|
|
|
|
{
|
|
|
|
|
|
|
|
class DataStream;
|
|
|
|
|
|
|
|
class IQueryPlanStep;
|
|
|
|
using QueryPlanStepPtr = std::unique_ptr<IQueryPlanStep>;
|
|
|
|
|
|
|
|
class QueryPipeline;
|
|
|
|
using QueryPipelinePtr = std::unique_ptr<QueryPipeline>;
|
|
|
|
|
2020-06-19 14:42:01 +00:00
|
|
|
class Context;
|
2020-06-22 14:37:42 +00:00
|
|
|
class WriteBuffer;
|
2020-06-19 14:42:01 +00:00
|
|
|
|
2020-10-01 17:34:22 +00:00
|
|
|
class QueryPlan;
|
|
|
|
using QueryPlanPtr = std::unique_ptr<QueryPlan>;
|
|
|
|
|
2020-10-07 11:26:29 +00:00
|
|
|
class Pipe;
|
|
|
|
|
2020-06-08 09:14:58 +00:00
|
|
|
/// A tree of query steps.
|
2020-06-22 10:18:28 +00:00
|
|
|
/// The goal of QueryPlan is to build QueryPipeline.
|
|
|
|
/// QueryPlan let delay pipeline creation which is helpful for pipeline-level optimisations.
|
2020-06-08 09:14:58 +00:00
|
|
|
class QueryPlan
|
|
|
|
{
|
|
|
|
public:
|
2020-06-22 14:37:42 +00:00
|
|
|
QueryPlan();
|
2020-06-19 14:42:01 +00:00
|
|
|
~QueryPlan();
|
2020-09-15 17:13:13 +00:00
|
|
|
QueryPlan(QueryPlan &&);
|
|
|
|
QueryPlan & operator=(QueryPlan &&);
|
2020-06-19 14:42:01 +00:00
|
|
|
|
2020-10-01 17:34:22 +00:00
|
|
|
void unitePlans(QueryPlanStepPtr step, std::vector<QueryPlanPtr> plans);
|
2020-06-08 09:14:58 +00:00
|
|
|
void addStep(QueryPlanStepPtr step);
|
|
|
|
|
|
|
|
bool isInitialized() const { return root != nullptr; } /// Tree is not empty
|
|
|
|
bool isCompleted() const; /// Tree is not empty and root hasOutputStream()
|
|
|
|
const DataStream & getCurrentDataStream() const; /// Checks that (isInitialized() && !isCompleted())
|
|
|
|
|
2020-07-23 10:20:38 +00:00
|
|
|
void optimize();
|
|
|
|
|
2020-06-08 09:14:58 +00:00
|
|
|
QueryPipelinePtr buildQueryPipeline();
|
|
|
|
|
2020-10-07 11:26:29 +00:00
|
|
|
/// If initialized, build pipeline and convert to pipe. Otherwise, return empty pipe.
|
|
|
|
Pipe convertToPipe();
|
|
|
|
|
2020-06-26 13:58:28 +00:00
|
|
|
struct ExplainPlanOptions
|
2020-06-23 11:26:06 +00:00
|
|
|
{
|
2020-06-26 13:58:28 +00:00
|
|
|
/// Add output header to step.
|
2020-06-23 11:26:06 +00:00
|
|
|
bool header = false;
|
2020-06-26 13:58:28 +00:00
|
|
|
/// Add description of step.
|
2020-06-23 14:11:15 +00:00
|
|
|
bool description = true;
|
2020-06-26 13:58:28 +00:00
|
|
|
/// Add detailed information about step actions.
|
2020-06-23 16:06:56 +00:00
|
|
|
bool actions = false;
|
2020-06-23 11:26:06 +00:00
|
|
|
};
|
|
|
|
|
2020-06-26 13:58:28 +00:00
|
|
|
struct ExplainPipelineOptions
|
|
|
|
{
|
|
|
|
/// Show header of output ports.
|
|
|
|
bool header = false;
|
|
|
|
};
|
|
|
|
|
|
|
|
void explainPlan(WriteBuffer & buffer, const ExplainPlanOptions & options);
|
|
|
|
void explainPipeline(WriteBuffer & buffer, const ExplainPipelineOptions & options);
|
2020-06-22 14:37:42 +00:00
|
|
|
|
2020-06-18 17:45:00 +00:00
|
|
|
/// Set upper limit for the recommend number of threads. Will be applied to the newly-created pipelines.
|
|
|
|
/// TODO: make it in a better way.
|
|
|
|
void setMaxThreads(size_t max_threads_) { max_threads = max_threads_; }
|
2020-10-22 11:08:12 +00:00
|
|
|
size_t getMaxThreads() const { return max_threads; }
|
2020-06-18 17:45:00 +00:00
|
|
|
|
2020-06-19 14:42:01 +00:00
|
|
|
void addInterpreterContext(std::shared_ptr<Context> context);
|
|
|
|
|
2020-06-22 10:18:28 +00:00
|
|
|
/// Tree node. Step and it's children.
|
2020-06-08 09:14:58 +00:00
|
|
|
struct Node
|
|
|
|
{
|
|
|
|
QueryPlanStepPtr step;
|
2020-06-16 14:11:19 +00:00
|
|
|
std::vector<Node *> children = {};
|
2020-06-08 09:14:58 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
using Nodes = std::list<Node>;
|
|
|
|
|
2020-08-12 13:30:02 +00:00
|
|
|
private:
|
|
|
|
Nodes nodes;
|
2020-06-08 09:14:58 +00:00
|
|
|
Node * root = nullptr;
|
|
|
|
|
|
|
|
void checkInitialized() const;
|
|
|
|
void checkNotCompleted() const;
|
2020-06-18 17:45:00 +00:00
|
|
|
|
2020-06-22 10:18:28 +00:00
|
|
|
/// Those fields are passed to QueryPipeline.
|
2020-06-18 17:45:00 +00:00
|
|
|
size_t max_threads = 0;
|
2020-06-19 14:42:01 +00:00
|
|
|
std::vector<std::shared_ptr<Context>> interpreter_context;
|
2020-06-08 09:14:58 +00:00
|
|
|
};
|
|
|
|
|
2020-12-24 09:06:12 +00:00
|
|
|
std::string debugExplainStep(const IQueryPlanStep & step);
|
2020-12-24 04:03:33 +00:00
|
|
|
|
2020-06-08 09:14:58 +00:00
|
|
|
}
|