summaryrefslogtreecommitdiff
path: root/src/mongo/db/query/query_shape/shape_helpers.cpp
diff options
context:
space:
mode:
authorLucas de Castro Borges <lucas@gnuabordo.com.br>2025-02-18 17:02:53 -0300
committerLucas de Castro Borges <lucas@gnuabordo.com.br>2025-02-18 17:02:53 -0300
commit959575a5ca598bf5f37fb5cebe7ed1d80d3d71f7 (patch)
treeacc8d60aedb12b70048e676e8a7349deb0010db8 /src/mongo/db/query/query_shape/shape_helpers.cpp
parent76588293975fc059cf076779e4283e6ffaf8afff (diff)
New upstream version 6.0.20upstream
Diffstat (limited to 'src/mongo/db/query/query_shape/shape_helpers.cpp')
-rw-r--r--src/mongo/db/query/query_shape/shape_helpers.cpp108
1 files changed, 108 insertions, 0 deletions
diff --git a/src/mongo/db/query/query_shape/shape_helpers.cpp b/src/mongo/db/query/query_shape/shape_helpers.cpp
new file mode 100644
index 00000000000..8eea475ab78
--- /dev/null
+++ b/src/mongo/db/query/query_shape/shape_helpers.cpp
@@ -0,0 +1,108 @@
+/**
+ * Copyright (C) 2023-present MongoDB, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ *
+ * As a special exception, the copyright holders give permission to link the
+ * code of portions of this program with the OpenSSL library under certain
+ * conditions as described in each individual source file and distribute
+ * linked combinations including the program with the OpenSSL library. You
+ * must comply with the Server Side Public License in all respects for
+ * all of the code used other than as permitted herein. If you modify file(s)
+ * with this exception, you may extend this exception to your version of the
+ * file(s), but you are not obligated to do so. If you do not wish to do so,
+ * delete this exception statement from your version. If you delete this
+ * exception statement from all source files in the program, then also delete
+ * it in the license file.
+ */
+
+#include "mongo/db/query/query_shape/shape_helpers.h"
+
+#include "mongo/db/query/query_shape/query_shape_gen.h"
+
+namespace mongo::shape_helpers {
+
+static constexpr StringData hintSpecialField = "$hint"_sd;
+// A "Flat" object is one with only top-level fields. We won't descend recursively to shapify any
+// sub-objects.
+BSONObj shapifyFlatObj(BSONObj obj, const SerializationOptions& opts, bool valuesAreLiterals) {
+ if (obj.isEmpty()) {
+ // fast-path for the common case.
+ return obj;
+ }
+
+ BSONObjBuilder bob;
+ for (BSONElement elem : obj) {
+ if (hintSpecialField.compare(elem.fieldNameStringData()) == 0) {
+ if (elem.type() == BSONType::String) {
+ bob.append(hintSpecialField, opts.serializeFieldPathFromString(elem.String()));
+ } else if (elem.type() == BSONType::Object) {
+ opts.appendLiteral(&bob, hintSpecialField, elem.Obj());
+ } else {
+ // SERVER-85500: $hint syntax will not be validated if the collection does not
+ // exist, so we should accept a value that is neither string nor object here.
+ opts.appendLiteral(&bob, hintSpecialField, elem);
+ }
+ continue;
+ }
+
+ // $natural doesn't need to be redacted.
+ if (elem.fieldNameStringData().compare(query_request_helper::kNaturalSortField) == 0) {
+ bob.append(elem);
+ continue;
+ }
+
+ if (valuesAreLiterals) {
+ opts.appendLiteral(&bob, opts.serializeFieldPathFromString(elem.fieldName()), elem);
+ } else {
+ bob.appendAs(elem, opts.serializeFieldPathFromString(elem.fieldName()));
+ }
+ }
+ return bob.obj();
+}
+
+BSONObj extractHintShape(BSONObj hintObj, const SerializationOptions& opts) {
+ return shapifyFlatObj(hintObj, opts, /* valuesAreLiterals = */ false);
+}
+
+BSONObj extractMinOrMaxShape(BSONObj obj, const SerializationOptions& opts) {
+ return shapifyFlatObj(obj, opts, /* valuesAreLiterals = */ true);
+}
+
+void appendNamespaceShape(BSONObjBuilder& bob,
+ const NamespaceString& nss,
+ const SerializationOptions& opts) {
+ bob.append("db", opts.serializeIdentifier(nss.db()));
+ bob.append("coll", opts.serializeIdentifier(nss.coll()));
+}
+
+NamespaceStringOrUUID parseNamespaceShape(BSONElement cmdNsElt) {
+ tassert(7632900, "cmdNs must be an object.", cmdNsElt.type() == BSONType::Object);
+ auto cmdNs = query_shape::CommandNamespace::parse("cmdNs"_sd, cmdNsElt.embeddedObject());
+
+ if (cmdNs.getColl().has_value()) {
+ tassert(7632903,
+ "Exactly one of 'uuid' and 'coll' can be defined.",
+ !cmdNs.getUuid().has_value());
+ return NamespaceString(cmdNs.getDb(), cmdNs.getColl().value());
+ } else {
+ tassert(7632904,
+ "Exactly one of 'uuid' and 'coll' can be defined.",
+ !cmdNs.getColl().has_value());
+ UUID uuid = uassertStatusOK(UUID::parse(cmdNs.getUuid().value().toString()));
+ return NamespaceStringOrUUID(cmdNs.getDb().toString(), uuid);
+ }
+}
+
+} // namespace mongo::shape_helpers