diff options
Diffstat (limited to 'src/mongo/db/ops/modifier_pull_all.h')
| -rw-r--r-- | src/mongo/db/ops/modifier_pull_all.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/src/mongo/db/ops/modifier_pull_all.h b/src/mongo/db/ops/modifier_pull_all.h new file mode 100644 index 00000000000..54e3ae571e2 --- /dev/null +++ b/src/mongo/db/ops/modifier_pull_all.h @@ -0,0 +1,88 @@ +/** + * Copyright (C) 2013 10gen 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. + */ + +#pragma once + +#include <boost/scoped_ptr.hpp> +#include <string> + +#include "mongo/base/disallow_copying.h" +#include "mongo/bson/mutable/element.h" +#include "mongo/db/field_ref.h" +#include "mongo/db/jsobj.h" +#include "mongo/db/ops/modifier_interface.h" + +namespace mongo { + + class LogBuilder; + + class ModifierPullAll : public ModifierInterface { + MONGO_DISALLOW_COPYING(ModifierPullAll); + + public: + + ModifierPullAll(); + virtual ~ModifierPullAll(); + + /** + * The modifier $pullAll takes an array of values to match literally, and remove + * + * Ex. {$pullAll : {<field> : [<values>]}} + * {$pullAll :{ array : [1,2] } } will transform {array: [1,2,3]} -> {array: [3]} + */ + virtual Status init(const BSONElement& modExpr, const Options& opts, + bool* positional = NULL); + + virtual Status prepare(mutablebson::Element root, + const StringData& matchedField, + ExecInfo* execInfo); + + + virtual Status apply() const; + + virtual Status log(LogBuilder* logBuilder) const; + + private: + + // Access to each component of fieldName that's the target of this mod. + FieldRef _fieldRef; + + // 0 or index for $-positional in _fieldRef. + size_t _positionalPathIndex; + + // The instance of the field in the provided doc. + // This data is valid after prepare, for use by log and apply + struct PreparedState; + scoped_ptr<PreparedState> _preparedState; + + // User specified elements to remove + std::vector<BSONElement> _elementsToFind; + + }; + +} // namespace mongo |
