MongoDB C++ Driver  mongocxx-3.3.2
All Classes Namespaces Functions Enumerations Enumerator Friends Pages
client.hpp
1 // Copyright 2014-present 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 <mongocxx/client_session.hpp>
20 #include <mongocxx/database.hpp>
21 #include <mongocxx/options/client.hpp>
22 #include <mongocxx/options/client_session.hpp>
23 #include <mongocxx/read_concern.hpp>
24 #include <mongocxx/read_preference.hpp>
25 #include <mongocxx/stdx.hpp>
26 #include <mongocxx/uri.hpp>
27 #include <mongocxx/write_concern.hpp>
28 
29 #include <mongocxx/config/prelude.hpp>
30 
34 namespace mongocxx {
35 MONGOCXX_INLINE_NAMESPACE_BEGIN
36 
37 class client_session;
38 
57 class MONGOCXX_API client {
58  public:
64  client() noexcept;
65 
77  client(const class uri& mongodb_uri, const options::client& options = options::client());
78 
82  client(client&&) noexcept;
83 
87  client& operator=(client&&) noexcept;
88 
92  ~client();
93 
98  explicit operator bool() const noexcept;
99 
116  MONGOCXX_DEPRECATED void read_concern(class read_concern rc);
117  void read_concern_deprecated(class read_concern rc);
118 
124  class read_concern read_concern() const;
125 
142  MONGOCXX_DEPRECATED void read_preference(class read_preference rp);
143  void read_preference_deprecated(class read_preference rp);
144 
152  class read_preference read_preference() const;
153 
159  class uri uri() const;
160 
175  MONGOCXX_DEPRECATED void write_concern(class write_concern wc);
176  void write_concern_deprecated(class write_concern wc);
177 
182  class write_concern write_concern() const;
183 
194  class database database(bsoncxx::string::view_or_value name) const&;
195  class database database(bsoncxx::string::view_or_value name) const&& = delete;
196 
208  MONGOCXX_INLINE class database operator[](bsoncxx::string::view_or_value name) const&;
209  MONGOCXX_INLINE class database operator[](bsoncxx::string::view_or_value name) const&& = delete;
210 
226  cursor list_databases() const;
227 
244  cursor list_databases(const client_session& session) const;
245 
249 
259  client_session start_session(const options::client_session& options = {});
260 
261  private:
262  friend class collection;
263  friend class database;
264  friend class pool;
265  friend class client_session;
266 
267 #ifdef MONGOCXX_TESTING
268  // TODO: Port to C++ Driver's APM once it's implemented, CXX-1562.
269  friend MONGOCXX_API void* MONGOCXX_CALL client_t_from_client(client& client);
270 #endif
271 
272  MONGOCXX_PRIVATE explicit client(void* implementation);
273 
274  class MONGOCXX_PRIVATE impl;
275 
276  MONGOCXX_PRIVATE impl& _get_impl();
277  MONGOCXX_PRIVATE const impl& _get_impl() const;
278 
279  std::unique_ptr<impl> _impl;
280 };
281 
282 MONGOCXX_INLINE database client::operator[](bsoncxx::string::view_or_value name) const& {
283  return database(name);
284 }
285 
286 MONGOCXX_INLINE_NAMESPACE_END
287 } // namespace mongocxx
288 
289 #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:24
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:57
A pool of client objects associated with a MongoDB deployment.
Definition: pool.hpp:47
Use a session for a sequence of operations, optionally with causal consistency.
Definition: client_session.hpp:38
Class representing a MongoDB database.
Definition: database.hpp:47
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
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:87