summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/database_catalog_entry.h
blob: b1f26fa134d59049e4281022b92afa11dee2307d (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
// database_catalog_entry.h

/**
*    Copyright (C) 2014 MongoDB 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 <list>
#include <string>

#include "mongo/base/status.h"
#include "mongo/base/string_data.h"

namespace mongo {

    class BSONObjBuilder;
    class CollectionCatalogEntry;
    class IndexAccessMethod;
    class IndexCatalogEntry;
    class OperationContext;
    class RecordStore;

    struct CollectionOptions;

    class DatabaseCatalogEntry {
    public:
        DatabaseCatalogEntry( const StringData& name )
            : _name( name.toString() ) {
        }

        virtual ~DatabaseCatalogEntry(){ }

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

        virtual bool exists() const = 0;
        virtual bool isEmpty() const = 0;

        virtual void appendExtraStats( OperationContext* opCtx,
                                       BSONObjBuilder* out,
                                       double scale ) const = 0;

        // these are hacks :(
        virtual bool isOlderThan24( OperationContext* opCtx ) const = 0;
        virtual void markIndexSafe24AndUp( OperationContext* opCtx ) = 0;

        /**
         * @return true if current files on disk are compatibile with the current version.
         *              if we return false, then an upgrade will be required
         */
        virtual bool currentFilesCompatible( OperationContext* opCtx ) const = 0;

        // ----

        virtual void getCollectionNamespaces( std::list<std::string>* out ) const = 0;

        // The DatabaseCatalogEntry owns this, do not delete
        virtual CollectionCatalogEntry* getCollectionCatalogEntry( OperationContext* txn,
                                                                   const StringData& ns ) const = 0;

        // The DatabaseCatalogEntry owns this, do not delete
        virtual RecordStore* getRecordStore( OperationContext* txn,
                                             const StringData& ns ) = 0;

        // Ownership passes to caller
        virtual IndexAccessMethod* getIndex( OperationContext* txn,
                                             const CollectionCatalogEntry* collection,
                                             IndexCatalogEntry* index ) = 0;

        virtual Status createCollection( OperationContext* txn,
                                         const StringData& ns,
                                         const CollectionOptions& options,
                                         bool allocateDefaultSpace ) = 0;

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

        virtual Status dropCollection( OperationContext* opCtx,
                                       const StringData& ns ) = 0;

    private:
        std::string _name;
    };
}