summaryrefslogtreecommitdiff
path: root/src/mongo/db/cloner.h
blob: 6f4e104ec60f7f3b47ccb54a697144ec8ef55455 (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
// cloner.h - copy a database (export/import basically)

/**
 *    Copyright (C) 2011 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/>.
 */

#pragma once

#include "mongo/db/jsobj.h"
#include "mongo/db/sort_phase_one.h"

namespace mongo {

    struct CloneOptions;
    class IndexSpec;
    class DBClientBase;
    class DBClientCursor;
    class Query;

    class Cloner: boost::noncopyable {
    public:
        Cloner();
        /**
         *  slaveOk     - if true it is ok if the source of the data is !ismaster.
         *  useReplAuth - use the credentials we normally use as a replication slave for the cloning
         *  snapshot    - use $snapshot mode for copying collections.  note this should not be used
         *                when it isn't required, as it will be slower.  for example,
         *                repairDatabase need not use it.
         */
        void setConnection( DBClientBase *c ) { _conn.reset( c ); }

        /** copy the entire database */
        bool go(const char *masterHost, string& errmsg, const string& fromdb, bool logForRepl,
                bool slaveOk, bool useReplAuth, bool snapshot, bool mayYield,
                bool mayBeInterrupted, int *errCode = 0);

        bool go(const char *masterHost, const CloneOptions& opts, set<string>& clonedColls,
                string& errmsg, int *errCode = 0);

        bool go(const char *masterHost, const CloneOptions& opts, string& errmsg, int *errCode = 0);

        bool copyCollection(const string& ns, const BSONObj& query, string& errmsg,
                            bool mayYield, bool mayBeInterrupted, bool copyIndexes = true,
                            bool logForRepl = true );
        /**
         * validate the cloner query was successful
         * @param cur   Cursor the query was executed on
         * @param errCode out  Error code encountered during the query
         */
        static bool validateQueryResults(const auto_ptr<DBClientCursor>& cur, int32_t* errCode);

        /**
         * @param errmsg out  - Error message (if encountered).
         * @param slaveOk     - if true it is ok if the source of the data is !ismaster.
         * @param useReplAuth - use the credentials we normally use as a replication slave for the
         *                      cloning.
         * @param snapshot    - use $snapshot mode for copying collections.  note this should not be
         *                      used when it isn't required, as it will be slower.  for example
         *                      repairDatabase need not use it.
         * @param errCode out - If provided, this will be set on error to the server's error code.
         *                      Currently this will only be set if there is an error in the initial
         *                      system.namespaces query.
         */
        static bool cloneFrom(const char *masterHost, string& errmsg, const string& fromdb,
                              bool logForReplication, bool slaveOk, bool useReplAuth,
                              bool snapshot, bool mayYield, bool mayBeInterrupted,
                              int *errCode = 0);

        static bool cloneFrom(const string& masterHost, const CloneOptions& options,
                              string& errmsg, int* errCode = 0,
                              set<string>* clonedCollections = 0);

        /**
         * Copy a collection (and indexes) from a remote host
         */
        static bool copyCollectionFromRemote(const string& host, const string& ns, string& errmsg);

    private:
        void copy(const char *from_ns, const char *to_ns, bool isindex, bool logForRepl,
                  bool masterSameProcess, bool slaveOk, bool mayYield, bool mayBeInterrupted,
                  Query q);

        // index presort info
        typedef struct {
            IndexSpec spec;
            SortPhaseOne preSortPhase;
        } PreSortDetails;

        typedef map<string, PreSortDetails> SortersForIndex; // map from index name to presorter
        typedef map<string, SortersForIndex> SortersForNS;   // map from ns to indices/sorters

        struct Fun;
        auto_ptr<DBClientBase> _conn;
        SortersForNS _sortersForNS;
    };

    struct CloneOptions {

        CloneOptions() {
            logForRepl = true;
            slaveOk = false;
            useReplAuth = false;
            snapshot = true;
            mayYield = true;
            mayBeInterrupted = false;

            syncData = true;
            syncIndexes = true;
        }
            
        string fromDB;
        set<string> collsToIgnore;

        bool logForRepl;
        bool slaveOk;
        bool useReplAuth;
        bool snapshot;
        bool mayYield;
        bool mayBeInterrupted;

        bool syncData;
        bool syncIndexes;
    };

} // namespace mongo