MongoDB C++ Driver mongocxx-3.4.0
|
Class representing a client connection to MongoDB. More...
#include <client.hpp>
Public Member Functions | |
client () noexcept | |
Default constructs a new client. | |
client (const class uri &mongodb_uri, const options::client &options=options::client()) | |
Creates a new client connection to MongoDB. | |
client (client &&) noexcept | |
Move constructs a client. | |
client & | operator= (client &&) noexcept |
Move assigns a client. | |
~client () | |
Destroys a client. | |
operator bool () const noexcept | |
Returns true if the client is valid, meaning it was not default constructed or moved from. | |
void | read_concern (class read_concern rc) |
Sets the read concern for this client. | |
class read_concern | read_concern () const |
Returns the current read concern for this client. | |
void | read_preference (class read_preference rp) |
Sets the read preference for this client. | |
class read_preference | read_preference () const |
Returns the current read preference for this client. | |
class uri | uri () const |
Returns the current uri for this client. | |
void | write_concern (class write_concern wc) |
Sets the write concern for this client. | |
class write_concern | write_concern () const |
Returns the current write concern for this client. | |
class database | database (bsoncxx::string::view_or_value name) const & |
Obtains a database that represents a logical grouping of collections on a MongoDB server. | |
class database | operator[] (bsoncxx::string::view_or_value name) const & |
Allows the syntax client ["db_name"] as a convenient shorthand for the client::database() method by implementing the array subscript operator. | |
client_session | start_session (const options::client_session &options={}) |
Create a client session for a sequence of operations. | |
Class representing a client connection to MongoDB.
Acts as a logical gateway for working with databases contained within a MongoDB server.
Databases that are created via this client inherit the read_concern
, read_preference
, and write_concern
settings of this client when they are created. The lifetimes of objects created via a client object (databases, collections, cursors, etc...) must be a subset of the lifetime of the client that created them.
Example:
Note that client is not thread-safe. See https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/thread-safety/ for more details.
|
noexcept |
Default constructs a new client.
The client is not connected and is equivalent to the state of a moved-from client. The only valid actions to take with a default constructed 'client' are to assign to it, or destroy it.
mongocxx::client::client | ( | const class uri & | mongodb_uri, |
const options::client & | options = options::client() |
||
) |
Creates a new client connection to MongoDB.
mongodb_uri | A MongoDB URI representing the connection parameters |
options | Additional options that cannot be specified via the mongodb_uri |
mongocxx::exception | if invalid options are provided (whether from the URI or provided client options). |
class database mongocxx::client::database | ( | bsoncxx::string::view_or_value | name | ) | const & |
Obtains a database that represents a logical grouping of collections on a MongoDB server.
name | The name of the database to get |
cursor mongocxx::client::list_databases | ( | ) | const |
Enumerates the databases in the client.
mongocxx::operation_exception | if the underlying 'listDatabases' command fails. |
cursor mongocxx::client::list_databases | ( | const bsoncxx::document::view_or_value | filter | ) | const |
Enumerates the databases in the client.
filter | The filter that documents must match in order to be listed. |
mongocxx::operation_exception | if the underlying 'listDatabases' command fails. |
cursor mongocxx::client::list_databases | ( | const client_session & | session | ) | const |
Enumerates the databases in the client.
session | The mongocxx::client_session with which to perform the aggregation. |
mongocxx::operation_exception | if the underlying 'listDatabases' command fails. |
database mongocxx::client::operator[] | ( | bsoncxx::string::view_or_value | name | ) | const & |
Allows the syntax client
["db_name"] as a convenient shorthand for the client::database() method by implementing the array subscript operator.
name | The name of the database. |
class read_concern mongocxx::client::read_concern | ( | ) | const |
Returns the current read concern for this client.
read_concern
void mongocxx::client::read_concern | ( | class read_concern | rc | ) |
Sets the read concern for this client.
Modifications at this level do not affect existing database instances that have been created by this client but do affect new ones as databases inherit the read_concern
settings of their parent upon instantiation.
rc | The new read_concern |
class read_preference mongocxx::client::read_preference | ( | ) | const |
Returns the current read preference for this client.
read_preference
void mongocxx::client::read_preference | ( | class read_preference | rp | ) |
Sets the read preference for this client.
Modifications at this level do not affect existing database instances that have been created by this client but do affect new ones as databases inherit the read_preference
settings of their parent upon instantiation.
rp | The new read_preference |
client_session mongocxx::client::start_session | ( | const options::client_session & | options = {} | ) |
Create a client session for a sequence of operations.
mongocxx::client_session
for more information.mongocxx::operation_exception | if the driver is not built with crypto support, if options is misconfigured, or if the session is configured with options that the server does not support. |
class uri mongocxx::client::uri | ( | ) | const |
Returns the current uri for this client.
uri
that this client was created with. change_stream mongocxx::client::watch | ( | const client_session & | session, |
const options::change_stream & | options = {} |
||
) |
session | The mongocxx::client_session with which to perform the watch operation. |
options | The options to use when creating the change stream. |
change_stream mongocxx::client::watch | ( | const client_session & | session, |
const pipeline & | pipe, | ||
const options::change_stream & | options = {} |
||
) |
Gets a change stream on this client.
session | The mongocxx::client_session with which to perform the watch operation. |
pipe | The aggregation pipeline to be used on the change notifications. |
options | The options to use when creating the change stream. |
change_stream mongocxx::client::watch | ( | const options::change_stream & | options = {} | ) |
Gets a change stream on this client with an empty pipeline.
Change streams are only supported with a "majority" read concern or no read concern.
options | The options to use when creating the change stream. |
change_stream mongocxx::client::watch | ( | const pipeline & | pipe, |
const options::change_stream & | options = {} |
||
) |
Gets a change stream on this client.
Change streams are only supported with a "majority" read concern or no read concern.
pipe | The aggregation pipeline to be used on the change notifications. Only a subset of pipeline operations are supported for change streams. For more information see the change streams documentation. |
options | The options to use when creating the change stream. |
class write_concern mongocxx::client::write_concern | ( | ) | const |
Returns the current write concern for this client.
write_concern
void mongocxx::client::write_concern | ( | class write_concern | wc | ) |
Sets the write concern for this client.
write_concern
upon instantiation.wc | The new write concern |