Implement edge type indices (#1542)

 Implement edge type indices (#1542 )

Author: gvolfing

src/communication/result_stream_faker.hpp

@@ -1,4 +1,4 @@
-// Copyright 2023 Memgraph Ltd.
+// Copyright 2024 Memgraph Ltd.
 //
 // Use of this software is governed by the Business Source License
 // included in the file licenses/BSL.txt; by using this file, you agree to be bound by the terms of the Business Source

src/dbms/database_handler.hpp

@@ -1,4 +1,4 @@
-// Copyright 2023 Memgraph Ltd.
+// Copyright 2024 Memgraph Ltd.
 //
 // Use of this software is governed by the Business Source License
 // included in the file licenses/BSL.txt; by using this file, you agree to be bound by the terms of the Business Source

src/dbms/inmemory/replication_handlers.cpp

@@ -840,6 +840,20 @@ uint64_t InMemoryReplicationHandlers::ReadAndApplyDelta(storage::InMemoryStorage
  transaction->DeleteLabelPropertyIndexStats(storage->NameToLabel(info.label));
  break;
  }
+ case WalDeltaData::Type::EDGE_INDEX_CREATE: {
+ spdlog::trace(" Create edge index on :{}", delta.operation_edge_type.edge_type);
+ auto *transaction = get_transaction(timestamp, kUniqueAccess);
+ if (transaction->CreateIndex(storage->NameToEdgeType(delta.operation_label.label)).HasError())
+ throw utils::BasicException("Invalid transaction! Please raise an issue, {}:{}", __FILE__, __LINE__);
+ break;
+ }
+ case WalDeltaData::Type::EDGE_INDEX_DROP: {
+ spdlog::trace(" Drop edge index on :{}", delta.operation_edge_type.edge_type);
+ auto *transaction = get_transaction(timestamp, kUniqueAccess);
+ if (transaction->DropIndex(storage->NameToEdgeType(delta.operation_label.label)).HasError())
+ throw utils::BasicException("Invalid transaction! Please raise an issue, {}:{}", __FILE__, __LINE__);
+ break;
+ }
  case WalDeltaData::Type::EXISTENCE_CONSTRAINT_CREATE: {
  spdlog::trace(" Create existence constraint on :{} ({})", delta.operation_label_property.label,
  delta.operation_label_property.property);

src/glue/communication.hpp

@@ -1,4 +1,4 @@
-// Copyright 2023 Memgraph Ltd.
+// Copyright 2024 Memgraph Ltd.
 //
 // Use of this software is governed by the Business Source License
 // included in the file licenses/BSL.txt; by using this file, you agree to be bound by the terms of the Business Source

src/query/db_accessor.hpp

@@ -371,6 +371,62 @@ class VerticesIterable final {
  }
 };
 
+class EdgesIterable final {
+ std::variant<storage::EdgesIterable, std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>> *>
+ iterable_;
+
+ public:
+ class Iterator final {
+ std::variant<storage::EdgesIterable::Iterator,
+ std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>>::iterator>
+ it_;
+
+ public:
+ explicit Iterator(storage::EdgesIterable::Iterator it) : it_(std::move(it)) {}
+ explicit Iterator(std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>>::iterator it)
+ : it_(it) {}
+
+ EdgeAccessor operator*() const {
+ return std::visit([](auto &it_) { return EdgeAccessor(*it_); }, it_);
+ }
+
+ Iterator &operator++() {
+ std::visit([](auto &it_) { ++it_; }, it_);
+ return *this;
+ }
+
+ bool operator==(const Iterator &other) const { return it_ == other.it_; }
+
+ bool operator!=(const Iterator &other) const { return !(other == *this); }
+ };
+
+ explicit EdgesIterable(storage::EdgesIterable iterable) : iterable_(std::move(iterable)) {}
+ explicit EdgesIterable(std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>> *edges)
+ : iterable_(edges) {}
+
+ Iterator begin() {
+ return std::visit(
+ memgraph::utils::Overloaded{
+ [](storage::EdgesIterable &iterable_) { return Iterator(iterable_.begin()); },
+ [](std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>> *iterable_) { return Iterator(iterable_->begin()); }},
+ iterable_);
+ }
+
+ Iterator end() {
+ return std::visit(
+ memgraph::utils::Overloaded{
+ [](storage::EdgesIterable &iterable_) { return Iterator(iterable_.end()); },
+ [](std::unordered_set<EdgeAccessor, std::hash<EdgeAccessor>, std::equal_to<void>,
+ utils::Allocator<EdgeAccessor>> *iterable_) { return Iterator(iterable_->end()); }},
+ iterable_);
+ }
+};
+
 class DbAccessor final {
  storage::Storage::Accessor *accessor_;
 
@@ -416,6 +472,10 @@ class DbAccessor final {
  return VerticesIterable(accessor_->Vertices(label, property, lower, upper, view));
  }
 
+ EdgesIterable Edges(storage::View view, storage::EdgeTypeId edge_type) {
+ return EdgesIterable(accessor_->Edges(edge_type, view));
+ }
+
  VertexAccessor InsertVertex() { return VertexAccessor(accessor_->CreateVertex()); }
 
  storage::Result<EdgeAccessor> InsertEdge(VertexAccessor *from, VertexAccessor *to,
@@ -572,6 +632,8 @@ class DbAccessor final {
  return accessor_->LabelPropertyIndexExists(label, prop);
  }
 
+ bool EdgeTypeIndexExists(storage::EdgeTypeId edge_type) const { return accessor_->EdgeTypeIndexExists(edge_type); }
+
  std::optional<storage::LabelIndexStats> GetIndexStats(const storage::LabelId &label) const {
  return accessor_->GetIndexStats(label);
  }
@@ -638,6 +700,10 @@ class DbAccessor final {
  return accessor_->CreateIndex(label, property);
  }
 
+ utils::BasicResult<storage::StorageIndexDefinitionError, void> CreateIndex(storage::EdgeTypeId edge_type) {
+ return accessor_->CreateIndex(edge_type);
+ }
+
  utils::BasicResult<storage::StorageIndexDefinitionError, void> DropIndex(storage::LabelId label) {
  return accessor_->DropIndex(label);
  }
@@ -647,6 +713,10 @@ class DbAccessor final {
  return accessor_->DropIndex(label, property);
  }
 
+ utils::BasicResult<storage::StorageIndexDefinitionError, void> DropIndex(storage::EdgeTypeId edge_type) {
+ return accessor_->DropIndex(edge_type);
+ }
+
  utils::BasicResult<storage::StorageExistenceConstraintDefinitionError, void> CreateExistenceConstraint(
  storage::LabelId label, storage::PropertyId property) {
  return accessor_->CreateExistenceConstraint(label, property);

src/query/dump.cpp

@@ -242,6 +242,10 @@ void DumpLabelIndex(std::ostream *os, query::DbAccessor *dba, const storage::Lab
  *os << "CREATE INDEX ON :" << EscapeName(dba->LabelToName(label)) << ";";
 }
 
+void DumpEdgeTypeIndex(std::ostream *os, query::DbAccessor *dba, const storage::EdgeTypeId edge_type) {
+ *os << "CREATE EDGE INDEX ON :" << EscapeName(dba->EdgeTypeToName(edge_type)) << ";";
+}
+
 void DumpLabelPropertyIndex(std::ostream *os, query::DbAccessor *dba, storage::LabelId label,
  storage::PropertyId property) {
  *os << "CREATE INDEX ON :" << EscapeName(dba->LabelToName(label)) << "(" << EscapeName(dba->PropertyToName(property))
@@ -297,7 +301,9 @@ PullPlanDump::PullPlanDump(DbAccessor *dba, dbms::DatabaseAccess db_acc)
  // Internal index cleanup
  CreateInternalIndexCleanupPullChunk(),
  // Dump all triggers
- CreateTriggersPullChunk()} {}
+ CreateTriggersPullChunk(),
+ // Dump all edge-type indices
+ CreateEdgeTypeIndicesPullChunk()} {}
 
 bool PullPlanDump::Pull(AnyStream *stream, std::optional<int> n) {
  // Iterate all functions that stream some results.
@@ -352,6 +358,33 @@ PullPlanDump::PullChunk PullPlanDump::CreateLabelIndicesPullChunk() {
  };
 }
 
+PullPlanDump::PullChunk PullPlanDump::CreateEdgeTypeIndicesPullChunk() {
+ // Dump all label indices
+ return [this, global_index = 0U](AnyStream *stream, std::optional<int> n) mutable -> std::optional<size_t> {
+ // Delay the construction of indices vectors
+ if (!indices_info_) {
+ indices_info_.emplace(dba_->ListAllIndices());
+ }
+ const auto &edge_type = indices_info_->edge_type;
+
+ size_t local_counter = 0;
+ while (global_index < edge_type.size() && (!n || local_counter < *n)) {
+ std::ostringstream os;
+ DumpEdgeTypeIndex(&os, dba_, edge_type[global_index]);
+ stream->Result({TypedValue(os.str())});
+
+ ++global_index;
+ ++local_counter;
+ }
+
+ if (global_index == edge_type.size()) {
+ return local_counter;
+ }
+
+ return std::nullopt;
+ };
+}
+
 PullPlanDump::PullChunk PullPlanDump::CreateLabelPropertyIndicesPullChunk() {
  return [this, global_index = 0U](AnyStream *stream, std::optional<int> n) mutable -> std::optional<size_t> {
  // Delay the construction of indices vectors

src/query/dump.hpp

@@ -63,5 +63,6 @@ struct PullPlanDump {
  PullChunk CreateDropInternalIndexPullChunk();
  PullChunk CreateInternalIndexCleanupPullChunk();
  PullChunk CreateTriggersPullChunk();
+ PullChunk CreateEdgeTypeIndicesPullChunk();
 };
 } // namespace memgraph::query

src/query/frontend/ast/ast.cpp

@@ -186,6 +186,9 @@ constexpr utils::TypeInfo query::ProfileQuery::kType{utils::TypeId::AST_PROFILE_
 
 constexpr utils::TypeInfo query::IndexQuery::kType{utils::TypeId::AST_INDEX_QUERY, "IndexQuery", &query::Query::kType};
 
+constexpr utils::TypeInfo query::EdgeIndexQuery::kType{utils::TypeId::AST_EDGE_INDEX_QUERY, "EdgeIndexQuery",
+ &query::Query::kType};
+
 constexpr utils::TypeInfo query::Create::kType{utils::TypeId::AST_CREATE, "Create", &query::Clause::kType};
 
 constexpr utils::TypeInfo query::CallProcedure::kType{utils::TypeId::AST_CALL_PROCEDURE, "CallProcedure",

src/query/frontend/ast/ast.hpp

@@ -2224,6 +2224,34 @@ class IndexQuery : public memgraph::query::Query {
  friend class AstStorage;
 };
 
+class EdgeIndexQuery : public memgraph::query::Query {
+ public:
+ static const utils::TypeInfo kType;
+ const utils::TypeInfo &GetTypeInfo() const override { return kType; }
+
+ enum class Action { CREATE, DROP };
+
+ EdgeIndexQuery() = default;
+
+ DEFVISITABLE(QueryVisitor<void>);
+
+ memgraph::query::EdgeIndexQuery::Action action_;
+ memgraph::query::EdgeTypeIx edge_type_;
+
+ EdgeIndexQuery *Clone(AstStorage *storage) const override {
+ EdgeIndexQuery *object = storage->Create<EdgeIndexQuery>();
+ object->action_ = action_;
+ object->edge_type_ = storage->GetEdgeTypeIx(edge_type_.name);
+ return object;
+ }
+
+ protected:
+ EdgeIndexQuery(Action action, EdgeTypeIx edge_type) : action_(action), edge_type_(edge_type) {}
+
+ private:
+ friend class AstStorage;
+};
+
 class Create : public memgraph::query::Clause {
  public:
  static const utils::TypeInfo kType;

src/query/frontend/ast/ast_visitor.hpp

@@ -82,6 +82,7 @@ class AuthQuery;
 class ExplainQuery;
 class ProfileQuery;
 class IndexQuery;
+class EdgeIndexQuery;
 class DatabaseInfoQuery;
 class SystemInfoQuery;
 class ConstraintQuery;
@@ -143,11 +144,11 @@ class ExpressionVisitor
 
 template <class TResult>
 class QueryVisitor
- : public utils::Visitor<TResult, CypherQuery, ExplainQuery, ProfileQuery, IndexQuery, AuthQuery, DatabaseInfoQuery,
- SystemInfoQuery, ConstraintQuery, DumpQuery, ReplicationQuery, LockPathQuery,
- FreeMemoryQuery, TriggerQuery, IsolationLevelQuery, CreateSnapshotQuery, StreamQuery,
- SettingQuery, VersionQuery, ShowConfigQuery, TransactionQueueQuery, StorageModeQuery,
- AnalyzeGraphQuery, MultiDatabaseQuery, ShowDatabasesQuery, EdgeImportModeQuery,
- CoordinatorQuery> {};
+ : public utils::Visitor<TResult, CypherQuery, ExplainQuery, ProfileQuery, IndexQuery, EdgeIndexQuery, AuthQuery,
+ DatabaseInfoQuery, SystemInfoQuery, ConstraintQuery, DumpQuery, ReplicationQuery,
+ LockPathQuery, FreeMemoryQuery, TriggerQuery, IsolationLevelQuery, CreateSnapshotQuery,
+ StreamQuery, SettingQuery, VersionQuery, ShowConfigQuery, TransactionQueueQuery,
+ StorageModeQuery, AnalyzeGraphQuery, MultiDatabaseQuery, ShowDatabasesQuery,
+ EdgeImportModeQuery, CoordinatorQuery> {};
 
 } // namespace memgraph::query