summaryrefslogtreecommitdiff
path: root/src/mongo/s/write_ops/batched_upsert_detail.h
blob: cff8122f7eee045d8d06f8cc7ee2e9c723b9aa7f (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
/**
 *    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 <string>
#include <vector>

#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"
#include "mongo/s/bson_serializable.h"

namespace mongo {

    /**
     * This class represents the layout and content of an idem inside the 'upserted' array
     * of a write command's response (see batched_command_response.h)
     */
    class BatchedUpsertDetail : public BSONSerializable {
        MONGO_DISALLOW_COPYING(BatchedUpsertDetail);
    public:

        //
        // schema declarations
        //

        static const BSONField<int> index;
        static const BSONField<BSONObj> upsertedID; // ID type

        //
        // construction / destruction
        //

        BatchedUpsertDetail();
        virtual ~BatchedUpsertDetail();

        /** Copies all the fields present in 'this' to 'other'. */
        void cloneTo(BatchedUpsertDetail* other) const;

        //
        // bson serializable interface implementation
        //

        virtual bool isValid(std::string* errMsg) const;
        virtual BSONObj toBSON() const;
        virtual bool parseBSON(const BSONObj& source, std::string* errMsg);
        virtual void clear();
        virtual std::string toString() const;

        //
        // individual field accessors
        //

        void setIndex(int index);
        void unsetIndex();
        bool isIndexSet() const;
        int getIndex() const;

        void setUpsertedID(const BSONObj& upsertedID);
        void unsetUpsertedID();
        bool isUpsertedIDSet() const;
        const BSONObj& getUpsertedID() const;

    private:
        // Convention: (M)andatory, (O)ptional

        // (M)  number of the batch item the upsert refers to
        int _index;
        bool _isIndexSet;

        // (M)  _id for the upserted document
        BSONObj _upsertedID;
        bool _isUpsertedIDSet;
    };

} // namespace mongo