MongoDB C++ Driver  mongocxx-3.2.0
client.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <memory>
18 
19 #include <bsoncxx/string/view_or_value.hpp>
20 #include <mongocxx/database.hpp>
21 #include <mongocxx/options/client.hpp>
22 #include <mongocxx/read_concern.hpp>
23 #include <mongocxx/read_preference.hpp>
24 #include <mongocxx/stdx.hpp>
25 #include <mongocxx/uri.hpp>
26 #include <mongocxx/write_concern.hpp>
27 
28 #include <mongocxx/config/prelude.hpp>
29 
33 namespace mongocxx {
34 MONGOCXX_INLINE_NAMESPACE_BEGIN
35 
54 class MONGOCXX_API client {
55  public:
61  client() noexcept;
62 
74  client(const class uri& mongodb_uri, const options::client& options = options::client());
75 
79  client(client&&) noexcept;
80 
84  client& operator=(client&&) noexcept;
85 
89  ~client();
90 
95  explicit operator bool() const noexcept;
96 
113  MONGOCXX_DEPRECATED void read_concern(class read_concern rc);
114  void read_concern_deprecated(class read_concern rc);
115 
121  class read_concern read_concern() const;
122 
139  MONGOCXX_DEPRECATED void read_preference(class read_preference rp);
140  void read_preference_deprecated(class read_preference rp);
141 
149  class read_preference read_preference() const;
150 
156  class uri uri() const;
157 
172  MONGOCXX_DEPRECATED void write_concern(class write_concern wc);
173  void write_concern_deprecated(class write_concern wc);
174 
179  class write_concern write_concern() const;
180 
191  class database database(bsoncxx::string::view_or_value name) const&;
192  class database database(bsoncxx::string::view_or_value name) const&& = delete;
193 
205  MONGOCXX_INLINE class database operator[](bsoncxx::string::view_or_value name) const&;
206  MONGOCXX_INLINE class database operator[](bsoncxx::string::view_or_value name) const&& = delete;
207 
221  cursor list_databases() const;
222 
223  private:
224  friend class collection;
225  friend class database;
226  friend class pool;
227 
228  MONGOCXX_PRIVATE explicit client(void* implementation);
229 
230  class MONGOCXX_PRIVATE impl;
231 
232  MONGOCXX_PRIVATE impl& _get_impl();
233  MONGOCXX_PRIVATE const impl& _get_impl() const;
234 
235  std::unique_ptr<impl> _impl;
236 };
237 
238 MONGOCXX_INLINE database client::operator[](bsoncxx::string::view_or_value name) const& {
239  return database(name);
240 }
241 
242 MONGOCXX_INLINE_NAMESPACE_END
243 } // namespace mongocxx
244 
245 #include <mongocxx/config/postlude.hpp>
Class representing a MongoDB connection string URI.
Definition: uri.hpp:40
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:22
Class representing the optional arguments to a MongoDB driver client object.
Definition: client.hpp:33
Class representing a pointer to the result set of a query on a MongoDB server.
Definition: cursor.hpp:36
Class representing a client connection to MongoDB.
Definition: client.hpp:54
A pool of client objects associated with a MongoDB deployment.
Definition: pool.hpp:47
Class representing a MongoDB database.
Definition: database.hpp:46
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:57
A class to represent the read concern.
Definition: read_concern.hpp:52
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
Class representing the server-side requirement for reporting the success of a write operation...
Definition: write_concern.hpp:55
Class representing server side document groupings within a MongoDB database.
Definition: collection.hpp:84