diff options
Diffstat (limited to 'src/mongo/s/shard_invalidated_for_targeting_exception.h')
-rw-r--r-- | src/mongo/s/shard_invalidated_for_targeting_exception.h | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/src/mongo/s/shard_invalidated_for_targeting_exception.h b/src/mongo/s/shard_invalidated_for_targeting_exception.h new file mode 100644 index 00000000000..16d848cd372 --- /dev/null +++ b/src/mongo/s/shard_invalidated_for_targeting_exception.h @@ -0,0 +1,73 @@ +/** + * Copyright (C) 2020-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/error_extra_info.h" +#include "mongo/bson/bsonobj.h" +#include "mongo/bson/bsonobjbuilder.h" +#include "mongo/db/namespace_string.h" + +namespace mongo { + +/** + * This error is thrown when a stale shard is found when attempting to retrieve a shard's shard + * version for a namespace. The router (mongos) will retry a command when encountering this error, + * and will block on a catalog cache refresh. + * + * TODO SERVER-39704 Allow transactions to retry upon receiving a ShardInvalidatedForTargeting + * error. + */ +class ShardInvalidatedForTargetingInfo final : public ErrorExtraInfo { +public: + static constexpr auto code = ErrorCodes::ShardInvalidatedForTargeting; + + explicit ShardInvalidatedForTargetingInfo(NamespaceString nss) : _nss(nss){}; + + const auto& getNss() const { + return _nss; + } + + BSONObj toBSON() const { + BSONObjBuilder bob; + serialize(&bob); + return bob.obj(); + } + + void serialize(BSONObjBuilder* bob) const override; + static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&); + static ShardInvalidatedForTargetingInfo parseFromCommandError(const BSONObj& commandError); + +private: + NamespaceString _nss; +}; +using ShardInvalidatedForTargetingException = + ExceptionFor<ErrorCodes::ShardInvalidatedForTargeting>; + +} // namespace mongo |