1 
2 /**
3  *    Copyright (C) 2018-present MongoDB, Inc.
4  *
5  *    This program is free software: you can redistribute it and/or modify
6  *    it under the terms of the Server Side Public License, version 1,
7  *    as published by MongoDB, Inc.
8  *
9  *    This program is distributed in the hope that it will be useful,
10  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *    Server Side Public License for more details.
13  *
14  *    You should have received a copy of the Server Side Public License
15  *    along with this program. If not, see
16  *    <http://www.mongodb.com/licensing/server-side-public-license>.
17  *
18  *    As a special exception, the copyright holders give permission to link the
19  *    code of portions of this program with the OpenSSL library under certain
20  *    conditions as described in each individual source file and distribute
21  *    linked combinations including the program with the OpenSSL library. You
22  *    must comply with the Server Side Public License in all respects for
23  *    all of the code used other than as permitted herein. If you modify file(s)
24  *    with this exception, you may extend this exception to your version of the
25  *    file(s), but you are not obligated to do so. If you do not wish to do so,
26  *    delete this exception statement from your version. If you delete this
27  *    exception statement from all source files in the program, then also delete
28  *    it in the license file.
29  */
30 
31 #include "mongo/base/status.h"
32 #include "mongo/base/status_with.h"
33 #include "mongo/db/catalog/collection_options.h"
34 
35 namespace mongo {
36 class BSONObj;
37 class BSONObjBuilder;
38 class Collection;
39 class NamespaceString;
40 class OperationContext;
41 
42 /**
43  * If upgrade is true, adds UUIDs to all collections of all databases. If upgrade is false, removes
44  * UUIDs from all collections of all databases. It updates non-replicated collections by indirectly
45  * calling updateUUIDSchemaVersionNonReplicated().
46  */
47 void updateUUIDSchemaVersion(OperationContext* opCtx, bool upgrade);
48 
49 /**
50  * If upgrade is true, adds UUIDs to all non-replicated collections of all databases. If upgrade is
51  * false, removes UUIDs from all non-replicated collections of all databases.
52  */
53 Status updateUUIDSchemaVersionNonReplicated(OperationContext* opCtx, bool upgrade);
54 
55 /**
56  * Performs the collection modification described in "cmdObj" on the collection "ns".
57  */
58 Status collMod(OperationContext* opCtx,
59                const NamespaceString& ns,
60                const BSONObj& cmdObj,
61                BSONObjBuilder* result);
62 
63 /*
64  * Adds uuid to the collection "ns" if uuid exists and removes any existing UUID from
65  * the collection "ns" if uuid is boost::none. This is called in circumstances where
66  * we may be upgrading or downgrading and we need to update the UUID.
67  */
68 Status collModForUUIDUpgrade(OperationContext* opCtx,
69                              const NamespaceString& ns,
70                              const BSONObj& cmdObj,
71                              OptionalCollectionUUID uuid);
72 }  // namespace mongo
73