collection_info_cache_impl.h

Go to the documentation of this file.

#pragma once

#include "mongo/db/catalog/collection_info_cache.h"

#include "mongo/base/shim.h"
#include "mongo/db/collection_index_usage_tracker.h"
#include "mongo/db/query/plan_cache.h"
#include "mongo/db/query/query_settings.h"
#include "mongo/db/update_index_data.h"

namespace mongo {

class Collection;
class IndexDescriptor;
class OperationContext;

class CollectionInfoCacheImpl : public CollectionInfoCache::Impl {
public:
    explicit CollectionInfoCacheImpl(Collection* collection, const NamespaceString& ns);

    ~CollectionInfoCacheImpl();

    PlanCache* getPlanCache() const;

    QuerySettings* getQuerySettings() const;

    /* get set of index keys for this namespace.  handy to quickly check if a given
       field is indexed (Note it might be a secondary component of a compound index.)
    */
    const UpdateIndexData& getIndexKeys(OperationContext* opCtx) const;

    CollectionIndexUsageMap getIndexUsageStats() const;

    void init(OperationContext* opCtx);

    void addedIndex(OperationContext* opCtx, const IndexDescriptor* desc);

    void droppedIndex(OperationContext* opCtx, StringData indexName);

    void clearQueryCache();

    void notifyOfQuery(OperationContext* opCtx, const std::set<std::string>& indexesUsed);

private:
    void computeIndexKeys(OperationContext* opCtx);
    void updatePlanCacheIndexEntries(OperationContext* opCtx);

    void rebuildIndexData(OperationContext* opCtx);

    Collection* _collection;  // not owned
    const NamespaceString _ns;

    // ---  index keys cache
    bool _keysComputed;
    UpdateIndexData _indexedPaths;

    // A cache for query plans.
    std::unique_ptr<PlanCache> _planCache;

    // Query settings.
    // Includes index filters.
    std::unique_ptr<QuerySettings> _querySettings;

    // Tracks index usage statistics for this collection.
    CollectionIndexUsageTracker _indexUsageTracker;

    bool _hasTTLIndex = false;
};

}  // namespace mongo