summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/collection_validation.h
diff options
context:
space:
mode:
authorGabe Villasana <villagab4@gmail.com>2019-07-17 17:53:24 -0400
committerGabe Villasana <villagab4@gmail.com>2019-07-24 16:47:30 -0400
commit9dd393da7f1961dc7f09d8b0696a3082dbbf0190 (patch)
tree471608ace4955a2b610fe78eaf85db079a4a6c8b /src/mongo/db/catalog/collection_validation.h
parent59790d4626c193613db34c34338c424a636b8cad (diff)
downloadmongo-9dd393da7f1961dc7f09d8b0696a3082dbbf0190.tar.gz
SERVER-42180 Move the CollectionImpl::validate logic out of the Collection class and into it's own file + namespace
Diffstat (limited to 'src/mongo/db/catalog/collection_validation.h')
-rw-r--r--src/mongo/db/catalog/collection_validation.h59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/mongo/db/catalog/collection_validation.h b/src/mongo/db/catalog/collection_validation.h
new file mode 100644
index 00000000000..b7993e88c91
--- /dev/null
+++ b/src/mongo/db/catalog/collection_validation.h
@@ -0,0 +1,59 @@
+/**
+ * Copyright (C) 2019-present MongoDB, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * 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
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ *
+ * 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 Server Side 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 "mongo/db/catalog/record_store_validate_adaptor.h"
+
+namespace mongo {
+
+class OperationContext;
+class Collection;
+struct ValidateResults;
+class BSONObjBuilder;
+class Status;
+
+namespace CollectionValidation {
+
+/**
+ * Expects the caller to hold at least a collection IS lock.
+ *
+ * @return OK if the validate run successfully
+ * OK will be returned even if corruption is found
+ * details will be in 'results'.
+ */
+Status validate(OperationContext* opCtx,
+ Collection* coll,
+ ValidateCmdLevel level,
+ bool background,
+ ValidateResults* results,
+ BSONObjBuilder* output);
+
+} // namespace CollectionValidation
+} // namespace mongo