summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/database.h
blob: e3a0b37f28c90c1d64910370e84fb9ae16c0b5d0 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// database.h

/**
*    Copyright (C) 2008 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 "mongo/bson/bsonobj.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/storage_options.h"
#include "mongo/util/concurrency/mutex.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/string_map.h"

namespace mongo {

    class Collection;
    class DatabaseCatalogEntry;
    class DataFile;
    class ExtentManager;
    class IndexCatalog;
    class MMAP1DatabaseCatalogEntry;
    class MmapV1ExtentManager;
    class NamespaceDetails;
    class NamespaceIndex;
    class OperationContext;

    /**
     * Database represents a database database
     * Each database database has its own set of files -- dbname.ns, dbname.0, dbname.1, ...
     * NOT memory mapped
    */
    class Database {
    public:
        // you probably need to be in dbHolderMutex when constructing this
        Database(OperationContext* txn,
                 const char *nm,
                 /*out*/ bool& newDb,
                 const std::string& path = storageGlobalParams.dbpath);

        /* you must use this to close - there is essential code in this method that is not in the ~Database destructor.
           thus the destructor is private.  this could be cleaned up one day...
        */
        static void closeDatabase( const std::string& db, const std::string& path );

        const std::string& name() const { return _name; }
        const std::string& path() const { return _path; }

        void clearTmpCollections(OperationContext* txn);

        bool isEmpty() const;

        /**
         * total file size of Database in bytes
         */
        long long fileSize() const;

        int numFiles() const;

        void getFileFormat( int* major, int* minor );

        /**
         * @return true if success.  false if bad level or error creating profile ns
         */
        bool setProfilingLevel( OperationContext* txn, int newLevel , std::string& errmsg );

        void flushFiles( bool sync );

        /**
         * @return true if ns is part of the database
         *         ns=foo.bar, db=foo returns true
         */
        bool ownsNS( const std::string& ns ) const {
            if ( ! mongoutils::str::startsWith( ns , _name ) )
                return false;
            return ns[_name.size()] == '.';
        }

        int getProfilingLevel() const { return _profile; }
        const char* getProfilingNS() const { return _profileName.c_str(); }

        void getStats( BSONObjBuilder* output, double scale = 1 );

        long long getIndexSizeForCollection( Collection* collections,
                                             BSONObjBuilder* details = NULL,
                                             int scale = 1 );

        const DatabaseCatalogEntry* getDatabaseCatalogEntry() const;

        // TODO: do not think this method should exist, so should try and encapsulate better
        MmapV1ExtentManager* getExtentManager();
        const MmapV1ExtentManager* getExtentManager() const;

        Status dropCollection( OperationContext* txn, const StringData& fullns );

        Collection* createCollection( OperationContext* txn,
                                      const StringData& ns,
                                      const CollectionOptions& options = CollectionOptions(),
                                      bool allocateSpace = true,
                                      bool createDefaultIndexes = true );

        /**
         * @param ns - this is fully qualified, which is maybe not ideal ???
         * The methods without a transaction are deprecated.
         * TODO remove deprecated method once we require reads to have Transaction objects.
         */
        Collection* getCollection( const StringData& ns );

        Collection* getCollection( const NamespaceString& ns ) { return getCollection( ns.ns() ); }

        Collection* getCollection( OperationContext* txn, const StringData& ns );

        Collection* getCollection( OperationContext* txn, const NamespaceString& ns ) {
            return getCollection( txn, ns.ns() );
        }

        Collection* getOrCreateCollection( const StringData& ns );
        Collection* getOrCreateCollection( OperationContext* txn, const StringData& ns );

        Status renameCollection( OperationContext* txn,
                                 const StringData& fromNS,
                                 const StringData& toNS,
                                 bool stayTemp );

        /**
         * @return name of an existing database with same text name but different
         * casing, if one exists.  Otherwise the empty std::string is returned.  If
         * 'duplicates' is specified, it is filled with all duplicate names.
         // TODO move???
         */
        static string duplicateUncasedName( bool inholderlockalready,
                                            const std::string &name,
                                            const std::string &path,
                                            std::set< std::string > *duplicates = 0 );

        static Status validateDBName( const StringData& dbname );

        const std::string& getSystemIndexesName() const { return _indexesName; }
    private:

        void _clearCollectionCache( const StringData& fullns );

        void _clearCollectionCache_inlock( const StringData& fullns );

        ~Database(); // closes files and other cleanup see below.

        void _addNamespaceToCatalog( OperationContext* txn,
                                     const StringData& ns,
                                     const BSONObj* options );


        /**
         * removes from *.system.namespaces
         * frees extents
         * removes from NamespaceIndex
         * NOT RIGHT NOW, removes cache entry in Database TODO?
         */
        Status _dropNS( OperationContext* txn, const StringData& ns );

        Status _renameSingleNamespace( OperationContext* txn,
                                       const StringData& fromNS,
                                       const StringData& toNS,
                                       bool stayTemp );

        const std::string _name; // "alleyinsider"
        const std::string _path; // "/data/db"

        boost::scoped_ptr<MMAP1DatabaseCatalogEntry> _dbEntry;

        const std::string _profileName; // "alleyinsider.system.profile"
        const std::string _namespacesName; // "alleyinsider.system.namespaces"
        const std::string _indexesName; // "alleyinsider.system.indexes"

        int _profile; // 0=off.

        // TODO: make sure deletes go through
        // this in some ways is a dupe of _namespaceIndex
        // but it points to a much more useful data structure
        typedef StringMap< Collection* > CollectionMap;
        CollectionMap _collections;
        mongo::mutex _collectionLock;

        friend class Collection;
        friend class NamespaceDetails;
        friend class IndexCatalog;
    };

} // namespace mongo