File: exception.cpp

package info (click to toggle)
mongo-cxx-driver 4.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 13,832 kB
  • sloc: cpp: 61,365; python: 1,436; sh: 356; xml: 253; perl: 215; makefile: 21
file content (155 lines) | stat: -rw-r--r-- 6,458 bytes parent folder | download
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <cstdlib>
#include <iostream>

#include <bsoncxx/builder/basic/document.hpp>
#include <bsoncxx/builder/basic/kvp.hpp>
#include <bsoncxx/json.hpp>

#include <mongocxx/client.hpp>
#include <mongocxx/exception/bulk_write_exception.hpp>
#include <mongocxx/exception/error_code.hpp>
#include <mongocxx/exception/logic_error.hpp>
#include <mongocxx/exception/operation_exception.hpp>
#include <mongocxx/exception/server_error_code.hpp>
#include <mongocxx/instance.hpp>
#include <mongocxx/uri.hpp>

#include <examples/macros.hh>

using bsoncxx::builder::basic::kvp;
using bsoncxx::builder::basic::make_document;

int EXAMPLES_CDECL main() {
    // Do not print error messages when run in CI to prevent MSBuild diagnostic format detection
    // from causing build failures. There is currently no way to specify
    // IgnoreStandardErrorWarningFormat=true via CMake or CLI. See:
    // https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-diagnostic-format-for-tasksIgnoreStandardErrorWarningFormat
    const bool print_error_messages = std::getenv("MONGOCXX_TEST_TOPOLOGY") == nullptr;

    // The mongocxx::instance constructor and destructor initialize and shut down the driver,
    // respectively. Therefore, a mongocxx::instance must be created before using the driver and
    // must remain alive for as long as the driver is in use.
    mongocxx::instance inst{};
    mongocxx::client conn{mongocxx::uri{}};

    // Using an uninitialized collection throws a mongocxx::logic_error.
    // A mongocxx::logic_error is-a mongocxx::exception is-a std::system_error.
    mongocxx::collection coll;
    try {
        coll.name();
    } catch (const mongocxx::logic_error& e) {
        std::cout << "Using an uninitialized collection throws:" << std::endl;

        // Local errors, like those generated by mis-use of the
        // library itself, exist in the mongocxx 'error_category'
        // object. This is to be distinguished from the mongocxx
        // 'server_error_category' object, which tracks errors
        // returned by the server.
        //
        // NOTE: At this time, the server_error_category has no
        // associated symbolic errors. You must use numeric codes to
        // understand the errors returned in this category. See below
        // for more discussion.
        if (e.code().category() != mongocxx::error_category()) {
            return EXIT_FAILURE;
        }

        // We can compare the error_code to a known mongocxx::error_code.
        if (e.code() != mongocxx::error_code::k_invalid_collection_object) {
            return EXIT_FAILURE;
        }

        if (print_error_messages) {
            std::cout << e.what() << std::endl << std::endl;
        }
    }

    // Renaming a collection that does not exist throws a mongocxx::operation_exception.
    // A mongocxx::operation_exception is-a mongocxx::exception is-a std::system_error.
    coll = conn["test"]["coll"];
    coll.drop();
    try {
        coll.rename("coll2");
    } catch (const mongocxx::operation_exception& e) {
        std::cout << "Renaming a collection that does not exist throws:" << std::endl;

        // We expect this error to arise from the server
        if (e.code().category() != mongocxx::server_error_category()) {
            return EXIT_FAILURE;
        }

        // We can compare the error_code to a known server side error
        // code number. Please see
        // https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.yml
        // for details on the sort of error codes the server might
        // return. In this case, 26 means 'NamespaceNotFound'.
        //
        // NOTE: Due to a design flaw in the C driver which currently
        // is the underlying implementation of the C++11 driver, it is
        // not possible to reliably distinguish between error codes
        // generated locally by libmongoc, or error codes generated
        // remotely by the server. Clients of libmongocxx are
        // therefore required to interpret the code numerically and
        // contextually.  When the C driver fixes its error handling
        // strategy, we will add symbolic codes for server errors, and
        // report local library errors from libmongoc in the
        // mongocxx::error_code enumeration.
        if (e.code().value() != 26) {
            return EXIT_FAILURE;
        }

        if (print_error_messages) {
            std::cout << e.what() << std::endl;
            if (e.raw_server_error()) {
                std::cout << bsoncxx::to_json(*(e.raw_server_error())) << std::endl;
            }
            std::cout << std::endl;
        }
    }

    // Adding a document whose "_id" is already present throws a mongocxx::bulk_write_exception.
    // A mongocxx::bulk_write_exception is-a mongocxx::operation_exception is-a mongocxx::exception
    // is-a std::system_error.
    auto doc = make_document(kvp("_id", 1));
    coll.insert_one(doc.view());
    try {
        coll.insert_one(doc.view());
    } catch (const mongocxx::bulk_write_exception& e) {
        std::cout << "Adding a document whose _id is already present throws:" << std::endl;

        // We expect this error to arise from the server
        if (e.code().category() != mongocxx::server_error_category()) {
            return EXIT_FAILURE;
        }

        // We can compare the error_code to a known server side error code number
        if (e.code().value() != 11000) {
            return EXIT_FAILURE;
        }

        if (print_error_messages) {
            std::cout << e.what() << std::endl;
            if (e.raw_server_error()) {
                std::cout << "Raw server error:" << std::endl;
                std::cout << bsoncxx::to_json(*(e.raw_server_error())) << std::endl;
            }
            std::cout << std::endl;
        }
    }

    return EXIT_SUCCESS;
}