index_key_validate.h

Go to the documentation of this file.

#pragma once

#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/server_options.h"

namespace mongo {
class BSONObj;
class CollatorInterface;
class NamespaceString;
class Status;
template <typename T>
class StatusWith;

namespace index_key_validate {

Status validateKeyPattern(const BSONObj& key, IndexDescriptor::IndexVersion indexVersion);

StatusWith<BSONObj> validateIndexSpec(
    OperationContext* opCtx,
    const BSONObj& indexSpec,
    const NamespaceString& expectedNamespace,
    const ServerGlobalParams::FeatureCompatibility& featureCompatibility);

Status validateIdIndexSpec(const BSONObj& indexSpec);

Status validateIndexSpecFieldNames(const BSONObj& indexSpec);

StatusWith<BSONObj> validateIndexSpecCollation(OperationContext* opCtx,
                                               const BSONObj& indexSpec,
                                               const CollatorInterface* defaultCollator);

}  // namespace index_key_validate
}  // namespace mongo