1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/**
* Copyright (C) 2018-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
namespace mongo {
class BSONObj;
class Status;
/**
* Converts "result" into a Status object. The input is expected to be the object returned
* by running a command. Returns ErrorCodes::CommandResultSchemaViolation if "result" does
* not look like the result of a command.
*
* Command results must have a field called "ok" whose value may be interpreted as a boolean.
* If the value interpreted as a boolean is true, the resultant status is Status::OK().
* Otherwise, it is an error status. The code comes from the "code" field, if present and
* number-ish, while the reason message will come from the errmsg field, if present and
* string-ish.
*/
Status getStatusFromCommandResult(const BSONObj& result);
/**
* Extracts the write concern error from a command response.
*/
Status getWriteConcernStatusFromCommandResult(const BSONObj& cmdResponse);
/**
* Extracts the first write error from a command response and converts it into a status. This
* ignores all errors after the first and does not preserve the write error index, so it should not
* be used with bulk writes.
*/
Status getFirstWriteErrorStatusFromCommandResult(const BSONObj& cmdResponse);
/**
* Extracts any type of error from a write command response.
*/
Status getStatusFromWriteCommandReply(const BSONObj& cmdResponse);
} // namespace mongo
|
