summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/coll_mod.cpp
blob: 768ee713b0a007b7ebcb9d5dc9ccd8833a21e639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/**
 *    Copyright (C) 2015 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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/platform/basic.h"

#include "mongo/db/catalog/coll_mod.h"

#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/client.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/repl/replication_coordinator_global.h"
#include "mongo/db/service_context.h"

namespace mongo {
    Status collMod(OperationContext* txn,
                   const NamespaceString& ns,
                   const BSONObj& cmdObj,
                   BSONObjBuilder* result) {
        StringData dbName = ns.db();
        ScopedTransaction transaction(txn, MODE_IX);
        AutoGetDb autoDb(txn, dbName, MODE_X);
        Database* const db = autoDb.getDb();
        Collection* coll = db ? db->getCollection(ns) : NULL;

        // If db/collection does not exist, short circuit and return.
        if (!db || !coll) {
            return Status(ErrorCodes::NamespaceNotFound, "ns does not exist");
        }

        OldClientContext ctx(txn,  ns);

        bool userInitiatedWritesAndNotPrimary = txn->writesAreReplicated() &&
            !repl::getGlobalReplicationCoordinator()->canAcceptWritesFor(ns);

        if (userInitiatedWritesAndNotPrimary) {
            return Status(ErrorCodes::NotMaster,
                          str::stream() << "Not primary while setting collection options on "
                                        << ns.toString());
        }

        WriteUnitOfWork wunit(txn);

        Status errorStatus = Status::OK();

        BSONForEach(e, cmdObj) {
            if (str::equals("collMod", e.fieldName())) {
                // no-op
            }
            else if (str::startsWith(e.fieldName(), "$")) {
                // no-op ignore top-level fields prefixed with $. They are for the command processor
            }
            else if (LiteParsedQuery::cmdOptionMaxTimeMS == e.fieldNameStringData()) {
                // no-op
            }
            else if (str::equals("index", e.fieldName())) {
                BSONObj indexObj = e.Obj();
                BSONObj keyPattern = indexObj.getObjectField("keyPattern");

                if (keyPattern.isEmpty()){
                    errorStatus = Status(ErrorCodes::InvalidOptions, "no keyPattern specified");
                    continue;
                }

                BSONElement newExpireSecs = indexObj["expireAfterSeconds"];
                if (newExpireSecs.eoo()) {
                    errorStatus = Status(ErrorCodes::InvalidOptions, "no expireAfterSeconds field");
                    continue;
                }
                if (! newExpireSecs.isNumber()) {
                    errorStatus = Status(ErrorCodes::InvalidOptions,
                                         "expireAfterSeconds field must be a number");
                    continue;
                }

                const IndexDescriptor* idx = coll->getIndexCatalog()
                                                 ->findIndexByKeyPattern(txn, keyPattern);
                if (idx == NULL) {
                    errorStatus = Status(ErrorCodes::InvalidOptions,
                                         str::stream() << "cannot find index " << keyPattern
                                                       << " for ns " << ns.toString());
                    continue;
                }
                BSONElement oldExpireSecs = idx->infoObj().getField("expireAfterSeconds");
                if (oldExpireSecs.eoo()){
                    errorStatus = Status(ErrorCodes::InvalidOptions,
                                         "no expireAfterSeconds field to update");
                    continue;
                }
                if (! oldExpireSecs.isNumber()) {
                    errorStatus = Status(ErrorCodes::InvalidOptions,
                                         "existing expireAfterSeconds field is not a number");
                    continue;
                }

                if (oldExpireSecs != newExpireSecs) {
                    result->appendAs(oldExpireSecs, "expireAfterSeconds_old");
                    // Change the value of "expireAfterSeconds" on disk.
                    coll->getCatalogEntry()->updateTTLSetting(txn,
                                                              idx->indexName(),
                                                              newExpireSecs.numberLong());
                    // Notify the index catalog that the definition of this index changed.
                    idx = coll->getIndexCatalog()->refreshEntry(txn, idx);
                    result->appendAs(newExpireSecs , "expireAfterSeconds_new");
                }
            }
            else if (str::equals("validator", e.fieldName())) {
                auto status = coll->setValidator(txn, e.Obj());
                if (!status.isOK())
                    errorStatus = std::move(status);
            }
            else {
                // As of SERVER-17312 we only support these two options. When SERVER-17320 is
                // resolved this will need to be enhanced to handle other options.
                typedef CollectionOptions CO;
                const StringData name = e.fieldNameStringData();
                const int flag = (name == "usePowerOf2Sizes") ? CO::Flag_UsePowerOf2Sizes :
                                 (name == "noPadding") ? CO::Flag_NoPadding :
                                 0;
                if (!flag) {
                    errorStatus = Status(ErrorCodes::InvalidOptions,
                                         str::stream() << "unknown option to collMod: " << name);
                    continue;
                }

                CollectionCatalogEntry* cce = coll->getCatalogEntry();

                const int oldFlags = cce->getCollectionOptions(txn).flags;
                const bool oldSetting = oldFlags & flag;
                const bool newSetting = e.trueValue();

                result->appendBool(name.toString() + "_old", oldSetting);
                result->appendBool(name.toString() + "_new", newSetting);

                const int newFlags = newSetting
                                   ? (oldFlags | flag) // set flag
                                   : (oldFlags & ~flag); // clear flag

                // NOTE we do this unconditionally to ensure that we note that the user has
                // explicitly set flags, even if they are just setting the default.
                cce->updateFlags(txn, newFlags);

                const CollectionOptions newOptions = cce->getCollectionOptions(txn);
                invariant(newOptions.flags == newFlags);
                invariant(newOptions.flagsSet);
            }
        }

        if (!errorStatus.isOK()) {
            return errorStatus;
        }

        getGlobalServiceContext()->getOpObserver()->onCollMod(txn,
                                                              (dbName.toString() + ".$cmd").c_str(),
                                                              cmdObj);

        wunit.commit();
        return Status::OK();
    }
} // namespace mongo