From 445b20e6652773f62fa09474c855ffe08067fbeb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ante=20Pu=C5=A1i=C4=87?= <ante.pusic@memgraph.io>
Date: Mon, 26 Feb 2024 07:56:29 +0100
Subject: [PATCH] Rename an unclearly-named procedure and improve error message

---
 src/storage/v2/indices/text_index.cpp | 9 ++++++---
 src/storage/v2/indices/text_index.hpp | 3 ++-
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/storage/v2/indices/text_index.cpp b/src/storage/v2/indices/text_index.cpp
index c19805ad7..414f4d310 100644
--- a/src/storage/v2/indices/text_index.cpp
+++ b/src/storage/v2/indices/text_index.cpp
@@ -279,7 +279,8 @@ LabelId TextIndex::DropIndex(const std::string &index_name) {
 
 bool TextIndex::IndexExists(const std::string &index_name) const { return index_.contains(index_name); }
 
-mgcxx::text_search::SearchOutput TextIndex::TQLSearch(const std::string &index_name, const std::string &search_query) {
+mgcxx::text_search::SearchOutput TextIndex::SearchGivenProperties(const std::string &index_name,
+                                                                  const std::string &search_query) {
   auto input = mgcxx::text_search::SearchInput{.search_query = search_query, .return_fields = {"data", "metadata"}};
   mgcxx::text_search::SearchOutput search_results;
   try {
@@ -334,13 +335,15 @@ std::vector<Gid> TextIndex::Search(const std::string &index_name, const std::str
 
   mgcxx::text_search::SearchOutput search_results;
   if (search_mode == "specify_property") {
-    search_results = TQLSearch(index_name, search_query);
+    search_results = SearchGivenProperties(index_name, search_query);
   } else if (search_mode == "regex") {
     search_results = RegexSearch(index_name, search_query);
   } else if (search_mode == "all_properties") {
     search_results = SearchAllProperties(index_name, search_query);
   } else {
-    throw query::TextSearchException("Unsupported search type");  // TODO improve
+    throw query::TextSearchException(
+        "Unsupported search mode: please use one of text_search.search, text_search.search_all, or "
+        "text_search.regex_search.");
   }
 
   std::vector<Gid> found_nodes;
diff --git a/src/storage/v2/indices/text_index.hpp b/src/storage/v2/indices/text_index.hpp
index f0e291ae0..fb0e02860 100644
--- a/src/storage/v2/indices/text_index.hpp
+++ b/src/storage/v2/indices/text_index.hpp
@@ -46,7 +46,8 @@ class TextIndex {
 
   void CommitLoadedNodes(mgcxx::text_search::Context &index_context);
 
-  mgcxx::text_search::SearchOutput TQLSearch(const std::string &index_name, const std::string &search_query);
+  mgcxx::text_search::SearchOutput SearchGivenProperties(const std::string &index_name,
+                                                         const std::string &search_query);
 
   mgcxx::text_search::SearchOutput RegexSearch(const std::string &index_name, const std::string &search_query);