summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage_options.h
blob: 3967af7139a6a8bbb0537d3a041103e0cac84500 (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
/*
 *    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>

/*
 * This file defines the storage for options that come from the command line related to data file
 * persistence.  Many executables that can access data files directly such as mongod and certain
 * tools use these variables, but each executable may have a different set of command line flags
 * that allow the user to change a different subset of these options.
 */

namespace mongo {

    struct StorageGlobalParams {

        // Default data directory for mongod when running in non-config server mode.
        static const char* kDefaultDbPath;

        // Default data directory for mongod when running as the config database of
        // a sharded cluster.
        static const char* kDefaultConfigDbPath;

        StorageGlobalParams() :
            engine("wiredTiger"),
            engineSetByUser(false),
            dbpath(kDefaultDbPath),
            upgrade(false),
            repair(false),
            noTableScan(false),
            directoryperdb(false),
            syncdelay(60.0) {
            dur = false;
            if (sizeof(void*) == 8)
                dur = true;
        }

        // --storageEngine
        // storage engine for this instance of mongod.
        std::string engine;

        // True if --storageEngine was passed on the command line, and false otherwise.
        bool engineSetByUser;

        // The directory where the mongod instance stores its data.
        std::string dbpath;

        // --upgrade
        // Upgrades the on-disk data format of the files specified by the --dbpath to the
        // latest version, if needed.
        bool upgrade;

        // --repair
        // Runs a repair routine on all databases. This is equivalent to shutting down and
        // running the repairDatabase database command on all databases.
        bool repair;

        // --repairpath
        // Specifies the root directory containing MongoDB data files to use for the --repair
        // operation.
        // Default: A _tmp directory within the path specified by the dbPath option.
        std::string repairpath;

        bool dur;                       // --dur durability (now --journal)

        // --notablescan
        // no table scans allowed
        bool noTableScan;

        // --directoryperdb
        // Stores each database’s files in its own folder in the data directory.
        // When applied to an existing system, the directoryPerDB option alters
        // the storage pattern of the data directory.
        bool directoryperdb;

        // --syncdelay
        // Controls how much time can pass before MongoDB flushes data to the data files
        // via an fsync operation.
        // Do not set this value on production systems.
        // In almost every situation, you should use the default setting.
        double syncdelay;      // seconds between fsyncs
    };

    extern StorageGlobalParams storageGlobalParams;

} // namespace mongo