diff options
author | Jason Zhang <jason.zhang@mongodb.com> | 2023-02-14 21:06:25 +0000 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2023-02-15 01:59:50 +0000 |
commit | 77c03f9e26931596059122c251bf875c190123e3 (patch) | |
tree | aca2fe4ffbafb1add38f557f24e4e8e8c0d71e80 /src/mongo/s/commands/cluster_find_and_modify_cmd.h | |
parent | d1fbeed2f867f9c51e6f4e0c3739fcd771567fb2 (diff) | |
download | mongo-77c03f9e26931596059122c251bf875c190123e3.tar.gz |
SERVER-70581 Handle WCOS for update and findAndModify if replacement document changes data placement
Diffstat (limited to 'src/mongo/s/commands/cluster_find_and_modify_cmd.h')
-rw-r--r-- | src/mongo/s/commands/cluster_find_and_modify_cmd.h | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/src/mongo/s/commands/cluster_find_and_modify_cmd.h b/src/mongo/s/commands/cluster_find_and_modify_cmd.h new file mode 100644 index 00000000000..5b6144467b4 --- /dev/null +++ b/src/mongo/s/commands/cluster_find_and_modify_cmd.h @@ -0,0 +1,188 @@ +/** + * Copyright (C) 2022-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. + */ + +#pragma once + +#include "mongo/base/status_with.h" +#include "mongo/bson/util/bson_extract.h" +#include "mongo/db/auth/action_set.h" +#include "mongo/db/auth/action_type.h" +#include "mongo/db/auth/authorization_session.h" +#include "mongo/db/auth/resource_pattern.h" +#include "mongo/db/catalog/document_validation.h" +#include "mongo/db/commands.h" +#include "mongo/db/commands/update_metrics.h" +#include "mongo/db/fle_crud.h" +#include "mongo/db/internal_transactions_feature_flag_gen.h" +#include "mongo/db/ops/write_ops_gen.h" +#include "mongo/db/query/collation/collator_factory_interface.h" +#include "mongo/db/storage/duplicate_key_error_info.h" +#include "mongo/db/transaction/transaction_api.h" +#include "mongo/executor/task_executor_pool.h" +#include "mongo/logv2/log.h" +#include "mongo/rpc/get_status_from_command_result.h" +#include "mongo/s/balancer_configuration.h" +#include "mongo/s/catalog_cache.h" +#include "mongo/s/client/shard_registry.h" +#include "mongo/s/cluster_commands_helpers.h" +#include "mongo/s/cluster_ddl.h" +#include "mongo/s/commands/cluster_explain.h" +#include "mongo/s/commands/document_shard_key_update_util.h" +#include "mongo/s/commands/strategy.h" +#include "mongo/s/grid.h" +#include "mongo/s/multi_statement_transaction_requests_sender.h" +#include "mongo/s/query_analysis_sampler_util.h" +#include "mongo/s/request_types/cluster_commands_without_shard_key_gen.h" +#include "mongo/s/session_catalog_router.h" +#include "mongo/s/shard_key_pattern_query_util.h" +#include "mongo/s/stale_exception.h" +#include "mongo/s/transaction_router.h" +#include "mongo/s/transaction_router_resource_yielder.h" +#include "mongo/s/would_change_owning_shard_exception.h" +#include "mongo/s/write_ops/write_without_shard_key_util.h" +#include "mongo/util/timer.h" + +namespace mongo { + +class FindAndModifyCmd : public BasicCommand { +public: + FindAndModifyCmd() + : BasicCommand("findAndModify", "findandmodify"), _updateMetrics{"findAndModify"} {} + + const std::set<std::string>& apiVersions() const override { + return kApiVersions1; + } + + AllowedOnSecondary secondaryAllowed(ServiceContext*) const override { + return AllowedOnSecondary::kAlways; + } + + ReadWriteType getReadWriteType() const override { + return ReadWriteType::kWrite; + } + + bool adminOnly() const override { + return false; + } + + bool supportsWriteConcern(const BSONObj& cmd) const override { + return true; + } + + ReadConcernSupportResult supportsReadConcern(const BSONObj& cmdObj, + repl::ReadConcernLevel level, + bool isImplicitDefault) const override { + return {{level != repl::ReadConcernLevel::kLocalReadConcern && + level != repl::ReadConcernLevel::kSnapshotReadConcern, + {ErrorCodes::InvalidOptions, "read concern not supported"}}, + {{ErrorCodes::InvalidOptions, "default read concern not permitted"}}}; + } + + Status checkAuthForOperation(OperationContext* opCtx, + const DatabaseName& dbName, + const BSONObj& cmdObj) const override; + + Status explain(OperationContext* opCtx, + const OpMsgRequest& request, + ExplainOptions::Verbosity verbosity, + rpc::ReplyBuilderInterface* result) const override; + + bool allowedInTransactions() const final { + return true; + } + + bool supportsRetryableWrite() const final { + return true; + } + + bool run(OperationContext* opCtx, + const DatabaseName& dbName, + const BSONObj& cmdObj, + BSONObjBuilder& result) override; + + /** + * Changes the shard key for the document if the response object contains a + * WouldChangeOwningShard error. If the original command was sent as a retryable write, starts a + * transaction on the same session and txnNum, deletes the original document, inserts the new + * one, and commits the transaction. If the original command is part of a transaction, deletes + * the original document and inserts the new one. + */ + static void handleWouldChangeOwningShardError(OperationContext* opCtx, + const ShardId& shardId, + const NamespaceString& nss, + const BSONObj& cmdObj, + Status responseStatus, + BSONObjBuilder* result); + +private: + static bool getCrudProcessedFromCmd(const BSONObj& cmdObj); + + // Catches errors in the given response, and reruns the command if necessary. Uses the given + // response to construct the findAndModify command result passed to the client. + static void _constructResult(OperationContext* opCtx, + const ShardId& shardId, + const boost::optional<ShardVersion>& shardVersion, + const boost::optional<DatabaseVersion>& dbVersion, + const NamespaceString& nss, + const BSONObj& cmdObj, + const BSONObj& response, + BSONObjBuilder* result); + + // Two-phase protocol to run a findAndModify command without a shard key or _id. + static void _runCommandWithoutShardKey(OperationContext* opCtx, + const NamespaceString& nss, + const BSONObj& cmdObj, + bool isExplain, + BSONObjBuilder* result); + + // Command invocation to be used if a shard key is specified or the collection is unsharded. + static void _runCommand(OperationContext* opCtx, + const ShardId& shardId, + const boost::optional<ShardVersion>& shardVersion, + const boost::optional<DatabaseVersion>& dbVersion, + const NamespaceString& nss, + const BSONObj& cmdObj, + bool isExplain, + BSONObjBuilder* result); + + // TODO SERVER-67429: Remove this function. + static void _handleWouldChangeOwningShardErrorRetryableWriteLegacy( + OperationContext* opCtx, + const ShardId& shardId, + const boost::optional<ShardVersion>& shardVersion, + const boost::optional<DatabaseVersion>& dbVersion, + const NamespaceString& nss, + const BSONObj& cmdObj, + BSONObjBuilder* result); + + // Update related command execution metrics. + UpdateMetrics _updateMetrics; +}; + +} // namespace mongo |