collection_options.h

Go to the documentation of this file.

#pragma once

#include <string>

#include <boost/optional.hpp>

#include "mongo/base/status.h"
#include "mongo/db/jsobj.h"
#include "mongo/util/uuid.h"

namespace mongo {

// TODO(SERVER-34489) Remove when upgrade/downgrade is ready.
extern bool createTimestampSafeUniqueIndex;

class CollatorFactoryInterface;

using CollectionUUID = UUID;

using OptionalCollectionUUID = boost::optional<CollectionUUID>;

struct CollectionOptions {
    bool isView() const;

    enum ParseKind { parseForCommand, parseForStorage };

    Status validateForStorage() const;

    Status parse(const BSONObj& obj, ParseKind kind = parseForCommand);

    void appendBSON(BSONObjBuilder* builder) const;
    BSONObj toBSON() const;

    static bool validMaxCappedDocs(long long* max);

    bool matchesStorageOptions(const CollectionOptions& other,
                               CollatorFactoryInterface* collatorFactory) const;

    // ----

    // Collection UUID. Present for all CollectionOptions parsed for storage, except for those
    // corresponding to the system.namespaces and system.indexes collections on MMAP (see
    // SERVER-29926, SERVER-30095).
    OptionalCollectionUUID uuid;

    bool capped = false;
    long long cappedSize = 0;
    long long cappedMaxDocs = 0;

    // (MMAPv1) The following 2 are mutually exclusive, can only have one set.
    long long initialNumExtents = 0;
    std::vector<long long> initialExtentSizes;

    // The behavior of _id index creation when collection created
    void setNoIdIndex() {
        autoIndexId = NO;
    }
    enum {
        DEFAULT,  // currently yes for most collections, NO for some system ones
        YES,      // create _id index
        NO        // do not create _id index
    } autoIndexId = DEFAULT;

    // user flags
    enum UserFlags {
        Flag_UsePowerOf2Sizes = 1 << 0,
        Flag_NoPadding = 1 << 1,
    };
    int flags = Flag_UsePowerOf2Sizes;  // a bitvector of UserFlags
    bool flagsSet = false;

    bool temp = false;

    // Storage engine collection options. Always owned or empty.
    BSONObj storageEngine;

    // Default options for indexes created on the collection. Always owned or empty.
    BSONObj indexOptionDefaults;

    // Index specs for the _id index.
    BSONObj idIndex;

    // Always owned or empty.
    BSONObj validator;
    std::string validationAction;
    std::string validationLevel;

    // The namespace's default collation.
    BSONObj collation;

    // View-related options.
    // The namespace of the view or collection that "backs" this view, or the empty string if this
    // collection is not a view.
    std::string viewOn;
    // The aggregation pipeline that defines this view.
    BSONObj pipeline;
};
}