fixed has many and belongs to eager loading via sql join

This commit is contained in:
Sascha Kühl 2025-02-16 19:57:14 +01:00
parent ec96c15905
commit 66d5bc6c86
8 changed files with 157 additions and 84 deletions

View File

@ -26,43 +26,41 @@ class join_column_collector
{ {
public: public:
template<class Type> template<class Type>
join_columns collect() join_columns collect() {
{
join_columns_ = {}; join_columns_ = {};
Type obj; Type obj;
matador::access::process(*this, obj); access::process(*this, obj);
return join_columns_; return join_columns_;
} }
template < class V > template < class V >
void on_primary_key(const char * /*id*/, V &, typename std::enable_if<std::is_integral<V>::value && !std::is_same<bool, V>::value>::type* = 0) {} void on_primary_key(const char * /*id*/, V &, std::enable_if_t<std::is_integral_v<V> && !std::is_same_v<bool, V>>* = nullptr) {}
void on_primary_key(const char * /*id*/, std::string &, size_t) {} static void on_primary_key(const char * /*id*/, std::string &, size_t) {}
void on_revision(const char * /*id*/, unsigned long long &/*rev*/) {} static void on_revision(const char * /*id*/, unsigned long long &/*rev*/) {}
template<typename Type> template<typename Type>
void on_attribute(const char * /*id*/, Type &, const utils::field_attributes &/*attr*/ = utils::null_attributes) {} static void on_attribute(const char * /*id*/, Type &, const utils::field_attributes &/*attr*/ = utils::null_attributes) {}
template<class Pointer> template<class Pointer>
void on_belongs_to(const char * /*id*/, Pointer &obj, const utils::foreign_attributes &attr) {} static void on_belongs_to(const char * /*id*/, Pointer &obj, const utils::foreign_attributes &attr) {}
template<class Pointer> template<class Pointer>
void on_has_one(const char * /*id*/, Pointer &obj, const utils::foreign_attributes &attr) {} static void on_has_one(const char * /*id*/, Pointer &obj, const utils::foreign_attributes &attr) {}
template<class ContainerType> template<class ContainerType>
void on_has_many(ContainerType &, const char *join_column, const utils::foreign_attributes &attr) {} static void on_has_many(ContainerType &, const char *join_column, const utils::foreign_attributes &attr) {}
template<class ContainerType> template<class ContainerType>
void on_has_many_to_many(const char * /*id*/, ContainerType &/*c*/, const char *join_column, const char *inverse_join_column, const utils::foreign_attributes &/*attr*/) void on_has_many_to_many(const char * /*id*/, ContainerType &/*c*/, const char *join_column, const char *inverse_join_column, const utils::foreign_attributes &/*attr*/) {
{
join_columns_.join_column = join_column; join_columns_.join_column = join_column;
join_columns_.inverse_join_column = inverse_join_column; join_columns_.inverse_join_column = inverse_join_column;
} }
template<class ContainerType> template<class ContainerType>
void on_has_many_to_many(const char * /*id*/, ContainerType &/*c*/, const utils::foreign_attributes &/*attr*/) {} static void on_has_many_to_many(const char * /*id*/, ContainerType &/*c*/, const utils::foreign_attributes &/*attr*/) {}
private: private:
join_columns join_columns_; join_columns join_columns_;
}; };
struct entity_query_data { struct entity_query_data {
std::string root_table_name; std::shared_ptr<sql::table> root_table;
std::string pk_column_{}; std::string pk_column_name{};
std::vector<sql::column> columns{}; std::vector<sql::column> columns{};
std::vector<query::join_data> joins{}; std::vector<query::join_data> joins{};
std::unique_ptr<query::basic_condition> where_clause{}; std::unique_ptr<query::basic_condition> where_clause{};
@ -100,10 +98,10 @@ public:
} }
pk_ = pk; pk_ = pk;
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
processed_tables_.insert(info->get().name()); entity_query_data_ = { std::make_shared<sql::table>(info.value().get().name(), build_alias('t', ++table_index)) };
entity_query_data_ = { info.value().get().name() }; processed_tables_.insert({info->get().name(), entity_query_data_.root_table});
try { try {
access::process(*this, info.value().get().prototype()); access::process(*this, info->get().prototype());
return {utils::ok(std::move(entity_query_data_))}; return {utils::ok(std::move(entity_query_data_))};
} catch (const query_builder_exception &ex) { } catch (const query_builder_exception &ex) {
@ -121,7 +119,8 @@ public:
} }
pk_ = nullptr; pk_ = nullptr;
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
entity_query_data_ = { info->get().name() }; entity_query_data_ = { std::make_shared<sql::table>(info.value().get().name(), build_alias('t', ++table_index)) };
processed_tables_.insert({info->get().name(), entity_query_data_.root_table});
try { try {
access::process(*this, info->get().prototype()); access::process(*this, info->get().prototype());
@ -141,15 +140,14 @@ public:
return; return;
} }
if (pk_.is_null()) { if (pk_.is_null()) {
entity_query_data_.pk_column_ = id; entity_query_data_.pk_column_name = id;
} else if (pk_.is_integer()) { } else if (pk_.is_integer()) {
auto t = std::make_shared<sql::table>(table_info_stack_.top().get().name()); const auto t = std::make_shared<sql::table>(table_info_stack_.top().get().name());
auto v = *pk_.as<V>(); auto v = *pk_.as<V>();
auto c = sql::column{t, id, ""}; auto c = sql::column{t, id, ""};
auto co = std::make_unique<query::condition<sql::column, V>>(c, query::basic_condition::operand_type::EQUAL, v); auto co = std::make_unique<query::condition<sql::column, V>>(c, query::basic_condition::operand_type::EQUAL, v);
entity_query_data_.where_clause = std::move(co); entity_query_data_.where_clause = std::move(co);
// entity_query_data_.where_clause = query::make_condition(c == v); entity_query_data_.pk_column_name = id;
entity_query_data_.pk_column_ = id;
} }
} }
@ -182,13 +180,16 @@ public:
throw query_builder_exception{query_build_error::UnknownType}; throw query_builder_exception{query_build_error::UnknownType};
} }
auto curr = table_info_stack_.top().get().name(); const auto curr = processed_tables_.find(table_info_stack_.top().get().name());
auto next = info.value().get().name(); if (curr == processed_tables_.end()) {
if (processed_tables_.count(next) > 0) { throw query_builder_exception{query_build_error::UnexpectedError};
};
auto next = processed_tables_.find(info->get().name());
if (next != processed_tables_.end()) {
return; return;
} }
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
processed_tables_.insert(next); next = processed_tables_.insert({info->get().name(), std::make_shared<sql::table>(info->get().name(), build_alias('t', ++table_index))}).first;
typename ContainerType::value_type::value_type obj; typename ContainerType::value_type::value_type obj;
access::process(*this , obj); access::process(*this , obj);
table_info_stack_.pop(); table_info_stack_.pop();
@ -199,14 +200,14 @@ public:
} }
append_join( append_join(
sql::column{std::make_shared<sql::table>(table_info_stack_.top().get().name()), table_info_stack_.top().get().definition().primary_key()->name()}, sql::column{curr->second, table_info_stack_.top().get().definition().primary_key()->name()},
sql::column{std::make_shared<sql::table>(info->get().name()), join_column} sql::column{next->second, join_column}
); );
} }
} }
template<class ContainerType> template<class ContainerType>
void on_has_many_to_many(const char *id, ContainerType &c, const char *join_column, const char *inverse_join_column, const utils::foreign_attributes &attr) void on_has_many_to_many(const char *id, ContainerType &/*cont*/, const char *join_column, const char *inverse_join_column, const utils::foreign_attributes &attr)
{ {
if (attr.fetch() != utils::fetch_type::EAGER) { if (attr.fetch() != utils::fetch_type::EAGER) {
return; return;
@ -217,7 +218,7 @@ public:
} }
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
typename ContainerType::value_type::value_type obj; typename ContainerType::value_type::value_type obj;
matador::access::process(*this , obj); access::process(*this , obj);
table_info_stack_.pop(); table_info_stack_.pop();
auto pk = info->get().definition().primary_key(); auto pk = info->get().definition().primary_key();
@ -236,7 +237,7 @@ public:
} }
template<class ContainerType> template<class ContainerType>
void on_has_many_to_many(const char *id, ContainerType &c, const utils::foreign_attributes &attr) void on_has_many_to_many(const char *id, ContainerType &/*cont*/, const utils::foreign_attributes &attr)
{ {
if (attr.fetch() != utils::fetch_type::EAGER) { if (attr.fetch() != utils::fetch_type::EAGER) {
return; return;
@ -247,7 +248,7 @@ public:
} }
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
typename ContainerType::value_type::value_type obj; typename ContainerType::value_type::value_type obj;
matador::access::process(*this , obj); access::process(*this , obj);
table_info_stack_.pop(); table_info_stack_.pop();
auto pk = info->get().definition().primary_key(); auto pk = info->get().definition().primary_key();
@ -271,16 +272,18 @@ private:
template<class Pointer> template<class Pointer>
void on_foreign_object(const char *id, Pointer &, const utils::foreign_attributes &attr); void on_foreign_object(const char *id, Pointer &, const utils::foreign_attributes &attr);
void push(const std::string &column_name); void push(const std::string &column_name);
static std::string build_alias(char prefix, unsigned int count);
[[nodiscard]] bool is_root_entity() const; [[nodiscard]] bool is_root_entity() const;
void append_join(const sql::column &left, const sql::column &right); void append_join(const sql::column &left, const sql::column &right);
private: private:
utils::value pk_; utils::value pk_;
std::stack<std::reference_wrapper<const object::basic_object_info>> table_info_stack_; std::stack<std::reference_wrapper<const object::basic_object_info>> table_info_stack_;
std::unordered_set<std::string> processed_tables_; std::unordered_map<std::string, std::shared_ptr<sql::table>> processed_tables_;
const object::schema &schema_; const object::schema &schema_;
entity_query_data entity_query_data_; entity_query_data entity_query_data_;
int column_index{0}; unsigned int column_index{0};
unsigned int table_index{0};
join_column_collector join_column_collector_; join_column_collector join_column_collector_;
}; };
@ -292,12 +295,16 @@ void session_query_builder::on_foreign_object(const char *id, Pointer &, const u
if (!info) { if (!info) {
throw query_builder_exception{query_build_error::UnknownType}; throw query_builder_exception{query_build_error::UnknownType};
} }
auto curr = table_info_stack_.top().get().name();
auto next = info.value().get().name(); const auto curr = processed_tables_.find(table_info_stack_.top().get().name());
if (processed_tables_.count(next) > 0) { if (curr == processed_tables_.end()) {
throw query_builder_exception{query_build_error::UnexpectedError};
};
auto next = processed_tables_.find(info->get().name());
if (next != processed_tables_.end()) {
return; return;
} }
processed_tables_.insert(next); next = processed_tables_.insert({info->get().name(), std::make_shared<sql::table>(info->get().name(), build_alias('t', ++table_index))}).first;
table_info_stack_.push(info.value()); table_info_stack_.push(info.value());
typename Pointer::value_type obj; typename Pointer::value_type obj;
access::process(*this, obj); access::process(*this, obj);
@ -308,8 +315,8 @@ void session_query_builder::on_foreign_object(const char *id, Pointer &, const u
throw query_builder_exception{query_build_error::MissingPrimaryKey}; throw query_builder_exception{query_build_error::MissingPrimaryKey};
} }
append_join( append_join(
sql::column{std::make_shared<sql::table>(table_info_stack_.top().get().name()), id}, sql::column{curr->second, id},
sql::column{std::make_shared<sql::table>(info->get().name()), pk->name()} sql::column{next->second, pk->name()}
); );
} else { } else {
push(id); push(id);

View File

@ -23,7 +23,7 @@ struct column
column(const char *name, const std::string& as = ""); // NOLINT(*-explicit-constructor) column(const char *name, const std::string& as = ""); // NOLINT(*-explicit-constructor)
explicit column(std::string name, std::string as = ""); // NOLINT(*-explicit-constructor) explicit column(std::string name, std::string as = ""); // NOLINT(*-explicit-constructor)
column(sql_function_t func, std::string name); // NOLINT(*-explicit-constructor) column(sql_function_t func, std::string name); // NOLINT(*-explicit-constructor)
column(const struct table &t, std::string name, std::string as = ""); column(const struct table &tab, std::string name, std::string as = "");
column(const std::shared_ptr<table> &t, std::string name, std::string as = ""); column(const std::shared_ptr<table> &t, std::string name, std::string as = "");
[[nodiscard]] bool equals(const column &x) const; [[nodiscard]] bool equals(const column &x) const;

View File

@ -126,10 +126,10 @@ const class sql::dialect &session::dialect() const
query::fetchable_query session::build_select_query(entity_query_data &&data) { query::fetchable_query session::build_select_query(entity_query_data &&data) {
return query::query::select(data.columns) return query::query::select(data.columns)
.from(data.root_table_name) .from(*data.root_table)
.join_left(data.joins) .join_left(data.joins)
.where(std::move(data.where_clause)) .where(std::move(data.where_clause))
.order_by(sql::column{data.root_table_name, data.pk_column_}) .order_by(sql::column{data.root_table, data.pk_column_name})
.asc(); .asc();
} }

View File

@ -3,39 +3,42 @@
#include <iostream> #include <iostream>
namespace matador::orm { namespace matador::orm {
void session_query_builder::on_primary_key(const char *id, std::string &, size_t) {
void session_query_builder::on_primary_key(const char *id, std::string &, size_t) push(id);
{ if (!is_root_entity()) {
push(id); const auto b = pk_.is_varchar();
if (!is_root_entity()) { std::cout << "is matching primary key: " << std::boolalpha << b << "\n";
const auto b = pk_.is_varchar(); }
std::cout << "is matching primary key: " << std::boolalpha << b << "\n";
}
} }
void session_query_builder::on_revision(const char *id, unsigned long long &/*rev*/) void session_query_builder::on_revision(const char *id, unsigned long long &/*rev*/) {
{ push(id);
push(id);
} }
void session_query_builder::push(const std::string &column_name) void session_query_builder::push(const std::string &column_name) {
{ const auto it = processed_tables_.find(table_info_stack_.top().get().name());
char str[4]; if (it == processed_tables_.end()) {
snprintf(str, 4, "c%02d", ++column_index); throw query_builder_exception{query_build_error::UnexpectedError};
entity_query_data_.columns.emplace_back(table_info_stack_.top().get().name(), column_name, str); }
entity_query_data_.columns.emplace_back(it->second, column_name, build_alias('c', ++column_index));
}
std::string session_query_builder::build_alias(const char prefix, const unsigned int count) {
char str[4];
snprintf(str, 4, "%c%02d", prefix, count);
return str;
} }
[[nodiscard]] bool session_query_builder::is_root_entity() const { [[nodiscard]] bool session_query_builder::is_root_entity() const {
return table_info_stack_.size() == 1; return table_info_stack_.size() == 1;
} }
void session_query_builder::append_join(const sql::column &left, const sql::column &right) void session_query_builder::append_join(const sql::column &left, const sql::column &right) {
{ using namespace matador::query;
using namespace matador::query; entity_query_data_.joins.push_back({
entity_query_data_.joins.push_back({ {right.table_},
{ right.table_ }, make_condition(left == right)
make_condition(left == right) });
}); }
} }
}

View File

@ -77,7 +77,7 @@ void query_compiler::visit(internal::query_select_part &select_part)
void query_compiler::visit(internal::query_from_part &from_part) void query_compiler::visit(internal::query_from_part &from_part)
{ {
query_.table = from_part.table(); query_.table = from_part.table();
query_.sql += " " + query_compiler::build_table_name(from_part.token(), *dialect_, query_.table); query_.sql += " " + build_table_name(from_part.token(), *dialect_, query_.table);
query_.table_aliases.insert({query_.table.name, query_.table.alias}); query_.table_aliases.insert({query_.table.name, query_.table.alias});
} }

View File

@ -24,8 +24,8 @@ column::column(const sql_function_t func, std::string name)
, name(std::move(name)) , name(std::move(name))
, function_(func) {} , function_(func) {}
column::column(const struct sql::table& t, std::string name, std::string as) column::column(const table& tab, std::string name, std::string as)
: table_(std::make_shared<sql::table>(t)) : table_(std::make_shared<table>(tab))
, name(std::move(name)) , name(std::move(name))
, alias(std::move(as)) { , alias(std::move(as)) {
table_->columns.push_back(*this); table_->columns.push_back(*this);

View File

@ -19,8 +19,7 @@ struct book {
unsigned short published_in{}; unsigned short published_in{};
template<typename Operator> template<typename Operator>
void process(Operator &op) void process(Operator &op) {
{
namespace field = matador::access; namespace field = matador::access;
field::primary_key(op, "id", id); field::primary_key(op, "id", id);
field::attribute(op, "title", title, 511); field::attribute(op, "title", title, 511);

View File

@ -1,7 +1,10 @@
#include <iostream>
#include <catch2/catch_test_macros.hpp> #include <catch2/catch_test_macros.hpp>
#include "matador/sql/backend_provider.hpp" #include "matador/sql/backend_provider.hpp"
#include "matador/sql/connection.hpp" #include "matador/sql/connection.hpp"
#include "matador/sql/column.hpp"
#include "matador/sql/table.hpp"
#include "matador/query/query.hpp" #include "matador/query/query.hpp"
@ -20,6 +23,7 @@
using namespace matador::object; using namespace matador::object;
using namespace matador::orm; using namespace matador::orm;
using namespace matador::query;
using namespace matador::sql; using namespace matador::sql;
using namespace matador::test; using namespace matador::test;
@ -36,7 +40,7 @@ TEST_CASE("Create sql query data for entity with eager has one", "[query][entity
auto data = eqb.build<flight>(17U); auto data = eqb.build<flight>(17U);
REQUIRE(data.is_ok()); REQUIRE(data.is_ok());
REQUIRE(data->root_table_name == "flights"); REQUIRE(data->root_table->name == "flights");
REQUIRE(data->joins.size() == 1); REQUIRE(data->joins.size() == 1);
const std::vector<column> expected_columns { const std::vector<column> expected_columns {
{ "flights", "id", "c01" }, { "flights", "id", "c01" },
@ -51,7 +55,7 @@ TEST_CASE("Create sql query data for entity with eager has one", "[query][entity
} }
std::vector<std::pair<std::string, std::string>> expected_join_data { std::vector<std::pair<std::string, std::string>> expected_join_data {
{ "airplanes", R"("flights"."airplane_id" = "airplanes"."id")"} { "airplanes", R"("t01"."airplane_id" = "t02"."id")"}
}; };
query_context qc; query_context qc;
@ -81,7 +85,7 @@ TEST_CASE("Create sql query data for entity with eager belongs to", "[query][ent
auto data = eqb.build<book>(17); auto data = eqb.build<book>(17);
REQUIRE(data.is_ok()); REQUIRE(data.is_ok());
REQUIRE(data->root_table_name == "books"); REQUIRE(data->root_table->name == "books");
REQUIRE(data->joins.size() == 1); REQUIRE(data->joins.size() == 1);
const std::vector<column> expected_columns { const std::vector<column> expected_columns {
{ "books", "id", "c01" }, { "books", "id", "c01" },
@ -100,7 +104,7 @@ TEST_CASE("Create sql query data for entity with eager belongs to", "[query][ent
} }
std::vector<std::pair<std::string, std::string>> expected_join_data { std::vector<std::pair<std::string, std::string>> expected_join_data {
{ "authors", R"("books"."author_id" = "authors"."id")"} { "authors", R"("t01"."author_id" = "t02"."id")"}
}; };
query_context qc; query_context qc;
@ -116,7 +120,7 @@ TEST_CASE("Create sql query data for entity with eager belongs to", "[query][ent
REQUIRE(cond == R"("books"."id" = 17)"); REQUIRE(cond == R"("books"."id" = 17)");
auto q = matador::query::query::select(data->columns) auto q = matador::query::query::select(data->columns)
.from(data->root_table_name); .from(data->root_table->name);
for (auto &jd : data->joins) { for (auto &jd : data->joins) {
q.join_left(*jd.join_table) q.join_left(*jd.join_table)
@ -143,7 +147,7 @@ TEST_CASE("Create sql query data for entity with eager has many belongs to", "[q
auto data = eqb.build<order>(17); auto data = eqb.build<order>(17);
REQUIRE(data.is_ok()); REQUIRE(data.is_ok());
REQUIRE(data->root_table_name == "orders"); REQUIRE(data->root_table->name == "orders");
REQUIRE(data->joins.size() == 1); REQUIRE(data->joins.size() == 1);
const std::vector<column> expected_columns = { const std::vector<column> expected_columns = {
{ "orders", "order_id", "c01" }, { "orders", "order_id", "c01" },
@ -168,7 +172,7 @@ TEST_CASE("Create sql query data for entity with eager has many belongs to", "[q
} }
std::vector<std::pair<std::string, std::string>> expected_join_data { std::vector<std::pair<std::string, std::string>> expected_join_data {
{ "order_details", R"("orders"."order_id" = "order_details"."order_id")"} { "order_details", R"("t01"."order_id" = "t02"."order_id")"}
}; };
query_context qc; query_context qc;
@ -197,7 +201,7 @@ TEST_CASE("Create sql query data for entity with eager many to many", "[query][e
auto data = eqb.build<ingredient>(17); auto data = eqb.build<ingredient>(17);
REQUIRE(data.is_ok()); REQUIRE(data.is_ok());
REQUIRE(data->root_table_name == "ingredients"); REQUIRE(data->root_table->name == "ingredients");
REQUIRE(data->joins.size() == 2); REQUIRE(data->joins.size() == 2);
const std::vector<column> expected_columns { const std::vector<column> expected_columns {
{ "ingredients", "id", "c01" }, { "ingredients", "id", "c01" },
@ -241,7 +245,7 @@ TEST_CASE("Create sql query data for entity with eager many to many (inverse par
auto data = eqb.build<course>(17); auto data = eqb.build<course>(17);
REQUIRE(data.is_ok()); REQUIRE(data.is_ok());
REQUIRE(data->root_table_name == "courses"); REQUIRE(data->root_table->name == "courses");
REQUIRE(data->joins.size() == 2); REQUIRE(data->joins.size() == 2);
const std::vector<column> expected_columns { const std::vector<column> expected_columns {
{ "courses", "id", "c01" }, { "courses", "id", "c01" },
@ -270,4 +274,64 @@ TEST_CASE("Create sql query data for entity with eager many to many (inverse par
REQUIRE(data->where_clause); REQUIRE(data->where_clause);
auto cond = data->where_clause->evaluate(db.dialect(), qc); auto cond = data->where_clause->evaluate(db.dialect(), qc);
REQUIRE(cond == R"("courses"."id" = 17)"); REQUIRE(cond == R"("courses"."id" = 17)");
}
namespace matador::test::orm {
struct employee;
struct department {
unsigned int id{};
std::string name;
std::vector<object_ptr<employee>> employees;
template<typename Operator>
void process(Operator &op) {
namespace field = matador::access;
field::primary_key(op, "id", id);
field::attribute(op, "name", name, 63);
field::has_many(op, "employees", employees, "dep_id", utils::fetch_type::EAGER);
}
};
struct employee {
unsigned int id{};
std::string first_name;
std::string last_name;
object_ptr<department> dep;
template<typename Operator>
void process(Operator &op) {
namespace field = matador::access;
field::primary_key(op, "id", id);
field::attribute(op, "first_name", first_name, 63);
field::attribute(op, "last_name", last_name, 63);
field::belongs_to(op, "dep_id", dep, utils::fetch_type::EAGER);
}
};
}
TEST_CASE("Test eager relationship", "[session][eager]") {
using namespace matador::test;
backend_provider::instance().register_backend("noop", std::make_unique<orm::test_backend_service>());
connection db("noop://noop.db");
schema scm("noop");
auto result = scm.attach<orm::department>("departments")
.and_then( [&scm] { return scm.attach<orm::employee>("employees"); } );
session_query_builder eqb(scm);
auto data = eqb.build<orm::department>();
REQUIRE(data.is_ok());
auto ctx = query::select(data->columns)
.from(*data->root_table)
.join_left(data->joins)
.where(std::move(data->where_clause))
.order_by(column{data->root_table, data->pk_column_name})
.asc()
.str(db);
std::cout << ctx << std::endl;
} }