summaryrefslogtreecommitdiff
path: root/db/cloner.h
blob: 130fea0fac10a24b4e0e52f4a6ea0dca65936ec1 (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
// 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 "jsobj.h"

namespace mongo {
    
    /**
     * @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     - 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.
     */
    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);

    bool copyCollectionFromRemote(const string& host, const string& ns, string& errmsg);

} // namespace mongo