summaryrefslogtreecommitdiff
path: root/src/mongo/db/ops/write_ops_exec.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/db/ops/write_ops_exec.h')
-rw-r--r--src/mongo/db/ops/write_ops_exec.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/src/mongo/db/ops/write_ops_exec.h b/src/mongo/db/ops/write_ops_exec.h
new file mode 100644
index 00000000000..37ab8dd3ee1
--- /dev/null
+++ b/src/mongo/db/ops/write_ops_exec.h
@@ -0,0 +1,85 @@
+/**
+ * Copyright (C) 2016 MongoDB Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * 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 GNU Affero General 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 <boost/optional.hpp>
+#include <vector>
+
+#include "mongo/base/status_with.h"
+#include "mongo/db/operation_context.h"
+#include "mongo/db/ops/write_ops.h"
+#include "mongo/s/stale_exception.h"
+
+namespace mongo {
+
+/**
+ * The result of performing a single write, possibly within a batch.
+ */
+struct WriteResult {
+ struct SingleResult {
+ int64_t n;
+ int64_t nModified;
+ BSONObj upsertedId; // Non-empty if something was upserted.
+ };
+
+ /**
+ * Maps 1-to-1 to single ops in request. May be shorter than input if there are errors.
+ *
+ * staleConfigException should be considered appended to this if it is non-null.
+ */
+ std::vector<StatusWith<SingleResult>> results;
+
+ /**
+ * If non-null, the SendStaleConfigException that was encountered while processing the op after
+ * the last op reported in results. Processing always stops at the first SCE and nothing is
+ * placed in results for the op that triggered it. The whole exception is copied here because it
+ * contains additional data not included in the Status.
+ *
+ * TODO convert to std::unique_ptr once we are on MSVC2015.
+ */
+ std::shared_ptr<SendStaleConfigException> staleConfigException;
+};
+
+
+/**
+ * Performs a batch of inserts, updates, or deletes.
+ *
+ * These functions handle all of the work of doing the writes, including locking, incrementing
+ * counters, managing CurOp, and of course actually doing the write. Waiting for the writeConcern is
+ * *not* handled by these functions and is expected to be done by the caller if needed.
+ *
+ * LastError is updated for failures of individual writes, but not for batch errors reported by an
+ * exception being thrown from these functions. Callers are responsible for managing LastError in
+ * that case. This should generally be combined with LastError handling from parse failures.
+ */
+WriteResult performInserts(OperationContext* txn, const InsertOp& op);
+WriteResult performUpdates(OperationContext* txn, const UpdateOp& op);
+WriteResult performDeletes(OperationContext* txn, const DeleteOp& op);
+
+} // namespace mongo