1
0
Fork 0
arangodb/arangod/Aql/ExecutionPlan.cpp

695 lines
23 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief Infrastructure for ExecutionPlans
///
/// @file arangod/Aql/ExecutionPlan.cpp
///
/// DISCLAIMER
///
/// Copyright 2010-2014 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Max Neunhoeffer
/// @author Copyright 2014, triagens GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#include "Aql/ExecutionPlan.h"
using namespace triagens::basics;
using namespace triagens::aql;
// -----------------------------------------------------------------------------
// --SECTION-- methods of ExecutionPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, export an ExecutionPlan to JSON
////////////////////////////////////////////////////////////////////////////////
Json ExecutionPlan::toJson (TRI_memory_zone_t* zone) {
std::map<ExecutionPlan*, int> indexTab;
Json json;
Json nodes;
try {
nodes = Json(Json::List,10);
toJsonHelper(indexTab, nodes, zone);
json = Json(Json::Array,1)
("nodes", nodes);
}
catch (std::exception& e) {
return Json();
}
return json;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief toJsonHelper, for a generic node
////////////////////////////////////////////////////////////////////////////////
Json ExecutionPlan::toJsonHelperGeneric (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
auto iter = indexTab.find(this);
if (iter != indexTab.end()) {
return Json();
}
for (size_t i = 0; i < _dependencies.size(); i++) {
_dependencies[i]->toJsonHelper(indexTab, nodes, zone);
}
Json json;
json = Json(Json::Array,2)
("type", Json(getTypeString()));
Json deps(Json::List, _dependencies.size());
for (size_t i = 0; i < _dependencies.size(); i++) {
auto it = indexTab.find(_dependencies[i]);
if (it != indexTab.end()) {
deps(Json(static_cast<double>(it->second)));
}
else {
deps(Json("unknown"));
}
}
json("dependencies", deps);
json("index", Json(static_cast<double>(nodes.size())));
return json;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief convert to a string, basically for debugging purposes
////////////////////////////////////////////////////////////////////////////////
static void someSpaces (std::string& st, int nr) {
for (int i = 0; i < nr; i++) {
st.push_back(' ');
}
}
void ExecutionPlan::appendAsString (std::string& st, int indent) {
someSpaces(st, indent);
st.push_back('<');
st.append(getTypeString());
if (_dependencies.size() != 0) {
st.push_back('\n');
for (size_t i = 0; i < _dependencies.size(); i++) {
_dependencies[i]->appendAsString(st, indent+2);
if (i != _dependencies.size()-1) {
st.push_back(',');
}
else {
st.push_back(' ');
}
}
}
st.push_back('>');
}
////////////////////////////////////////////////////////////////////////////////
/// @brief functionality to walk an execution plan recursively
////////////////////////////////////////////////////////////////////////////////
void ExecutionPlan::walk (WalkerWorker& worker) {
worker.before(this);
for (auto it = _dependencies.begin();
it != _dependencies.end();
++it) {
(*it)->walk(worker);
}
if (getType() == SUBQUERY) {
auto p = static_cast<SubqueryPlan*>(this);
worker.enterSubquery(this, p->getSubquery());
p->getSubquery()->walk(worker);
worker.leaveSubquery(this, p->getSubquery());
}
worker.after(this);
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of SingletonPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for SingletonPlan
////////////////////////////////////////////////////////////////////////////////
void SingletonPlan::toJsonHelper (
std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of EnumerateCollectionPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for EnumerateCollectionPlan
////////////////////////////////////////////////////////////////////////////////
void EnumerateCollectionPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
// Now put info about vocbase and cid in there
if (_vocbase == nullptr) {
json("vocbase", Json("<nullptr>"));
}
else {
json("vocbase", Json(_vocbase->_name));
}
json("collection", Json(_collname))
("outVarNumber", Json(static_cast<double>(_outVarNumber)))
("outVarName", Json(_outVarName));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of EnumerateListPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for EnumerateListPlan
////////////////////////////////////////////////////////////////////////////////
void EnumerateListPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
json("varNumber", Json(static_cast<double>(_varNumber)))
("varName", Json(_varName))
("outVarNumber", Json(static_cast<double>(_outVarNumber)))
("outVarName", Json(_outVarName));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of LimitPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for LimitPlan
////////////////////////////////////////////////////////////////////////////////
void LimitPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
// Now put info about offset and limit in
json("offset", Json(static_cast<double>(_offset)))
("limit", Json(static_cast<double>(_limit)));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of CalculationPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for CalculationPlan
////////////////////////////////////////////////////////////////////////////////
void CalculationPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
json("varNumber", Json(static_cast<double>(_varNumber)))
("varName", Json(_varName))
("expression", _expression->toJson(TRI_UNKNOWN_MEM_ZONE));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of SubqueryPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for SubqueryPlan
////////////////////////////////////////////////////////////////////////////////
void SubqueryPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
json("varNumber", Json(static_cast<double>(_varNumber)))
("varName", Json(_varName))
("subquery", _subquery->toJson(TRI_UNKNOWN_MEM_ZONE));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of ProjectionPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for ProjectionPlan
////////////////////////////////////////////////////////////////////////////////
void ProjectionPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
Json vec(Json::List,_keepAttributes.size());
for (auto it = _keepAttributes.begin(); it != _keepAttributes.end(); ++it) {
vec(Json(*it));
}
json("inVarNumber", Json(static_cast<double>(_inVar)))
("inVarName", Json(_inVarName))
("outVarNumber", Json(static_cast<double>(_outVar)))
("outVarName", Json(_outVarName))
("keepAttributes", vec);
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of FilterPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for FilterPlan
////////////////////////////////////////////////////////////////////////////////
void FilterPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
// Now put info about offset and limit in
json("varName", Json(_varName))
("varNumber", Json(static_cast<double>(_varNumber)));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of SortPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for SortPlan
////////////////////////////////////////////////////////////////////////////////
void SortPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
Json numbers(Json::List, _varNumbers.size());
for (auto it = _varNumbers.begin(); it != _varNumbers.end(); ++it) {
numbers(Json(static_cast<double>(*it)));
}
Json names(Json::List, _varNames.size());
for (auto it = _varNames.begin(); it != _varNames.end(); ++it) {
names(Json(*it));
}
Json vec(Json::List, _sortAscending.size());
for (auto it = _sortAscending.begin(); it != _sortAscending.end(); ++it) {
vec(Json(*it));
}
json("varNumbers", numbers)
("varNames", names)
("sortAscending", vec);
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of AggregateOnUnSortedPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for AggregateOnUnSortedPlan
////////////////////////////////////////////////////////////////////////////////
void AggregateOnUnsortedPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
Json numbers(Json::List, _varNumbers.size());
for (auto it = _varNumbers.begin(); it != _varNumbers.end(); ++it) {
numbers(Json(static_cast<double>(*it)));
}
Json names(Json::List, _varNames.size());
for (auto it = _varNames.begin(); it != _varNames.end(); ++it) {
names(Json(*it));
}
json("varNumbers", numbers)
("varNames", names)
("outVarNumber", Json(static_cast<double>(_outVarNumber)))
("outVarName", Json(_outVarName));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
// -----------------------------------------------------------------------------
// --SECTION-- methods of RootPlan
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief toJson, for RootPlan
////////////////////////////////////////////////////////////////////////////////
void RootPlan::toJsonHelper (std::map<ExecutionPlan*, int>& indexTab,
triagens::basics::Json& nodes,
TRI_memory_zone_t* zone) {
Json json(ExecutionPlan::toJsonHelperGeneric(indexTab, nodes, zone)); // call base class method
if (json.isEmpty()) {
return;
}
json("varNumber", Json(static_cast<double>(_varNumber)))
("varName" , Json(_varName));
// And add it:
int len = static_cast<int>(nodes.size());
nodes(json);
indexTab.insert(make_pair(this, len));
}
////////////////////////////////////////////////////////////////////////////////
/// @brief test function
////////////////////////////////////////////////////////////////////////////////
using namespace triagens::basics;
using namespace std;
class MyWorker2 : public triagens::aql::ExecutionPlan::WalkerWorker {
public:
int count;
MyWorker2 () : count(0) {};
~MyWorker2 () {};
void before (triagens::aql::ExecutionPlan* ep) {
std::cout << "Before node of type " << ep->getTypeString()
<< std::endl;
count++;
}
void after (triagens::aql::ExecutionPlan* ep) {
std::cout << "After node of type " << ep->getTypeString()
<< std::endl;
}
};
void testExecutionPlans () {
Json a(12);
Json b(Json::Array);
b("a",a);
std::cout << b.toString() << std::endl;
std::cout << a.toString() << std::endl;
std::cout << "Got here" << std::endl;
auto ec = new EnumerateCollectionPlan(nullptr, "guck", 1, "X");
Json jjj(ec->toJson());
cout << jjj.toString() << endl;
auto li = new LimitPlan(12, 17);
li->addDependency(ec);
jjj = li->toJson();
cout << jjj.toString() << endl;
TRI_json_t* json = Json(12);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(true);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(Json::Null);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(Json::String);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(Json::List);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(Json::Array);
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
json = Json(Json::Array, 10)
("myinteger", Json(12))
("mystring", Json("hallo"))
("mybool", Json(false))
("mynull", Json(Json::Null))
("mylist", Json(Json::List, 3)
(Json(1))
(Json(2))
(Json(3)))
("myarray", Json(Json::Array, 2)
("a",Json("hallo"))
("b",Json(13)));
cout << JsonHelper::toString(json) << endl;
TRI_FreeJson(TRI_UNKNOWN_MEM_ZONE, json);
Json j(Json::Array);
j("a", Json(12))
("b", Json(true))
("c", Json(Json::List)
(Json(1))(Json(2))(Json(3)))
("d", Json(Json::Array)
("x", Json(12))
("y", Json(true)));
cout << j.toString() << endl;
// We expect to see exactly two copies here:
Json jjjj = j.copy(); // create an explicit copy
Json jj(12);
cout << "Before assignment" << jj.toString() << endl;
jj = j; // this steals the pointer from j
cout << jjjj.toString();
cout << jj.toString();
Json k = jj.get("c");
Json l = k.at(2);
cout << l.toString() << endl;
cout << "and now a complete test" << endl << endl;
// Here we want to build the unoptimised plan for:
//
// LET A = [1,2,3]
// FOR g IN guck
// FILTER g.name == "Wurst"
// SORT g.vorname
// LIMIT 2, 10
// FOR i IN A
// LET X = { "vorname": g.vorname, "addresse": g.addresse,
// "nr": i*2 }
// RETURN X
//
//
{
AstNode* a;
AstNode* b;
AstNode* c;
ExecutionPlan* e;
ExecutionPlan* n;
// Singleton
e = new SingletonPlan();
// LET A = [1,2,3]
a = new AstNode(NODE_TYPE_LIST);
b = new AstNode(NODE_TYPE_VALUE);
b->setValueType(VALUE_TYPE_INT);
b->setIntValue(1);
a->addMember(b);
b = new AstNode(NODE_TYPE_VALUE);
b->setValueType(VALUE_TYPE_INT);
b->setIntValue(2);
a->addMember(b);
b = new AstNode(NODE_TYPE_VALUE);
b->setValueType(VALUE_TYPE_INT);
b->setIntValue(3);
a->addMember(b);
n = new CalculationPlan(new AqlExpression(a), 1, "A");
n->addDependency(e);
e = n;
// FOR g IN guck
n = new EnumerateCollectionPlan(nullptr, "guck", 2, "g");
n->addDependency(e);
e = n;
// FILTER g.name == "Wurst"
a = new AstNode(NODE_TYPE_OPERATOR_BINARY_EQ);
b = new AstNode(NODE_TYPE_VALUE);
b->setValueType(VALUE_TYPE_STRING);
b->setStringValue("g.name");
a->addMember(b);
b = new AstNode(NODE_TYPE_VALUE);
b->setValueType(VALUE_TYPE_STRING);
b->setStringValue("Wurst");
a->addMember(b);
n = new CalculationPlan(new AqlExpression(a), 2, "_1");
n->addDependency(e);
e = n;
n = new FilterPlan(2, "_1");
n->addDependency(e);
e = n;
// SORT g.vorname
a = new AstNode(NODE_TYPE_VALUE);
a->setValueType(VALUE_TYPE_STRING);
a->setStringValue("g.vorname");
n = new CalculationPlan(new AqlExpression(a), 3, "_2");
n->addDependency(e);
e = n;
std::vector<VariableId> vars;
std::vector<std::string> names;
std::vector<bool> asc;
vars.push_back(3);
names.push_back(string("_2"));
asc.push_back(true);
n = new SortPlan(vars, names, asc);
n->addDependency(e);
e = n;
// LIMIT 2, 10
n = new LimitPlan(2, 10);
n->addDependency(e);
e = n;
// FOR i in A
n = new EnumerateListPlan(1, "A", 2, "i");
n->addDependency(e);
e = n;
// LET X = {"vorname": g.vorname, "addresse": g.addresse, "nr": i*2}
a = new AstNode(NODE_TYPE_ARRAY);
b = new AstNode(NODE_TYPE_ARRAY_ELEMENT);
b->setValueType(VALUE_TYPE_STRING);
b->setStringValue("vorname");
c = new AstNode(NODE_TYPE_VALUE);
c->setValueType(VALUE_TYPE_STRING);
c->setStringValue("g.vorname");
b->addMember(c);
a->addMember(b);
b = new AstNode(NODE_TYPE_ARRAY_ELEMENT);
b->setValueType(VALUE_TYPE_STRING);
b->setStringValue("adresse");
c = new AstNode(NODE_TYPE_VALUE);
c->setValueType(VALUE_TYPE_STRING);
c->setStringValue("g.addresse");
b->addMember(c);
a->addMember(b);
b = new AstNode(NODE_TYPE_ARRAY_ELEMENT);
b->setValueType(VALUE_TYPE_STRING);
b->setStringValue("nr");
c = new AstNode(NODE_TYPE_VALUE);
c->setValueType(VALUE_TYPE_STRING);
c->setStringValue("i*2");
b->addMember(c);
a->addMember(b);
n = new CalculationPlan(new AqlExpression(a), 4, "X");
n->addDependency(e);
e = n;
// RETURN X
n = new RootPlan(4, "X");
n->addDependency(e);
e = n;
cout << e->toJson().toString() << endl;
MyWorker2 w;
e->walk(w);
cout << "Count is: " << w.count << endl;
delete e;
}
}
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: