Skip to content

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Remove reference helper fields from response.

Harpreet Sangarb469962b422b
diff --git a/include/collection.h b/include/collection.h
index 59c8f9be..2ad4742c 100644
--- a/include/collection.h
+++ b/include/collection.h
@@ -401,6 +401,8 @@ public:
static void remove_flat_fields(nlohmann::json& document);
+ static void remove_reference_helper_fields(nlohmann::json& document);
+
static Option<bool> add_reference_fields(nlohmann::json& doc,
const std::string& ref_collection_name,
Collection *const ref_collection,
diff --git a/include/field.h b/include/field.h
index 274f59cd..4b02f474 100644
--- a/include/field.h
+++ b/include/field.h
@@ -68,6 +68,7 @@ namespace fields {
static const std::string api_key = "api_key";
static const std::string model_config = "model_config";
+ static const std::string reference_helper_fields = ".reference_helper_fields";
static const std::string REFERENCE_HELPER_FIELD_SUFFIX = "_sequence_id";
}
diff --git a/src/collection.cpp b/src/collection.cpp
index 02220990..422b4214 100644
--- a/src/collection.cpp
+++ b/src/collection.cpp
@@ -81,6 +81,10 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
continue;
}
+ if (document.count(fields::reference_helper_fields) == 0) {
+ document[fields::reference_helper_fields] = nlohmann::json::array();
+ }
+
auto reference_pair = pair.second;
auto reference_collection_name = reference_pair.collection;
auto reference_field_name = reference_pair.field;
@@ -91,10 +95,13 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
+ "` not found.");
}
+ auto const reference_helper_field = field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX;
+ document[fields::reference_helper_fields] += reference_helper_field;
+
if (reference_field_name == "id") {
auto id_field_type_error_op = Option<bool>(400, "Field `" + field_name + "` must have string value.");
if (document[field_name].is_array()) {
- document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] = nlohmann::json::array();
+ document[reference_helper_field] = nlohmann::json::array();
for (const auto &item: document[field_name].items()) {
if (!item.value().is_string()) {
return id_field_type_error_op;
@@ -108,7 +115,7 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
reference_collection_name + "`." );
}
- document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] += ref_doc_id_op.get();
+ document[reference_helper_field] += ref_doc_id_op.get();
}
} else if (document[field_name].is_string()) {
auto id = document[field_name].get<std::string>();
@@ -119,7 +126,7 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
reference_collection_name + "`." );
}
- document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] = ref_doc_id_op.get();
+ document[reference_helper_field] = ref_doc_id_op.get();
} else {
return id_field_type_error_op;
}
@@ -191,7 +198,7 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
if (document[field_name].is_array()) {
document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] = nlohmann::json::array();
for (uint32_t i = 0; i < filter_result.count; i++) {
- document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] += filter_result.docs[i];
+ document[reference_helper_field] += filter_result.docs[i];
}
} else {
if (filter_result.count != 1) {
@@ -203,7 +210,7 @@ Option<bool> Collection::add_reference_helper_fields(nlohmann::json& document) {
reference_collection_name + "`.");
}
- document[field_name + fields::REFERENCE_HELPER_FIELD_SUFFIX] = filter_result.docs[0];
+ document[reference_helper_field] = filter_result.docs[0];
}
}
@@ -491,6 +498,7 @@ nlohmann::json Collection::add_many(std::vector<std::string>& json_lines, nlohma
const auto& rec = index_records[0];
document = rec.is_update ? rec.new_doc : rec.doc;
remove_flat_fields(document);
+ remove_reference_helper_fields(document);
}
index_records.clear();
batch_doc_ids.clear();
@@ -2136,6 +2144,7 @@ Option<nlohmann::json> Collection::search(std::string raw_query,
if(!highlight_items.empty()) {
copy_highlight_doc(highlight_items, enable_nested_fields, document, highlight_res);
remove_flat_fields(highlight_res);
+ remove_reference_helper_fields(highlight_res);
highlight_res.erase("id");
}
@@ -2260,6 +2269,7 @@ Option<nlohmann::json> Collection::search(std::string raw_query,
}
remove_flat_fields(document);
+ remove_reference_helper_fields(document);
auto doc_id_op = doc_id_to_seq_id(document["id"].get<std::string>());
if (!doc_id_op.ok()) {
return Option<nlohmann::json>(doc_id_op.code(), doc_id_op.error());
@@ -4452,6 +4462,15 @@ void Collection::remove_flat_fields(nlohmann::json& document) {
}
}
+void Collection::remove_reference_helper_fields(nlohmann::json& document) {
+ if(document.count(fields::reference_helper_fields) != 0) {
+ for(const auto& key: document[fields::reference_helper_fields].get<std::vector<std::string>>()) {
+ document.erase(key);
+ }
+ document.erase(fields::reference_helper_fields);
+ }
+}
+
Option<bool> Collection::add_reference_fields(nlohmann::json& doc,
const std::string& ref_collection_name,
Collection *const ref_collection,
@@ -4472,6 +4491,7 @@ Option<bool> Collection::add_reference_fields(nlohmann::json& doc,
}
remove_flat_fields(ref_doc);
+ remove_reference_helper_fields(ref_doc);
auto prune_op = prune_doc(ref_doc, ref_include_fields_full, ref_exclude_fields_full);
if (!prune_op.ok()) {
@@ -4509,6 +4529,7 @@ Option<bool> Collection::add_reference_fields(nlohmann::json& doc,
}
remove_flat_fields(ref_doc);
+ remove_reference_helper_fields(ref_doc);
auto prune_op = prune_doc(ref_doc, ref_include_fields_full, ref_exclude_fields_full);
if (!prune_op.ok()) {
diff --git a/src/core_api_utils.cpp b/src/core_api_utils.cpp
index fda1777b..b043ffc2 100644
--- a/src/core_api_utils.cpp
+++ b/src/core_api_utils.cpp
@@ -67,6 +67,7 @@ Option<bool> stateful_export_docs(export_state_t* export_state, size_t batch_siz
export_state->res_body->append(doc.dump());
} else {
Collection::remove_flat_fields(doc);
+ Collection::remove_reference_helper_fields(doc);
Collection::prune_doc(doc, export_state->include_fields, export_state->exclude_fields);
export_state->res_body->append(doc.dump());
}
diff --git a/test/collection_join_test.cpp b/test/collection_join_test.cpp
index daee7be7..07f4f514 100644
--- a/test/collection_join_test.cpp
+++ b/test/collection_join_test.cpp
@@ -282,17 +282,22 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
customer_collection = collection_create_op.get();
add_doc_op = customer_collection->add(customer_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- ASSERT_EQ(0, customer_collection->get("0").get().at("reference_id_sequence_id"));
- nlohmann::json document;
+ auto customer_doc = customer_collection->get("0").get();
+ ASSERT_EQ(0, customer_doc.at("reference_id_sequence_id"));
+ ASSERT_EQ(1, customer_doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, customer_doc[".reference_helper_fields"].size());
+ ASSERT_EQ("reference_id_sequence_id", customer_doc[".reference_helper_fields"].at(0));
+
+ nlohmann::json product_doc;
// Referenced document's sequence_id must be valid.
auto get_op = collectionManager.get_collection("Products")->get_document_from_store(
- customer_collection->get("0").get()["reference_id_sequence_id"].get<uint32_t>(),
- document);
+ customer_doc["reference_id_sequence_id"].get<uint32_t>(),
+ product_doc);
ASSERT_TRUE(get_op.ok());
- ASSERT_EQ(document.count("product_id"), 1);
- ASSERT_EQ(document["product_id"], "product_a");
- ASSERT_EQ(document["product_name"], "shampoo");
+ ASSERT_EQ(product_doc.count("product_id"), 1);
+ ASSERT_EQ(product_doc["product_id"], "product_a");
+ ASSERT_EQ(product_doc["product_name"], "shampoo");
auto id_ref_schema_json =
R"({
@@ -320,12 +325,6 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Referenced document having `id: foo` not found in the collection `Products`.", add_doc_op.error());
- id_ref_json = R"({
- "id_reference": "0"
- })"_json;
- add_doc_op = id_ref_collection->add(id_ref_json.dump());
- ASSERT_TRUE(add_doc_op.ok());
-
id_ref_json = R"({
"multi_id_reference": ["0", 1]
})"_json;
@@ -340,24 +339,61 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Referenced document having `id: foo` not found in the collection `Products`.", add_doc_op.error());
+ collectionManager.drop_collection("id_ref");
+ id_ref_schema_json =
+ R"({
+ "name": "id_ref",
+ "fields": [
+ {"name": "id_reference", "type": "string", "reference": "Products.id", "optional": true},
+ {"name": "multi_id_reference", "type": "string[]", "reference": "Products.id", "optional": true}
+ ]
+ })"_json;
+ collection_create_op = collectionManager.create_collection(id_ref_schema_json);
+ ASSERT_TRUE(collection_create_op.ok());
+ id_ref_collection = collection_create_op.get();
+
+ id_ref_json = R"({
+ "id_reference": "0"
+ })"_json;
+ add_doc_op = id_ref_collection->add(id_ref_json.dump());
+ ASSERT_TRUE(add_doc_op.ok());
+
+ auto doc = id_ref_collection->get("0").get();
+ ASSERT_EQ(0, doc["id_reference_sequence_id"]);
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("id_reference_sequence_id", doc[".reference_helper_fields"].at(0));
+
id_ref_json = R"({
"multi_id_reference": ["1"]
})"_json;
add_doc_op = id_ref_collection->add(id_ref_json.dump());
ASSERT_TRUE(add_doc_op.ok());
+ doc = id_ref_collection->get("1").get();
+ ASSERT_EQ(1, doc["multi_id_reference_sequence_id"].size());
+ ASSERT_EQ(1, doc["multi_id_reference_sequence_id"][0]);
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("multi_id_reference_sequence_id", doc[".reference_helper_fields"][0]);
+
id_ref_json = R"({
"multi_id_reference": ["0", "1"]
})"_json;
add_doc_op = id_ref_collection->add(id_ref_json.dump());
ASSERT_TRUE(add_doc_op.ok());
+ doc = id_ref_collection->get("2").get();
+ ASSERT_EQ(2, doc["multi_id_reference_sequence_id"].size());
+ ASSERT_EQ(0, doc["multi_id_reference_sequence_id"][0]);
+ ASSERT_EQ(1, doc["multi_id_reference_sequence_id"][1]);
+
auto result = id_ref_collection->search("*", {}, "", {}, {}, {0}).get();
ASSERT_EQ(3, result["found"].get<size_t>());
ASSERT_EQ(3, result["hits"].size());
- ASSERT_EQ(2, result["hits"][0]["document"]["multi_id_reference_sequence_id"].size());
- ASSERT_EQ(1, result["hits"][1]["document"]["multi_id_reference_sequence_id"].size());
- ASSERT_EQ(0, result["hits"][2]["document"]["id_reference_sequence_id"]);
+ ASSERT_EQ(0, result["hits"][0]["document"].count("multi_id_reference_sequence_id"));
+ ASSERT_EQ(0, result["hits"][1]["document"].count("multi_id_reference_sequence_id"));
+ ASSERT_EQ(0, result["hits"][2]["document"].count("id_reference_sequence_id"));
collectionManager.drop_collection("Customers");
collectionManager.drop_collection("Products");
@@ -409,7 +445,8 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
{"name": "ref_object_array_field", "type": "object[]", "optional": true, "reference": "coll1.object_array_field"}
]
})"_json;
- collection_create_op = collectionManager.create_collection(schema_json);
+ auto temp_json = schema_json;
+ collection_create_op = collectionManager.create_collection(temp_json);
ASSERT_TRUE(collection_create_op.ok());
auto coll2 = collection_create_op.get();
@@ -441,6 +478,25 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Field `ref_string_array_field` must only have `string` values.", add_doc_op.error());
+ collectionManager.drop_collection("coll2");
+ temp_json = schema_json;
+ collection_create_op = collectionManager.create_collection(temp_json);
+ ASSERT_TRUE(collection_create_op.ok());
+ coll2 = collection_create_op.get();
+
+ doc_json = R"({
+ "ref_string_field": "d"
+ })"_json;
+ add_doc_op = coll2->add(doc_json.dump());
+ ASSERT_TRUE(add_doc_op.ok());
+
+ doc = coll2->get("0").get();
+ ASSERT_EQ(1, doc.count("ref_string_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_string_field_sequence_id"]);
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_string_field_sequence_id", doc[".reference_helper_fields"][0]);
+
doc_json = R"({
"ref_string_array_field": ["a", "d"]
})"_json;
@@ -450,15 +506,23 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
result = coll2->search("*", {}, "", {}, {}, {0}).get();
ASSERT_EQ(0, result["hits"][0]["document"]["ref_string_array_field_sequence_id"].size());
+ doc = coll2->get("1").get();
+ ASSERT_EQ(1, doc.count("ref_string_array_field_sequence_id"));
+ ASSERT_EQ(0, doc["ref_string_array_field_sequence_id"].size());
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_string_array_field_sequence_id", doc[".reference_helper_fields"][0]);
+
doc_json = R"({
"ref_string_array_field": ["b", "foo"]
})"_json;
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_string_array_field_sequence_id"].size());
- ASSERT_EQ(0, result["hits"][0]["document"]["ref_string_array_field_sequence_id"][0]);
+ doc = coll2->get("2").get();
+ ASSERT_EQ(1, doc.count("ref_string_array_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_string_array_field_sequence_id"].size());
+ ASSERT_EQ(0, doc["ref_string_array_field_sequence_id"][0]);
doc_json = R"({
"ref_string_array_field": ["c", "e"]
@@ -466,10 +530,11 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(2, result["hits"][0]["document"]["ref_string_array_field_sequence_id"].size());
- ASSERT_EQ(0, result["hits"][0]["document"]["ref_string_array_field_sequence_id"][0]);
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_string_array_field_sequence_id"][1]);
+ doc = coll2->get("3").get();
+ ASSERT_EQ(1, doc.count("ref_string_array_field_sequence_id"));
+ ASSERT_EQ(2, doc["ref_string_array_field_sequence_id"].size());
+ ASSERT_EQ(0, doc["ref_string_array_field_sequence_id"][0]);
+ ASSERT_EQ(1, doc["ref_string_array_field_sequence_id"][1]);
// int32/int32[] reference fields
doc_json = R"({
@@ -520,15 +585,6 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Multiple documents having `int32_field: 1` found in the collection `coll1`.", add_doc_op.error());
- doc_json = R"({
- "ref_int32_field": 4
- })"_json;
- add_doc_op = coll2->add(doc_json.dump());
- ASSERT_TRUE(add_doc_op.ok());
-
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(4, result["hits"][0]["document"]["ref_int32_field_sequence_id"]);
-
doc_json = R"({
"ref_int32_array_field": [1, "2"]
})"_json;
@@ -550,14 +606,37 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Field `ref_int32_array_field` must only have `int32` values.", add_doc_op.error());
+ collectionManager.drop_collection("coll2");
+ temp_json = schema_json;
+ collection_create_op = collectionManager.create_collection(temp_json);
+ ASSERT_TRUE(collection_create_op.ok());
+ coll2 = collection_create_op.get();
+
+ doc_json = R"({
+ "ref_int32_field": 4
+ })"_json;
+ add_doc_op = coll2->add(doc_json.dump());
+ ASSERT_TRUE(add_doc_op.ok());
+
+ doc = coll2->get("0").get();
+ ASSERT_EQ(1, doc.count("ref_int32_field_sequence_id"));
+ ASSERT_EQ(4, doc["ref_int32_field_sequence_id"]);
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_int32_field_sequence_id", doc[".reference_helper_fields"][0]);
+
doc_json = R"({
"ref_int32_array_field": [1]
})"_json;
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(0, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"].size());
+ doc = coll2->get("1").get();
+ ASSERT_EQ(1, doc.count("ref_int32_array_field_sequence_id"));
+ ASSERT_EQ(0, doc["ref_int32_array_field_sequence_id"].size());
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_int32_array_field_sequence_id", doc[".reference_helper_fields"][0]);
doc_json = R"({
"ref_int32_array_field": [1, 2]
@@ -565,9 +644,10 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"].size());
- ASSERT_EQ(3, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"][0]);
+ doc = coll2->get("2").get();
+ ASSERT_EQ(1, doc.count("ref_int32_array_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_int32_array_field_sequence_id"].size());
+ ASSERT_EQ(3, doc["ref_int32_array_field_sequence_id"][0]);
doc_json = R"({
"ref_int32_array_field": [2, 5]
@@ -575,10 +655,11 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(2, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"].size());
- ASSERT_EQ(3, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"][0]);
- ASSERT_EQ(4, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"][1]);
+ doc = coll2->get("3").get();
+ ASSERT_EQ(1, doc.count("ref_int32_array_field_sequence_id"));
+ ASSERT_EQ(2, doc["ref_int32_array_field_sequence_id"].size());
+ ASSERT_EQ(3, doc["ref_int32_array_field_sequence_id"][0]);
+ ASSERT_EQ(4, doc["ref_int32_array_field_sequence_id"][1]);
doc_json = R"({
"ref_int32_array_field": [-2147483648]
@@ -586,9 +667,10 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"].size());
- ASSERT_EQ(3, result["hits"][0]["document"]["ref_int32_array_field_sequence_id"][0]);
+ doc = coll2->get("4").get();
+ ASSERT_EQ(1, doc.count("ref_int32_array_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_int32_array_field_sequence_id"].size());
+ ASSERT_EQ(3, doc["ref_int32_array_field_sequence_id"][0]);
// int64/int64[] reference fields
doc_json = R"({
@@ -632,15 +714,6 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Multiple documents having `int64_field: 1` found in the collection `coll1`.", add_doc_op.error());
- doc_json = R"({
- "ref_int64_field": 4
- })"_json;
- add_doc_op = coll2->add(doc_json.dump());
- ASSERT_TRUE(add_doc_op.ok());
-
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(7, result["hits"][0]["document"]["ref_int64_field_sequence_id"]);
-
doc_json = R"({
"ref_int64_array_field": [1, "2"]
})"_json;
@@ -662,14 +735,37 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
ASSERT_FALSE(add_doc_op.ok());
ASSERT_EQ("Field `ref_int64_array_field` must only have `int64` values.", add_doc_op.error());
+ collectionManager.drop_collection("coll2");
+ temp_json = schema_json;
+ collection_create_op = collectionManager.create_collection(temp_json);
+ ASSERT_TRUE(collection_create_op.ok());
+ coll2 = collection_create_op.get();
+
+ doc_json = R"({
+ "ref_int64_field": 4
+ })"_json;
+ add_doc_op = coll2->add(doc_json.dump());
+ ASSERT_TRUE(add_doc_op.ok());
+
+ doc = coll2->get("0").get();
+ ASSERT_EQ(1, doc.count("ref_int64_field_sequence_id"));
+ ASSERT_EQ(7, doc["ref_int64_field_sequence_id"]);
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_int64_field_sequence_id", doc[".reference_helper_fields"][0]);
+
doc_json = R"({
"ref_int64_array_field": [1]
})"_json;
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(0, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"].size());
+ doc = coll2->get("1").get();
+ ASSERT_EQ(1, doc.count("ref_int64_array_field_sequence_id"));
+ ASSERT_EQ(0, doc["ref_int64_array_field_sequence_id"].size());
+ ASSERT_EQ(1, doc.count(".reference_helper_fields"));
+ ASSERT_EQ(1, doc[".reference_helper_fields"].size());
+ ASSERT_EQ("ref_int64_array_field_sequence_id", doc[".reference_helper_fields"][0]);
doc_json = R"({
"ref_int64_array_field": [1, 2]
@@ -677,9 +773,10 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"].size());
- ASSERT_EQ(6, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"][0]);
+ doc = coll2->get("2").get();
+ ASSERT_EQ(1, doc.count("ref_int64_array_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_int64_array_field_sequence_id"].size());
+ ASSERT_EQ(6, doc["ref_int64_array_field_sequence_id"][0]);
doc_json = R"({
"ref_int64_array_field": [2, 5]
@@ -687,10 +784,11 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(2, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"].size());
- ASSERT_EQ(6, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"][0]);
- ASSERT_EQ(7, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"][1]);
+ doc = coll2->get("3").get();
+ ASSERT_EQ(1, doc.count("ref_int64_array_field_sequence_id"));
+ ASSERT_EQ(2, doc["ref_int64_array_field_sequence_id"].size());
+ ASSERT_EQ(6, doc["ref_int64_array_field_sequence_id"][0]);
+ ASSERT_EQ(7, doc["ref_int64_array_field_sequence_id"][1]);
doc_json = R"({
"ref_int64_array_field": [-9223372036854775808]
@@ -698,9 +796,10 @@ TEST_F(CollectionJoinTest, IndexDocumentHavingReferenceField) {
add_doc_op = coll2->add(doc_json.dump());
ASSERT_TRUE(add_doc_op.ok());
- result = coll2->search("*", {}, "", {}, {}, {0}).get();
- ASSERT_EQ(1, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"].size());
- ASSERT_EQ(6, result["hits"][0]["document"]["ref_int64_array_field_sequence_id"][0]);
+ doc = coll2->get("4").get();
+ ASSERT_EQ(1, doc.count("ref_int64_array_field_sequence_id"));
+ ASSERT_EQ(1, doc["ref_int64_array_field_sequence_id"].size());
+ ASSERT_EQ(6, doc["ref_int64_array_field_sequence_id"][0]);
// float/float[] reference fields
doc_json = R"({
@@ -1688,12 +1787,11 @@ TEST_F(CollectionJoinTest, IncludeExcludeFieldsByReference) {
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("embedding"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("rating"));
// Default strategy of reference includes is nest. No alias was provided, collection name becomes the field name.
- ASSERT_EQ(6, res_obj["hits"][0]["document"]["Customers"].size());
+ ASSERT_EQ(5, res_obj["hits"][0]["document"]["Customers"].size());
ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("customer_id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("customer_name"));
ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("product_id"));
- ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("product_id_sequence_id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"]["Customers"].count("product_price"));
req_params = {
@@ -1709,7 +1807,7 @@ TEST_F(CollectionJoinTest, IncludeExcludeFieldsByReference) {
res_obj = nlohmann::json::parse(json_res);
ASSERT_EQ(1, res_obj["found"].get<size_t>());
ASSERT_EQ(1, res_obj["hits"].size());
- ASSERT_EQ(12, res_obj["hits"][0]["document"].size());
+ ASSERT_EQ(11, res_obj["hits"][0]["document"].size());
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("product_id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("product_name"));
@@ -1719,8 +1817,6 @@ TEST_F(CollectionJoinTest, IncludeExcludeFieldsByReference) {
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.customer_id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.customer_name"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.id"));
- ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.product_id"));
- ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.product_id_sequence_id"));
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("Customers.product_price"));
req_params = {
@@ -1810,10 +1906,9 @@ TEST_F(CollectionJoinTest, IncludeExcludeFieldsByReference) {
res_obj = nlohmann::json::parse(json_res);
ASSERT_EQ(1, res_obj["found"].get<size_t>());
ASSERT_EQ(1, res_obj["hits"].size());
- // 6 fields in Products document and 2 fields from Customers document
- ASSERT_EQ(8, res_obj["hits"][0]["document"].size());
+ // 6 fields in Products document and 1 field from Customers document
+ ASSERT_EQ(7, res_obj["hits"][0]["document"].size());
ASSERT_EQ(1, res_obj["hits"][0]["document"].count("product_price"));
- ASSERT_EQ(1, res_obj["hits"][0]["document"].count("product_id_sequence_id"));
req_params = {
{"collection", "Products"},