mongocxx::v_noabi Namespace Reference

Description

Declares entities whose ABI stability is NOT guaranteed.

Namespaces
namespace	events
	Declares entities describing APM events.
namespace	gridfs
	Declares entities related to GridFS.
namespace	model
	Declares entities representing bulk write operations.
namespace	options
	Declares entities representing options to use with various commands.
namespace	result
	Declares entities representing the result of various commands.

Classes
class	authentication_exception
	Unused. To be removed in an upcoming major release. More...
class	bulk_write
	A batch of write operations that can be sent to the server as a group. More...
class	bulk_write_exception
	An exception thrown during a bulk write operation. More...
class	change_stream
	A MongoDB change stream. More...
class	client
	A client connection to a MongoDB server. More...
class	client_encryption
	Supports MongoDB Client-Side Field Level Encryption operations. More...
class	client_session
	Supports MongoDB client session operations. More...
class	collection
	A MongoDB collection. More...
class	cursor
	A cursor over the documents returned by a query to a MongoDB server. More...
class	database
	A MongoDB database. More...
class	exception
	Base class for all exceptions thrown by the mongocxx library unless otherwise specified. More...
class	gridfs_exception
	An exception thrown during a GridFS operation. More...
class	hint
	The index to "hint" or force a MongoDB server to use when performing a query. More...
class	index_model
	Used by mongocxx::v_noabi::index_view. More...
class	index_view
	A MongoDB index. More...
class	instance
	An instance of the MongoDB driver. More...
class	logger
	The interface which user-defined loggers must implement. More...
class	logic_error
	An exception thrown due to incorrect use of mongocxx interfaces. More...
class	operation_exception
	An exception thrown during a MongoDB server operation. More...
class	pipeline
	A MongoDB aggregation pipeline. More...
class	pool
	A pool of reusable client objects connected to the same MongoDB topology. More...
class	query_exception
	An exception thrown during a query operation. More...
class	read_concern
	Controls the consistency and isolation properties of data read from replica sets and sharded clusters. More...
class	read_preference
	Describes how MongoDB clients route read operations to the members of a replica set or sharded cluster. More...
class	search_index_model
	Used by mongocxx::v_noabi::search_index_view. More...
class	search_index_view
	A MongoDB Atlas Search Index. More...
class	uri
	A MongoDB connection string URI. More...
class	validation_criteria
	Supports creating validation rules for fields. More...
class	write_concern
	The level of acknowledgment requested for write operations to a MongoDB server. More...
class	write_exception
	An exception thrown during a write operation. More...

Enumerations
enum class	error_code : std::int32_t
	Errors which may occur during mongocxx library usage. More...
enum class	log_level
	The log level of a log message. More...
enum class	server_error_code : std::int32_t
	Errors which may be returned by the server. More...
enum class	write_type
	Used by mongocxx::v_noabi::model::write. More...

Functions
std::error_category const &	error_category ()
	Get the error_category for mongocxx library exceptions.
std::error_code	make_error_code (error_code error)
	Translate a mongocxx::v_noabi::error_code into a std::error_code.
std::error_code	make_error_code (server_error_code error)
	Translate a mongocxx::v_noabi::server_error_code into a std::error_code.
std::error_category const &	server_error_category ()
	Get the error_category for mongocxx library exceptions.
bsoncxx::v_noabi::stdx::string_view	to_string (log_level level)
	Returns a stringification of the given log level.
bool	operator== (std::string index, hint const &index_hint)
	Convenience methods to compare against an index name.
bool	operator!= (hint const &index_hint, std::string index)
	Convenience methods to compare against an index name.
bool	operator!= (std::string index, hint const &index_index)
	Convenience methods to compare against an index name.
bool	operator== (std::string index, hint const &index_hint)
	Convenience methods to compare against an index name.
bool	operator!= (hint const &index_hint, std::string index)
	Convenience methods to compare against an index name.
bool	operator!= (std::string index, hint const &index_index)
	Convenience methods to compare against an index name.
bool	operator== (bsoncxx::v_noabi::document::view index, hint const &index_hint)
	Convenience methods to compare for equality against an index document.
bool	operator!= (hint const &index_hint, bsoncxx::v_noabi::document::view index)
	Convenience methods to compare for equality against an index document.
bool	operator!= (bsoncxx::v_noabi::document::view index, hint const &index_hint)
	Convenience methods to compare for equality against an index document.
bool	operator== (bsoncxx::v_noabi::document::view index, hint const &index_hint)
	Convenience methods to compare for equality against an index document.
bool	operator!= (hint const &index_hint, bsoncxx::v_noabi::document::view index)
	Convenience methods to compare for equality against an index document.
bool	operator!= (bsoncxx::v_noabi::document::view index, hint const &index_hint)
	Convenience methods to compare for equality against an index document.
bool	operator== (validation_criteria const &lhs, validation_criteria const &rhs)
	Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.
bool	operator!= (validation_criteria const &lhs, validation_criteria const &rhs)
	Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.
bool	operator== (validation_criteria const &lhs, validation_criteria const &rhs)
	Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.
bool	operator!= (validation_criteria const &lhs, validation_criteria const &rhs)
	Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.

Enumeration Type Documentation

error_code

enum class mongocxx::v_noabi::error_code : std::int32_t

strong

Errors which may occur during mongocxx library usage.

Note

std::is_error_code_enum is specialized for this type.

Enumerator
k_cannot_recreate_instance	More than one mongocxx::v_noabi::instance has been created.
k_invalid_client_object	A default-constructed or moved-from mongocxx::v_noabi::client object has been used.
k_invalid_collection_object	A default-constructed or moved-from mongocxx::v_noabi::collection object has been used.
k_invalid_database_object	A default-constructed or moved-from mongocxx::v_noabi::database object has been used.
k_invalid_parameter	An invalid or out-of-bounds parameter was provided.
k_ssl_not_supported	An SSL operation was used without SSL support being built.
k_unknown_read_concern	An unknown read concern level was set.
k_unknown_write_concern	An unknown write concern level was set.
k_server_response_malformed	The server returned a malformed response.
k_invalid_uri	An invalid MongoDB URI was provided.
k_invalid_gridfs_bucket_object	A default-constructed or moved-from mongocxx::v_noabi::gridfs::bucket object has been used.
k_invalid_gridfs_uploader_object	A default-constructed or moved-from mongocxx::v_noabi::gridfs::uploader object has been used.
k_invalid_gridfs_downloader_object	A default-constructed or moved-from mongocxx::v_noabi::gridfs::downloader object has been used.
k_gridfs_stream_not_open	A mongocxx::v_noabi::gridfs::uploader object was not open for writing, or a mongocxx::v_noabi::gridfs::downloader object was not open for reading.
k_gridfs_upload_requires_too_many_chunks	A mongocxx::v_noabi::gridfs::uploader object has exceeded the maximum number of allowable GridFS chunks when attempting to upload the requested file.
k_gridfs_file_not_found	The requested GridFS file was not found.
k_gridfs_file_corrupted	A GridFS file being operated on was discovered to be corrupted.
k_instance_destroyed	The mongocxx::v_noabi::instance has been destroyed.
k_cannot_create_session	mongocxx::v_noabi::client.create_session failed to create a mongocxx::v_noabi::client_session.
k_invalid_session	A failure attempting to pass a mongocxx::v_noabi::client_session to a method.
k_invalid_transaction_options_object	A moved-from mongocxx::v_noabi::options::transaction object has been used.
k_create_resource_fail	A resource (server API handle, etc.) could not be created:
k_invalid_search_index_model	A default-constructed or moved-from mongocxx::v_noabi::search_index_model object has been used.
k_invalid_search_index_view	A default-constructed or moved-from mongocxx::v_noabi::search_index_view object has been used.
k_pool_wait_queue_timeout	Timed out while waiting for a client to be returned to the pool.

log_level

enum class mongocxx::v_noabi::log_level

strong

The log level of a log message.

Enumerator
k_error	Log Level Error.
k_critical	Log Level Critical.
k_warning	Log Level Warning.
k_message	Log Level Message.
k_info	Log Level Info.
k_debug	Log Level Debug.
k_trace	Log Level Trace.

server_error_code

enum class mongocxx::v_noabi::server_error_code : std::int32_t

strong

Errors which may be returned by the server.

This type is used to represent Int32 server error codeswithout defining the error codes themselves.

Note

std::is_error_code_enum is specialized for this type.

write_type

enum class mongocxx::v_noabi::write_type

strong

Used by mongocxx::v_noabi::model::write.

Enumerator
k_insert_one	Inserting a single document into a collection.
k_delete_one	Deleting a single document from a collection.
k_delete_many	Delete one or more documents from a collection.
k_update_one	Update a single document in a collection.
k_update_many	Update one or more documents in a collection.
k_replace_one	Replace a single document in a collection with a new one.

Function Documentation

error_category()

std::error_category const & mongocxx::v_noabi::error_category

(

)

Get the error_category for mongocxx library exceptions.

Returns

The mongocxx error_category

make_error_code() [1/2]

std::error_code mongocxx::v_noabi::make_error_code ( error_code error )

inline

Translate a mongocxx::v_noabi::error_code into a std::error_code.

Parameters

error

A mongocxx::v_noabi::error_code

Returns

A std::error_code

make_error_code() [2/2]

std::error_code mongocxx::v_noabi::make_error_code ( server_error_code error )

inline

Translate a mongocxx::v_noabi::server_error_code into a std::error_code.

Parameters

error

A mongocxx::v_noabi::error_code

Returns

A std::error_code

operator!=() [1/10]

bool operator!=	(	bsoncxx::v_noabi::document::view	index,
		hint const &	index_hint )

Convenience methods to compare for equality against an index document.

Compares equal if the hint contains a matching index document. Otherwise, compares unequal.

operator!=() [2/10]

bool operator!=	(	hint const &	index_hint,
		bsoncxx::v_noabi::document::view	index )

Convenience methods to compare for equality against an index document.

Compares equal if the hint contains a matching index document. Otherwise, compares unequal.

operator!=() [3/10]

bool operator!=	(	hint const &	index_hint,
		std::string	index )

Convenience methods to compare against an index name.

Compares equal if the hint contains a matching index name. Otherwise, compares unequal.

operator!=() [4/10]

bool operator!=	(	std::string	index,
		hint const &	index_index )

Convenience methods to compare against an index name.

Compares equal if the hint contains a matching index name. Otherwise, compares unequal.

operator!=() [5/10]

bool operator!=	(	validation_criteria const &	lhs,
		validation_criteria const &	rhs )

Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.

operator==() [1/6]

bool operator==	(	bsoncxx::v_noabi::document::view	index,
		hint const &	index_hint )

Convenience methods to compare for equality against an index document.

Compares equal if the hint contains a matching index document. Otherwise, compares unequal.

operator==() [2/6]

bool operator==	(	std::string	index,
		hint const &	index_hint )

Convenience methods to compare against an index name.

Compares equal if the hint contains a matching index name. Otherwise, compares unequal.

operator==() [3/6]

bool operator==	(	validation_criteria const &	lhs,
		validation_criteria const &	rhs )

Compare equal when the arguments' rule, level, and action compare equal; otherwise, compare false.

server_error_category()

std::error_category const & mongocxx::v_noabi::server_error_category

(

)

Get the error_category for mongocxx library exceptions.

Returns

The mongocxx error_category

to_string()

bsoncxx::v_noabi::stdx::string_view mongocxx::v_noabi::to_string

(

log_level

level

)

Returns a stringification of the given log level.

Parameters

level

The type to stringify.

Returns

a std::string representation of the type.