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
|
// 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/>.
*
* 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/disallow_copying.h"
#include "mongo/client/dbclientinterface.h"
#include "mongo/db/catalog/collection_options.h"
namespace mongo {
struct CloneOptions;
class DBClientBase;
class NamespaceString;
class OperationContext;
class Cloner {
MONGO_DISALLOW_COPYING(Cloner);
public:
Cloner();
void setConnection(std::unique_ptr<DBClientBase> c) {
_conn = std::move(c);
}
/**
* Copies an entire database from the specified host.
* clonedColls: when not-null, the function will return with this populated with a list of
* the collections that were cloned. This is for the user-facing clone command.
* collectionsToClone: When opts.createCollections is false, this list reflects the collections
* that are cloned. When opts.createCollections is true, this parameter is
* ignored and the collection list is fetched from the remote via _conn.
*/
Status copyDb(OperationContext* opCtx,
const std::string& toDBName,
const std::string& masterHost,
const CloneOptions& opts,
std::set<std::string>* clonedColls,
std::vector<BSONObj> collectionsToClone = std::vector<BSONObj>());
/**
* Copies a collection. The optionsParser indicates how to parse the collection options. If
* 'parseForCommand' is provided, then the UUID is ignored and a new UUID is generated. If
* 'parseForStorage' is provided, then the UUID will be preserved and parsed out of the
* options.
*/
bool copyCollection(OperationContext* opCtx,
const std::string& ns,
const BSONObj& query,
std::string& errmsg,
bool copyIndexes,
CollectionOptions::ParseKind optionsParser);
// Filters a database's collection list and removes collections that should not be cloned.
// CloneOptions should be populated with a fromDB and a list of collections to ignore, which
// will be filtered out.
StatusWith<std::vector<BSONObj>> filterCollectionsForClone(
const CloneOptions& opts, const std::list<BSONObj>& initialCollections);
struct CreateCollectionParams {
std::string collectionName;
BSONObj collectionInfo;
BSONObj idIndexSpec;
};
// Executes 'createCollection' for each collection described in 'createCollectionParams', in
// 'dbName'.
Status createCollectionsForDb(OperationContext* opCtx,
const std::vector<CreateCollectionParams>& createCollectionParams,
const std::string& dbName,
const CloneOptions& opts);
/*
* Returns the _id index spec from 'indexSpecs', or an empty BSONObj if none is found.
*/
static BSONObj getIdIndexSpec(const std::list<BSONObj>& indexSpecs);
private:
void copy(OperationContext* opCtx,
const std::string& toDBName,
const NamespaceString& from_ns,
const BSONObj& from_opts,
const BSONObj& from_id_index,
const NamespaceString& to_ns,
const CloneOptions& opts,
Query q);
void copyIndexes(OperationContext* opCtx,
const std::string& toDBName,
const NamespaceString& from_ns,
const BSONObj& from_opts,
const std::list<BSONObj>& from_indexes,
const NamespaceString& to_ns);
struct Fun;
std::unique_ptr<DBClientBase> _conn;
};
/**
* 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.
* createCollections - When 'true', will fetch a list of collections from the remote and create
* them. When 'false', assumes collections have already been created ahead of time.
* metadataOnly - Intended to be used with syncData=false. When metadataOnly=true, will copy
* collection
* options, indexes, and views.
*/
struct CloneOptions {
std::string fromDB;
std::set<std::string> collsToIgnore;
bool slaveOk = false;
bool useReplAuth = false;
bool snapshot = true;
bool syncData = true;
bool syncIndexes = true;
bool createCollections = true;
bool metadataOnly = false;
};
} // namespace mongo
|
