98dc7e2849
Reviewers: teon.banek Reviewed By: teon.banek Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D2633
229 lines
8.1 KiB
C++
229 lines
8.1 KiB
C++
#include <gtest/gtest.h>
|
|
#include <memory>
|
|
|
|
#include "query/db_accessor.hpp"
|
|
#include "query/frontend/ast/ast.hpp"
|
|
#include "query/frontend/semantic/symbol_table.hpp"
|
|
#include "query/plan/cost_estimator.hpp"
|
|
#include "query/plan/operator.hpp"
|
|
#include "storage/v2/storage.hpp"
|
|
|
|
using namespace query;
|
|
using namespace query::plan;
|
|
|
|
using CardParam = CostEstimator<query::DbAccessor>::CardParam;
|
|
using CostParam = CostEstimator<query::DbAccessor>::CostParam;
|
|
using MiscParam = CostEstimator<query::DbAccessor>::MiscParam;
|
|
|
|
/** A fixture for cost estimation. Sets up the database
|
|
* and accessor (adds some vertices). Provides convenience
|
|
* functions for creating the logical plan. Note that the
|
|
* resulting plan is NOT fit for execution, only for cost
|
|
* estimation testing. */
|
|
class QueryCostEstimator : public ::testing::Test {
|
|
protected:
|
|
storage::Storage db;
|
|
std::optional<storage::Storage::Accessor> storage_dba;
|
|
std::optional<query::DbAccessor> dba;
|
|
storage::LabelId label = db.NameToLabel("label");
|
|
storage::PropertyId property = db.NameToProperty("property");
|
|
|
|
// we incrementally build the logical operator plan
|
|
// start it off with Once
|
|
std::shared_ptr<LogicalOperator> last_op_ = std::make_shared<Once>();
|
|
|
|
AstStorage storage_;
|
|
SymbolTable symbol_table_;
|
|
Parameters parameters_;
|
|
int symbol_count = 0;
|
|
|
|
void SetUp() {
|
|
ASSERT_TRUE(db.CreateIndex(label));
|
|
ASSERT_TRUE(db.CreateIndex(label, property));
|
|
storage_dba.emplace(db.Access());
|
|
dba.emplace(&*storage_dba);
|
|
}
|
|
|
|
Symbol NextSymbol() {
|
|
return symbol_table_.CreateSymbol("Symbol" + std::to_string(symbol_count++),
|
|
true);
|
|
}
|
|
|
|
/** Adds the given number of vertices to the DB, of which
|
|
* the given numbers are labeled and have a property set. */
|
|
void AddVertices(int vertex_count, int labeled_count,
|
|
int property_count = 0) {
|
|
for (int i = 0; i < vertex_count; i++) {
|
|
auto vertex = dba->InsertVertex();
|
|
if (i < labeled_count) {
|
|
ASSERT_TRUE(vertex.AddLabel(label).HasValue());
|
|
}
|
|
if (i < property_count) {
|
|
ASSERT_TRUE(
|
|
vertex.SetProperty(property, storage::PropertyValue(i)).HasValue());
|
|
}
|
|
}
|
|
|
|
dba->AdvanceCommand();
|
|
}
|
|
|
|
auto Cost() {
|
|
CostEstimator<query::DbAccessor> cost_estimator(&*dba, parameters_);
|
|
last_op_->Accept(cost_estimator);
|
|
return cost_estimator.cost();
|
|
}
|
|
|
|
template <typename TLogicalOperator, typename... TArgs>
|
|
void MakeOp(TArgs... args) {
|
|
last_op_ = std::make_shared<TLogicalOperator>(args...);
|
|
}
|
|
|
|
template <typename TValue>
|
|
Expression *Literal(TValue value) {
|
|
return storage_.Create<PrimitiveLiteral>(value);
|
|
}
|
|
|
|
template <typename TValue>
|
|
Expression *Parameter(TValue value) {
|
|
int token_position = parameters_.size();
|
|
parameters_.Add(token_position, storage::PropertyValue(value));
|
|
return storage_.Create<ParameterLookup>(token_position);
|
|
}
|
|
|
|
auto InclusiveBound(Expression *expression) {
|
|
return std::make_optional(utils::MakeBoundInclusive(expression));
|
|
};
|
|
|
|
const std::nullopt_t nullopt = std::nullopt;
|
|
};
|
|
|
|
// multiply with 1 to avoid linker error (possibly fixed in CLang >= 3.81)
|
|
#define EXPECT_COST(COST) EXPECT_FLOAT_EQ(Cost(), 1 * COST)
|
|
|
|
TEST_F(QueryCostEstimator, Once) { EXPECT_COST(0); }
|
|
|
|
TEST_F(QueryCostEstimator, ScanAll) {
|
|
AddVertices(100, 30, 20);
|
|
MakeOp<ScanAll>(last_op_, NextSymbol());
|
|
EXPECT_COST(100 * CostParam::kScanAll);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelCardinality) {
|
|
AddVertices(100, 30, 20);
|
|
MakeOp<ScanAllByLabel>(last_op_, NextSymbol(), label);
|
|
EXPECT_COST(30 * CostParam::kScanAllByLabel);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelPropertyValueConstant) {
|
|
AddVertices(100, 30, 20);
|
|
for (auto const_val : {Literal(12), Parameter(12)}) {
|
|
MakeOp<ScanAllByLabelPropertyValue>(nullptr, NextSymbol(), label, property,
|
|
"property", const_val);
|
|
EXPECT_COST(1 * CostParam::MakeScanAllByLabelPropertyValue);
|
|
}
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelPropertyValueConstExpr) {
|
|
AddVertices(100, 30, 20);
|
|
for (auto const_val : {Literal(12), Parameter(12)}) {
|
|
MakeOp<ScanAllByLabelPropertyValue>(
|
|
nullptr, NextSymbol(), label, property, "property",
|
|
// once we make expression const-folding this test case will fail
|
|
storage_.Create<UnaryPlusOperator>(const_val));
|
|
EXPECT_COST(20 * CardParam::kFilter *
|
|
CostParam::MakeScanAllByLabelPropertyValue);
|
|
}
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelPropertyRangeUpperConstant) {
|
|
AddVertices(100, 30, 20);
|
|
for (auto const_val : {Literal(12), Parameter(12)}) {
|
|
MakeOp<ScanAllByLabelPropertyRange>(nullptr, NextSymbol(), label, property,
|
|
"property", nullopt,
|
|
InclusiveBound(const_val));
|
|
// cardinality estimation is exact for very small indexes
|
|
EXPECT_COST(13 * CostParam::MakeScanAllByLabelPropertyRange);
|
|
}
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelPropertyRangeLowerConstant) {
|
|
AddVertices(100, 30, 20);
|
|
for (auto const_val : {Literal(17), Parameter(17)}) {
|
|
MakeOp<ScanAllByLabelPropertyRange>(nullptr, NextSymbol(), label, property,
|
|
"property", InclusiveBound(const_val),
|
|
nullopt);
|
|
// cardinality estimation is exact for very small indexes
|
|
EXPECT_COST(3 * CostParam::MakeScanAllByLabelPropertyRange);
|
|
}
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ScanAllByLabelPropertyRangeConstExpr) {
|
|
AddVertices(100, 30, 20);
|
|
for (auto const_val : {Literal(12), Parameter(12)}) {
|
|
auto bound =
|
|
std::make_optional(utils::MakeBoundInclusive(static_cast<Expression *>(
|
|
storage_.Create<UnaryPlusOperator>(const_val))));
|
|
MakeOp<ScanAllByLabelPropertyRange>(nullptr, NextSymbol(), label, property,
|
|
"property", bound, nullopt);
|
|
EXPECT_COST(20 * CardParam::kFilter *
|
|
CostParam::MakeScanAllByLabelPropertyRange);
|
|
}
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, Expand) {
|
|
MakeOp<Expand>(last_op_, NextSymbol(), NextSymbol(), NextSymbol(),
|
|
EdgeAtom::Direction::IN, std::vector<storage::EdgeTypeId>{},
|
|
false, storage::View::OLD);
|
|
EXPECT_COST(CardParam::kExpand * CostParam::kExpand);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, ExpandVariable) {
|
|
MakeOp<ExpandVariable>(last_op_, NextSymbol(), NextSymbol(), NextSymbol(),
|
|
EdgeAtom::Type::DEPTH_FIRST, EdgeAtom::Direction::IN,
|
|
std::vector<storage::EdgeTypeId>{}, false, nullptr,
|
|
nullptr, false,
|
|
ExpansionLambda{NextSymbol(), NextSymbol(), nullptr},
|
|
std::nullopt, std::nullopt);
|
|
EXPECT_COST(CardParam::kExpandVariable * CostParam::kExpandVariable);
|
|
}
|
|
|
|
// Helper for testing an operations cost and cardinality.
|
|
// Only for operations that first increment cost, then modify cardinality.
|
|
// Intentially a macro (instead of function) for better test feedback.
|
|
#define TEST_OP(OP, OP_COST_PARAM, OP_CARD_PARAM) \
|
|
OP; \
|
|
EXPECT_COST(OP_COST_PARAM); \
|
|
OP; \
|
|
EXPECT_COST(OP_COST_PARAM + OP_CARD_PARAM * OP_COST_PARAM);
|
|
|
|
TEST_F(QueryCostEstimator, Filter) {
|
|
TEST_OP(MakeOp<Filter>(last_op_, Literal(true)), CostParam::kFilter,
|
|
CardParam::kFilter);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, EdgeUniquenessFilter) {
|
|
TEST_OP(MakeOp<EdgeUniquenessFilter>(last_op_, NextSymbol(),
|
|
std::vector<Symbol>()),
|
|
CostParam::kEdgeUniquenessFilter, CardParam::kEdgeUniquenessFilter);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, UnwindLiteral) {
|
|
TEST_OP(
|
|
MakeOp<query::plan::Unwind>(
|
|
last_op_,
|
|
storage_.Create<ListLiteral>(std::vector<Expression *>(7, nullptr)),
|
|
NextSymbol()),
|
|
CostParam::kUnwind, 7);
|
|
}
|
|
|
|
TEST_F(QueryCostEstimator, UnwindNoLiteral) {
|
|
TEST_OP(MakeOp<query::plan::Unwind>(last_op_, nullptr, NextSymbol()),
|
|
CostParam::kUnwind, MiscParam::kUnwindNoLiteral);
|
|
}
|
|
|
|
#undef TEST_OP
|
|
#undef EXPECT_COST
|
|
//
|
|
// TODO test cost when ScanAll, Expand, Accumulate, Limit
|
|
// vs cost for SA, Expand, Limit
|