database_catalog_entry.h

Go to the documentation of this file.

// database_catalog_entry.h

#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(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 bool hasUserData() const = 0;

    virtual int64_t sizeOnDisk(OperationContext* opCtx) 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;

    virtual Status 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(StringData ns) const = 0;

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

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

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

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

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

private:
    std::string _name;
};
}